In this article
You can use this Snap to monitor the mailbox for new or updated emails.
Email Listener is a Read-type Snap that monitors the mailbox for new emails.
Valid Exchange Online tenant.
Valid OAUth2 application in Azure Active Directory with all the required API permissions.
Works in Ultra Pipelines. However, we recommend that you not use this Snap in an Ultra Pipeline. To know the list of Snaps that work in Ultra and the related caveats, see Snap Support for Ultra Pipelines.
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.
None.
Type | Format | Number of Views | Examples of Upstream and Downstream Snaps | Description |
---|---|---|---|---|
Input | Document |
|
| Requires the Email folder and the Polling Interval set to alert or poll for receiving a new email. |
Output | Document |
|
| Record of emails received. |
Error | Error handling is a generic way to handle errors without losing data or failing the Snap execution. You can handle the errors that the Snap might encounter when running the Pipeline by choosing one of the following options from the When errors occur list under the Views tab:
Learn more about Error handling in Pipelines. |
|
Field Name | Field Type | Description |
---|---|---|
Label* Default Value: Email Listener | String | Specify 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. |
User/Shared MailBox
Default Value: N/A | 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. |
Email Folder* Default Value: Inbox | String/Expression | Specify the Email Folder to read. |
Alert Only For New Emails Default Value: Selected | Checkbox | Select if you want to receive notification only for a new email. |
Polling Interval (minutes)* Default Value: 5 | String/Expression | Specify a time interval, in minutes, to poll for a new email. Minimum Value: 1 |
Number Of Retries
Default Value: 0 | 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. |
Retry Intervals (seconds)
Default Value: 1 | Integer/Expression | Specify the time interval between retry requests. A retry happens only when the previous attempt results in an exception. |
Snap Execution
Default Value: Validate & Execute | Dropdown list | Select one of the three following modes in which the Snap executes:
|
None.
We use an example to monitor a folder in a mailbox for new emails, where we have an Email Listener Snap which is configured to monitor the new emails delivered in the folder.
Let us configure the Snap setting in the Email Listener Snap and check how it runs and monitors the mailbox.
Email Listener Snap |
---|
We can see the progress on validating the Snap as follows:
Result |
---|
Important Steps to Successfully Reuse Pipelines
|