Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

In this article

Table of Contents
maxLevel2
absoluteUrltrue

...


Parameter NameData TypeDescriptionDefault ValueExample 
LabelString
Required. 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.
Read EmailRead Email
User/Shared MailBoxString

Enter the mailbox from which you want to retrieve the list of emails. If not provided, then the mailbox associated with the account user is used.



N/Ajohn.doe@microsoft.com
Email FolderStringRequired. Enter the name of the email folder.InboxInboxSent Items
Filter Conditions

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

This fieldset consists of the following fields:

  • Email Field
  • Operator
  • Email Field Value
Email FieldString

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

The available options are as follows:

  • From
  • Subject
  • Body
  • RecievedDate
N/ASubject
OperatorString

Specify a conditional operator.

The available options are as follows: 

  • eq
  • ne
  • gt
  • lt
  • le
  • startswith
N/A

ne

Email Field ValueStringSpecify a value for email field to add a condition.N/ASubject
Fetch Only Focused EmailsCheck Box

Select to retrieve the emails which are marked as Focused.

This is applicable only in inbox folder.

Not selected.
Fetch Only Unread Emails Check Box Select to retrieve the mails to retrieve only unread emails.Not selected.
Older messages on TopCheck Box

Select to sort the older messages by date.

Not selected.
Download attachmentsCheck BoxSelect to download attachments into binary output view. If not selected attachments will not be downloaded.Not selected.
Mark Email As ReadCheck BoxSelect to mark the email as read.Not selected.
Number Of Messages To FetchNumeric

Enter the maximum number of messages to be retrieved.

If left blank, then it fetches all messages.

N/A1
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 onlyValidate & Execute


Troubleshooting


Error
Reason
Resolution
Select valid MailBox Email IDThe email ID you have provided is invalid.Verify and enter the correct email ID.
Select valid Email Folder NameThe name of the Email Folder you have provided  is invalid.Verify and enter the correct name of the email folder.


...


Read Email Snap
Output

Upon execution, we see an output with email details from the desired folder.


Here, let us look into Flag Email Snap in this Pipeline.

We flag an email from a mailbox, where in we provide all the required details in the Snap Settings shown below:


Flag Email Snap
Output

Upon execution, we see an output confirming flagging the desired email.

Here, let us look into Move Email Snap in this Pipeline.

We move an email from one folder to another folder, where in we provide all the required details in the Snap Settings shown below:


Move Email Snap
Output

Upon execution, we see an output confirming that the email has moved to the destination folder.


Download this Pipeline. 

Downloads

...