Activities
latest
false
Productivity Activities
Last updated Jun 3, 2024

GetEmails

Retrieves a list of emails that match the criteria defined in the filter that belong to the folder.

Namespace: UiPath.MicrosoftOffice365.Activities.Api

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

Syntax

IReadOnlyCollection<IMail> GetEmails(
	IMailFolder folder = null,
	MailFilter filter = null,
	string account = null,
	OrderBy orderBy = OrderBy.NewestFirst,
	bool includeSubfolders = true,
	bool markAsRead = false,
	bool bodyAsHtml = false,
	int? maxResults = null
)IReadOnlyCollection<IMail> GetEmails(
	IMailFolder folder = null,
	MailFilter filter = null,
	string account = null,
	OrderBy orderBy = OrderBy.NewestFirst,
	bool includeSubfolders = true,
	bool markAsRead = false,
	bool bodyAsHtml = false,
	int? maxResults = null
)

Parameters

folder IMailFolder (Optional)
The mail folder from which to retrieve the emails from. Optional, default value is All Mail.
filter MailFilter (Optional)
The mail filter criteria that should be matched for the retrieved emails. Optional, default value is null.
account String (Optional)
If specified uses the given shared mailbox, otherwise it uses the current account. Optional, default value is null.
orderBy OrderBy (Optional)
The order of the results. Optional, default value is NewestFirst.
includeSubfolders Boolean (Optional)
Specifies if subfolders should be included in the search results. Optional, default value is true.
markAsRead Boolean (Optional)
Specifies if the retrieved emails should be marked as read. Optional, default value is false.
bodyAsHtml Boolean (Optional)
If the content of the email should be interpreted as HTML format. Optional, default value is false.
maxResults Nullable<Int32> (Optional)
Maximum number of retrieved results. Values lower than or equal to 0 will be interpreted as unlimited. Optional, default value is unlimited.

Return value

IReadOnlyCollection<IMail> A list of emails that match the given criteria.
  • Syntax
  • Parameters
  • Return value

Was this page helpful?

Get The Help You Need
Learning RPA - Automation Courses
UiPath Community Forum
Uipath Logo White
Trust and Security
© 2005-2024 UiPath. All rights reserved.