Search Email

In this article

Overview

You can use this Snap to search Exchange Online user emails matching the provided keyword.

Snap Type

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

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. 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 & Known Issues

None.

Snap Views

Type

Format

Number of Views

Examples of Upstream and Downstream Snaps

Description

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

  • Asterisk (*): Indicates a mandatory field.

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

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

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

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

Field Name

Field Type

Description

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.

User/Shared MailBox

 

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

String/Expression

Specify the mailbox from which you want to 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
Example: Sent Items

String/Expression

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

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
Example: 32

String/Expression

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

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

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

Troubleshooting

Error

Reason

Resolution

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

  2. Marking an email as read using Mark Email As Read Snap.

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

Search Email Snap

Output

Search Email Snap

Output

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

Mark Email As Read Snap

Output

 

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 Search Email. Mark Email as Read.slp

Nov 15, 2020 by Siddharth Menon

Snap Pack History


See Also