Email

Category: Cloud Status: draft

Connects to an email account over IMAP (browsing mailbox contents) and SMTP (sending messages). The connection is established and verified via IMAP; SMTP parameters are derived from it or set explicitly in the connector options.

Connection Settings

Field Default Description
imap_host (empty) IMAP server hostname (e.g. imap.gmail.com)
imap_port 993 IMAP port (993 for SSL)
smtp_host (empty) SMTP server hostname; if empty, derived from the IMAP host by replacing the imap. prefix with smtp.
smtp_port 465 SMTP port (465 for SSL)
user (empty) Email address or username
password (empty) Email password or app password

The connection string is compiled as imap://user:password@imap_host:imap_port. Connection check (check_connection / is_active) verifies the IMAP login.

Additional Options

Option Default Description
smtp_use_ssl true Use implicit SSL for SMTP; when false, STARTTLS is used instead
folders ["INBOX"] Folders to monitor
search_criteria UNSEEN IMAP search criteria for new messages
mark_as_seen true Mark processed messages as read
timeout 60.0 Mail polling period, seconds
connection_timeout 30.0 Network connection timeout, seconds
initial_fetch_limit 20 Number of messages fetched initially

Authentication

Username (email address) and password. For Gmail and other modern providers, use an App Password instead of the account password. The password is stored encrypted in the application config, not in the connection string.

Supported Actions

Related

External Links