Read Email

In this article

Overview

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

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 

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

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

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 Read Email. Flag Email. Move Email .slp

Nov 15, 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