Input 

Document

• Min: 0

• Max: 1

• Mapper Snap

• Copy Snap

A document containing the email folder from which you want to retrieve the emails.

Output

Document

Binary

• Min: 2

• Max: 2

• Binary  Snap

• Mark Email as Read Snap 

Document containing a list of emails from the target mailbox.

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.

Label*

Default Value: Read Email
Example: Read Email

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 retrieve the list of emails. Alternatively, click the Suggestionicon to select the email folder in the mailbox. For example, custom/subfolder.

Email Folder*

Default Value: Inbox
Example: Sent Items

String/Expression

Enter the name of the email folder.

Filter Conditions

Use this fieldset to specify the email filter conditions you want to include. Click + to add a row.

Email Field

Default Value: N/A
Example: From

String/Expression

Specify the email field’s name upon which to apply the filter.

Available options are as follows:

• From

• Subject

• Body

• RecievedDate

Operator

Default Value: N/A
Example: eq

String/Expression

Specify a conditional operator.

Available options are as follows: 

• eq

• ne

• gt

• lt

• le

• startswith

Email Field Value

Default Value: N/A
Example: Subject

String/Expression

Specify a value for the email field to add a condition.

Fetch only focused emails

Default Value: Deselected

Checkbox

Select to retrieve the emails which are marked as Focused.

This is applicable only in the inbox folder.

Fetch only unread emails 

Default Value: Deselected

Checkbox

 Select to retrieve the mails to retrieve only unread emails.

Older messages on top

Default Value: Deselected

Checkbox

Select to sort the older messages by date.

Download attachments

Default Value: Deselected

Checkbox

Select to download attachments into binary output view. If not selected attachments will not be downloaded.

Mark email as read

Default Value: Deselected

Checkbox

Select to mark the email as read.

Number of Messages to Fetch

Default Value: N/A
Example: 1

Integer/Expression

Enter the maximum number of messages to be retrieved.

If left blank, then it fetches all messages.

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.

Select valid MailBox Email ID

The email ID you have provided is invalid.

Verify and enter the correct email ID.

Select valid Email Folder Name

The name of the Email Folder you have provided  is invalid.

Verify and enter the correct name of the email folder.