Skip to main content
Version: Current

Read IMAP Email

Description​

The Read IMAP Email activity reads email messages from an IMAP mailbox using a configured Email Server connection and exposes the retrieved emails as structured output for downstream processing.

Common Capabilities​

Process Data Support​

info

This activity supports dynamic configuration using variables from the Process Data drawer.

You can bind values from Model Data, Form Data, System Data, Enterprise Variables, and Activity Outputs.

Learn more → Using Process Data

Design Time Configuration​

Display Text​

Specifies the activity's display name as shown on the workflow canvas.

Connection Name​

Selects the IMAP connection used to access the mailbox.

Mail Folder​

Specifies the mailbox folder to read emails from (for example, INBOX, Sent, or Drafts).   Default: INBOX.

Max Messages​

Defines the maximum number of email messages to retrieve per execution.   Default: 10   Minimum: 1.

Filters​

Provides advanced filtering criteria to retrieve specific emails.

For detailed information on configuring filters and expressions, see Email Filters.

note

The Number of Messages setting mentioned in the Email Filters documentation is not applicable to the Read IMAP Email activity.

Read Only Unread Mails​

Controls whether only unread messages are fetched.

  • True – Only unread emails are read.
  • False – All emails in the folder are read.   Default: True.

Mark As Read​

Determines whether the retrieved emails are marked as read after processing.

  • True – Sets the Seen flag on the messages.
  • False – Leaves message status unchanged.   Default: True.

Execution Control (Wait All Incoming)​

Controls how the activity behaves when multiple incoming execution paths converge.

For detailed behavior and examples, see   Execution Control – Wait All Incoming.

Error Handling (On Error)​

Defines how the workflow proceeds if the activity encounters an error.

For supported strategies (Fault, Continue, Suspend, Retry), see   On Error Handler.

Output​

Emails​

Returns the list of emails read from the mailbox as a JSON array.   Each email object includes the following properties:

  • From – Sender email address  
  • To – Recipient email addresses  
  • Subject – Email subject  
  • TextBody – Plain text content  
  • HtmlBody – HTML content  
  • ReceivedAt – Date and time the email was received  
  • MessageId – IMAP UID (unique identifier)  
  • InternalId – Provider-specific message identifier  
  • Attachments – List of attachments of type File References. File References are an IB-X file system abstraction and can be passed directly to other activities that accept file inputs Each attachment contains:
    • AttachmentReference – Used by attachment-specific activities such as Get IMAP Email Attachment.

See Mail Models and File Reference.

Count​

Returns the total number of emails read during the execution.