Email Listener

Overview

The Email Listener Snap monitors the mailbox for new or updated emails.



  • This is a Read-type Snap.
  • Works in Ultra Tasks when the Batch size is set to 1.

Supported Accounts

Prerequisites

  • Valid Exchange Online tenant.
  • Valid OAuth2 application in Azure Active Directory with all the required API permissions.

Limitations

  • Probability of Snap failing with short polling interval is high.
  • Best practice is to add retry configured in Snap settings.
  • Value less than 5 is error prone.
  • For more information, see Outlook service limits.

Snap views

Type Description Examples of upstream and downstream Snaps
Input

This Snap has at most one document input view.

Requires the Email folder and the Polling Interval set to alert or poll for receiving a new email.

Output

This Snap has at most one document output view.

Record of emails received.

Learn more about Error handling.

Snap settings

Note: Learn about the common controls in the Snap settings dialog.
Field/Field set Description
Label*

String

Specify a unique name for the Snap. Modify this to be more appropriate, especially if more than one of the same Snaps is in the pipeline.

Default value: Email Listener

User/Shared MailBox

String/Expression

Specify the mailbox from which you want to configure auto reply for emails received. If not provided, then the mailbox specified in the account settings is used.

Default value: N/A

Example: [email protected]

Email Folder*

String/Expression

Specify the Email Folder to read.

Default value: Inbox

Example: Starred

Alert Only For New Emails

Checkbox

Select if you want to receive notification only for a new email.

Default value: Selected

Polling Interval (minutes)*

String/Expression

Specify a time interval, in minutes, to poll for a new email.

Default value: 5

Example: 3

Minimum Value: 1

Maximum Value: 1400

Number Of Retries

Integer/Expression

Specify the maximum number of attempts to be made to receive a response. The request is terminated if the attempts do not result in a response.

Default value: 0

Example: 4

Retry Intervals (seconds)

Integer/Expression

Specify the time interval between retry requests. A retry happens only when the previous attempt results in an exception.

Default value: 1

Example: 21

Snap execution

Dropdown list
Choose one of the three modes in which the Snap executes. Available options are:
  • Validate & Execute. Performs limited execution of the Snap and generates a data preview during pipeline validation. Subsequently, performs full execution of the Snap (unlimited records) during pipeline runtime.
  • Execute only. Performs full execution of the Snap during pipeline execution without generating preview data.
  • Disabled. Disables the Snap and all Snaps that are downstream from it.