AptlyStar

IMAP

Available IMAP triggers for automating workflows

IMAP provides 1 trigger for automating workflows based on events.

All triggers below are polling-based — they check for new data on a schedule rather than receiving push notifications.

Triggers

IMAP Email Trigger

Triggers when new emails are received via IMAP (works with any email provider)

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
emailobjectemail output from the tool
↳ 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

On this page