Microsoft: Me mail folder schemas
20 Microsoft schemas with complete fields and constraints.
← Me mail folder operations · All schemas
Create Mail Folder — request body — body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | JSON | Root | |
$ (allOf 1) | Model | All variants apply | Expand Get rule — response body — @odata type, id |
$ (allOf 2) | object | All variants apply | discriminator: {"mapping": {}, "propertyName": "@odata.type"} |
$ (allOf 2).@odata.type | string | Optional | |
$ (allOf 2).childFolderCount | JSON | Optional | |
$ (allOf 2).childFolderCount (anyOf 1) | number | Alternative | The number of immediate child mailFolders in the current mailFolder. Format: int32 Maximum: 2147483647 Minimum: -2147483648 |
$ (allOf 2).childFolderCount (anyOf 2) | null | Alternative | |
$ (allOf 2).childFolders | array | Optional | The collection of child folders in the mailFolder. |
$ (allOf 2).childFolders[] | Model | Each item | Expand Create Mail Folder — request body — body @odata type, child Folder Count, child Folders, display Name, is Hidden, message Rules, messages, multi Value Extended Properties, parent Folder Id, single Value Extended Properties, total Item Count, unread Item Count child Folders item |
$ (allOf 2).displayName | JSON | Optional | |
$ (allOf 2).displayName (anyOf 1) | string | Alternative | The mailFolder's display name. |
$ (allOf 2).displayName (anyOf 2) | null | Alternative | |
$ (allOf 2).isHidden | JSON | Optional | |
$ (allOf 2).isHidden (anyOf 1) | boolean | Alternative | Indicates whether the mailFolder is hidden. This property can be set only when creating the folder. Find more information in Hidden mail folders. |
$ (allOf 2).isHidden (anyOf 2) | null | Alternative | |
$ (allOf 2).messageRules | array | Optional | The collection of rules that apply to the user's Inbox folder. |
$ (allOf 2).messageRules[] | Model | Each item | Expand Create rule — request body — body |
$ (allOf 2).messages | array | Optional | The collection of messages in the mailFolder. |
$ (allOf 2).messages[] | Model | Each item | Expand Create Mail Folder — request body — body @odata type, child Folder Count, child Folders, display Name, is Hidden, message Rules, messages, multi Value Extended Properties, parent Folder Id, single Value Extended Properties, total Item Count, unread Item Count messages item |
$ (allOf 2).multiValueExtendedProperties | array | Optional | The collection of multi-value extended properties defined for the mailFolder. Read-only. Nullable. |
$ (allOf 2).multiValueExtendedProperties[] | Model | Each item | Expand Get mail Folder — response body — @odata type, child Folder Count, child Folders, display Name, is Hidden, message Rules, messages, multi Value Extended Properties, parent Folder Id, single Value Extended Properties, total Item Count, unread Item Count multi Value Extended Properties item |
$ (allOf 2).parentFolderId | JSON | Optional | |
$ (allOf 2).parentFolderId (anyOf 1) | string | Alternative | The unique identifier for the mailFolder's parent mailFolder. |
$ (allOf 2).parentFolderId (anyOf 2) | null | Alternative | |
$ (allOf 2).singleValueExtendedProperties | array | Optional | The collection of single-value extended properties defined for the mailFolder. Read-only. Nullable. |
$ (allOf 2).singleValueExtendedProperties[] | Model | Each item | Expand Get mail Folder — response body — @odata type, child Folder Count, child Folders, display Name, is Hidden, message Rules, messages, multi Value Extended Properties, parent Folder Id, single Value Extended Properties, total Item Count, unread Item Count single Value Extended Properties item |
$ (allOf 2).totalItemCount | JSON | Optional | |
$ (allOf 2).totalItemCount (anyOf 1) | number | Alternative | The number of items in the mailFolder. Format: int32 Maximum: 2147483647 Minimum: -2147483648 |
$ (allOf 2).totalItemCount (anyOf 2) | null | Alternative | |
$ (allOf 2).unreadItemCount | JSON | Optional | |
$ (allOf 2).unreadItemCount (anyOf 1) | number | Alternative | The number of items in the mailFolder marked as unread. Format: int32 Maximum: 2147483647 Minimum: -2147483648 |
$ (allOf 2).unreadItemCount (anyOf 2) | null | Alternative |
Referenced models: Get rule — response body — @odata type, id, Get mail Folder — response body — @odata type, child Folder Count, child Folders, display Name, is Hidden, message Rules, messages, multi Value Extended Properties, parent Folder Id, single Value Extended Properties, total Item Count, unread Item Count multi Value Extended Properties item, Get mail Folder — response body — @odata type, child Folder Count, child Folders, display Name, is Hidden, message Rules, messages, multi Value Extended Properties, parent Folder Id, single Value Extended Properties, total Item Count, unread Item Count single Value Extended Properties item, Create Mail Folder — request body — body @odata type, child Folder Count, child Folders, display Name, is Hidden, message Rules, messages, multi Value Extended Properties, parent Folder Id, single Value Extended Properties, total Item Count, unread Item Count child Folders item, Create Mail Folder — request body — body @odata type, child Folder Count, child Folders, display Name, is Hidden, message Rules, messages, multi Value Extended Properties, parent Folder Id, single Value Extended Properties, total Item Count, unread Item Count messages item, Create rule — request body — body
Create Mail Folder — request body — body @odata type, child Folder Count, child Folders, display Name, is Hidden, message Rules, messages, multi Value Extended Properties, parent Folder Id, single Value Extended Properties, total Item Count, unread Item Count child Folders item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | JSON | Root | |
$ (allOf 1) | Model | All variants apply | Expand Get rule — response body — @odata type, id |
$ (allOf 2) | object | All variants apply | discriminator: {"mapping": {}, "propertyName": "@odata.type"} |
$ (allOf 2).@odata.type | string | Optional | |
$ (allOf 2).childFolderCount | JSON | Optional | |
$ (allOf 2).childFolderCount (anyOf 1) | number | Alternative | The number of immediate child mailFolders in the current mailFolder. Format: int32 Maximum: 2147483647 Minimum: -2147483648 |
$ (allOf 2).childFolderCount (anyOf 2) | null | Alternative | |
$ (allOf 2).displayName | JSON | Optional | |
$ (allOf 2).displayName (anyOf 1) | string | Alternative | The mailFolder's display name. |
$ (allOf 2).displayName (anyOf 2) | null | Alternative | |
$ (allOf 2).isHidden | JSON | Optional | |
$ (allOf 2).isHidden (anyOf 1) | boolean | Alternative | Indicates whether the mailFolder is hidden. This property can be set only when creating the folder. Find more information in Hidden mail folders. |
$ (allOf 2).isHidden (anyOf 2) | null | Alternative | |
$ (allOf 2).parentFolderId | JSON | Optional | |
$ (allOf 2).parentFolderId (anyOf 1) | string | Alternative | The unique identifier for the mailFolder's parent mailFolder. |
$ (allOf 2).parentFolderId (anyOf 2) | null | Alternative | |
$ (allOf 2).totalItemCount | JSON | Optional | |
$ (allOf 2).totalItemCount (anyOf 1) | number | Alternative | The number of items in the mailFolder. Format: int32 Maximum: 2147483647 Minimum: -2147483648 |
$ (allOf 2).totalItemCount (anyOf 2) | null | Alternative | |
$ (allOf 2).unreadItemCount | JSON | Optional | |
$ (allOf 2).unreadItemCount (anyOf 1) | number | Alternative | The number of items in the mailFolder marked as unread. Format: int32 Maximum: 2147483647 Minimum: -2147483648 |
$ (allOf 2).unreadItemCount (anyOf 2) | null | Alternative |
Referenced models: Get rule — response body — @odata type, id
Create Mail Folder — request body — body @odata type, child Folder Count, child Folders, display Name, is Hidden, message Rules, messages, multi Value Extended Properties, parent Folder Id, single Value Extended Properties, total Item Count, unread Item Count messages item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | JSON | Root | |
$ (allOf 1) | Model | All variants apply | Expand Get event — response body — @odata type, categories, change Key, created Date Time, id, last Modified Date Time |
$ (allOf 2) | object | All variants apply | discriminator: {"mapping": {}, "propertyName": "@odata.type"} |
$ (allOf 2).@odata.type | string | Optional | Default: #microsoft.graph.message |
$ (allOf 2).bccRecipients | array | Optional | The Bcc: recipients for the message. |
$ (allOf 2).bccRecipients[] | Model | Each item | Expand Invoke action forward — me Event events Forward — request body — body To Recipients item |
$ (allOf 2).body | JSON | Optional | The body of the message. It can be in HTML or text format. Find out about safe HTML in a message body. |
$ (allOf 2).body (anyOf 1) | Model | Alternative | Expand Create message — request body — body @odata type, attachments, bcc Recipients, body, body Preview, cc Recipients, conversation Id, conversation Index, extensions, flag, from, has Attachments, importance, inference Classification, internet Message Headers, internet Message Id, is Delivery Receipt Requested, is Draft, is Read, is Read Receipt Requested, multi Value Extended Properties, parent Folder Id, received Date Time, reply To, sender, sent Date Time, single Value Extended Properties, subject, to Recipients, unique Body, web Link body @odata type, content, content Type |
$ (allOf 2).body (anyOf 2) | JSON | Alternative | |
$ (allOf 2).body (anyOf 2) (anyOf 1) | object | Alternative | |
$ (allOf 2).body (anyOf 2) (anyOf 2) | null | Alternative | |
$ (allOf 2).bodyPreview | JSON | Optional | |
$ (allOf 2).bodyPreview (anyOf 1) | string | Alternative | The first 255 characters of the message body. It is in text format. |
$ (allOf 2).bodyPreview (anyOf 2) | null | Alternative | |
$ (allOf 2).ccRecipients | array | Optional | The Cc: recipients for the message. |
$ (allOf 2).ccRecipients[] | Model | Each item | Expand Invoke action forward — me Event events Forward — request body — body To Recipients item |
$ (allOf 2).conversationId | JSON | Optional | |
$ (allOf 2).conversationId (anyOf 1) | string | Alternative | The ID of the conversation the email belongs to. |
$ (allOf 2).conversationId (anyOf 2) | null | Alternative | |
$ (allOf 2).conversationIndex | JSON | Optional | |
$ (allOf 2).conversationIndex (anyOf 1) | string | Alternative | Indicates the position of the message within the conversation. Format: base64url |
$ (allOf 2).conversationIndex (anyOf 2) | null | Alternative | |
$ (allOf 2).flag | JSON | Optional | Indicates the status, start date, due date, or completion date for the message. |
$ (allOf 2).flag (anyOf 1) | Model | Alternative | Expand Create message — request body — body @odata type, attachments, bcc Recipients, body, body Preview, cc Recipients, conversation Id, conversation Index, extensions, flag, from, has Attachments, importance, inference Classification, internet Message Headers, internet Message Id, is Delivery Receipt Requested, is Draft, is Read, is Read Receipt Requested, multi Value Extended Properties, parent Folder Id, received Date Time, reply To, sender, sent Date Time, single Value Extended Properties, subject, to Recipients, unique Body, web Link flag @odata type, completed Date Time, due Date Time, flag Status, start Date Time |
$ (allOf 2).flag (anyOf 2) | JSON | Alternative | |
$ (allOf 2).flag (anyOf 2) (anyOf 1) | object | Alternative | |
$ (allOf 2).flag (anyOf 2) (anyOf 2) | null | Alternative | |
$ (allOf 2).from | JSON | Optional | The owner of the mailbox from which the message is sent. In most cases, this value is the same as the sender property, except for sharing or delegation scenarios. The value must correspond to the actual mailbox used. Find out more about setting the from and sender properties of a message. |
$ (allOf 2).from (anyOf 1) | Model | Alternative | Expand Invoke action forward — me Event events Forward — request body — body To Recipients item |
$ (allOf 2).from (anyOf 2) | JSON | Alternative | |
$ (allOf 2).from (anyOf 2) (anyOf 1) | object | Alternative | |
$ (allOf 2).from (anyOf 2) (anyOf 2) | null | Alternative | |
$ (allOf 2).hasAttachments | JSON | Optional | |
$ (allOf 2).hasAttachments (anyOf 1) | boolean | Alternative | Indicates whether the message has attachments. This property doesn't include inline attachments, so if a message contains only inline attachments, this property is false. To verify the existence of inline attachments, parse the body property to look for a src attribute, such as <IMG src='cid:image001.jpg@01D26CD8.6C05F070'>. |
$ (allOf 2).hasAttachments (anyOf 2) | null | Alternative | |
$ (allOf 2).importance | JSON | Optional | The importance of the message. The possible values are: low, normal, and high. |
$ (allOf 2).importance (anyOf 1) | string | Alternative | One of: low, normal, high |
$ (allOf 2).importance (anyOf 2) | JSON | Alternative | |
$ (allOf 2).importance (anyOf 2) (anyOf 1) | object | Alternative | |
$ (allOf 2).importance (anyOf 2) (anyOf 2) | null | Alternative | |
$ (allOf 2).inferenceClassification | JSON | Optional | The classification of the message for the user, based on inferred relevance or importance, or on an explicit override. The possible values are: focused or other. |
$ (allOf 2).inferenceClassification (anyOf 1) | string | Alternative | One of: focused, other |
$ (allOf 2).inferenceClassification (anyOf 2) | JSON | Alternative | |
$ (allOf 2).inferenceClassification (anyOf 2) (anyOf 1) | object | Alternative | |
$ (allOf 2).inferenceClassification (anyOf 2) (anyOf 2) | null | Alternative | |
$ (allOf 2).internetMessageHeaders | array | Optional | A collection of message headers defined by RFC5322. The set includes message headers indicating the network path taken by a message from the sender to the recipient. It can also contain custom message headers that hold app data for the message. Requires $select to retrieve. Read-only. |
$ (allOf 2).internetMessageHeaders[] | Model | Each item | Expand Get message — response body — @odata type, attachments, bcc Recipients, body, body Preview, cc Recipients, conversation Id, conversation Index, extensions, flag, from, has Attachments, importance, inference Classification, internet Message Headers, internet Message Id, is Delivery Receipt Requested, is Draft, is Read, is Read Receipt Requested, multi Value Extended Properties, parent Folder Id, received Date Time, reply To, sender, sent Date Time, single Value Extended Properties, subject, to Recipients, unique Body, web Link internet Message Headers item |
$ (allOf 2).internetMessageId | JSON | Optional | |
$ (allOf 2).internetMessageId (anyOf 1) | string | Alternative | The message ID in the format specified by RFC2822. |
$ (allOf 2).internetMessageId (anyOf 2) | null | Alternative | |
$ (allOf 2).isDeliveryReceiptRequested | JSON | Optional | |
$ (allOf 2).isDeliveryReceiptRequested (anyOf 1) | boolean | Alternative | Indicates whether a read receipt is requested for the message. |
$ (allOf 2).isDeliveryReceiptRequested (anyOf 2) | null | Alternative | |
$ (allOf 2).isDraft | JSON | Optional | |
$ (allOf 2).isDraft (anyOf 1) | boolean | Alternative | Indicates whether the message is a draft. A message is a draft if it hasn't been sent yet. |
$ (allOf 2).isDraft (anyOf 2) | null | Alternative | |
$ (allOf 2).isRead | JSON | Optional | |
$ (allOf 2).isRead (anyOf 1) | boolean | Alternative | Indicates whether the message has been read. |
$ (allOf 2).isRead (anyOf 2) | null | Alternative | |
$ (allOf 2).isReadReceiptRequested | JSON | Optional | |
$ (allOf 2).isReadReceiptRequested (anyOf 1) | boolean | Alternative | Indicates whether a read receipt is requested for the message. |
$ (allOf 2).isReadReceiptRequested (anyOf 2) | null | Alternative | |
$ (allOf 2).parentFolderId | JSON | Optional | |
$ (allOf 2).parentFolderId (anyOf 1) | string | Alternative | The unique identifier for the message's parent mailFolder. |
$ (allOf 2).parentFolderId (anyOf 2) | null | Alternative | |
$ (allOf 2).receivedDateTime | JSON | Optional | |
$ (allOf 2).receivedDateTime (anyOf 1) | string | Alternative | The date and time the message was received. The date and time information uses ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z. Format: date-time Pattern: ^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$ |
$ (allOf 2).receivedDateTime (anyOf 2) | null | Alternative | |
$ (allOf 2).replyTo | array | Optional | The email addresses to use when replying. |
$ (allOf 2).replyTo[] | Model | Each item | Expand Invoke action forward — me Event events Forward — request body — body To Recipients item |
$ (allOf 2).sender | JSON | Optional | The account that is used to generate the message. In most cases, this value is the same as the from property. You can set this property to a different value when sending a message from a shared mailbox, for a shared calendar, or as a delegate. In any case, the value must correspond to the actual mailbox used. Find out more about setting the from and sender properties of a message. |
$ (allOf 2).sender (anyOf 1) | Model | Alternative | Expand Invoke action forward — me Event events Forward — request body — body To Recipients item |
$ (allOf 2).sender (anyOf 2) | JSON | Alternative | |
$ (allOf 2).sender (anyOf 2) (anyOf 1) | object | Alternative | |
$ (allOf 2).sender (anyOf 2) (anyOf 2) | null | Alternative | |
$ (allOf 2).sentDateTime | JSON | Optional | |
$ (allOf 2).sentDateTime (anyOf 1) | string | Alternative | The date and time the message was sent. The date and time information uses ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z. Format: date-time Pattern: ^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$ |
$ (allOf 2).sentDateTime (anyOf 2) | null | Alternative | |
$ (allOf 2).subject | JSON | Optional | |
$ (allOf 2).subject (anyOf 1) | string | Alternative | The subject of the message. |
$ (allOf 2).subject (anyOf 2) | null | Alternative | |
$ (allOf 2).toRecipients | array | Optional | The To: recipients for the message. |
$ (allOf 2).toRecipients[] | Model | Each item | Expand Invoke action forward — me Event events Forward — request body — body To Recipients item |
$ (allOf 2).uniqueBody | JSON | Optional | The part of the body of the message that is unique to the current message. uniqueBody is not returned by default but can be retrieved for a given message by use of the ?$select=uniqueBody query. It can be in HTML or text format. |
$ (allOf 2).uniqueBody (anyOf 1) | Model | Alternative | Expand Create message — request body — body @odata type, attachments, bcc Recipients, body, body Preview, cc Recipients, conversation Id, conversation Index, extensions, flag, from, has Attachments, importance, inference Classification, internet Message Headers, internet Message Id, is Delivery Receipt Requested, is Draft, is Read, is Read Receipt Requested, multi Value Extended Properties, parent Folder Id, received Date Time, reply To, sender, sent Date Time, single Value Extended Properties, subject, to Recipients, unique Body, web Link body @odata type, content, content Type |
$ (allOf 2).uniqueBody (anyOf 2) | JSON | Alternative | |
$ (allOf 2).uniqueBody (anyOf 2) (anyOf 1) | object | Alternative | |
$ (allOf 2).uniqueBody (anyOf 2) (anyOf 2) | null | Alternative | |
$ (allOf 2).webLink | JSON | Optional | |
$ (allOf 2).webLink (anyOf 1) | string | Alternative | The URL to open the message in Outlook on the web.You can append an ispopout argument to the end of the URL to change how the message is displayed. If ispopout is not present or if it is set to 1, then the message is shown in a popout window. If ispopout is set to 0, the browser shows the message in the Outlook on the web review pane.The message opens in the browser if you are signed in to your mailbox via Outlook on the web. You are prompted to sign in if you are not already signed in with the browser.This URL cannot be accessed from within an iFrame.NOTE: When using this URL to access a message from a mailbox with delegate permissions, both the signed-in user and the target mailbox must be in the same database region. For example, an error is returned when a user with a mailbox in the EUR (Europe) region attempts to access messages from a mailbox in the NAM (North America) region. |
$ (allOf 2).webLink (anyOf 2) | null | Alternative |
Referenced models: Get message — response body — @odata type, attachments, bcc Recipients, body, body Preview, cc Recipients, conversation Id, conversation Index, extensions, flag, from, has Attachments, importance, inference Classification, internet Message Headers, internet Message Id, is Delivery Receipt Requested, is Draft, is Read, is Read Receipt Requested, multi Value Extended Properties, parent Folder Id, received Date Time, reply To, sender, sent Date Time, single Value Extended Properties, subject, to Recipients, unique Body, web Link internet Message Headers item, Get event — response body — @odata type, categories, change Key, created Date Time, id, last Modified Date Time, Invoke action forward — me Event events Forward — request body — body To Recipients item, Create message — request body — body @odata type, attachments, bcc Recipients, body, body Preview, cc Recipients, conversation Id, conversation Index, extensions, flag, from, has Attachments, importance, inference Classification, internet Message Headers, internet Message Id, is Delivery Receipt Requested, is Draft, is Read, is Read Receipt Requested, multi Value Extended Properties, parent Folder Id, received Date Time, reply To, sender, sent Date Time, single Value Extended Properties, subject, to Recipients, unique Body, web Link flag @odata type, completed Date Time, due Date Time, flag Status, start Date Time, Create message — request body — body @odata type, attachments, bcc Recipients, body, body Preview, cc Recipients, conversation Id, conversation Index, extensions, flag, from, has Attachments, importance, inference Classification, internet Message Headers, internet Message Id, is Delivery Receipt Requested, is Draft, is Read, is Read Receipt Requested, multi Value Extended Properties, parent Folder Id, received Date Time, reply To, sender, sent Date Time, single Value Extended Properties, subject, to Recipients, unique Body, web Link body @odata type, content, content Type
Create rule — request body — body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | JSON | Root | |
$ (allOf 1) | Model | All variants apply | Expand Get rule — response body — @odata type, id |
$ (allOf 2) | object | All variants apply | |
$ (allOf 2).@odata.type | string | Optional | |
$ (allOf 2).actions | JSON | Optional | Actions to be taken on a message when the corresponding conditions are fulfilled. |
$ (allOf 2).actions (anyOf 1) | Model | Alternative | Expand Create rule — request body — body @odata type, actions, conditions, display Name, exceptions, has Error, is Enabled, is Read Only, sequence actions @odata type, assign Categories, copy To Folder, delete, forward As Attachment To, forward To, mark As Read, mark Importance, move To Folder, permanent Delete, redirect To, stop Processing Rules |
$ (allOf 2).actions (anyOf 2) | JSON | Alternative | |
$ (allOf 2).actions (anyOf 2) (anyOf 1) | object | Alternative | |
$ (allOf 2).actions (anyOf 2) (anyOf 2) | null | Alternative | |
$ (allOf 2).conditions | JSON | Optional | Conditions that when fulfilled trigger the corresponding actions for that rule. |
$ (allOf 2).conditions (anyOf 1) | Model | Alternative | Expand Create rule — request body — body @odata type, actions, conditions, display Name, exceptions, has Error, is Enabled, is Read Only, sequence conditions @odata type, body Contains, body Or Subject Contains, categories, from Addresses, has Attachments, header Contains, importance, is Approval Request, is Automatic Forward, is Automatic Reply, is Encrypted, is Meeting Request, is Meeting Response, is Non Delivery Report, is Permission Controlled, is Read Receipt, is Signed, is Voicemail, message Action Flag, not Sent To Me, recipient Contains, sender Contains, sensitivity, sent Cc Me, sent Only To Me, sent To Addresses, sent To Me, sent To Or Cc Me, subject Contains, within Size Range |
$ (allOf 2).conditions (anyOf 2) | JSON | Alternative | |
$ (allOf 2).conditions (anyOf 2) (anyOf 1) | object | Alternative | |
$ (allOf 2).conditions (anyOf 2) (anyOf 2) | null | Alternative | |
$ (allOf 2).displayName | JSON | Optional | |
$ (allOf 2).displayName (anyOf 1) | string | Alternative | The display name of the rule. |
$ (allOf 2).displayName (anyOf 2) | null | Alternative | |
$ (allOf 2).exceptions | JSON | Optional | Exception conditions for the rule. |
$ (allOf 2).exceptions (anyOf 1) | Model | Alternative | Expand Create rule — request body — body @odata type, actions, conditions, display Name, exceptions, has Error, is Enabled, is Read Only, sequence conditions @odata type, body Contains, body Or Subject Contains, categories, from Addresses, has Attachments, header Contains, importance, is Approval Request, is Automatic Forward, is Automatic Reply, is Encrypted, is Meeting Request, is Meeting Response, is Non Delivery Report, is Permission Controlled, is Read Receipt, is Signed, is Voicemail, message Action Flag, not Sent To Me, recipient Contains, sender Contains, sensitivity, sent Cc Me, sent Only To Me, sent To Addresses, sent To Me, sent To Or Cc Me, subject Contains, within Size Range |
$ (allOf 2).exceptions (anyOf 2) | JSON | Alternative | |
$ (allOf 2).exceptions (anyOf 2) (anyOf 1) | object | Alternative | |
$ (allOf 2).exceptions (anyOf 2) (anyOf 2) | null | Alternative | |
$ (allOf 2).hasError | JSON | Optional | |
$ (allOf 2).hasError (anyOf 1) | boolean | Alternative | Indicates whether the rule is in an error condition. Read-only. |
$ (allOf 2).hasError (anyOf 2) | null | Alternative | |
$ (allOf 2).isEnabled | JSON | Optional | |
$ (allOf 2).isEnabled (anyOf 1) | boolean | Alternative | Indicates whether the rule is enabled to be applied to messages. |
$ (allOf 2).isEnabled (anyOf 2) | null | Alternative | |
$ (allOf 2).isReadOnly | JSON | Optional | |
$ (allOf 2).isReadOnly (anyOf 1) | boolean | Alternative | Indicates if the rule is read-only and cannot be modified or deleted by the rules REST API. |
$ (allOf 2).isReadOnly (anyOf 2) | null | Alternative | |
$ (allOf 2).sequence | JSON | Optional | |
$ (allOf 2).sequence (anyOf 1) | number | Alternative | Indicates the order in which the rule is executed, among other rules. Format: int32 Maximum: 2147483647 Minimum: -2147483648 |
$ (allOf 2).sequence (anyOf 2) | null | Alternative |
Referenced models: Get rule — response body — @odata type, id, Create rule — request body — body @odata type, actions, conditions, display Name, exceptions, has Error, is Enabled, is Read Only, sequence actions @odata type, assign Categories, copy To Folder, delete, forward As Attachment To, forward To, mark As Read, mark Importance, move To Folder, permanent Delete, redirect To, stop Processing Rules, Create rule — request body — body @odata type, actions, conditions, display Name, exceptions, has Error, is Enabled, is Read Only, sequence conditions @odata type, body Contains, body Or Subject Contains, categories, from Addresses, has Attachments, header Contains, importance, is Approval Request, is Automatic Forward, is Automatic Reply, is Encrypted, is Meeting Request, is Meeting Response, is Non Delivery Report, is Permission Controlled, is Read Receipt, is Signed, is Voicemail, message Action Flag, not Sent To Me, recipient Contains, sender Contains, sensitivity, sent Cc Me, sent Only To Me, sent To Addresses, sent To Me, sent To Or Cc Me, subject Contains, within Size Range
Create rule — request body — body @odata type, actions, conditions, display Name, exceptions, has Error, is Enabled, is Read Only, sequence actions @odata type, assign Categories, copy To Folder, delete, forward As Attachment To, forward To, mark As Read, mark Importance, move To Folder, permanent Delete, redirect To, stop Processing Rules
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
@odata.type | string | Optional | |
assignCategories | array | Optional | A list of categories to be assigned to a message. |
assignCategories[] | JSON | Each item | |
assignCategories[] (anyOf 1) | string | Alternative | |
assignCategories[] (anyOf 2) | null | Alternative | |
copyToFolder | JSON | Optional | |
copyToFolder (anyOf 1) | string | Alternative | The ID of a folder that a message is to be copied to. |
copyToFolder (anyOf 2) | null | Alternative | |
delete | JSON | Optional | |
delete (anyOf 1) | boolean | Alternative | Indicates whether a message should be moved to the Deleted Items folder. |
delete (anyOf 2) | null | Alternative | |
forwardAsAttachmentTo | array | Optional | The email addresses of the recipients to which a message should be forwarded as an attachment. |
forwardAsAttachmentTo[] | Model | Each item | Expand Invoke action forward — me Event events Forward — request body — body To Recipients item |
forwardTo | array | Optional | The email addresses of the recipients to which a message should be forwarded. |
forwardTo[] | Model | Each item | Expand Invoke action forward — me Event events Forward — request body — body To Recipients item |
markAsRead | JSON | Optional | |
markAsRead (anyOf 1) | boolean | Alternative | Indicates whether a message should be marked as read. |
markAsRead (anyOf 2) | null | Alternative | |
markImportance | JSON | Optional | Sets the importance of the message, which can be: low, normal, high. |
markImportance (anyOf 1) | string | Alternative | One of: low, normal, high |
markImportance (anyOf 2) | JSON | Alternative | |
markImportance (anyOf 2) (anyOf 1) | object | Alternative | |
markImportance (anyOf 2) (anyOf 2) | null | Alternative | |
moveToFolder | JSON | Optional | |
moveToFolder (anyOf 1) | string | Alternative | The ID of the folder that a message will be moved to. |
moveToFolder (anyOf 2) | null | Alternative | |
permanentDelete | JSON | Optional | |
permanentDelete (anyOf 1) | boolean | Alternative | Indicates whether a message should be permanently deleted and not saved to the Deleted Items folder. |
permanentDelete (anyOf 2) | null | Alternative | |
redirectTo | array | Optional | The email addresses to which a message should be redirected. |
redirectTo[] | Model | Each item | Expand Invoke action forward — me Event events Forward — request body — body To Recipients item |
stopProcessingRules | JSON | Optional | |
stopProcessingRules (anyOf 1) | boolean | Alternative | Indicates whether subsequent rules should be evaluated. |
stopProcessingRules (anyOf 2) | null | Alternative |
Referenced models: Invoke action forward — me Event events Forward — request body — body To Recipients item
Create rule — request body — body @odata type, actions, conditions, display Name, exceptions, has Error, is Enabled, is Read Only, sequence conditions @odata type, body Contains, body Or Subject Contains, categories, from Addresses, has Attachments, header Contains, importance, is Approval Request, is Automatic Forward, is Automatic Reply, is Encrypted, is Meeting Request, is Meeting Response, is Non Delivery Report, is Permission Controlled, is Read Receipt, is Signed, is Voicemail, message Action Flag, not Sent To Me, recipient Contains, sender Contains, sensitivity, sent Cc Me, sent Only To Me, sent To Addresses, sent To Me, sent To Or Cc Me, subject Contains, within Size Range
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
@odata.type | string | Optional | |
bodyContains | array | Optional | Represents the strings that should appear in the body of an incoming message in order for the condition or exception to apply. |
bodyContains[] | JSON | Each item | |
bodyContains[] (anyOf 1) | string | Alternative | |
bodyContains[] (anyOf 2) | null | Alternative | |
bodyOrSubjectContains | array | Optional | Represents the strings that should appear in the body or subject of an incoming message in order for the condition or exception to apply. |
bodyOrSubjectContains[] | JSON | Each item | |
bodyOrSubjectContains[] (anyOf 1) | string | Alternative | |
bodyOrSubjectContains[] (anyOf 2) | null | Alternative | |
categories | array | Optional | Represents the categories that an incoming message should be labeled with in order for the condition or exception to apply. |
categories[] | JSON | Each item | |
categories[] (anyOf 1) | string | Alternative | |
categories[] (anyOf 2) | null | Alternative | |
fromAddresses | array | Optional | Represents the specific sender email addresses of an incoming message in order for the condition or exception to apply. |
fromAddresses[] | Model | Each item | Expand Invoke action forward — me Event events Forward — request body — body To Recipients item |
hasAttachments | JSON | Optional | |
hasAttachments (anyOf 1) | boolean | Alternative | Indicates whether an incoming message must have attachments in order for the condition or exception to apply. |
hasAttachments (anyOf 2) | null | Alternative | |
headerContains | array | Optional | Represents the strings that appear in the headers of an incoming message in order for the condition or exception to apply. |
headerContains[] | JSON | Each item | |
headerContains[] (anyOf 1) | string | Alternative | |
headerContains[] (anyOf 2) | null | Alternative | |
importance | JSON | Optional | The importance that is stamped on an incoming message in order for the condition or exception to apply: low, normal, high. |
importance (anyOf 1) | string | Alternative | One of: low, normal, high |
importance (anyOf 2) | JSON | Alternative | |
importance (anyOf 2) (anyOf 1) | object | Alternative | |
importance (anyOf 2) (anyOf 2) | null | Alternative | |
isApprovalRequest | JSON | Optional | |
isApprovalRequest (anyOf 1) | boolean | Alternative | Indicates whether an incoming message must be an approval request in order for the condition or exception to apply. |
isApprovalRequest (anyOf 2) | null | Alternative | |
isAutomaticForward | JSON | Optional | |
isAutomaticForward (anyOf 1) | boolean | Alternative | Indicates whether an incoming message must be automatically forwarded in order for the condition or exception to apply. |
isAutomaticForward (anyOf 2) | null | Alternative | |
isAutomaticReply | JSON | Optional | |
isAutomaticReply (anyOf 1) | boolean | Alternative | Indicates whether an incoming message must be an auto reply in order for the condition or exception to apply. |
isAutomaticReply (anyOf 2) | null | Alternative | |
isEncrypted | JSON | Optional | |
isEncrypted (anyOf 1) | boolean | Alternative | Indicates whether an incoming message must be encrypted in order for the condition or exception to apply. |
isEncrypted (anyOf 2) | null | Alternative | |
isMeetingRequest | JSON | Optional | |
isMeetingRequest (anyOf 1) | boolean | Alternative | Indicates whether an incoming message must be a meeting request in order for the condition or exception to apply. |
isMeetingRequest (anyOf 2) | null | Alternative | |
isMeetingResponse | JSON | Optional | |
isMeetingResponse (anyOf 1) | boolean | Alternative | Indicates whether an incoming message must be a meeting response in order for the condition or exception to apply. |
isMeetingResponse (anyOf 2) | null | Alternative | |
isNonDeliveryReport | JSON | Optional | |
isNonDeliveryReport (anyOf 1) | boolean | Alternative | Indicates whether an incoming message must be a non-delivery report in order for the condition or exception to apply. |
isNonDeliveryReport (anyOf 2) | null | Alternative | |
isPermissionControlled | JSON | Optional | |
isPermissionControlled (anyOf 1) | boolean | Alternative | Indicates whether an incoming message must be permission controlled (RMS-protected) in order for the condition or exception to apply. |
isPermissionControlled (anyOf 2) | null | Alternative | |
isReadReceipt | JSON | Optional | |
isReadReceipt (anyOf 1) | boolean | Alternative | Indicates whether an incoming message must be a read receipt in order for the condition or exception to apply. |
isReadReceipt (anyOf 2) | null | Alternative | |
isSigned | JSON | Optional | |
isSigned (anyOf 1) | boolean | Alternative | Indicates whether an incoming message must be S/MIME-signed in order for the condition or exception to apply. |
isSigned (anyOf 2) | null | Alternative | |
isVoicemail | JSON | Optional | |
isVoicemail (anyOf 1) | boolean | Alternative | Indicates whether an incoming message must be a voice mail in order for the condition or exception to apply. |
isVoicemail (anyOf 2) | null | Alternative | |
messageActionFlag | JSON | Optional | Represents the flag-for-action value that appears on an incoming message in order for the condition or exception to apply. The possible values are: any, call, doNotForward, followUp, fyi, forward, noResponseNecessary, read, reply, replyToAll, review. |
messageActionFlag (anyOf 1) | string | Alternative | One of: any, call, doNotForward, followUp, fyi, forward, noResponseNecessary, read, reply, replyToAll, review |
messageActionFlag (anyOf 2) | JSON | Alternative | |
messageActionFlag (anyOf 2) (anyOf 1) | object | Alternative | |
messageActionFlag (anyOf 2) (anyOf 2) | null | Alternative | |
notSentToMe | JSON | Optional | |
notSentToMe (anyOf 1) | boolean | Alternative | Indicates whether the owner of the mailbox must not be a recipient of an incoming message in order for the condition or exception to apply. |
notSentToMe (anyOf 2) | null | Alternative | |
recipientContains | array | Optional | Represents the strings that appear in either the toRecipients or ccRecipients properties of an incoming message in order for the condition or exception to apply. |
recipientContains[] | JSON | Each item | |
recipientContains[] (anyOf 1) | string | Alternative | |
recipientContains[] (anyOf 2) | null | Alternative | |
senderContains | array | Optional | Represents the strings that appear in the from property of an incoming message in order for the condition or exception to apply. |
senderContains[] | JSON | Each item | |
senderContains[] (anyOf 1) | string | Alternative | |
senderContains[] (anyOf 2) | null | Alternative | |
sensitivity | JSON | Optional | Represents the sensitivity level that must be stamped on an incoming message in order for the condition or exception to apply. The possible values are: normal, personal, private, confidential. |
sensitivity (anyOf 1) | string | Alternative | One of: normal, personal, private, confidential |
sensitivity (anyOf 2) | JSON | Alternative | |
sensitivity (anyOf 2) (anyOf 1) | object | Alternative | |
sensitivity (anyOf 2) (anyOf 2) | null | Alternative | |
sentCcMe | JSON | Optional | |
sentCcMe (anyOf 1) | boolean | Alternative | Indicates whether the owner of the mailbox must be in the ccRecipients property of an incoming message in order for the condition or exception to apply. |
sentCcMe (anyOf 2) | null | Alternative | |
sentOnlyToMe | JSON | Optional | |
sentOnlyToMe (anyOf 1) | boolean | Alternative | Indicates whether the owner of the mailbox must be the only recipient in an incoming message in order for the condition or exception to apply. |
sentOnlyToMe (anyOf 2) | null | Alternative | |
sentToAddresses | array | Optional | Represents the email addresses that an incoming message must have been sent to in order for the condition or exception to apply. |
sentToAddresses[] | Model | Each item | Expand Invoke action forward — me Event events Forward — request body — body To Recipients item |
sentToMe | JSON | Optional | |
sentToMe (anyOf 1) | boolean | Alternative | Indicates whether the owner of the mailbox must be in the toRecipients property of an incoming message in order for the condition or exception to apply. |
sentToMe (anyOf 2) | null | Alternative | |
sentToOrCcMe | JSON | Optional | |
sentToOrCcMe (anyOf 1) | boolean | Alternative | Indicates whether the owner of the mailbox must be in either a toRecipients or ccRecipients property of an incoming message in order for the condition or exception to apply. |
sentToOrCcMe (anyOf 2) | null | Alternative | |
subjectContains | array | Optional | Represents the strings that appear in the subject of an incoming message in order for the condition or exception to apply. |
subjectContains[] | JSON | Each item | |
subjectContains[] (anyOf 1) | string | Alternative | |
subjectContains[] (anyOf 2) | null | Alternative | |
withinSizeRange | JSON | Optional | Represents the minimum and maximum sizes (in kilobytes) that an incoming message must fall in between in order for the condition or exception to apply. |
withinSizeRange (anyOf 1) | Model | Alternative | Expand Create rule — request body — body @odata type, actions, conditions, display Name, exceptions, has Error, is Enabled, is Read Only, sequence conditions @odata type, body Contains, body Or Subject Contains, categories, from Addresses, has Attachments, header Contains, importance, is Approval Request, is Automatic Forward, is Automatic Reply, is Encrypted, is Meeting Request, is Meeting Response, is Non Delivery Report, is Permission Controlled, is Read Receipt, is Signed, is Voicemail, message Action Flag, not Sent To Me, recipient Contains, sender Contains, sensitivity, sent Cc Me, sent Only To Me, sent To Addresses, sent To Me, sent To Or Cc Me, subject Contains, within Size Range within Size Range @odata type, maximum Size, minimum Size |
withinSizeRange (anyOf 2) | JSON | Alternative | |
withinSizeRange (anyOf 2) (anyOf 1) | object | Alternative | |
withinSizeRange (anyOf 2) (anyOf 2) | null | Alternative |
Referenced models: Invoke action forward — me Event events Forward — request body — body To Recipients item, Create rule — request body — body @odata type, actions, conditions, display Name, exceptions, has Error, is Enabled, is Read Only, sequence conditions @odata type, body Contains, body Or Subject Contains, categories, from Addresses, has Attachments, header Contains, importance, is Approval Request, is Automatic Forward, is Automatic Reply, is Encrypted, is Meeting Request, is Meeting Response, is Non Delivery Report, is Permission Controlled, is Read Receipt, is Signed, is Voicemail, message Action Flag, not Sent To Me, recipient Contains, sender Contains, sensitivity, sent Cc Me, sent Only To Me, sent To Addresses, sent To Me, sent To Or Cc Me, subject Contains, within Size Range within Size Range @odata type, maximum Size, minimum Size
Create rule — request body — body @odata type, actions, conditions, display Name, exceptions, has Error, is Enabled, is Read Only, sequence conditions @odata type, body Contains, body Or Subject Contains, categories, from Addresses, has Attachments, header Contains, importance, is Approval Request, is Automatic Forward, is Automatic Reply, is Encrypted, is Meeting Request, is Meeting Response, is Non Delivery Report, is Permission Controlled, is Read Receipt, is Signed, is Voicemail, message Action Flag, not Sent To Me, recipient Contains, sender Contains, sensitivity, sent Cc Me, sent Only To Me, sent To Addresses, sent To Me, sent To Or Cc Me, subject Contains, within Size Range within Size Range @odata type, maximum Size, minimum Size
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
@odata.type | string | Optional | |
maximumSize | JSON | Optional | |
maximumSize (anyOf 1) | number | Alternative | The maximum size (in kilobytes) that an incoming message must have in order for a condition or exception to apply. Format: int32 Maximum: 2147483647 Minimum: -2147483648 |
maximumSize (anyOf 2) | null | Alternative | |
minimumSize | JSON | Optional | |
minimumSize (anyOf 1) | number | Alternative | The minimum size (in kilobytes) that an incoming message must have in order for a condition or exception to apply. Format: int32 Maximum: 2147483647 Minimum: -2147483648 |
minimumSize (anyOf 2) | null | Alternative |
Get mail Folder — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | JSON | Root | |
$ (allOf 1) | Model | All variants apply | Expand Get rule — response body — @odata type, id |
$ (allOf 2) | object | All variants apply | discriminator: {"mapping": {}, "propertyName": "@odata.type"} |
$ (allOf 2).@odata.type | string | Optional | |
$ (allOf 2).childFolderCount | JSON | Optional | |
$ (allOf 2).childFolderCount (anyOf 1) | JSON | Alternative | |
$ (allOf 2).childFolderCount (anyOf 1) (anyOf 1) | number | Alternative | The number of immediate child mailFolders in the current mailFolder. Format: int32 Maximum: 2147483647 Minimum: -2147483648 |
$ (allOf 2).childFolderCount (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
$ (allOf 2).childFolderCount (anyOf 2) | null | Alternative | |
$ (allOf 2).childFolders | array | Optional | The collection of child folders in the mailFolder. |
$ (allOf 2).childFolders[] | Model | Each item | Expand Get mail Folder — response body |
$ (allOf 2).displayName | JSON | Optional | |
$ (allOf 2).displayName (anyOf 1) | string | Alternative | The mailFolder's display name. |
$ (allOf 2).displayName (anyOf 2) | null | Alternative | |
$ (allOf 2).isHidden | JSON | Optional | |
$ (allOf 2).isHidden (anyOf 1) | boolean | Alternative | Indicates whether the mailFolder is hidden. This property can be set only when creating the folder. Find more information in Hidden mail folders. |
$ (allOf 2).isHidden (anyOf 2) | null | Alternative | |
$ (allOf 2).messageRules | array | Optional | The collection of rules that apply to the user's Inbox folder. |
$ (allOf 2).messageRules[] | Model | Each item | Expand Get rule — response body |
$ (allOf 2).messages | array | Optional | The collection of messages in the mailFolder. |
$ (allOf 2).messages[] | Model | Each item | Expand Get message — response body |
$ (allOf 2).multiValueExtendedProperties | array | Optional | The collection of multi-value extended properties defined for the mailFolder. Read-only. Nullable. |
$ (allOf 2).multiValueExtendedProperties[] | Model | Each item | Expand Get mail Folder — response body — @odata type, child Folder Count, child Folders, display Name, is Hidden, message Rules, messages, multi Value Extended Properties, parent Folder Id, single Value Extended Properties, total Item Count, unread Item Count multi Value Extended Properties item |
$ (allOf 2).parentFolderId | JSON | Optional | |
$ (allOf 2).parentFolderId (anyOf 1) | string | Alternative | The unique identifier for the mailFolder's parent mailFolder. |
$ (allOf 2).parentFolderId (anyOf 2) | null | Alternative | |
$ (allOf 2).singleValueExtendedProperties | array | Optional | The collection of single-value extended properties defined for the mailFolder. Read-only. Nullable. |
$ (allOf 2).singleValueExtendedProperties[] | Model | Each item | Expand Get mail Folder — response body — @odata type, child Folder Count, child Folders, display Name, is Hidden, message Rules, messages, multi Value Extended Properties, parent Folder Id, single Value Extended Properties, total Item Count, unread Item Count single Value Extended Properties item |
$ (allOf 2).totalItemCount | JSON | Optional | |
$ (allOf 2).totalItemCount (anyOf 1) | JSON | Alternative | |
$ (allOf 2).totalItemCount (anyOf 1) (anyOf 1) | number | Alternative | The number of items in the mailFolder. Format: int32 Maximum: 2147483647 Minimum: -2147483648 |
$ (allOf 2).totalItemCount (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
$ (allOf 2).totalItemCount (anyOf 2) | null | Alternative | |
$ (allOf 2).unreadItemCount | JSON | Optional | |
$ (allOf 2).unreadItemCount (anyOf 1) | JSON | Alternative | |
$ (allOf 2).unreadItemCount (anyOf 1) (anyOf 1) | number | Alternative | The number of items in the mailFolder marked as unread. Format: int32 Maximum: 2147483647 Minimum: -2147483648 |
$ (allOf 2).unreadItemCount (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
$ (allOf 2).unreadItemCount (anyOf 2) | null | Alternative |
Referenced models: Get rule — response body — @odata type, id, Get mail Folder — response body, Get message — response body, Get rule — response body, Get mail Folder — response body — @odata type, child Folder Count, child Folders, display Name, is Hidden, message Rules, messages, multi Value Extended Properties, parent Folder Id, single Value Extended Properties, total Item Count, unread Item Count multi Value Extended Properties item, Get mail Folder — response body — @odata type, child Folder Count, child Folders, display Name, is Hidden, message Rules, messages, multi Value Extended Properties, parent Folder Id, single Value Extended Properties, total Item Count, unread Item Count single Value Extended Properties item
Get mail Folder — response body — @odata type, child Folder Count, child Folders, display Name, is Hidden, message Rules, messages, multi Value Extended Properties, parent Folder Id, single Value Extended Properties, total Item Count, unread Item Count multi Value Extended Properties item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | JSON | Root | |
$ (allOf 1) | Model | All variants apply | Expand Get rule — response body — @odata type, id |
$ (allOf 2) | object | All variants apply | |
$ (allOf 2).@odata.type | string | Optional | |
$ (allOf 2).value | array | Optional | A collection of property values. |
$ (allOf 2).value[] | JSON | Each item | |
$ (allOf 2).value[] (anyOf 1) | string | Alternative | |
$ (allOf 2).value[] (anyOf 2) | null | Alternative |
Referenced models: Get rule — response body — @odata type, id
Get mail Folder — response body — @odata type, child Folder Count, child Folders, display Name, is Hidden, message Rules, messages, multi Value Extended Properties, parent Folder Id, single Value Extended Properties, total Item Count, unread Item Count single Value Extended Properties item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | JSON | Root | |
$ (allOf 1) | Model | All variants apply | Expand Get rule — response body — @odata type, id |
$ (allOf 2) | object | All variants apply | |
$ (allOf 2).@odata.type | string | Optional | |
$ (allOf 2).value | JSON | Optional | |
$ (allOf 2).value (anyOf 1) | string | Alternative | A property value. |
$ (allOf 2).value (anyOf 2) | null | Alternative |
Referenced models: Get rule — response body — @odata type, id
Get rule — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | JSON | Root | |
$ (allOf 1) | Model | All variants apply | Expand Get rule — response body — @odata type, id |
$ (allOf 2) | object | All variants apply | |
$ (allOf 2).@odata.type | string | Optional | |
$ (allOf 2).actions | JSON | Optional | Actions to be taken on a message when the corresponding conditions are fulfilled. |
$ (allOf 2).actions (anyOf 1) | Model | Alternative | Expand Get rule — response body — @odata type, actions, conditions, display Name, exceptions, has Error, is Enabled, is Read Only, sequence actions @odata type, assign Categories, copy To Folder, delete, forward As Attachment To, forward To, mark As Read, mark Importance, move To Folder, permanent Delete, redirect To, stop Processing Rules |
$ (allOf 2).actions (anyOf 2) | JSON | Alternative | |
$ (allOf 2).actions (anyOf 2) (anyOf 1) | object | Alternative | |
$ (allOf 2).actions (anyOf 2) (anyOf 2) | null | Alternative | |
$ (allOf 2).conditions | JSON | Optional | Conditions that when fulfilled trigger the corresponding actions for that rule. |
$ (allOf 2).conditions (anyOf 1) | Model | Alternative | Expand Get rule — response body — @odata type, actions, conditions, display Name, exceptions, has Error, is Enabled, is Read Only, sequence conditions @odata type, body Contains, body Or Subject Contains, categories, from Addresses, has Attachments, header Contains, importance, is Approval Request, is Automatic Forward, is Automatic Reply, is Encrypted, is Meeting Request, is Meeting Response, is Non Delivery Report, is Permission Controlled, is Read Receipt, is Signed, is Voicemail, message Action Flag, not Sent To Me, recipient Contains, sender Contains, sensitivity, sent Cc Me, sent Only To Me, sent To Addresses, sent To Me, sent To Or Cc Me, subject Contains, within Size Range |
$ (allOf 2).conditions (anyOf 2) | JSON | Alternative | |
$ (allOf 2).conditions (anyOf 2) (anyOf 1) | object | Alternative | |
$ (allOf 2).conditions (anyOf 2) (anyOf 2) | null | Alternative | |
$ (allOf 2).displayName | JSON | Optional | |
$ (allOf 2).displayName (anyOf 1) | string | Alternative | The display name of the rule. |
$ (allOf 2).displayName (anyOf 2) | null | Alternative | |
$ (allOf 2).exceptions | JSON | Optional | Exception conditions for the rule. |
$ (allOf 2).exceptions (anyOf 1) | Model | Alternative | Expand Get rule — response body — @odata type, actions, conditions, display Name, exceptions, has Error, is Enabled, is Read Only, sequence conditions @odata type, body Contains, body Or Subject Contains, categories, from Addresses, has Attachments, header Contains, importance, is Approval Request, is Automatic Forward, is Automatic Reply, is Encrypted, is Meeting Request, is Meeting Response, is Non Delivery Report, is Permission Controlled, is Read Receipt, is Signed, is Voicemail, message Action Flag, not Sent To Me, recipient Contains, sender Contains, sensitivity, sent Cc Me, sent Only To Me, sent To Addresses, sent To Me, sent To Or Cc Me, subject Contains, within Size Range |
$ (allOf 2).exceptions (anyOf 2) | JSON | Alternative | |
$ (allOf 2).exceptions (anyOf 2) (anyOf 1) | object | Alternative | |
$ (allOf 2).exceptions (anyOf 2) (anyOf 2) | null | Alternative | |
$ (allOf 2).hasError | JSON | Optional | |
$ (allOf 2).hasError (anyOf 1) | boolean | Alternative | Indicates whether the rule is in an error condition. Read-only. |
$ (allOf 2).hasError (anyOf 2) | null | Alternative | |
$ (allOf 2).isEnabled | JSON | Optional | |
$ (allOf 2).isEnabled (anyOf 1) | boolean | Alternative | Indicates whether the rule is enabled to be applied to messages. |
$ (allOf 2).isEnabled (anyOf 2) | null | Alternative | |
$ (allOf 2).isReadOnly | JSON | Optional | |
$ (allOf 2).isReadOnly (anyOf 1) | boolean | Alternative | Indicates if the rule is read-only and cannot be modified or deleted by the rules REST API. |
$ (allOf 2).isReadOnly (anyOf 2) | null | Alternative | |
$ (allOf 2).sequence | JSON | Optional | |
$ (allOf 2).sequence (anyOf 1) | JSON | Alternative | |
$ (allOf 2).sequence (anyOf 1) (anyOf 1) | number | Alternative | Indicates the order in which the rule is executed, among other rules. Format: int32 Maximum: 2147483647 Minimum: -2147483648 |
$ (allOf 2).sequence (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
$ (allOf 2).sequence (anyOf 2) | null | Alternative |
Referenced models: Get rule — response body — @odata type, id, Get rule — response body — @odata type, actions, conditions, display Name, exceptions, has Error, is Enabled, is Read Only, sequence actions @odata type, assign Categories, copy To Folder, delete, forward As Attachment To, forward To, mark As Read, mark Importance, move To Folder, permanent Delete, redirect To, stop Processing Rules, Get rule — response body — @odata type, actions, conditions, display Name, exceptions, has Error, is Enabled, is Read Only, sequence conditions @odata type, body Contains, body Or Subject Contains, categories, from Addresses, has Attachments, header Contains, importance, is Approval Request, is Automatic Forward, is Automatic Reply, is Encrypted, is Meeting Request, is Meeting Response, is Non Delivery Report, is Permission Controlled, is Read Receipt, is Signed, is Voicemail, message Action Flag, not Sent To Me, recipient Contains, sender Contains, sensitivity, sent Cc Me, sent Only To Me, sent To Addresses, sent To Me, sent To Or Cc Me, subject Contains, within Size Range
Get rule — response body — @odata type, actions, conditions, display Name, exceptions, has Error, is Enabled, is Read Only, sequence actions @odata type, assign Categories, copy To Folder, delete, forward As Attachment To, forward To, mark As Read, mark Importance, move To Folder, permanent Delete, redirect To, stop Processing Rules
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
@odata.type | string | Optional | |
assignCategories | array | Optional | A list of categories to be assigned to a message. |
assignCategories[] | JSON | Each item | |
assignCategories[] (anyOf 1) | string | Alternative | |
assignCategories[] (anyOf 2) | null | Alternative | |
copyToFolder | JSON | Optional | |
copyToFolder (anyOf 1) | string | Alternative | The ID of a folder that a message is to be copied to. |
copyToFolder (anyOf 2) | null | Alternative | |
delete | JSON | Optional | |
delete (anyOf 1) | boolean | Alternative | Indicates whether a message should be moved to the Deleted Items folder. |
delete (anyOf 2) | null | Alternative | |
forwardAsAttachmentTo | array | Optional | The email addresses of the recipients to which a message should be forwarded as an attachment. |
forwardAsAttachmentTo[] | Model | Each item | Expand Invoke action forward — me Event events Forward — request body — body To Recipients item |
forwardTo | array | Optional | The email addresses of the recipients to which a message should be forwarded. |
forwardTo[] | Model | Each item | Expand Invoke action forward — me Event events Forward — request body — body To Recipients item |
markAsRead | JSON | Optional | |
markAsRead (anyOf 1) | boolean | Alternative | Indicates whether a message should be marked as read. |
markAsRead (anyOf 2) | null | Alternative | |
markImportance | JSON | Optional | Sets the importance of the message, which can be: low, normal, high. |
markImportance (anyOf 1) | string | Alternative | Known values: low, normal, high |
markImportance (anyOf 2) | JSON | Alternative | |
markImportance (anyOf 2) (anyOf 1) | object | Alternative | |
markImportance (anyOf 2) (anyOf 2) | null | Alternative | |
moveToFolder | JSON | Optional | |
moveToFolder (anyOf 1) | string | Alternative | The ID of the folder that a message will be moved to. |
moveToFolder (anyOf 2) | null | Alternative | |
permanentDelete | JSON | Optional | |
permanentDelete (anyOf 1) | boolean | Alternative | Indicates whether a message should be permanently deleted and not saved to the Deleted Items folder. |
permanentDelete (anyOf 2) | null | Alternative | |
redirectTo | array | Optional | The email addresses to which a message should be redirected. |
redirectTo[] | Model | Each item | Expand Invoke action forward — me Event events Forward — request body — body To Recipients item |
stopProcessingRules | JSON | Optional | |
stopProcessingRules (anyOf 1) | boolean | Alternative | Indicates whether subsequent rules should be evaluated. |
stopProcessingRules (anyOf 2) | null | Alternative |
Referenced models: Invoke action forward — me Event events Forward — request body — body To Recipients item
Get rule — response body — @odata type, actions, conditions, display Name, exceptions, has Error, is Enabled, is Read Only, sequence conditions @odata type, body Contains, body Or Subject Contains, categories, from Addresses, has Attachments, header Contains, importance, is Approval Request, is Automatic Forward, is Automatic Reply, is Encrypted, is Meeting Request, is Meeting Response, is Non Delivery Report, is Permission Controlled, is Read Receipt, is Signed, is Voicemail, message Action Flag, not Sent To Me, recipient Contains, sender Contains, sensitivity, sent Cc Me, sent Only To Me, sent To Addresses, sent To Me, sent To Or Cc Me, subject Contains, within Size Range
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
@odata.type | string | Optional | |
bodyContains | array | Optional | Represents the strings that should appear in the body of an incoming message in order for the condition or exception to apply. |
bodyContains[] | JSON | Each item | |
bodyContains[] (anyOf 1) | string | Alternative | |
bodyContains[] (anyOf 2) | null | Alternative | |
bodyOrSubjectContains | array | Optional | Represents the strings that should appear in the body or subject of an incoming message in order for the condition or exception to apply. |
bodyOrSubjectContains[] | JSON | Each item | |
bodyOrSubjectContains[] (anyOf 1) | string | Alternative | |
bodyOrSubjectContains[] (anyOf 2) | null | Alternative | |
categories | array | Optional | Represents the categories that an incoming message should be labeled with in order for the condition or exception to apply. |
categories[] | JSON | Each item | |
categories[] (anyOf 1) | string | Alternative | |
categories[] (anyOf 2) | null | Alternative | |
fromAddresses | array | Optional | Represents the specific sender email addresses of an incoming message in order for the condition or exception to apply. |
fromAddresses[] | Model | Each item | Expand Invoke action forward — me Event events Forward — request body — body To Recipients item |
hasAttachments | JSON | Optional | |
hasAttachments (anyOf 1) | boolean | Alternative | Indicates whether an incoming message must have attachments in order for the condition or exception to apply. |
hasAttachments (anyOf 2) | null | Alternative | |
headerContains | array | Optional | Represents the strings that appear in the headers of an incoming message in order for the condition or exception to apply. |
headerContains[] | JSON | Each item | |
headerContains[] (anyOf 1) | string | Alternative | |
headerContains[] (anyOf 2) | null | Alternative | |
importance | JSON | Optional | The importance that is stamped on an incoming message in order for the condition or exception to apply: low, normal, high. |
importance (anyOf 1) | string | Alternative | Known values: low, normal, high |
importance (anyOf 2) | JSON | Alternative | |
importance (anyOf 2) (anyOf 1) | object | Alternative | |
importance (anyOf 2) (anyOf 2) | null | Alternative | |
isApprovalRequest | JSON | Optional | |
isApprovalRequest (anyOf 1) | boolean | Alternative | Indicates whether an incoming message must be an approval request in order for the condition or exception to apply. |
isApprovalRequest (anyOf 2) | null | Alternative | |
isAutomaticForward | JSON | Optional | |
isAutomaticForward (anyOf 1) | boolean | Alternative | Indicates whether an incoming message must be automatically forwarded in order for the condition or exception to apply. |
isAutomaticForward (anyOf 2) | null | Alternative | |
isAutomaticReply | JSON | Optional | |
isAutomaticReply (anyOf 1) | boolean | Alternative | Indicates whether an incoming message must be an auto reply in order for the condition or exception to apply. |
isAutomaticReply (anyOf 2) | null | Alternative | |
isEncrypted | JSON | Optional | |
isEncrypted (anyOf 1) | boolean | Alternative | Indicates whether an incoming message must be encrypted in order for the condition or exception to apply. |
isEncrypted (anyOf 2) | null | Alternative | |
isMeetingRequest | JSON | Optional | |
isMeetingRequest (anyOf 1) | boolean | Alternative | Indicates whether an incoming message must be a meeting request in order for the condition or exception to apply. |
isMeetingRequest (anyOf 2) | null | Alternative | |
isMeetingResponse | JSON | Optional | |
isMeetingResponse (anyOf 1) | boolean | Alternative | Indicates whether an incoming message must be a meeting response in order for the condition or exception to apply. |
isMeetingResponse (anyOf 2) | null | Alternative | |
isNonDeliveryReport | JSON | Optional | |
isNonDeliveryReport (anyOf 1) | boolean | Alternative | Indicates whether an incoming message must be a non-delivery report in order for the condition or exception to apply. |
isNonDeliveryReport (anyOf 2) | null | Alternative | |
isPermissionControlled | JSON | Optional | |
isPermissionControlled (anyOf 1) | boolean | Alternative | Indicates whether an incoming message must be permission controlled (RMS-protected) in order for the condition or exception to apply. |
isPermissionControlled (anyOf 2) | null | Alternative | |
isReadReceipt | JSON | Optional | |
isReadReceipt (anyOf 1) | boolean | Alternative | Indicates whether an incoming message must be a read receipt in order for the condition or exception to apply. |
isReadReceipt (anyOf 2) | null | Alternative | |
isSigned | JSON | Optional | |
isSigned (anyOf 1) | boolean | Alternative | Indicates whether an incoming message must be S/MIME-signed in order for the condition or exception to apply. |
isSigned (anyOf 2) | null | Alternative | |
isVoicemail | JSON | Optional | |
isVoicemail (anyOf 1) | boolean | Alternative | Indicates whether an incoming message must be a voice mail in order for the condition or exception to apply. |
isVoicemail (anyOf 2) | null | Alternative | |
messageActionFlag | JSON | Optional | Represents the flag-for-action value that appears on an incoming message in order for the condition or exception to apply. The possible values are: any, call, doNotForward, followUp, fyi, forward, noResponseNecessary, read, reply, replyToAll, review. |
messageActionFlag (anyOf 1) | string | Alternative | Known values: any, call, doNotForward, followUp, fyi, forward, noResponseNecessary, read, reply, replyToAll, review |
messageActionFlag (anyOf 2) | JSON | Alternative | |
messageActionFlag (anyOf 2) (anyOf 1) | object | Alternative | |
messageActionFlag (anyOf 2) (anyOf 2) | null | Alternative | |
notSentToMe | JSON | Optional | |
notSentToMe (anyOf 1) | boolean | Alternative | Indicates whether the owner of the mailbox must not be a recipient of an incoming message in order for the condition or exception to apply. |
notSentToMe (anyOf 2) | null | Alternative | |
recipientContains | array | Optional | Represents the strings that appear in either the toRecipients or ccRecipients properties of an incoming message in order for the condition or exception to apply. |
recipientContains[] | JSON | Each item | |
recipientContains[] (anyOf 1) | string | Alternative | |
recipientContains[] (anyOf 2) | null | Alternative | |
senderContains | array | Optional | Represents the strings that appear in the from property of an incoming message in order for the condition or exception to apply. |
senderContains[] | JSON | Each item | |
senderContains[] (anyOf 1) | string | Alternative | |
senderContains[] (anyOf 2) | null | Alternative | |
sensitivity | JSON | Optional | Represents the sensitivity level that must be stamped on an incoming message in order for the condition or exception to apply. The possible values are: normal, personal, private, confidential. |
sensitivity (anyOf 1) | string | Alternative | Known values: normal, personal, private, confidential |
sensitivity (anyOf 2) | JSON | Alternative | |
sensitivity (anyOf 2) (anyOf 1) | object | Alternative | |
sensitivity (anyOf 2) (anyOf 2) | null | Alternative | |
sentCcMe | JSON | Optional | |
sentCcMe (anyOf 1) | boolean | Alternative | Indicates whether the owner of the mailbox must be in the ccRecipients property of an incoming message in order for the condition or exception to apply. |
sentCcMe (anyOf 2) | null | Alternative | |
sentOnlyToMe | JSON | Optional | |
sentOnlyToMe (anyOf 1) | boolean | Alternative | Indicates whether the owner of the mailbox must be the only recipient in an incoming message in order for the condition or exception to apply. |
sentOnlyToMe (anyOf 2) | null | Alternative | |
sentToAddresses | array | Optional | Represents the email addresses that an incoming message must have been sent to in order for the condition or exception to apply. |
sentToAddresses[] | Model | Each item | Expand Invoke action forward — me Event events Forward — request body — body To Recipients item |
sentToMe | JSON | Optional | |
sentToMe (anyOf 1) | boolean | Alternative | Indicates whether the owner of the mailbox must be in the toRecipients property of an incoming message in order for the condition or exception to apply. |
sentToMe (anyOf 2) | null | Alternative | |
sentToOrCcMe | JSON | Optional | |
sentToOrCcMe (anyOf 1) | boolean | Alternative | Indicates whether the owner of the mailbox must be in either a toRecipients or ccRecipients property of an incoming message in order for the condition or exception to apply. |
sentToOrCcMe (anyOf 2) | null | Alternative | |
subjectContains | array | Optional | Represents the strings that appear in the subject of an incoming message in order for the condition or exception to apply. |
subjectContains[] | JSON | Each item | |
subjectContains[] (anyOf 1) | string | Alternative | |
subjectContains[] (anyOf 2) | null | Alternative | |
withinSizeRange | JSON | Optional | Represents the minimum and maximum sizes (in kilobytes) that an incoming message must fall in between in order for the condition or exception to apply. |
withinSizeRange (anyOf 1) | Model | Alternative | Expand Get rule — response body — @odata type, actions, conditions, display Name, exceptions, has Error, is Enabled, is Read Only, sequence conditions @odata type, body Contains, body Or Subject Contains, categories, from Addresses, has Attachments, header Contains, importance, is Approval Request, is Automatic Forward, is Automatic Reply, is Encrypted, is Meeting Request, is Meeting Response, is Non Delivery Report, is Permission Controlled, is Read Receipt, is Signed, is Voicemail, message Action Flag, not Sent To Me, recipient Contains, sender Contains, sensitivity, sent Cc Me, sent Only To Me, sent To Addresses, sent To Me, sent To Or Cc Me, subject Contains, within Size Range within Size Range @odata type, maximum Size, minimum Size |
withinSizeRange (anyOf 2) | JSON | Alternative | |
withinSizeRange (anyOf 2) (anyOf 1) | object | Alternative | |
withinSizeRange (anyOf 2) (anyOf 2) | null | Alternative |
Referenced models: Invoke action forward — me Event events Forward — request body — body To Recipients item, Get rule — response body — @odata type, actions, conditions, display Name, exceptions, has Error, is Enabled, is Read Only, sequence conditions @odata type, body Contains, body Or Subject Contains, categories, from Addresses, has Attachments, header Contains, importance, is Approval Request, is Automatic Forward, is Automatic Reply, is Encrypted, is Meeting Request, is Meeting Response, is Non Delivery Report, is Permission Controlled, is Read Receipt, is Signed, is Voicemail, message Action Flag, not Sent To Me, recipient Contains, sender Contains, sensitivity, sent Cc Me, sent Only To Me, sent To Addresses, sent To Me, sent To Or Cc Me, subject Contains, within Size Range within Size Range @odata type, maximum Size, minimum Size
Get rule — response body — @odata type, actions, conditions, display Name, exceptions, has Error, is Enabled, is Read Only, sequence conditions @odata type, body Contains, body Or Subject Contains, categories, from Addresses, has Attachments, header Contains, importance, is Approval Request, is Automatic Forward, is Automatic Reply, is Encrypted, is Meeting Request, is Meeting Response, is Non Delivery Report, is Permission Controlled, is Read Receipt, is Signed, is Voicemail, message Action Flag, not Sent To Me, recipient Contains, sender Contains, sensitivity, sent Cc Me, sent Only To Me, sent To Addresses, sent To Me, sent To Or Cc Me, subject Contains, within Size Range within Size Range @odata type, maximum Size, minimum Size
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
@odata.type | string | Optional | |
maximumSize | JSON | Optional | |
maximumSize (anyOf 1) | JSON | Alternative | |
maximumSize (anyOf 1) (anyOf 1) | number | Alternative | The maximum size (in kilobytes) that an incoming message must have in order for a condition or exception to apply. Format: int32 Maximum: 2147483647 Minimum: -2147483648 |
maximumSize (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
maximumSize (anyOf 2) | null | Alternative | |
minimumSize | JSON | Optional | |
minimumSize (anyOf 1) | JSON | Alternative | |
minimumSize (anyOf 1) (anyOf 1) | number | Alternative | The minimum size (in kilobytes) that an incoming message must have in order for a condition or exception to apply. Format: int32 Maximum: 2147483647 Minimum: -2147483648 |
minimumSize (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
minimumSize (anyOf 2) | null | Alternative |
Get rule — response body — @odata type, id
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | discriminator: {"mapping": {"#microsoft.graph.activitiesContainer": "#/components/schemas/microsoft.graph.activitiesContainer", "#microsoft.graph.activityHistoryItem": "#/components/schemas/microsoft.graph.activityHistoryItem", "#microsoft.graph.adhocCall": "#/components/schemas/microsoft.graph.adhocCall", "#microsoft.graph.agreementAcceptance": "#/components/schemas/microsoft.graph.agreementAcceptance", "#microsoft.graph.appRoleAssignment": "#/components/schemas/microsoft.graph.appRoleAssignment", "#microsoft.graph.associatedTeamInfo": "#/components/schemas/microsoft.graph.associatedTeamInfo", "#microsoft.graph.attachment": "#/components/schemas/microsoft.graph.attachment", "#microsoft.graph.attachmentBase": "#/components/schemas/microsoft.graph.attachmentBase", "#microsoft.graph.attachmentSession": "#/components/schemas/microsoft.graph.attachmentSession", "#microsoft.graph.attendanceRecord": "#/components/schemas/microsoft.graph.attendanceRecord", "#microsoft.graph.authentication": "#/components/schemas/microsoft.graph.authentication", "#microsoft.graph.authenticationMethod": "#/components/schemas/microsoft.graph.authenticationMethod", "#microsoft.graph.baseItem": "#/components/schemas/microsoft.graph.baseItem", "#microsoft.graph.baseItemVersion": "#/components/schemas/microsoft.graph.baseItemVersion", "#microsoft.graph.baseSitePage": "#/components/schemas/microsoft.graph.baseSitePage", "#microsoft.graph.calendar": "#/components/schemas/microsoft.graph.calendar", "#microsoft.graph.calendarGroup": "#/components/schemas/microsoft.graph.calendarGroup", "#microsoft.graph.calendarPermission": "#/components/schemas/microsoft.graph.calendarPermission", "#microsoft.graph.callRecording": "#/components/schemas/microsoft.graph.callRecording", "#microsoft.graph.callTranscript": "#/components/schemas/microsoft.graph.callTranscript", "#microsoft.graph.changeTrackedEntity": "#/components/schemas/microsoft.graph.changeTrackedEntity", "#microsoft.graph.channel": "#/components/schemas/microsoft.graph.channel", "#microsoft.graph.chat": "#/components/schemas/microsoft.graph.chat", "#microsoft.graph.chatMessage": "#/components/schemas/microsoft.graph.chatMessage", "#microsoft.graph.chatMessageHostedContent": "#/components/schemas/microsoft.graph.chatMessageHostedContent", "#microsoft.graph.chatMessageInfo": "#/components/schemas/microsoft.graph.chatMessageInfo", "#microsoft.graph.checklistItem": "#/components/schemas/microsoft.graph.checklistItem", "#microsoft.graph.cloudClipboardItem": "#/components/schemas/microsoft.graph.cloudClipboardItem", "#microsoft.graph.cloudClipboardRoot": "#/components/schemas/microsoft.graph.cloudClipboardRoot", "#microsoft.graph.cloudPC": "#/components/schemas/microsoft.graph.cloudPC", "#microsoft.graph.columnDefinition": "#/components/schemas/microsoft.graph.columnDefinition", "#microsoft.graph.columnLink": "#/components/schemas/microsoft.graph.columnLink", "#microsoft.graph.contact": "#/components/schemas/microsoft.graph.contact", "#microsoft.graph.contactFolder": "#/components/schemas/microsoft.graph.contactFolder", "#microsoft.graph.contentActivity": "#/components/schemas/microsoft.graph.contentActivity", "#microsoft.graph.contentType": "#/components/schemas/microsoft.graph.contentType", "#microsoft.graph.conversation": "#/components/schemas/microsoft.graph.conversation", "#microsoft.graph.conversationMember": "#/components/schemas/microsoft.graph.conversationMember", "#microsoft.graph.conversationThread": "#/components/schemas/microsoft.graph.conversationThread", "#microsoft.graph.dataSecurityAndGovernance": "#/components/schemas/microsoft.graph.dataSecurityAndGovernance", "#microsoft.graph.dayNote": "#/components/schemas/microsoft.graph.dayNote", "#microsoft.graph.device": "#/components/schemas/microsoft.graph.device", "#microsoft.graph.deviceCategory": "#/components/schemas/microsoft.graph.deviceCategory", "#microsoft.graph.deviceCompliancePolicyState": "#/components/schemas/microsoft.graph.deviceCompliancePolicyState", "#microsoft.graph.deviceConfigurationState": "#/components/schemas/microsoft.graph.deviceConfigurationState", "#microsoft.graph.deviceLogCollectionResponse": "#/components/schemas/microsoft.graph.deviceLogCollectionResponse", "#microsoft.graph.deviceManagementTroubleshootingEvent": "#/components/schemas/microsoft.graph.deviceManagementTroubleshootingEvent", "#microsoft.graph.directoryObject": "#/components/schemas/microsoft.graph.directoryObject", "#microsoft.graph.documentSetVersion": "#/components/schemas/microsoft.graph.documentSetVersion", "#microsoft.graph.drive": "#/components/schemas/microsoft.graph.drive", "#microsoft.graph.driveItem": "#/components/schemas/microsoft.graph.driveItem", "#microsoft.graph.driveItemVersion": "#/components/schemas/microsoft.graph.driveItemVersion", "#microsoft.graph.emailAuthenticationMethod": "#/components/schemas/microsoft.graph.emailAuthenticationMethod", "#microsoft.graph.employeeExperienceUser": "#/components/schemas/microsoft.graph.employeeExperienceUser", "#microsoft.graph.engagementRole": "#/components/schemas/microsoft.graph.engagementRole", "#microsoft.graph.engagementRoleMember": "#/components/schemas/microsoft.graph.engagementRoleMember", "#microsoft.graph.event": "#/components/schemas/microsoft.graph.event", "#microsoft.graph.exchangeSettings": "#/components/schemas/microsoft.graph.exchangeSettings", "#microsoft.graph.extension": "#/components/schemas/microsoft.graph.extension", "#microsoft.graph.externalAuthenticationMethod": "#/components/schemas/microsoft.graph.externalAuthenticationMethod", "#microsoft.graph.fido2AuthenticationMethod": "#/components/schemas/microsoft.graph.fido2AuthenticationMethod", "#microsoft.graph.fieldValueSet": "#/components/schemas/microsoft.graph.fieldValueSet", "#microsoft.graph.group": "#/components/schemas/microsoft.graph.group", "#microsoft.graph.groupLifecyclePolicy": "#/components/schemas/microsoft.graph.groupLifecyclePolicy", "#microsoft.graph.groupSetting": "#/components/schemas/microsoft.graph.groupSetting", "#microsoft.graph.inferenceClassification": "#/components/schemas/microsoft.graph.inferenceClassification", "#microsoft.graph.inferenceClassificationOverride": "#/components/schemas/microsoft.graph.inferenceClassificationOverride", "#microsoft.graph.itemActivity": "#/components/schemas/microsoft.graph.itemActivity", "#microsoft.graph.itemActivityStat": "#/components/schemas/microsoft.graph.itemActivityStat", "#microsoft.graph.itemAnalytics": "#/components/schemas/microsoft.graph.itemAnalytics", "#microsoft.graph.itemInsights": "#/components/schemas/microsoft.graph.itemInsights", "#microsoft.graph.itemRetentionLabel": "#/components/schemas/microsoft.graph.itemRetentionLabel", "#microsoft.graph.learningCourseActivity": "#/components/schemas/microsoft.graph.learningCourseActivity", "#microsoft.graph.licenseDetails": "#/components/schemas/microsoft.graph.licenseDetails", "#microsoft.graph.linkedResource": "#/components/schemas/microsoft.graph.linkedResource", "#microsoft.graph.list": "#/components/schemas/microsoft.graph.list", "#microsoft.graph.listItem": "#/components/schemas/microsoft.graph.listItem", "#microsoft.graph.listItemVersion": "#/components/schemas/microsoft.graph.listItemVersion", "#microsoft.graph.longRunningOperation": "#/components/schemas/microsoft.graph.longRunningOperation", "#microsoft.graph.mailFolder": "#/components/schemas/microsoft.graph.mailFolder", "#microsoft.graph.managedAppOperation": "#/components/schemas/microsoft.graph.managedAppOperation", "#microsoft.graph.managedAppPolicy": "#/components/schemas/microsoft.graph.managedAppPolicy", "#microsoft.graph.managedAppRegistration": "#/components/schemas/microsoft.graph.managedAppRegistration", "#microsoft.graph.managedDevice": "#/components/schemas/microsoft.graph.managedDevice", "#microsoft.graph.meetingAttendanceReport": "#/components/schemas/microsoft.graph.meetingAttendanceReport", "#microsoft.graph.message": "#/components/schemas/microsoft.graph.message", "#microsoft.graph.messageRule": "#/components/schemas/microsoft.graph.messageRule", "#microsoft.graph.microsoftAuthenticatorAuthenticationMethod": "#/components/schemas/microsoft.graph.microsoftAuthenticatorAuthenticationMethod", "#microsoft.graph.multiValueLegacyExtendedProperty": "#/components/schemas/microsoft.graph.multiValueLegacyExtendedProperty", "#microsoft.graph.note": "#/components/schemas/microsoft.graph.note", "#microsoft.graph.notebook": "#/components/schemas/microsoft.graph.notebook", "#microsoft.graph.oAuth2PermissionGrant": "#/components/schemas/microsoft.graph.oAuth2PermissionGrant", "#microsoft.graph.offerShiftRequest": "#/components/schemas/microsoft.graph.offerShiftRequest", "#microsoft.graph.officeGraphInsights": "#/components/schemas/microsoft.graph.officeGraphInsights", "#microsoft.graph.onPremisesSyncBehavior": "#/components/schemas/microsoft.graph.onPremisesSyncBehavior", "#microsoft.graph.onenote": "#/components/schemas/microsoft.graph.onenote", "#microsoft.graph.onenoteEntityBaseModel": "#/components/schemas/microsoft.graph.onenoteEntityBaseModel", "#microsoft.graph.onenoteEntityHierarchyModel": "#/components/schemas/microsoft.graph.onenoteEntityHierarchyModel", "#microsoft.graph.onenoteEntitySchemaObjectModel": "#/components/schemas/microsoft.graph.onenoteEntitySchemaObjectModel", "#microsoft.graph.onenoteOperation": "#/components/schemas/microsoft.graph.onenoteOperation", "#microsoft.graph.onenotePage": "#/components/schemas/microsoft.graph.onenotePage", "#microsoft.graph.onenoteResource": "#/components/schemas/microsoft.graph.onenoteResource", "#microsoft.graph.onenoteSection": "#/components/schemas/microsoft.graph.onenoteSection", "#microsoft.graph.onlineMeeting": "#/components/schemas/microsoft.graph.onlineMeeting", "#microsoft.graph.onlineMeetingBase": "#/components/schemas/microsoft.graph.onlineMeetingBase", "#microsoft.graph.openShift": "#/components/schemas/microsoft.graph.openShift", "#microsoft.graph.openShiftChangeRequest": "#/components/schemas/microsoft.graph.openShiftChangeRequest", "#microsoft.graph.operation": "#/components/schemas/microsoft.graph.operation", "#microsoft.graph.outlookCategory": "#/components/schemas/microsoft.graph.outlookCategory", "#microsoft.graph.outlookItem": "#/components/schemas/microsoft.graph.outlookItem", "#microsoft.graph.outlookUser": "#/components/schemas/microsoft.graph.outlookUser", "#microsoft.graph.passwordAuthenticationMethod": "#/components/schemas/microsoft.graph.passwordAuthenticationMethod", "#microsoft.graph.permission": "#/components/schemas/microsoft.graph.permission", "#microsoft.graph.person": "#/components/schemas/microsoft.graph.person", "#microsoft.graph.phoneAuthenticationMethod": "#/components/schemas/microsoft.graph.phoneAuthenticationMethod", "#microsoft.graph.pinnedChatMessageInfo": "#/components/schemas/microsoft.graph.pinnedChatMessageInfo", "#microsoft.graph.plannerAssignedToTaskBoardTaskFormat": "#/components/schemas/microsoft.graph.plannerAssignedToTaskBoardTaskFormat", "#microsoft.graph.plannerBucket": "#/components/schemas/microsoft.graph.plannerBucket", "#microsoft.graph.plannerBucketTaskBoardTaskFormat": "#/components/schemas/microsoft.graph.plannerBucketTaskBoardTaskFormat", "#microsoft.graph.plannerGroup": "#/components/schemas/microsoft.graph.plannerGroup", "#microsoft.graph.plannerPlan": "#/components/schemas/microsoft.graph.plannerPlan", "#microsoft.graph.plannerPlanDetails": "#/components/schemas/microsoft.graph.plannerPlanDetails", "#microsoft.graph.plannerProgressTaskBoardTaskFormat": "#/components/schemas/microsoft.graph.plannerProgressTaskBoardTaskFormat", "#microsoft.graph.plannerTask": "#/components/schemas/microsoft.graph.plannerTask", "#microsoft.graph.plannerTaskDetails": "#/components/schemas/microsoft.graph.plannerTaskDetails", "#microsoft.graph.plannerUser": "#/components/schemas/microsoft.graph.plannerUser", "#microsoft.graph.platformCredentialAuthenticationMethod": "#/components/schemas/microsoft.graph.platformCredentialAuthenticationMethod", "#microsoft.graph.post": "#/components/schemas/microsoft.graph.post", "#microsoft.graph.presence": "#/components/schemas/microsoft.graph.presence", "#microsoft.graph.printConnector": "#/components/schemas/microsoft.graph.printConnector", "#microsoft.graph.printDocument": "#/components/schemas/microsoft.graph.printDocument", "#microsoft.graph.printJob": "#/components/schemas/microsoft.graph.printJob", "#microsoft.graph.printTask": "#/components/schemas/microsoft.graph.printTask", "#microsoft.graph.printTaskDefinition": "#/components/schemas/microsoft.graph.printTaskDefinition", "#microsoft.graph.printTaskTrigger": "#/components/schemas/microsoft.graph.printTaskTrigger", "#microsoft.graph.printer": "#/components/schemas/microsoft.graph.printer", "#microsoft.graph.printerBase": "#/components/schemas/microsoft.graph.printerBase", "#microsoft.graph.printerShare": "#/components/schemas/microsoft.graph.printerShare", "#microsoft.graph.profilePhoto": "#/components/schemas/microsoft.graph.profilePhoto", "#microsoft.graph.resourceAccountKeyAuthenticationMethod": "#/components/schemas/microsoft.graph.resourceAccountKeyAuthenticationMethod", "#microsoft.graph.resourceSpecificPermissionGrant": "#/components/schemas/microsoft.graph.resourceSpecificPermissionGrant", "#microsoft.graph.richLongRunningOperation": "#/components/schemas/microsoft.graph.richLongRunningOperation", "#microsoft.graph.schedule": "#/components/schemas/microsoft.graph.schedule", "#microsoft.graph.scheduleChangeRequest": "#/components/schemas/microsoft.graph.scheduleChangeRequest", "#microsoft.graph.schedulingGroup": "#/components/schemas/microsoft.graph.schedulingGroup", "#microsoft.graph.scopedRoleMembership": "#/components/schemas/microsoft.graph.scopedRoleMembership", "#microsoft.graph.sectionGroup": "#/components/schemas/microsoft.graph.sectionGroup", "#microsoft.graph.sensitivityLabel": "#/components/schemas/microsoft.graph.sensitivityLabel", "#microsoft.graph.serviceStorageQuotaBreakdown": "#/components/schemas/microsoft.graph.serviceStorageQuotaBreakdown", "#microsoft.graph.sharedInsight": "#/components/schemas/microsoft.graph.sharedInsight", "#microsoft.graph.sharedWithChannelTeamInfo": "#/components/schemas/microsoft.graph.sharedWithChannelTeamInfo", "#microsoft.graph.shift": "#/components/schemas/microsoft.graph.shift", "#microsoft.graph.shiftPreferences": "#/components/schemas/microsoft.graph.shiftPreferences", "#microsoft.graph.singleValueLegacyExtendedProperty": "#/components/schemas/microsoft.graph.singleValueLegacyExtendedProperty", "#microsoft.graph.site": "#/components/schemas/microsoft.graph.site", "#microsoft.graph.softwareOathAuthenticationMethod": "#/components/schemas/microsoft.graph.softwareOathAuthenticationMethod", "#microsoft.graph.storageQuotaBreakdown": "#/components/schemas/microsoft.graph.storageQuotaBreakdown", "#microsoft.graph.subscription": "#/components/schemas/microsoft.graph.subscription", "#microsoft.graph.swapShiftsChangeRequest": "#/components/schemas/microsoft.graph.swapShiftsChangeRequest", "#microsoft.graph.targetedChatMessage": "#/components/schemas/microsoft.graph.targetedChatMessage", "#microsoft.graph.team": "#/components/schemas/microsoft.graph.team", "#microsoft.graph.teamInfo": "#/components/schemas/microsoft.graph.teamInfo", "#microsoft.graph.teamsApp": "#/components/schemas/microsoft.graph.teamsApp", "#microsoft.graph.teamsAppDefinition": "#/components/schemas/microsoft.graph.teamsAppDefinition", "#microsoft.graph.teamsAppInstallation": "#/components/schemas/microsoft.graph.teamsAppInstallation", "#microsoft.graph.teamsAsyncOperation": "#/components/schemas/microsoft.graph.teamsAsyncOperation", "#microsoft.graph.teamsTab": "#/components/schemas/microsoft.graph.teamsTab", "#microsoft.graph.teamsTemplate": "#/components/schemas/microsoft.graph.teamsTemplate", "#microsoft.graph.teamworkBot": "#/components/schemas/microsoft.graph.teamworkBot", "#microsoft.graph.teamworkHostedContent": "#/components/schemas/microsoft.graph.teamworkHostedContent", "#microsoft.graph.teamworkTag": "#/components/schemas/microsoft.graph.teamworkTag", "#microsoft.graph.teamworkTagMember": "#/components/schemas/microsoft.graph.teamworkTagMember", "#microsoft.graph.temporaryAccessPassAuthenticationMethod": "#/components/schemas/microsoft.graph.temporaryAccessPassAuthenticationMethod", "#microsoft.graph.termStore.group": "#/components/schemas/microsoft.graph.termStore.group", "#microsoft.graph.termStore.relation": "#/components/schemas/microsoft.graph.termStore.relation", "#microsoft.graph.termStore.set": "#/components/schemas/microsoft.graph.termStore.set", "#microsoft.graph.termStore.store": "#/components/schemas/microsoft.graph.termStore.store", "#microsoft.graph.termStore.term": "#/components/schemas/microsoft.graph.termStore.term", "#microsoft.graph.thumbnailSet": "#/components/schemas/microsoft.graph.thumbnailSet", "#microsoft.graph.timeCard": "#/components/schemas/microsoft.graph.timeCard", "#microsoft.graph.timeOff": "#/components/schemas/microsoft.graph.timeOff", "#microsoft.graph.timeOffReason": "#/components/schemas/microsoft.graph.timeOffReason", "#microsoft.graph.timeOffRequest": "#/components/schemas/microsoft.graph.timeOffRequest", "#microsoft.graph.todo": "#/components/schemas/microsoft.graph.todo", "#microsoft.graph.todoTask": "#/components/schemas/microsoft.graph.todoTask", "#microsoft.graph.todoTaskList": "#/components/schemas/microsoft.graph.todoTaskList", "#microsoft.graph.trending": "#/components/schemas/microsoft.graph.trending", "#microsoft.graph.unifiedStorageQuota": "#/components/schemas/microsoft.graph.unifiedStorageQuota", "#microsoft.graph.usageRightsIncluded": "#/components/schemas/microsoft.graph.usageRightsIncluded", "#microsoft.graph.usedInsight": "#/components/schemas/microsoft.graph.usedInsight", "#microsoft.graph.user": "#/components/schemas/microsoft.graph.user", "#microsoft.graph.userActivity": "#/components/schemas/microsoft.graph.userActivity", "#microsoft.graph.userDataSecurityAndGovernance": "#/components/schemas/microsoft.graph.userDataSecurityAndGovernance", "#microsoft.graph.userInsightsSettings": "#/components/schemas/microsoft.graph.userInsightsSettings", "#microsoft.graph.userProtectionScopeContainer": "#/components/schemas/microsoft.graph.userProtectionScopeContainer", "#microsoft.graph.userScopeTeamsAppInstallation": "#/components/schemas/microsoft.graph.userScopeTeamsAppInstallation", "#microsoft.graph.userSettings": "#/components/schemas/microsoft.graph.userSettings", "#microsoft.graph.userSolutionRoot": "#/components/schemas/microsoft.graph.userSolutionRoot", "#microsoft.graph.userStorage": "#/components/schemas/microsoft.graph.userStorage", "#microsoft.graph.userTeamwork": "#/components/schemas/microsoft.graph.userTeamwork", "#microsoft.graph.windowsDeviceMalwareState": "#/components/schemas/microsoft.graph.windowsDeviceMalwareState", "#microsoft.graph.windowsHelloForBusinessAuthenticationMethod": "#/components/schemas/microsoft.graph.windowsHelloForBusinessAuthenticationMethod", "#microsoft.graph.windowsProtectionState": "#/components/schemas/microsoft.graph.windowsProtectionState", "#microsoft.graph.windowsSetting": "#/components/schemas/microsoft.graph.windowsSetting", "#microsoft.graph.windowsSettingInstance": "#/components/schemas/microsoft.graph.windowsSettingInstance", "#microsoft.graph.workHoursAndLocationsSetting": "#/components/schemas/microsoft.graph.workHoursAndLocationsSetting", "#microsoft.graph.workPlanOccurrence": "#/components/schemas/microsoft.graph.workPlanOccurrence", "#microsoft.graph.workPlanRecurrence": "#/components/schemas/microsoft.graph.workPlanRecurrence", "#microsoft.graph.workbook": "#/components/schemas/microsoft.graph.workbook", "#microsoft.graph.workbookApplication": "#/components/schemas/microsoft.graph.workbookApplication", "#microsoft.graph.workbookChart": "#/components/schemas/microsoft.graph.workbookChart", "#microsoft.graph.workbookChartAreaFormat": "#/components/schemas/microsoft.graph.workbookChartAreaFormat", "#microsoft.graph.workbookChartAxes": "#/components/schemas/microsoft.graph.workbookChartAxes", "#microsoft.graph.workbookChartAxis": "#/components/schemas/microsoft.graph.workbookChartAxis", "#microsoft.graph.workbookChartAxisFormat": "#/components/schemas/microsoft.graph.workbookChartAxisFormat", "#microsoft.graph.workbookChartAxisTitle": "#/components/schemas/microsoft.graph.workbookChartAxisTitle", "#microsoft.graph.workbookChartAxisTitleFormat": "#/components/schemas/microsoft.graph.workbookChartAxisTitleFormat", "#microsoft.graph.workbookChartDataLabelFormat": "#/components/schemas/microsoft.graph.workbookChartDataLabelFormat", "#microsoft.graph.workbookChartDataLabels": "#/components/schemas/microsoft.graph.workbookChartDataLabels", "#microsoft.graph.workbookChartFill": "#/components/schemas/microsoft.graph.workbookChartFill", "#microsoft.graph.workbookChartFont": "#/components/schemas/microsoft.graph.workbookChartFont", "#microsoft.graph.workbookChartGridlines": "#/components/schemas/microsoft.graph.workbookChartGridlines", "#microsoft.graph.workbookChartGridlinesFormat": "#/components/schemas/microsoft.graph.workbookChartGridlinesFormat", "#microsoft.graph.workbookChartLegend": "#/components/schemas/microsoft.graph.workbookChartLegend", "#microsoft.graph.workbookChartLegendFormat": "#/components/schemas/microsoft.graph.workbookChartLegendFormat", "#microsoft.graph.workbookChartLineFormat": "#/components/schemas/microsoft.graph.workbookChartLineFormat", "#microsoft.graph.workbookChartPoint": "#/components/schemas/microsoft.graph.workbookChartPoint", "#microsoft.graph.workbookChartPointFormat": "#/components/schemas/microsoft.graph.workbookChartPointFormat", "#microsoft.graph.workbookChartSeries": "#/components/schemas/microsoft.graph.workbookChartSeries", "#microsoft.graph.workbookChartSeriesFormat": "#/components/schemas/microsoft.graph.workbookChartSeriesFormat", "#microsoft.graph.workbookChartTitle": "#/components/schemas/microsoft.graph.workbookChartTitle", "#microsoft.graph.workbookChartTitleFormat": "#/components/schemas/microsoft.graph.workbookChartTitleFormat", "#microsoft.graph.workbookComment": "#/components/schemas/microsoft.graph.workbookComment", "#microsoft.graph.workbookCommentReply": "#/components/schemas/microsoft.graph.workbookCommentReply", "#microsoft.graph.workbookFilter": "#/components/schemas/microsoft.graph.workbookFilter", "#microsoft.graph.workbookFunctions": "#/components/schemas/microsoft.graph.workbookFunctions", "#microsoft.graph.workbookNamedItem": "#/components/schemas/microsoft.graph.workbookNamedItem", "#microsoft.graph.workbookOperation": "#/components/schemas/microsoft.graph.workbookOperation", "#microsoft.graph.workbookPivotTable": "#/components/schemas/microsoft.graph.workbookPivotTable", "#microsoft.graph.workbookTable": "#/components/schemas/microsoft.graph.workbookTable", "#microsoft.graph.workbookTableColumn": "#/components/schemas/microsoft.graph.workbookTableColumn", "#microsoft.graph.workbookTableRow": "#/components/schemas/microsoft.graph.workbookTableRow", "#microsoft.graph.workbookTableSort": "#/components/schemas/microsoft.graph.workbookTableSort", "#microsoft.graph.workbookWorksheet": "#/components/schemas/microsoft.graph.workbookWorksheet", "#microsoft.graph.workbookWorksheetProtection": "#/components/schemas/microsoft.graph.workbookWorksheetProtection", "#microsoft.graph.workingTimeSchedule": "#/components/schemas/microsoft.graph.workingTimeSchedule"}, "propertyName": "@odata.type"} |
@odata.type | string | Optional | |
id | string | Optional | The unique identifier for an entity. Read-only. |
List mail Folders — request body — query
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Additional keys: not allowed |
includeHiddenFolders | string | Optional | |
$top | integer | Optional | Minimum: 0 |
$skip | integer | Optional | Minimum: 0 |
$search | string | Optional | |
$filter | string | Optional | |
$count | boolean | Optional | |
$orderby | array | Optional | Unique items: true |
$orderby[] | string | Each item | |
$select | array | Optional | Unique items: true |
$select[] | string | Each item | |
$expand | array | Optional | Unique items: true |
$expand[] | string | Each item | |
$skiptoken | string | Optional |
List mail Folders — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
$ (allOf 1) | Model | All variants apply | Expand List rules — response body — @odata count, @odata next Link |
$ (allOf 2) | object | All variants apply | |
$ (allOf 2).value | array | Optional | |
$ (allOf 2).value[] | Model | Each item | Expand Get mail Folder — response body |
Referenced models: List rules — response body — @odata count, @odata next Link, Get mail Folder — response body
List rules — request body — query
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Additional keys: not allowed |
$top | integer | Optional | Minimum: 0 |
$skip | integer | Optional | Minimum: 0 |
$search | string | Optional | |
$filter | string | Optional | |
$count | boolean | Optional | |
$orderby | array | Optional | Unique items: true |
$orderby[] | string | Each item | |
$select | array | Optional | Unique items: true |
$select[] | string | Each item | |
$expand | array | Optional | Unique items: true |
$expand[] | string | Each item | |
$skiptoken | string | Optional |
List rules — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
$ (allOf 1) | Model | All variants apply | Expand List rules — response body — @odata count, @odata next Link |
$ (allOf 2) | object | All variants apply | |
$ (allOf 2).value | array | Optional | |
$ (allOf 2).value[] | Model | Each item | Expand Get rule — response body |
Referenced models: List rules — response body — @odata count, @odata next Link, Get rule — response body
List rules — response body — @odata count, @odata next Link
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
@odata.count | JSON | Optional | |
@odata.count (anyOf 1) | JSON | Alternative | |
@odata.count (anyOf 1) (anyOf 1) | integer | Alternative | Format: int64 |
@odata.count (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
@odata.count (anyOf 2) | null | Alternative | |
@odata.nextLink | JSON | Optional | |
@odata.nextLink (anyOf 1) | string | Alternative | |
@odata.nextLink (anyOf 2) | null | Alternative |