Search Contact

Overview

The Search Contact Snap searches personal contacts in a mailbox.



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

Requires the Contact Folder and Search Keyword along with number of contacts to be fetched.
Output

This Snap has at most one document output view.

Retrieves and outputs the contact details.
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 Contact
User/Shared MailBox

String/Expression

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

Default value: N/A

Example: [email protected]
Contact Folder

String/Expression

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

Default value: N/A

Example: ALL
Search Keyword

String/Expression

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

Default value: N/A

Example: Official
Number Of Contacts To Fetch

Integer/Expression

Specify the maximum number of contacts to be retrieved. If you leave this field blank, it fetches all contacts.

Default value: N/A

Example: 3
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
Select valid Contact Folder Name You have selected an invalid Contact Folder Name. Verify and enter a valid folder name.