GetImapMailOptions

Options used to retrieve IMAP email messages.

Namespace: UiPath.Mail.Activities.Api

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

Inheritance: System.Object > GetMailOptions > GetImapMailOptions

Constructors

Constructor	Description	Syntax
GetImapMailOptions	Initializes a new instance of the GetImapMailOptions class.	public GetImapMailOptions()

Properties

Property	Type	Description
DeleteMessages	bool	Specifies if the read messages should be marked for delete.
FilterExpression	string	Returns only those mail messages matching the filter expression.
FilterExpressionCharacterSet	string	The MIME name of the character set to use for the filter expression.
MailFolder	string	The mail folder from which to retrieve the messages.
MarkAsRead	bool	Specifies whether to mark retrieved messages as read.
OnlyUnreadMessages	bool	Specifies whether to retrieve only unread messages.
OrderByDate	EOrderByDate	Order mail messages by date.

GetImapMailOptions Methods

These are the methods you can use to configure mail options.

WithDeleteMessages

Specify if the read messages should be marked for delete.

Namespace: UiPath.Mail.Activities.Api

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

WithDeleteMessages(bool)

public GetImapMailOptions WithDeleteMessages(
	bool deleteMessages
)

deleteMessages Boolean

Whether the read messages should be marked for delete.

Return Value

GetImapMailOptions

Returns an updated instance of GetImapMailOptions.

WithFilterExpression

Set the filter expression the returned mail messages must match.

Namespace: UiPath.Mail.Activities.Api

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

WithFilterExpression(string)

public GetImapMailOptions WithFilterExpression(
	string filterExpression
)

filterExpression String

The filter expression to match.

Return Value

GetImapMailOptions

Returns an updated instance of GetImapMailOptions.

WithFilterExpressionCharacterSet

Set the MIME name of the character set to use for the filter expression.

Namespace: UiPath.Mail.Activities.Api

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

WithFilterExpressionCharacterSet(string)

public GetImapMailOptions WithFilterExpressionCharacterSet(
	string filterExpressionCharacterSet
)

filterExpressionCharacterSet String

The number of messages to retrieve.

Return Value

GetImapMailOptions

Returns an updated instance of GetImapMailOptions.

WithFolder

Set the mail folder from which to retrieve the messages.

Namespace: UiPath.Mail.Activities.Api

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

WithFolder(string)

public GetImapMailOptions WithFolder(
	string folder
)

folder String

The mail folder from which to retrieve the messages.

Return Value

GetImapMailOptions

Returns an updated instance of GetImapMailOptions.

WithMarkAsRead

Whether to mark retrieved messages as read.

Namespace: UiPath.Mail.Activities.Api

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

WithMarkAsRead(bool)

public GetImapMailOptions WithMarkAsRead(
	bool markAsRead
)

markAsRead Boolean

Whether to mark retrieved messages as read.

Return Value

GetImapMailOptions

Returns an updated instance of GetImapMailOptions.

WithOnlyUnreadMessages

Specify whether to retrieve only unread messages.

Namespace: UiPath.Mail.Activities.Api

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

WithOnlyUnreadMessages(bool)

public GetImapMailOptions WithOnlyUnreadMessages(
	bool onlyUnreadMessages
)

onlyUnreadMessages Boolean

Whether to retrieve only unread messages

Return Value

GetImapMailOptions

Returns an updated instance of GetImapMailOptions.

WithOrder

Set the order of mail messages by date.

Namespace: UiPath.Mail.Activities.Api

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

WithOrder(EOrderByDate)

public GetImapMailOptions WithOrder(
	EOrderByDate order
)

order EOrderByDate

Order mail messages by date. Available values: NewestFirst or OldestFirst.

Return Value

GetImapMailOptions

Returns an updated instance of GetImapMailOptions.

WithTop

Set the number of messages to retrieve starting from the top of the list.

Namespace: UiPath.Mail.Activities.Api

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

WithTop(int)

public GetImapMailOptions WithTop(
	int top
)

top Int32

The number of messages to retrieve.

Return Value

GetImapMailOptions

Returns an updated instance of GetImapMailOptions.