IMAP

Use the IMAP Email trigger to start workflows from messages in an IMAP-enabled mailbox. Configure the mailbox connection and folder, then filter messages by sender, subject, or custom search criteria. Message content and attachments are available to subsequent workflow steps.

Triggers

A trigger starts a workflow when a supported event occurs in this service.

These triggers poll for new data on a schedule.

IMAP Email Trigger

Start a workflow when an IMAP-enabled mailbox receives matching messages.

Configuration and outputs

Configuration

ParameterTypeRequiredDescription
hoststringYesIMAP server hostname (e.g., imap.gmail.com, outlook.office365.com)
portstringYesIMAP port (993 for SSL/TLS, 143 for STARTTLS)
securebooleanNoEnable SSL/TLS encryption (recommended for port 993)
usernamestringYesEmail address or username for authentication
passwordstringYesPassword or app-specific password (for Gmail, use an App Password)
mailboxstringNoChoose which mailbox/folder(s) to monitor for new emails. Leave empty to monitor INBOX.
searchCriteriastringNoImapFlow search criteria as JSON object. Default: unseen messages only.
markAsReadbooleanNoAutomatically mark emails as read (SEEN) after processing
includeAttachmentsbooleanNoDownload and include email attachments in the trigger payload

Output

ParameterTypeDescription
emailobject
↳ messageIdstringRFC Message-ID header
↳ subjectstringEmail subject line
↳ fromstringSender email address
↳ tostringRecipient email address
↳ ccstringCC recipients
↳ datestringEmail date in ISO format
↳ bodyTextstringPlain text email body
↳ bodyHtmlstringHTML email body
↳ mailboxstringMailbox/folder where email was received
↳ hasAttachmentsbooleanWhether email has attachments
↳ attachmentsfile[]Array of email attachments as files (if includeAttachments is enabled)
timestampstringEvent timestamp