UiPath Integrations

The UiPath Integrations Guide

Welcome to the UiPath Integrations guide. You will find comprehensive guides and documentation to help you start working with UiPath Integrations, as well as support if you get stuck.

In order to download the solutions mentioned here please visit the official UiPath Go! Marketplace here.

*Note that only integrations built in-house at UiPath are detailed below. For a complete list of UiPath's technology partners, see here.

Overview

Using your search parameters (Query), the Get Mail activity calls the Microsoft Graph GetMessage and ListMessages APIs to retrieve the matching messages from a specified mailbox (Mailbox).

After performing the search, the activity returns an array of the matching Office365Message objects (Results) that you can use as input variables in subsequent activities (e.g., Forward Mail and Move Mail).

How it works

The following steps and message sequence diagram is an example how the activity works from design time (i.e., the activity dependencies and input/output properties) to run time.

  1. Complete the Setup steps.
  2. Add the Microsoft Office 365 Scope activity to your project.
  3. Add the Get Mail activity inside the Microsoft Teams Scope activity.
  4. Enter values for the Input properties.
  5. Create and enter a Office365Message[] variable for your Output property.
  6. Run the activity.
    • Your input property values are sent to the GetMessage and ListMessages APIs.
    • The API returns the Office365Message[] value to your output property variable.

Properties

The values for the following properties are specified when adding this activity to your project in UiPath Studio.

Common

DisplayName

The display name of the activity.

Attributes
Details

Type

String

Required

Yes

Default value

Get Mail

Allowed values

Enter a String or String variable.

Notes

N/A


Input

Account

The email address that you want to get emails from.

Attributes
Details

Type

String

Required

No

Default value

Empty

Allowed values

Enter a String or String variable.

Notes

  • You may enter a shared mailbox if you have access rights.
  • To use your email address leave this property empty.

MailFolder

The mail folder that you want to search for messages.

Attributes
Details

Type

String

Required

Yes

Default value

"Inbox"

Allowed values

Enter a String or String variable.

Notes

  • Enter your folder as it appears in your Outlook application (e.g., "Inbox", "Sent Items", "Deleted Items", etc.)

Options

GetAsHTML

If selected, the message is returned in HTML format.

Attributes
Details

Type

Checkbox

Required

No

Default value

Not Selected

Allowed values

Selected or Not Selected

Notes

N/A


MarkAsRead

If selected, all of the messages returned in the Result property are marked as read.

Attributes
Details

Type

Checkbox

Required

No

Default value

Not Selected

Allowed values

Selected or Not Selected

Notes

N/A


OnlyUnreadMessages

If selected, only the unread messages are returned in the Result property.

Attributes
Details

Type

Checkbox

Required

No

Default value

Selected

Allowed values

Selected or Not Selected

Notes

N/A


Query

Your search parameters.

Attributes
Details

Type

String (OData syntax)

Required

No

Default value

Empty

Allowed values

Enter a String or String variable.

Notes


Top

The maximum number of messages that you want to retrieve.

Attributes
Details

Type

Int32

Required

No

Default value

50 (not shown)

Allowed values

Enter a Int32 or Int32 variable.

Notes

N/A


Misc

Private

If selected, the values of variables and arguments are no longer logged at Verbose level.

Attributes
Details

Type

Checkbox

Required

No

Default value

Not Selected

Allowed values

Selected or Not Selected

Notes

N/A


Output

Result

An array of messages (Office365Message objects) that match your Query value.

Attributes
Details

Type

Office365Message[]

Required

No (required if you plan to use the output data in subsequent activities)

Default value

Empty

Allowed values

Enter a Office365Message[] variable.

Notes

  • The variable you create for this property is also used in the Forward Mail and Move Mail activities (as the Message input property value).
    • When using this variable as an input property value, specify the item in the array that you want to use (e.g., foundMessages(0)).
  • The Office365Messageobject includes multiple properties that you can use in other activities. The example image below shows some of the properties that you can return.
    • The Body.Content property is returned in HTML format only.

Example

The following image shows an example of the activity dependency relationship and input/output property values.

For step-by-step instructions and examples, see the Quickstart guides.

Updated 3 months ago


Get Mail


Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.