Versions Compared

Old Version 15

changes.mady.by.user Siddharth Menon

Saved on

compared with

New Version Current

changes.mady.by.user Gouri Bhagchandani

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 search Exchange Online user emails matching the provided keyword.Image Removed

...

Snap Type

Search Email is a Read-type Snap that searches Exchange Online user emails matching the provided keyword.

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 Ultra Pipelines. However, we recommend that you not use this Snap in an Ultra Pipeline. To know the list of Snaps that work in Ultra and the related caveats, see Snap Support for 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

  • Copy Snap

  • JSON Parser

Requires the Email Folder and Search Keyword along with number of messages to be fetched.

Output

Document

  • Min:

0

  • 1

  • Max: 1

  • Send Email

  • Mapper

Retrieves and fetches you the emails .

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

...

Parameter Name

...

Data Type

...

Description

...

Default Value

...

Example 

...

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: Search Email
Example: Search Email

String

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.

Search Email Search Email 

User/Shared MailBox

 

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

String/Expression

Enter

Specify the mailbox from which you want to

search email

configure auto reply for emails received. If not provided, then the mailbox specified in the account settings is used.

 

Email Folder

Default Value: N/A

john.doe@gmail.comEmail Folder

Example: Sent Items

String/Expression

Required. Enter Search KeywordStringRequired. Enter

Specify the name of the email folder where you want to search for the email.

ALLSent Items

Search Keyword

Default Value: N/A
Example: from: snaps@snaplogic.com

String/Expression

Specify a keyword to enhance your search. This will help to narrow down and make your search more precise. Click more information.

Number Of Messages To Fetch

Default Value: N/A

from: snaps@snaplogic.comNumber Of Messages To FetchNumeric

Example: 32

String/Expression

Specify the maximum number of messages to be retrieved. If blank, it fetches all messages.

N/A32Snap ExecutionString

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

  • daa.

  • Disabled. Disables the Snap and all Snaps downstream from it.

Execute onlyDisabled

Troubleshooting

Error

Reason

Resolution

Provide Search Keyword Field

Missing Search Keyword field.

Ensure you provide input in Search Keyword field.

Examples

Search and mark an email as read

We use an example where we are going to search for an email from an individual's mailbox with required inputs and mark it as read.

In this example, our Pipeline activities are as follows:

...

  1. Searching and email using  Search Email

...

  1.  Snap.

...

  1. Marking an email as read

...

  1. using Mark Email As Read

...

  1.  Snap.

...

Here, let us look into the role of of Search Event Snap in this Pipeline.

Search Email Snap

Output

Image Removed
Image Added
Image Removed
Image Added

Upon execution, we see an output with the retrieved email.

Here, let us look into the role

...

of Mark Email As Read Snap in this Pipeline.

We mark an email as read.

...

Let's provide input in the Snap Settings and look at the output.

Mark Email As Read Snap

Output

Image Removed
Image Added
Image Removed
Image Added

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

Snap Pack History

Expand

Insert excerpt
Exchange Online Snap Pack
Exchange Online Snap Pack
nameExchange_Online_SPH
nopaneltrue

...

See Also

...