Search Emails

Search for an email or multiple emails. For more information, refer to Gmail Documentation.

Scopes

See Action cards for the list of required OAuth scopes for this card.

Field	Definition	Type	Required
Result Set	Choose from: First matching email: return the first email message that meets the search criteria All matching emails: return all email messages that match the search criteria	Dropdown	TRUE

Field

Definition

Type

Required

Result Set

Choose from:

First matching email: return the first email message that meets the search criteria
All matching emails: return all email messages that match the search criteria

Dropdown

TRUE

Field	Definition	Type	Required
Query	Return only the messages that match the specified query. This supports the same query format as the Gmail search box, for example from:someuser@example.com rfc822msgid:somemsgid@example.com is:unread. See Search operators you can use with Gmail.	Text	FALSE
With Labels	Labels to include in message filtering (such as Important, Starred, or Spam).	List	FALSE
Include Spam and Trash	Set to True to include spam and trash messages, or False to exclude them.	True/False	FALSE

Field

Definition

Type

Required

Query

Return only the messages that match the specified query.

This supports the same query format as the Gmail search box, for example from:someuser@example.com rfc822msgid:somemsgid@example.com is:unread.

Text

FALSE

With Labels

Labels to include in message filtering (such as Important, Starred, or Spam).

List

FALSE

Include Spam and Trash

Set to True to include spam and trash messages, or False to exclude them.

True/False

FALSE

Field	Definition	Type
Emails	List of email objects returned from the search, where each object contains the fields described in the First matching email section.	List
Message ID	Unique ID of the message.	Text
Subject	Subject of the message.	Text
Text Body	Text in the body of the message.	Text
HTML Body	HTML formatted body of the message.	Text
To	Email addresses of the message recipients (format multiple addresses in a list of individual emails or as a single text string separated by commas or semicolons).	Text
From	Sender of the message.	Text
CC	A list of carbon copied recipients.	List
Attachment IDs	List of unique IDs of the email attachments.	List of Objects
Labels	List of categories attributed to the message (for example, Unread, or Important).	List