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 |
|
| A document containing the email folder from which you want to retrieve the emails. |
| Output | Document Binary |
|
| Document containing a list of emails from the target mailbox. |
Snap Settings
| Parameter Name | Data Type | Description | Default Value | Example |
|---|---|---|---|---|
| Label | String | 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 Email | Read Email |
| User/Shared MailBox | String | 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/A | john.doe@microsoft.com |
| Email Folder | String | Required. Enter the name of the email folder. | Inbox | Sent 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 | String | Specify the email field’s name upon which to apply the filter. The available options are as follows:
| N/A | Subject |
| Operator | String | Specify a conditional operator. The available options are as follows:
| N/A | ne |
| Email Field Value | String | Specify a value for email field to add a condition. | N/A | Subject |
| Fetch Only Focused Emails | Check 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 Top | Check Box | Select to sort the older messages by date. | Not selected. | |
| Download attachments | Check Box | Select to download attachments into binary output view. If not selected attachments will not be downloaded. | Not selected. | |
| Mark Email As Read | Check Box | Select to mark the email as read. | Not selected. | |
| Number Of Messages To Fetch | Numeric | Enter the maximum number of messages to be retrieved. If left blank, then it fetches all messages. | N/A | 1 |
| Snap Execution | Drop-down | Select one of the three following modes in which the Snap executes:
| Execute only | Validate & Execute |
Troubleshooting
Error | Reason | Resolution |
|---|---|---|
| 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. |
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:
- Reading and email using Read Email Snap.
- Marking email as read using Mark Email As Read Snap.
- Copying document stream using Copy Snap.
- Flagging an email using Flag Email Snap.
- 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.
Downloads
Important Steps to Successfully Reuse Pipelines
- Download and import the Pipeline into SnapLogic.
- Configure Snap accounts as applicable.
- Provide Pipeline parameters as applicable.
Release | Snap Pack Version | Date | Type | Updates |
|---|---|---|---|---|
February 2024 | main25112 |
| Stable | The Microsoft Exchange Snap Pack is deprecated. We recommend that you use the Exchange Online Snap Pack for your existing pipelines containing the Microsoft Exchange Snaps. Contact support@snaplogic.com if your existing pipelines use Snaps from the deprecated Snap Pack. |
November 2023 | main23721 |
| Stable | Updated and certified against the current SnapLogic Platform release. |
August 2023 | main22460 |
| Stable | Updated and certified against the current SnapLogic Platform release. |
May 2023 | 433patches22402 |
| Latest | Fixed an issue with the Send Email Snap where attachments larger than 3 MB were not getting attached to the sent email messages. |
May 2023 | main21015 |
| Stable | Upgraded with the latest SnapLogic Platform release. |
February 2023 | 432patches20437 |
| Latest | Fixed an issue with the Microsoft Exchange Online OAuth2 User and Exchange Online OAuth2 Application accounts that caused |
February 2023 | 432patches20035 |
| Stable | The below Exchange Online patch got re-deployed as stable.
You can choose to not assign these permissions in your Snap accounts. |
February 2023 | 432patches19899 |
| Latest | The following permissions are no longer mandatory for the Exchange Online Snaps to work:
You can choose to not delegate these permissions for your Snap accounts. |
February 2023 | main19844 |
| Stable | Upgraded with the latest SnapLogic Platform release. |
December 2022 | 431patches19413 |
| Latest | When the Ultra Parent Pipeline is connected to a child Pipeline with the Send Email Snap using the Exchange Online OAuth2 application Account, it now refreshes, obtains a new access token, and continues the Snap operation. |
November 2022 | main18944 |
| Stable |
|
September 2022 | 430patches18442 |
| Latest | The Microsoft Exchange Online List Events Snap now does not fail with the |
September 2022 | 430patches18099 |
| Latest |
|
August 2022 | main17386 |
| Stable | Upgraded with the latest SnapLogic Platform release. |
4.29 | main15993 |
| Stable | Upgraded with the latest SnapLogic Platform release. |
4.28 | main14627 |
| Stable | Upgraded with the latest SnapLogic Platform release. |
4.27 | main12833 |
| Stable | Upgraded with the latest SnapLogic Platform release. |
4.26 | main11181 |
| Stable | Upgraded with the latest SnapLogic Platform release. |
4.25 Patch | 425patches10994 |
| 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.25 | main9554 |
| Stable | Upgraded with the latest SnapLogic Platform release. |
4.24 | 424patches8965 |
| 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.24 | main8556 |
| Stable | No updates made. |
4.23 | main7430 |
| Stable | Initial release of the Snap Pack with the following Snaps and Accounts: |