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

Productivity Activities

Last updated Feb 28, 2025

Get Email List

UiPath.MicrosoftOffice365.Activities.GetEmailListConnections

Description

Retrieve a list of emails from the specified folder that matches the filter criteria.

Scopes

This activity requires the following scopes:

  • Mail.Read AND User.Read

OR

  • Mail.ReadWrite AND User.Read

OR

  • Mail.Read.Shared AND User.Read

OR

  • Mail.ReadWrite.Shared AND User.Read

OR

  • Mail.Read AND User.ReadWrite

OR

  • Mail.ReadWrite AND User.ReadWrite

OR

  • Mail.Read.Shared AND User.ReadWrite

OR

  • Mail.ReadWrite.Shared AND User.ReadWrite

Project compatibility

Windows | Cross-platform

Configuration

  • Microsoft Outlook 365 connection - The connection for the Microsoft 365 account to use in the activity.
  • Use shared mailbox - Set the toggle to On if you want to use a shared mailbox. Default value is Off.

    • Shared mailbox - The email address of a user or shared mailbox. This field supports String type input.

  • Email folder - The folder to get the emails from. This option accepts input as IResource. Click the Folder docs image icon to browse email folders.
    • Use the See more button menu to switch to Folder path input mode, which 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.

  • Additional filters - Click this field to open the Filter builder and add additional filters for the query. Supports filtering on the following fields: Attachment name, BCC, Body, CC, Category, Date and time, From, Recipients, Subject, To, Type. Use the See more docs image button menu to switch to Free Text Filter.
  • Free text filter - Search for a list of emails by a free text. This field supports String type input.
Additional options
  • Limit emails to first - The number of emails to retrieve. This field supports Int32 variables and Int32 values.
  • Shared mailbox - The email address of a user or shared mailbox to retrieve the email from. This field supports String variables and string formatted 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.
  • Importance - The importance of the email. The options available in the dropdown menu are: Any, Low, Normal, High.
  • Mark as read - Indicates whether to mark the retrieved emails as read or not. This field supports Boolean values.
  • Return Body as HTML - Indicates whether to return the body as HTML or plain text. This field supports Boolean values.
Output
  • Email list - The list of emails retrieved by the activity, stored in a List<Office365Message> 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

Figure 1. Get Email List activity

The image shows and example of the Get Email List activity in Studio Web
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-2025 UiPath. All rights reserved.