UiPath Documentation
activities
latest
false
Productivity activities

GetMessagesAsync

Retrieve email messages asynchronously.

Retrieve email messages asynchronously.

Namespace: UiPath.Mail.Activities.Api

Assembly: UiPath.Mail.Activities.Api (in UiPath.Mail.Activities.Api.dll)

Overloads​

OverloadDescription
GetMessagesAsync(CancellationToken)Asynchronously retrieve email messages.
GetMessagesAsync(GetMailOptions, CancellationToken)Asynchronously retrieve email messages with additional options.

GetMessagesAsync(CancellationToken)​

Retrieve email messages asynchronously.

Task<IReadOnlyCollection<MailMessage>> GetMessagesAsync(
	CancellationToken token
)
Task<IReadOnlyCollection<MailMessage>> GetMessagesAsync(
	CancellationToken token
)

token CancellationToken : The token for the cancel operation.

GetMessagesAsync(GetMailOptions, CancellationToken)​

Retrieve email messages asynchronously with additional options.

Task<IReadOnlyCollection<MailMessage>> GetMessagesAsync(
	GetMailOptions options,
	CancellationToken token
)
Task<IReadOnlyCollection<MailMessage>> GetMessagesAsync(
	GetMailOptions options,
	CancellationToken token
)

options GetMailOptions : Additional options to customize the retrieval of mails:

* `Top` - The number of messages to retrieve starting from the top of the list.
* `Top` - The number of messages to retrieve starting from the top of the list.

token CancellationToken : The token for the cancel operation.

Return value​

Task<IReadOnlyCollection<MailMessage>>

The retrieved messages as a collection of MailMessage objects.

Was this page helpful?

Connect

Need help? Support(opens in new window)

Want to learn? UiPath Academy(opens in new window)

Have questions? UiPath Forum(opens in new window)

Stay updated