https://github.com/ovoshatchery/ovos-phal-plugin-email-commands
control mycroft by email
https://github.com/ovoshatchery/ovos-phal-plugin-email-commands
Last synced: about 1 year ago
JSON representation
control mycroft by email
- Host: GitHub
- URL: https://github.com/ovoshatchery/ovos-phal-plugin-email-commands
- Owner: OVOSHatchery
- License: apache-2.0
- Created: 2020-09-13T14:44:03.000Z (almost 6 years ago)
- Default Branch: master
- Last Pushed: 2021-10-20T17:54:31.000Z (almost 5 years ago)
- Last Synced: 2025-03-25T05:37:17.931Z (over 1 year ago)
- Language: Python
- Size: 448 KB
- Stars: 2
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: readme.md
- License: LICENSE
Awesome Lists containing this project
README
# 
Email Commands Skill
Control Mycroft by email
## About
Allows you to send commands to mycroft by email, inspired by [this blog post](https://medium.com/@thesanjeetc/want-to-control-something-with-siri-heres-how-bae98aceb586)
# Skill configuration
I did not use mycroft home backend for skill settings, it is irresponsible
to get your email credentials in there. Instead you need to edit mycroft.conf
This is a security measure, i will not change this behaviour
Add the following section to your [mycroft.conf](https://mycroft-ai.gitbook.io/docs/using-mycroft-ai/customizations/mycroft-conf)
```json
"email": {
"mail": "",
"password": "",
"address":"imap.gmail.com",
"port":993,
"folder":"inbox",
"time_between_checks":30,
"include_read": false,
"whitelist": ["thisemail@isallowed.com", "email@thatcansend.commands"]
}
```
only mail, password and whitelist are required, other parameters use the
defaults for gmail, if using a different provider you might need to change address and port
time_between_checks is in seconds, it is the time to sleep between checking
for new emails, the "lag" between a command and its execution
whitelist is a list of emails allowed to send commands to mycroft, if the
sender is not in this list then the emails will be ignored
some uses cases, like using siri Notes, will mark emails as read, setting
"include_read" to true will process those emails, note that this will
execute ALL old emails on first run, it is strongly recommended that you
only set this flag if using a newly created folder
# Email configuration
You might need to change some settings in your email provider, for gmail you need to
- enable less secure apps https://myaccount.google.com/lesssecureapps
- enable imap https://mail.google.com/mail/u/1/?tab=mm#settings/fwdandpop
# Platform support
- :heavy_check_mark: - tested and confirmed working
- :x: - incompatible/non-functional
- :question: - untested
- :construction: - partial support
| platform | status | tag | version | last tested |
|:---------------:|:----------:|:-----:|:-------:|:-----------:|
| [Chatterbox](https://hellochatterbox.com) | :question: | dev | | never |
| [HolmesV](https://github.com/HelloChatterbox/HolmesV) | :question: | dev | | never |
| [LocalHive](https://github.com/JarbasHiveMind/LocalHive) | :question: | dev | | never |
| [Mycroft Mark1](https://github.com/MycroftAI/enclosure-mark1) | :question: | dev | | never |
| [Mycroft Mark2](https://github.com/MycroftAI/hardware-mycroft-mark-II) | :question: | dev | | never |
| [NeonGecko](https://neon.ai) | :question: | dev | | never |
| [OVOS](https://github.com/OpenVoiceOS) | :question: | dev | | never |
| [Picroft](https://github.com/MycroftAI/enclosure-picroft) | :question: | dev | | never |
| [Plasma Bigscreen](https://plasma-bigscreen.org/) | :question: | dev | | never |
- `tag` - link to github release / branch / commit
- `version` - link to release/commit of platform repo where this was tested
## Credits
- JarbasAl
## Category
**Configuration**
## Tags
#configuration