Skip to main content

Email Receiver

Email Receiver is an event source. It polls the mailbox on an IMAP resource and starts a workflow for each message that passes its filters.

After Processing decides what happens to a message once its workflow has run — marked read, deleted, moved to another folder, or left untouched. Choosing an action here is what stops the same message being picked up on the next poll.

Attachments are inlined as base64 up to Inline Attachment Max (bytes). Anything larger is flagged truncated in the output rather than inlined.

The activity has three tabs: Configuration, Advanced, and Output.

Configuration

FieldRequiredDescription
NameOptionalName of the component.
DescriptionOptionalDescription of the component.
IMAP ConnectionOptionalThe IMAP or POP3 mailbox resource to poll.
FolderOptionalFolder to poll. Defaults to INBOX. Blank uses the connection's default folder.
After ProcessingOptionalMark as read, Delete, Move to folder, or Leave as-is. Defaults to Mark as read.

Choosing Move to folder requires Move To Folder on the Advanced tab.

Advanced

FieldRequiredDescription
Start PositionOptionalOn first activation, skip existing mailbox messages or drain the current backlog. New messages only or All existing messages. Defaults to New messages only.
Unseen OnlyOptionalFetch only unseen messages. Defaults to cleared.
Poll Interval (s)OptionalDefaults to 30.
Batch SizeOptionalMaximum messages processed per poll. Defaults to 25.
Download AttachmentsOptionalDefaults to selected.
Inline Attachment Max (bytes)OptionalAttachments up to this size are inlined as base64; larger ones are flagged truncated. Defaults to 262144.
From ContainsOptionalOnly deliver messages whose From contains this text.
Subject ContainsOptionalOnly deliver messages whose Subject contains this text.
Move To FolderOptionalTarget folder when After Processing is Move to folder.

Output

FieldData TypeDescription
messageIdStringMessage-ID header value when present.
fromStringSender address from the From header.
toArrayRecipients from the To header.
ccArrayRecipients from the Cc header.
subjectStringEmail subject.
dateStringSent date, ISO-8601.
headersObjectAll headers as key-value pairs.
messageStringPlain-text body parsed from the text/plain MIME part, when present.
htmlStringHTML body parsed from the text/html MIME part, when present.
attachmentsArrayAttachments and inline parts extracted from the message.

attachments

FieldData TypeDescription
nameStringAttachment filename.
contentTypeStringAttachment content type.
sizeIntegerAttachment size.
contentBase64StringPresent when the attachment was inlined, meaning it was within Inline Attachment Max (bytes).
truncatedBooleanTrue when the attachment exceeded the inline cap and was not downloaded.
cidStringContent-ID for inline images.