In this article

Overview

Use this Snap to monitor the mailbox for new or updated emails.

SnapLogic Documentation > Email Listener > Email Listener.png

Prerequisites

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

Support for Ultra Pipelines

Works in Ultra Pipelines.

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 info see outlook-service-limit.

Known Issues

None.

Snap Input and Output

Input/Output

Type of View

Number of Views

Examples of Upstream and Downstream Snaps

Description

Input

Document

Min: 0
Max: 1

Mapper Snap

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

Output

Document

Min: 0
Max: 1

Union Snap

Record of emails received.

Snap Settings

Parameter Name	Data Type	Description	Default Value	Example
Label	String	Required. The name for the Snap. You can modify this to be more specific, especially if you have more than one of the same Snap in your Pipeline.	Email Listener	Email Listener
User/Shared MailBox	String	Enter the mailbox from which you want to monitor emails. If not provided, then the mailbox specified in the account settings is used.	N/A	john.doe@microsoft.com
Alert Only For New Emails	Check-box	Select if you want to receive notification only for a new email.	Not Selected	Selected
Polling Interval (minutes)	String	Required. Enter a time interval, in minutes, to poll for a new email. Min: 1 Max: 1400	N/A	3
Number Of Retries	Numeric	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.	0	3
Retry Intervals (seconds)	Numeric	Specify the time interval between two successive retry requests. A retry happens only when the previous attempt resulted in an exception.	1	45
Snap Execution	Drop-down	Select one of the three following modes in which the Snap executes: Validate & Execute. Performs limited execution of the Snap and generates a data preview during Pipeline validation, then 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 downstream from it.	Execute only	Disabled

Troubleshooting

None.

Examples

Monitor receiving new emails

We use an example to monitor folder in a mailbox for new emails, where we have a Email Listener Snap which is configured to monitor the new emails delivered in the folder.