In this article

Overview

Use this Snap to read Exchange Online user emails from a specified folder.

Prerequisites

Support for Ultra Pipelines

Works in Ultra Pipelines. 

Limitations 

None.

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
  • 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.


Snap Settings


Parameter NameData TypeDescriptionDefault ValueExample 
Label*String
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 Folder*StringEnter the name of the email folder.InboxSent 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 the 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 the 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.


Examples

To manage an email in a mailbox

We are using an example of email management, where we have chain of email Snaps functioning respectively to perform tasks for the mails in the mailbox. 

In this example, our Pipeline activities are as follows:

  1. Reading and email using Read Email Snap.
  2. Marking email as read using Mark Email As Read Snap.
  3. Copying document stream using Copy Snap.
  4. Flagging an email using Flag Email Snap.
  5. Moving an email using Move Email Snap.

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

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


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

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



See Also