In this article

Overview

Use this Snap to search Exchange Online user emails matching the provided keyword.

Prerequisites

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
  • Copy Snap
  • JSON Parser
Requires the Email Folder and Search Keyword along with number of messages to be fetched.
Output

Document

  • Min: 0
  • Max: 1
  • Send Email
  • Mapper

Retrieves and fetches you the emails .


Snap Settings


Parameter Name
Data Type
Description
Default Value
Example 
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.
Search Email Search Email 
User/Shared MailBoxString

Enter the mailbox from which you want to search email. If not provided, then the mailbox specified in the account settings is used. 

N/Ajohn.doe@gmail.com
Email FolderStringRequired. Enter the name of the email folder where you want to search for the email.ALLSent Items
Search KeywordStringRequired. Enter a keyword to enhance your search. This will help to narrow down and make your search more precise. Click more information.N/Afrom: snaps@snaplogic.com
Number Of Messages To FetchNumericSpecify the maximum number of messages to be retrieved. If blank, it fetches all messages.N/A32
Snap ExecutionString

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 onlyDisabled


Troubleshooting


Error
Reason
Resolution
Provide Search Keyword FieldMissing 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

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. Lets provide input in the Snap Settings and look at the output.


Mark Email As Read Snap
Output


Download this Pipeline. 

Downloads

  1. Download and import the Pipeline into SnapLogic.
  2. Configure Snap accounts as applicable.
  3. Provide Pipeline parameters as applicable.





See Also