Versions Compared

Old Version 21

changes.mady.by.user Amritesh Singh

Saved on

compared with

New Version 22

changes.mady.by.user Amritesh Singh

Saved on

Key

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

In this article

Table of Contents
maxLevel2
absoluteUrltrue

Overview

Use You can use this Snap to read Exchange Online user emails from a specified folder.Image Removed

...

Snap Type

Read Email is a Read-type Snap that marks an email as read.

Prerequisites

  • Valid Exchange

    Valid Exchange Online tenant.

  • Valid 

    Valid OAUth2 application in Azure Active Directory with all the required API permissions.

Support for Ultra Pipelines

Works in Works in Ultra Pipelines. 

Limitations 

...

None.

& Known Issues

None.

Snap

...

Input/Output

...

Views

Type

Format

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.

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.

Snap Settings

...

Info

  • Asterisk (*): Indicates a mandatory field.

  • Suggestion icon ((blue star)): Indicates a list that is dynamically populated based on the configuration.

  • Expression icon ((blue star)): Indicates whether the value is an expression (if enabled) or a static value (if disabled). Learn more about Using Expressions in SnapLogic.

  • Add icon ((blue star)): Indicates that you can add fields in the field set.

  • Remove icon ((blue star)): Indicates that you can remove fields from the field set.

Field Name

Field Type

Description

Label*

Default Value

Example Label*

: Read Email
Example: Read Email

String

The

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.

Read EmailRead Email

User/Shared MailBox

Default Value: N/A
Example: john.doe@snaplogic.com

String/Expression

Enter

Specify the mailbox from which you want to retrieve the list of emails. Alternatively, click the SuggestionImage Modifiedicon

to select title

to select the email folder in the mailbox. For example, custom/subfolder.

Info

Recommendation

If you do not provide a user/shared mailbox, the mailbox associated with the user account of the OAuth2 User account (signed in user) is considered. However, if you use an OAuth2 Application account, you must select a User/Shared

Mailbox to

Mailbox to retrieve the mailboxes associated with the user.

N/Ajohn.doe@microsoft.com - John SL

Email Folder*

Default Value: Inbox
Example: Sent Items

String/Expression

Enter the name of the email folder.

InboxSent Items

Filter Conditions

Use this fieldset to

specify the email filter conditions you

specify the email filter conditions you want to include.

 Click

 Click + to add a row.

This fieldset consists of the following fields:

Email Field

  • Operator
  • Email Field Value
    • Email FieldString

    Default Value: N/A
    Example: From

    String/Expression

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

    The available Operator

    Available options are as follows:

    • From

    • Subject

    • Body

    • RecievedDate

    Operator

    Default Value: N/A

    Subject

    Example: eq

    String/Expression

    Specify a

    conditional operator

    conditional operator.

    The available Email Field Value

    Available options are as follows: 

    • eq

    • ne

    • gt

    • lt

    • le

    • startswith

    Email Field Value

    Default Value: N/A

    ne

    Example: Subject

    String/Expression

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

    N/ASubject

    Fetch only focused emails

    Check BoxSelect to retrieve the

    Default Value: Deselected

    Checkbox

    Select to retrieve the emails which are marked

    as Focused

    as Focused.

    This is applicable only in the inbox folder

    .Not selected

    .

    Fetch only unread emails 

    Check Box

    Default Value: Deselected

    Checkbox

     Select

    to retrieve the mails to retrieve

    to retrieve the mails to retrieve only unread emails.

    Not selected.

    Older messages on top

    Check Box

    Default Value: Deselected

    Checkbox

    Select to sort the older messages by date

    .Not selected

    .

    Download attachments

    Check Box

    Default Value: Deselected

    Checkbox

    Select to download

    attachments into

    attachments into binary output view.

    If

    If not selected attachments will not be downloaded

    .Not selected

    .

    Mark email as read

    Check Box

    Default Value: Deselected

    Checkbox

    Select to mark the email as read

    .Not selected

    .

    Number of Messages to Fetch

    Numeric

    Default Value: N/A
    Example: 1

    Integer/Expression

    Enter the

    maximum number Snap ExecutionDrop-down

    maximum number of messages to be retrieved.

    If left blank, then it fetches all messages.

    N/A1

    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.

    Execute onlyValidate & 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

    ...

    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.

      Image Modified

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

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

    Read Email Snap

    Output

    Image Removed
    Image Added
    Image Removed
    Image Added

    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,

    ...

    wherein we provide all the required details in the Snap Settings shown below:

    Flag Email Snap

    Output

    Image Removed
    Image Added
    Image Removed
    Image Added

    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,

    ...

    wherein we provide all the required details in the Snap Settings shown below:

    Move Email Snap

    Output

    Image Removed
    Image Added
    Image Removed
    Image Added

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

    Download this Pipeline. 

    Downloads

    title
    Note
    Info

    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.

    Attachments
    patterns*.slp, *.zip


    Insert excerpt
    Exchange Online Snap Pack
    Exchange Online Snap Pack
    nopaneltrue

    ...

    See Also