In this article
Overview
You can use this Snap to monitor the mailbox for new or updated emails.
Snap Type
Email Listener is a Read-type Snap.
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. 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.
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 Views
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. |
Snap Settings
Asterisk (*): Indicates a mandatory field.
Suggestion icon (): Indicates a list that is dynamically populated based on the configuration.
Expression icon (): Indicates whether the value is an expression (if enabled) or a static value (if disabled). Learn more about Using Expressions in SnapLogic.
Add icon (): Indicates that you can add fields in the field set.
Remove icon (): Indicates that you can remove fields from the field set.
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:
|
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.
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 |
---|
Downloads
Important Steps to Successfully Reuse Pipelines
Download and import the Pipeline into SnapLogic.
Configure Snap accounts as applicable.
Provide Pipeline parameters as applicable.
Release | Snap Pack Version | Date | Type | Updates |
---|---|---|---|---|
August 2024 | 438patches27849 |
| Stable | Fixed an issue with the Read Email Snap that prevented reading all the emails when you selected both the Fetch only unread emails and the Mark email as read checkboxes. |
August 2024 | main27765 | Stable | Upgraded the | |
May 2024 | main26341 |
| Stable | Updated and certified against the current SnapLogic Platform release. |
February 2024 | main25112 |
| Stable | Updated and certified against the current SnapLogic Platform release. |
November 2023 | main23721 |
| Stable | Updated and certified against the current SnapLogic Platform release. |
August 2023 | main22460 |
| Stable | Updated and certified against the current SnapLogic Platform release. |
May 2023 | 433patches22402 |
| Latest | Fixed an issue with the Send Email Snap where attachments larger than 3 MB were not getting attached to the sent email messages. |
May 2023 | main21015 |
| Stable | Upgraded with the latest SnapLogic Platform release. |
February 2023 | 432patches20437 |
| Latest | Fixed an issue with the Microsoft Exchange Online OAuth2 User and Exchange Online OAuth2 Application accounts that caused |
February 2023 | 432patches20035 |
| Stable | The below Exchange Online patch got re-deployed as stable.
You can choose to not assign these permissions in your Snap accounts. |
February 2023 | 432patches19899 |
| Latest | The following permissions are no longer mandatory for the Exchange Online Snaps to work:
You can choose to not delegate these permissions for your Snap accounts. |
February 2023 | main19844 |
| Stable | Upgraded with the latest SnapLogic Platform release. |
December 2022 | 431patches19413 |
| Latest | When the Ultra Parent Pipeline is connected to a child Pipeline with the Send Email Snap using the Exchange Online OAuth2 application Account, it now refreshes, obtains a new access token, and continues the Snap operation. |
November 2022 | main18944 |
| Stable |
|
September 2022 | 430patches18442 |
| Latest | The Microsoft Exchange Online List Events Snap now does not fail with the |
September 2022 | 430patches18099 |
| Latest |
|
August 2022 | main17386 |
| Stable | Upgraded with the latest SnapLogic Platform release. |
4.29 | main15993 |
| Stable | Upgraded with the latest SnapLogic Platform release. |
4.28 | main14627 |
| Stable | Upgraded with the latest SnapLogic Platform release. |
4.27 | main12833 |
| Stable | Upgraded with the latest SnapLogic Platform release. |
4.26 | main11181 |
| Stable | Upgraded with the latest SnapLogic Platform release. |
4.25 Patch | 425patches10994 |
| Latest | Improved the Exchange Online Snap Pack to handle authentication token errors and acquire new tokens and improved the error messages in the Create Event Snap where the Snap fails with Null Pointer Exception when the account reference provided is invalid. |
4.25 | main9554 |
| Stable | Upgraded with the latest SnapLogic Platform release. |
4.24 | 424patches8965 |
| Latest | Fixed an issue of the conflict of users' having similar email IDs by accepting only the first user’s email ID returned by the API and ignoring the duplicate ones. |
4.24 | main8556 |
| Stable | No updates made. |
4.23 | main7430 |
| Stable | Initial release of the Snap Pack with the following Snaps and Accounts: |