Email Listener

In this article

Overview

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

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 
LabelStringRequired. 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 ListenerEmail Listener
User/Shared MailBoxStringEnter the mailbox from which you want to monitor emails. If not provided, then the mailbox specified in the account settings is used.N/Ajohn.doe@microsoft.com
Alert Only For New EmailsCheck-box
Select if you want to receive notification only for a new email.
Not SelectedSelected
Polling Interval (minutes)String

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

Min: 1

Max: 1400

N/A3
Number Of RetriesNumericSpecify 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.03
Retry Intervals (seconds)NumericSpecify the time interval between two successive retry requests. A retry happens only when the previous attempt resulted in an exception.145
Snap ExecutionDrop-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 onlyDisabled

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


Download this Pipeline. 

Downloads

Important Steps to Successfully Reuse Pipelines

  1. Download and import the Pipeline into SnapLogic.
  2. Configure Snap accounts as applicable.
  3. Provide Pipeline parameters as applicable.

  File Modified

File Listener Snaps.slp

Nov 17, 2020 by Siddharth Menon



Snap Pack History

 Click here to expand...

Release

Snap Pack Version 

Date

Type

Updates

4.27

main12833

 

Stable

Upgraded with the latest SnapLogic Platform release.
4.26main11181 StableUpgraded with the latest SnapLogic Platform release.
4.25 Patch425patches10994 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.25main9554 
StableUpgraded with the latest SnapLogic Platform release.
4.24424patches8965
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.24main8556 StableNo updates made.
4.23 main7430 Stable

Initial release of the Snap Pack with the following Snaps and Accounts:

Snaps:

Accounts:




See Also