Activities
latest
false
GetImapMailOptions - Other latest
Banner background image
logo
Productivity Activities
Last updated Feb 16, 2024

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

ConstructorDescriptionSyntax
GetImapMailOptionsInitializes a new instance of the GetImapMailOptions class.
public GetImapMailOptions()public GetImapMailOptions()

Properties

PropertyTypeDescription
DeleteMessagesboolSpecifies if the read messages should be marked for delete.
FilterExpressionstringReturns only those mail messages matching the filter expression.
FilterExpressionCharacterSetstringThe MIME name of the character set to use for the filter expression.
MailFolderstringThe mail folder from which to retrieve the messages.
MarkAsReadboolSpecifies whether to mark retrieved messages as read.
OnlyUnreadMessagesboolSpecifies whether to retrieve only unread messages.
OrderByDateEOrderByDateOrder 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
)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
)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
)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
)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
)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
)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
)public GetImapMailOptions WithTop(
	int top
)
top Int32
The number of messages to retrieve.

Return Value

GetImapMailOptions
Returns an updated instance of GetImapMailOptions.
Support and Services icon
Get The Help You Need
UiPath Academy icon
Learning RPA - Automation Courses
UiPath Forum icon
UiPath Community Forum
Uipath Logo White
Trust and Security
© 2005-2024 UiPath. All rights reserved.