Returns emails associated with this client based on its email rules. Rules containing '@' match that email address, GUIDs pin a specific message, and plain values match all emails from that domain. Searches across mailbox configurations the current user can access (owned or shared). Returns empty results if no rules are configured. Pass folderScope=Received for received mail in every folder except Sent, wherever it has been filed.
Requires: ViewAll on ClientEmailRules.
Parameters
| Name | Type | Description |
|---|---|---|
| tenant* | path string | The Tenant.Code |
The Tenant.Code |
||
| client* | path string | |
| search | query string | |
| configCode | query array | |
| direction | query enum | Represents the direction of an email in the external mailbox |
Represents the direction of an email in the external mailbox |
||
| folderScope | query enum | A named set of folders to list mail from, resolved per mailbox. Where systemFolderType matches |
A named set of folders to list mail from, resolved per mailbox. Where systemFolderType matches |
||
| folderUniqueId | query array | |
| systemFolderType | query enum | Identifies which provider-system folder a row represents. |
Identifies which provider-system folder a row represents. |
||
| offset | query integer (int32) | Number of records to skip (default: 0). Use with limit for pagination. |
Number of records to skip (default: 0). Use with limit for pagination. |
||
| limit | query integer (int32) | Maximum number of records to return (default: 10, max: 50) |
Maximum number of records to return (default: 10, max: 50) |
||
| sortBy | query enum | Field to sort by. Valid values depend on the resource. |
Field to sort by. Valid values depend on the resource. |
||
| sortDesc | query boolean | Sort in descending order (true) or ascending order (false, default) |
Sort in descending order (true) or ascending order (false, default) |
||