Skip to main content
Version: Current

Email Trigger

Description

Use the Email Trigger activity to automatically start a workflow when a new email matching the configured criteria is received in a monitored mailbox folder.

info

Email triggers are registered only when the workflow is published. Saving or updating a draft workflow does not create or modify the trigger registration.

After publishing, the trigger can be managed from the Email Trigger Management section.


Configuration

Input

PropertyDescriptionDefault
Connection NameSelect the email connection used to monitor the mailbox. The available connections depend on the configured email integrations, such as IMAP, Microsoft Outlook, or Exchange-based providers.
Mail FolderSpecify the mailbox folder to monitor for incoming emails.INBOX
Max MessagesSpecify the maximum number of matching emails that can be processed during a single trigger execution cycle.10
Email Processing SequenceSpecify the order in which matching emails should be processed.Newest to Oldest
Check for new messages everySpecify the polling interval, in minutes, used to check the configured mailbox folder for new emails.1
Start DateOptionally specify the date and time from which the trigger should begin monitoring the mailbox.
FiltersEnable this option to configure email filtering conditions. Only emails matching the configured filter criteria trigger the workflow.Disabled
Can ExpireEnable this option to configure an expiration date for the trigger. After the configured expiration date and time, the trigger automatically stops monitoring the mailbox.Disabled
On ErrorSpecify how workflow errors should be handled during trigger execution. The configured strategy determines whether the workflow continues, faults, or routes execution through error handling paths.Inherit

Email Processing Sequence

OptionDescription
Oldest to NewestProcesses older emails first before processing newer emails.
Newest to OldestProcesses the most recent emails first.

Filters

When filters are enabled, only emails matching the configured filter conditions trigger the workflow.

Filter conditions may include:

  • Sender email address
  • Subject
  • Recipient
  • Body content
  • Attachment presence
  • Importance
  • Custom conditions

Outputs

Triggered At

Represents the UTC date and time when the workflow was triggered.


Run Id

Represents the unique identifier associated with the current trigger execution.


Trigger Payload

Represents the optional trigger payload associated with the workflow execution.


Count

Represents the total number of emails processed during the trigger execution cycle.


Emails

Represents the collection of emails that matched the configured trigger conditions.

Each email object may contain:

  • Attachments
  • Bcc
  • Cc
  • From
  • HtmlBody
  • InReplyTo
  • InternalId
  • MessageId
  • Priority
  • ReceivedAt
  • References
  • ReplyTo
  • Sender
  • SentAt
  • Subject
  • TextBody
  • To

Notes

  • The Email Trigger activity is a trigger activity and must be placed at the beginning of the workflow.
  • Email triggers are registered only when the workflow is published.
  • Updating a draft workflow does not update the registered trigger configuration.
  • Trigger registration and monitoring can be managed from the Email Trigger Management section.
  • Ensure that the configured email connection has sufficient permissions to access the monitored mailbox folder.
  • The trigger polling frequency may impact mailbox monitoring responsiveness and resource usage.