Email Listener

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 that monitors the mailbox for new 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. 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

Type

Format

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.

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:

  • Stop Pipeline Execution: Stops the current Pipeline execution when the Snap encounters an error.

  • Discard Error Data and Continue: Ignores the error, discards that record, and continues with the remaining records.

  • Route Error Data to Error View: Routes the error data to an error view without stopping the Snap execution.

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

Field Name

Field Type

Description

Label*

 

Default Value: Email Listener
Example: 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
Example: john.doe@snaplogic.com

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
Example: Starred

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
Example: 3

String/Expression

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

Minimum Value: 1
Maximum Value: 1400

Number Of Retries

 

Default Value: 0
Example: 4

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
Example: 21

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
Example: Execute only

Dropdown list

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.


Troubleshooting

None.

Examples

Monitor receiving new emails 

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

Email Listener Snap

We can see the progress on validating the Snap as follows:

Result

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 Example_Email_Listener.slp

Feb 28, 2022 by Subhajit Sengupta

Snap Pack History


See Also