activities
latest
false
UiPath logo, featuring letters U and I in white

Productivity Activities

Last updated Dec 6, 2024

Get Email List

UiPath.Gsuite.Activities.GetEmailListConnections

Description

Retrieves email messages matching filter criteria from the specified folder or label.

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 | Cross-platform

Configuration

  • Gmail connection - The connection for the Google Workspace account to use in the activity.
  • Email folder or label - The folder or label to get email messages from. This field accepts IResource input. Click the Folder docs image icon to browse email folders. Use See more docs image button menu to switch to Folder path input mode.
    • Folder path - Specify the full path of the folder or label. This property supports String variables and string formatted values.

    • Select the Reload Email Folder Data option if you've modified your email folders and need to retrieve the latest data.

Advanced options
  • Limit emails to first - The number of emails to retrieve. This field supports Int32 variables and Int32 values.
  • Include subfolders - Indicates whether to expand the search to include all subfolders of the selected mail folder or not. This field supports Boolean values.
  • Unread only - Indicates whether to consider only unread emails or not. This field supports Boolean values.
  • With attachments only - Indicates whether to consider only emails with attachments or not. This field supports Boolean values.
  • Important only - Indicates whether to consider only important emails. This field supports Boolean values.
  • Starred only - Indicates whether to consider only starred emails. This field supports Boolean values.
  • Additional filters - Click this field to open the Filter builder and add additional filters for the query. Supports filtering on the following fields: BCC, Has the words, CC, Categories, Date and time, Attachment name, From, Subject, To, Labels.

  • Mark as read - Indicates whether to mark the retrieved emails as read or not. This field supports Boolean values.
Output
  • Emails - The list of emails retrieved by the activity, stored in a List<GmailMessage>variable. Automatically generated output variable. You can use it as it is or save it with a different name. You can use this in other activities.

Example



See also:
  • Description
  • Project compatibility
  • Configuration
  • Example

Was this page helpful?

Get The Help You Need
Learning RPA - Automation Courses
UiPath Community Forum
Uipath Logo White
Trust and Security
© 2005-2024 UiPath. All rights reserved.