Get Mail Messages

UiPath.GSuite.Activities.GetMailMessages

Description

Searches for and gets emails from a specified Gmail account.

Scopes

This activity requires the following scopes:

• https://mail.google.com/

OR

• https://www.googleapis.com/auth/gmail.modify

OR

• https://www.googleapis.com/auth/gmail.readonly

OR

• https://www.googleapis.com/auth/gmail.metadata

Project compatibility

Windows - Legacy | Windows

Configuration

Properties

Common

• ContinueOnError - If set, the remaining activities are executed if the current activity fails. This field supports Boolean values.
• DisplayName - The display name of the activity. This property supports String variables and string formatted values.

Input

• LabelsFilter - Specifies the labels that you want to include in your search parameters. This property supports a Collection labels.
• MaxResults - The maximum number of emails that you want to return. This property supports Int32 variables and Int32 formatted values. The default value is 30.
• SearchExpression - The search parameters that you want to use to get mail messages. This property supports String variables and string formatted values. The default value is "from:[e-mail] subject:Some Subject has:attachment". When entering your value, you can use a combination of attributes (e.g., the sender, time periods, and attachments). For more information about building your search query, see Search operators you can use with Gmail in the Gmail Help documentation.

Misc

• Private - If selected, the values of variables and arguments are no longer logged at Verbose level. This field supports Boolean values.

Options

• Email ID - The ID of the email to look for. When specified, the MarkAsRead parameter is taken into consideration and the parameters in the Input category are ignored. If the email with the specified ID is found, the output array contains exactly one element. If not found, the activity throws an exception.
• MarkAsRead - If selected, the emails are set as read when received.

Output

• Emails - The search results. This property supports GmailMessages[] array variables. You can use this variable as an input property value result can be used in other Google Mail activities.