Search Email

Overview

The Search Email Snap searches Exchange Online user emails matching the provided keyword.



  • This is a Read-type Snap.
  • Works in Ultra Tasks. However, we recommend that you do not use this Snap in an Ultra Pipeline.

Supported Accounts

Prerequisites

  • Valid Exchange Online tenant.
  • Valid OAuth2 application in Azure Active Directory with all the required API permissions.

Snap views

Type Description Examples of upstream and downstream Snaps
Input

This Snap has at most one document input view.

A document containing the Email Folder, Search Keyword, and number of messages to be fetched.
Output

This Snap has exactly one document output view.

A document containing the retrieved emails.
Learn more about Error handling.

Snap settings

Note: Learn about the common controls in the Snap settings dialog.
Field/Field set Description
Label*

String

Specify a unique name for the Snap. Modify this to be more appropriate, especially if more than one of the same Snaps is in the pipeline.

Default value: Search Email
User/Shared MailBox

String/Expression

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

Default value: N/A

Example: [email protected]
Email Folder

String/Expression

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

Default value: N/A

Example: Sent Items
Search Keyword

String/Expression

Specify a keyword to enhance your search. This helps to narrow down and make your search more precise. Learn more about KQL syntax reference.

Default value: N/A

Example: from: [email protected]
Number Of Messages To Fetch

String/Expression

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

Default value: N/A

Example: 32
Snap execution

Dropdown list
Choose one of the three modes in which the Snap executes. Available options are:
  • Validate & Execute. Performs limited execution of the Snap and generates a data preview during pipeline validation. Subsequently, 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 that are downstream from it.

Troubleshooting

Error Cause Resolution
Provide Search Keyword Field Missing Search Keyword field. Ensure you provide input in the Search Keyword field.