Microsoft: Me message schemas
12 Microsoft schemas with complete fields and constraints.
← Me message operations · All schemas
Create message — request body — body
| 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).attachments | array | Optional | The fileAttachment and itemAttachment attachments for the message. |
$ (allOf 2).attachments[] | Model | Each item | Expand Add attachment — me Event events Create Attachments — request body — body |
$ (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).extensions | array | Optional | The collection of open extensions defined for the message. Nullable. |
$ (allOf 2).extensions[] | Model | Each item | Expand Create open extension — response body |
$ (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).multiValueExtendedProperties | array | Optional | The collection of multi-value extended properties defined for the message. 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 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).singleValueExtendedProperties | array | Optional | The collection of single-value extended properties defined for the message. 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).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: Create open extension — response body, 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 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 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, 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, Add attachment — me Event events Create Attachments — request body — body, 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 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
@odata.type | string | Optional | |
content | JSON | Optional | |
content (anyOf 1) | string | Alternative | The content of the item. |
content (anyOf 2) | null | Alternative | |
contentType | JSON | Optional | The type of the content. Possible values are text and html. |
contentType (anyOf 1) | string | Alternative | One of: text, html |
contentType (anyOf 2) | JSON | Alternative | |
contentType (anyOf 2) (anyOf 1) | object | Alternative | |
contentType (anyOf 2) (anyOf 2) | null | Alternative |
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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
@odata.type | string | Optional | |
completedDateTime | JSON | Optional | The date and time that the follow-up was finished. |
completedDateTime (anyOf 1) | Model | Alternative | Expand Invoke action snooze Reminder — me Event events Snooze Reminder — request body — body New Reminder Time |
completedDateTime (anyOf 2) | JSON | Alternative | |
completedDateTime (anyOf 2) (anyOf 1) | object | Alternative | |
completedDateTime (anyOf 2) (anyOf 2) | null | Alternative | |
dueDateTime | JSON | Optional | The date and time that the follow-up is to be finished. Note: To set the due date, you must also specify the startDateTime; otherwise, you get a 400 Bad Request response. |
dueDateTime (anyOf 1) | Model | Alternative | Expand Invoke action snooze Reminder — me Event events Snooze Reminder — request body — body New Reminder Time |
dueDateTime (anyOf 2) | JSON | Alternative | |
dueDateTime (anyOf 2) (anyOf 1) | object | Alternative | |
dueDateTime (anyOf 2) (anyOf 2) | null | Alternative | |
flagStatus | JSON | Optional | The status for follow-up for an item. Possible values are notFlagged, complete, and flagged. |
flagStatus (anyOf 1) | string | Alternative | One of: notFlagged, complete, flagged |
flagStatus (anyOf 2) | JSON | Alternative | |
flagStatus (anyOf 2) (anyOf 1) | object | Alternative | |
flagStatus (anyOf 2) (anyOf 2) | null | Alternative | |
startDateTime | JSON | Optional | The date and time that the follow-up is to begin. |
startDateTime (anyOf 1) | Model | Alternative | Expand Invoke action snooze Reminder — me Event events Snooze Reminder — request body — body New Reminder Time |
startDateTime (anyOf 2) | JSON | Alternative | |
startDateTime (anyOf 2) (anyOf 1) | object | Alternative | |
startDateTime (anyOf 2) (anyOf 2) | null | Alternative |
Referenced models: Invoke action snooze Reminder — me Event events Snooze Reminder — request body — body New Reminder Time
Create open extension — 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 |
Referenced models: Get rule — response body — @odata type, id
Get attachment — 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).contentType | JSON | Optional | |
$ (allOf 2).contentType (anyOf 1) | string | Alternative | The MIME type. |
$ (allOf 2).contentType (anyOf 2) | null | Alternative | |
$ (allOf 2).isInline | boolean | Optional | true if the attachment is an inline attachment; otherwise, false. |
$ (allOf 2).lastModifiedDateTime | JSON | Optional | |
$ (allOf 2).lastModifiedDateTime (anyOf 1) | string | Alternative | The Timestamp type represents date and time information using 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).lastModifiedDateTime (anyOf 2) | null | Alternative | |
$ (allOf 2).name | JSON | Optional | |
$ (allOf 2).name (anyOf 1) | string | Alternative | The attachment's file name. |
$ (allOf 2).name (anyOf 2) | null | Alternative | |
$ (allOf 2).size | JSON | Optional | |
$ (allOf 2).size (anyOf 1) | number | Alternative | The length of the attachment in bytes. Format: int32 Maximum: 2147483647 Minimum: -2147483648 |
$ (allOf 2).size (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
Referenced models: Get rule — response body — @odata type, id
Get message — response body
| 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).attachments | array | Optional | The fileAttachment and itemAttachment attachments for the message. |
$ (allOf 2).attachments[] | Model | Each item | Expand Get attachment — response body |
$ (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 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 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).extensions | array | Optional | The collection of open extensions defined for the message. Nullable. |
$ (allOf 2).extensions[] | Model | Each item | Expand Create open extension — response body |
$ (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 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 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 | Known values: 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 | Known values: 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).multiValueExtendedProperties | array | Optional | The collection of multi-value extended properties defined for the message. 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 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).singleValueExtendedProperties | array | Optional | The collection of single-value extended properties defined for the message. 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).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 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 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 attachment — response body, Create open extension — response body, 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 flag @odata type, completed Date Time, due Date Time, flag Status, start Date Time, 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 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 body @odata type, content, content Type, 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 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, 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 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 body @odata type, content, content Type
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
@odata.type | string | Optional | |
content | JSON | Optional | |
content (anyOf 1) | string | Alternative | The content of the item. |
content (anyOf 2) | null | Alternative | |
contentType | JSON | Optional | The type of the content. Possible values are text and html. |
contentType (anyOf 1) | string | Alternative | Known values: text, html |
contentType (anyOf 2) | JSON | Alternative | |
contentType (anyOf 2) (anyOf 1) | object | Alternative | |
contentType (anyOf 2) (anyOf 2) | null | Alternative |
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 flag @odata type, completed Date Time, due Date Time, flag Status, start Date Time
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
@odata.type | string | Optional | |
completedDateTime | JSON | Optional | The date and time that the follow-up was finished. |
completedDateTime (anyOf 1) | Model | Alternative | Expand Invoke action snooze Reminder — me Event events Snooze Reminder — request body — body New Reminder Time |
completedDateTime (anyOf 2) | JSON | Alternative | |
completedDateTime (anyOf 2) (anyOf 1) | object | Alternative | |
completedDateTime (anyOf 2) (anyOf 2) | null | Alternative | |
dueDateTime | JSON | Optional | The date and time that the follow-up is to be finished. Note: To set the due date, you must also specify the startDateTime; otherwise, you get a 400 Bad Request response. |
dueDateTime (anyOf 1) | Model | Alternative | Expand Invoke action snooze Reminder — me Event events Snooze Reminder — request body — body New Reminder Time |
dueDateTime (anyOf 2) | JSON | Alternative | |
dueDateTime (anyOf 2) (anyOf 1) | object | Alternative | |
dueDateTime (anyOf 2) (anyOf 2) | null | Alternative | |
flagStatus | JSON | Optional | The status for follow-up for an item. Possible values are notFlagged, complete, and flagged. |
flagStatus (anyOf 1) | string | Alternative | Known values: notFlagged, complete, flagged |
flagStatus (anyOf 2) | JSON | Alternative | |
flagStatus (anyOf 2) (anyOf 1) | object | Alternative | |
flagStatus (anyOf 2) (anyOf 2) | null | Alternative | |
startDateTime | JSON | Optional | The date and time that the follow-up is to begin. |
startDateTime (anyOf 1) | Model | Alternative | Expand Invoke action snooze Reminder — me Event events Snooze Reminder — request body — body New Reminder Time |
startDateTime (anyOf 2) | JSON | Alternative | |
startDateTime (anyOf 2) (anyOf 1) | object | Alternative | |
startDateTime (anyOf 2) (anyOf 2) | null | Alternative |
Referenced models: Invoke action snooze Reminder — me Event events Snooze Reminder — request body — body New Reminder Time
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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
@odata.type | string | Optional | |
name | JSON | Optional | |
name (anyOf 1) | string | Alternative | Represents the key in a key-value pair. |
name (anyOf 2) | null | Alternative | |
value | JSON | Optional | |
value (anyOf 1) | string | Alternative | The value in a key-value pair. |
value (anyOf 2) | null | Alternative |
Invoke function delta — me Message messages Delta — request body — query
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Additional keys: not allowed |
changeType | string | Optional | |
$top | integer | Optional | Minimum: 0 |
$skip | integer | Optional | Minimum: 0 |
$search | string | Optional | |
$filter | string | Optional | |
$count | boolean | Optional | |
$select | array | Optional | Unique items: true |
$select[] | string | Each item | |
$orderby | array | Optional | Unique items: true |
$orderby[] | string | Each item | |
$expand | array | Optional | Unique items: true |
$expand[] | string | Each item | |
$skiptoken | string | Optional | |
$deltatoken | string | Optional |
List messages — me Message list Messages — request body — query
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Additional keys: not allowed |
includeHiddenMessages | 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 messages — me Message list Messages — 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 message — response body |
Referenced models: List rules — response body — @odata count, @odata next Link, Get message — response body