Skip to content
Joshua Haas edited this page Aug 23, 2017 · 4 revisions

This allows sibyl to execute and reply to e-mails. Best practice is probably to have a dedicated account that only sibyl uses. It is highly recommended that you use email.key to counteract address spoofing.

Requirements

You just need an e-mail account with SMTP and IMAP enabled. For config options below, assume email.address is set to 'sibyl@mymail.com' for the purpose of determining the default values of email.imap and email.smtp.

Config

Required

  • protocols - include email
  • email.username - the e-mail account for Sibyl to use
  • email.password - the account's password

Optional

  • email.key - if specified, only e-mails that contain it will be executed (default None)
  • email.delete - if True, delete e-mails from the server after we read them (default True)
  • email.imap - IMAP server to use (default: 'imap.mymail.com')
  • email.smtp - SMTP server to use (default: 'smtp.mymail.com')

Notes

Mail Formatting

Sibyl only attempts to execute the first line of text in e-mails. On the other hand, email.key can be anywhere in the body.

Also note that sibyl only accepts plaintext messages. This shouldn't be an issue for most users, since MIME/multipart messages usually unclude a plaintext section.

Security

Plesae note that it isn't that hard to spoof the sender address of an e-mail. Therefore using sibyl's bw_list on its own may not be enough to ensure that spam mail can't control sibyl. Even if you do use email.key, activate this protocol at your own risk.

Servers

  • Postfix/Dovecot
  • GMail, Yahoo, Hotmail, etc.

Clients

  • Thunderbird (Linux/Windows/Mac)
  • Web clients
  • Phone clients

Credits

Clone this wiki locally