Operation: ListMails

The ListMails operation creates a list of all emails from a specific mail folder.

Note:

The Limit and Offset parameters can be used to specify how many items are output.

By default, 10 items are output.

If needed, you can use the Limit and Offset parameters in the adapter to get more than 10 elements in the output.

It should be noted that the MS Graph API can output a maximum of 1000 items at once. For example, if 2000 items are to be retrieved, an iteration with the appropriate paging settings is required. This means for the second iteration the value 2000 would have to be set for Limit and the value 1001 for Offset.

Note:

Based on the ID of the email folder, the ListMails operation can be used to generate the list of mails in that folder.

Input

The adapter expects the following XML structure as input:

Example

XML

<?xml version="1.0" encoding="UTF-8"?>
<MailFolder>
		<FolderId>1231241423141241</FolderId>
		<!-- ###OPTIONAL### -->
		<FilterBy>		
			<Read>true/false</Read>
			<Sender>test.user@softproject.de</Sender>
			<ReceivedDateTime>
				<From>2022-05-23T11:59:59Z</From>
				<To>2022-05-23T11:59:59Z</To>
			</ReceivedDateTime>
			<Importance>high|normal|low</Importance>
		</FilterBy>
</MailFolder>

The following elements can be included in the input:

Element	Description
`MailFolder`	Enclosing element for the `ListMails` operation
`FolderId`	ID of the email folder of which the emails are to be listed. The ID of the email folder is generated by the `ListMailFolders` operation. Possible values: `Any string`
`FilterBy`	(optional) Enclosing element for the filter options `Read, Sender, ReceivedDateTime` and `Importance.`
`Read`	(optional) Filters for emails marked read or unread. Possible values: `true`: Filter for emails that are marked as read. `false`: Filters for emails that are marked as unread.
`Sender`	(optional) Email address of the sender Possible values: `Email address` *Example:* `test.user@softproject.de`
`ReceivedDateTime`	(optional) Enclosing element for the time span containing the earliest and latest date of received emails to be listed.
`From`	(optional) Earliest date of receipt (time and date) of the emails to be listed Possible values: `YYYY-MM-DDThh:mm:ssZ` *Example:* `2022-05-23T11:59:59Z`
`To`	(optional) Latest date of receipt (time and date) of the emails to be listed Possible values: `YYYY-MM-DDThh:mm:ssZ` *Example:* `2022-05-23T11:59:59Z`
`Importance`	(optional) Importance level of the email Possible values: `high`: High level of importance `normal`: Normal level of importance `low`: Low level of importance

Output

Based on the information given in the input, the adapter creates a list of the account’s emails as output.