eventMessage resource type
Namespace: microsoft.graph
Important
APIs under the /beta version in Microsoft Graph are subject to change. Use of these APIs in production applications is not supported. To determine whether an API is available in v1.0, use the Version selector.
A message that represents a meeting request, cancellation, or response. Can be one of the following values: acceptance, tentative acceptance, or decline.
The eventMessage entity is derived from message. eventMessage is the base type for eventMessageRequest and eventMessageResponse. The meetingMessageType property identifies the type of the event message.
When an organizer or app sends a meeting request, the meeting request arrives in an invitee's mailbox as an eventMessage instance with the meetingMessageType of meetingRequest. In addition, Outlook automatically creates an event instance in the invitee's calendar, with the showAs property as tentative.
To get the properties of the associated event in the invitee's mailbox, the app can use the event navigation property of the eventMessage, as shown in this get event message example. The app can also respond to the event on behalf of the invitee programmatically, by accepting, tentatively accepting, or declining the event.
Aside from a meeting request, an eventMessage instance can be found in an invitee's mailbox as the result of an event organizer cancelling a meeting, or in the organizer's mailbox as a result of an invitee responding to the meeting request. An app can act on event messages in the same way as on messages with minor differences.
JSON representation
The following JSON representation shows the resource type.
{
"bccRecipients": [{"@odata.type": "microsoft.graph.recipient"}],
"body": {"@odata.type": "microsoft.graph.itemBody"},
"bodyPreview": "string",
"categories": ["string"],
"ccRecipients": [{"@odata.type": "microsoft.graph.recipient"}],
"changeKey": "string",
"conversationId": "string",
"conversationIndex": "String (binary)",
"createdDateTime": "DateTimeOffset",
"endDateTime": {"@odata.type": "microsoft.graph.dateTimeTimeZone"},
"flag": {"@odata.type": "microsoft.graph.followupFlag"},
"from": {"@odata.type": "microsoft.graph.recipient"},
"hasAttachments": true,
"id": "string (identifier)",
"importance": "String",
"inferenceClassification": "String",
"internetMessageHeaders": [{"@odata.type": "microsoft.graph.internetMessageHeader"}],
"internetMessageId": "String",
"isAllDay": "Boolean",
"isDelegated": true,
"isDeliveryReceiptRequested": true,
"isDraft": true,
"isOutOfDate": "Boolean",
"isRead": true,
"isReadReceiptRequested": true,
"lastModifiedDateTime": "DateTimeOffset",
"location": {"@odata.type": "microsoft.graph.location"},
"meetingMessageType": {"@odata.type": "microsoft.graph.meetingMessageType"},
"mentionsPreview": {"@odata.type": "microsoft.graph.mentionsPreview"},
"parentFolderId": "string",
"receivedDateTime": "DateTimeOffset",
"recurrence": {"@odata.type": "microsoft.graph.patternedRecurrence"},
"replyTo": [{"@odata.type": "microsoft.graph.recipient"}],
"sender": {"@odata.type": "microsoft.graph.recipient"},
"sentDateTime": "DateTimeOffset",
"startDateTime": {"@odata.type": "microsoft.graph.dateTimeTimeZone"},
"subject": "string",
"toRecipients": [{"@odata.type": "microsoft.graph.recipient"}],
"type": "string",
"uniqueBody": {"@odata.type": "microsoft.graph.itemBody"},
"UnsubscribeData": "string",
"UnsubscribeEnabled": true,
"webLink": "string"
}
Properties
| Property | Type | Description |
|---|---|---|
| bccRecipients | recipient collection | The Bcc: recipients for the message. |
| body | itemBody | The body of the message. It can be in HTML or text format. |
| bodyPreview | String | The first 255 characters of the message body. It is in text format. |
| categories | String collection | The categories associated with the message. |
| ccRecipients | recipient collection | The Cc: recipients for the message. |
| changeKey | String | The version of the message. |
| conversationId | String | The ID of the conversation the email belongs to. |
| conversationIndex | Edm.Binary | Indicates the position of the message within the conversation. |
| createdDateTime | DateTimeOffset | The date and time the message was created. |
| endDateTime | dateTimeTimeZone | The end time of the requested meeting. |
| flag | followupFlag | The flag value that indicates the status, start date, due date, or completion date for the message. |
| from | recipient | 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. |
| hasAttachments | Boolean | Indicates whether the message has attachments. |
| id | String | Unique identifier for the message. By default, this value changes when the item is moved from one container (such as a folder or calendar) to another. To change this behavior, use the Prefer: IdType="ImmutableId" header. See Get immutable identifiers for Outlook resources for more information. Read-only. |
| importance | String | The importance of the message: low, normal, high. |
| inferenceClassification | String | Possible values are: focused, other. |
| internetMessageHeaders | internetMessageHeader collection | The collection of message headers, defined by RFC5322, that provide details of the network path taken by a message from the sender to the recipient. Read-only. |
| internetMessageId | String | The message ID in the format specified by RFC5322. |
| isAllDay | Boolean | Indicates whether the event lasts the entire day. Adjusting this property requires adjusting the startDateTime and endDateTime properties of the event as well. |
| isDelegated | Boolean | True if this meeting request is accessible to a delegate, false otherwise. Default is false. |
| isDeliveryReceiptRequested | Boolean | Indicates whether a read receipt is requested for the message. |
| isDraft | Boolean | Indicates whether the message is a draft. A message is a draft if it hasn't been sent yet. |
| isOutOfDate | Boolean | Indicates whether this meeting request has been made out-of-date by a more recent request. |
| isRead | Boolean | Indicates whether the message has been read. |
| isReadReceiptRequested | Boolean | Indicates whether a read receipt is requested for the message. |
| lastModifiedDateTime | DateTimeOffset | The date and time the message was last changed. |
| location | location | The location of the requested meeting. |
| meetingMessageType | String | The type of event message: none, meetingRequest, meetingCancelled, meetingAccepted, meetingTentativelyAccepted, meetingDeclined. |
| mentionsPreview | mentionsPreview | Information about mentions in the message. When processing a GET /messages request, the server sets this property and includes it in the response by default. The server returns null if there are no mentions in the message. Optional. |
| parentFolderId | String | The unique identifier for the message's parent mailFolder. |
| receivedDateTime | DateTimeOffset | The date and time the message was received. |
| recurrence | patternedRecurrence | The recurrence pattern of the requested meeting. |
| replyTo | recipient collection | The email addresses to use when replying. |
| sender | recipient | 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. For more information, see setting the from and sender properties. |
| sentDateTime | DateTimeOffset | The date and time the message was sent. |
| startDateTime | dateTimeTimeZone | The start time of the requested meeting. |
| subject | String | The subject of the message. |
| toRecipients | recipient collection | The To: recipients for the message. |
| type | String | The type of requested meeting: singleInstance, occurence, exception, seriesMaster. |
| uniqueBody | itemBody | The part of the body of the message that is unique to the current message. |
| UnsubscribeData | String | The valid entries parsed from the List-Unsubscribe header. This is the data for the mail command in the List-Unsubscribe header if UnsubscribeEnabled property is true. |
| UnsubscribeEnabled | Boolean | Indicates whether the message is enabled for unsubscribe. Its valueTrue if the list-Unsubscribe header conforms to rfc-2369. |
| webLink | String | 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 isn't present or if it's set to 1, then the message is shown in a popout window. If ispopout is set to 0, then the browser shows the message in the Outlook on the web review pane. The message opens in the browser if you're logged in to your mailbox via Outlook on the web. You are prompted to login if you aren't already logged in with the browser. This URL can't be accessed from within an iFrame. |
Relationships
| Relationship | Type | Description |
|---|---|---|
| attachments | attachment collection | The collection of fileAttachment, itemAttachment, and referenceAttachment attachments for the message. Read-only. Nullable. |
| event | event | The event associated with the event message. The assumption for attendees or room resources is that the Calendar Attendant is set to automatically update the calendar with an event when meeting request event messages arrive. Navigation property. Read-only. |
| extensions | extension collection | The collection of open extensions defined for the eventMessage. Read-only. Nullable. |
| mentions | mention collection | A collection of mentions in the message, ordered by the createdDateTime from the newest to the oldest. By default, a GET /messages doesn't return this property unless you apply $expand on the property. |
| multiValueExtendedProperties | multiValueLegacyExtendedProperty collection | The collection of multi-value extended properties defined for the eventMessage. Read-only. Nullable. |
| singleValueExtendedProperties | singleValueLegacyExtendedProperty collection | The collection of single-value extended properties defined for the eventMessage. Read-only. Nullable. |
Methods
| Method | Return Type | Description |
|---|---|---|
| Get | eventMessage | Read properties and relationships of eventMessage object. |
| Update | eventMessage | Update eventMessage object. |
| Delete | None | Delete eventMessage object. |
| Copy message | message | Copy a message to a folder. |
| Create draft to forward message | message | Create a draft of the Forward message. You can then update or send the draft. |
| Create draft to reply | message | Create a draft of the Reply message. You can then update or send the draft. |
| Create draft to reply-all | message | Create a draft of the Reply All message. You can then update or send the draft. |
| Forward message | None | Forward a message. The message is then saved in the Sent Items folder. |
| Move message | message | Move a message to a folder. This creates a new copy of the message in the destination folder. |
| Reply to message | None | Reply to the sender of a message. The message is then saved in the Sent Items folder. |
| Reply-all to message | None | Reply to all recipients of a message. The message is then saved in the Sent Items folder. |
| Send draft message | None | Sends a previously created message draft. The message is then saved in the Sent Items folder. |
| Recall message | message | Recall a message in the specified user's mailbox Sent Items folder. |
| Unsubscribe | None | Send a message using the data and address specified in the first mailto command in the List-Unsubscribe header. |
| Permanently delete | None | Permanently delete an event message and place it in the Purges folder in the Recoverable Items folder in the user's mailbox. |
| Attachments | ||
| List attachments | attachment collection | Get all attachments on an eventMessage. |
| Add attachment | attachment | Add a new attachment to an eventMessage by posting to the attachments collection. |
| Open extensions | ||
| Create open extension | openTypeExtension | Create an open extension and add custom properties in a new or existing instance of a resource. |
| Get open extension | openTypeExtension collection | Get an open extension identified by name. |
| Extended properties | ||
| Create single-value property | eventMessage | Create one or more single-value extended properties in a new or existing eventMessage. |
| Get single-value property | eventMessage | Get eventMessages that contain a single-value extended property by using $expand or $filter. |
| Create multi-value property | eventMessage | Create one or more multi-value extended properties in a new or existing eventMessage. |
| Get multi-value property | eventMessage | Get an eventMessage that contains a multi-value extended property by using $expand. |