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

Productivity activities

Last updated Mar 13, 2026

GetMessagesAsync

Retrieves Imap mail messages asynchronously.

Namespace: UiPath.Mail.Activities.Api

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

Overloads

OverloadDescription
GetMessagesAsync(GetImapMailMailOptions, CancellationToken)Retrieves Imap mail messages asynchronously with properties configured using the GetImapMailMailOptions object.
GetMessagesAsync(GetMailOptions, CancellationToken)Retrieves Imap mail messages asynchronously with additional options.
GetMessagesAsync(CancellationToken)Retrieves Imap mail messages asynchronously.

GetMessagesAsync(GetImapMailMailOptions, CancellationToken)

Retrieves Imap mail messages asynchronously with properties configured using the GetImapMailMailOptions object.

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

options GetImapMailOptions : The options used to retrieve the email messages.

token CancellationToken : The cancellation token to cancel the 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.

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.

Return value

Task<IReadOnlyCollection<MailMessage>>

The retrieved messages as a collection of MailMessage objects.

Was this page helpful?

Connect

Need help? Support

Want to learn? UiPath Academy

Have questions? UiPath Forum

Stay updated