eventMessageRequest 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 in an invitee's mailbox.
The eventMessageRequest entity is derived from eventMessage.
To respond to the meeting request, first, use the event navigation property to access the corresponding event, as shown in this example. Then accept, tentativelyAccept, or decline that event associated with the eventMessageRequest.
JSON representation
The following JSON representation shows the resource type.
{
"allowNewTimeProposals": "Boolean",
"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": "String (timestamp)",
"endDateTime": {"@odata.type": "microsoft.graph.dateTimeTimeZone"},
"from": {"@odata.type": "microsoft.graph.recipient"},
"hasAttachments": true,
"id": "string (identifier)",
"importance": "String",
"inferenceClassification": "String",
"isDelegated": true,
"isDeliveryReceiptRequested": true,
"isDraft": true,
"isOutOfDate": "Boolean",
"isRead": true,
"isReadReceiptRequested": true,
"lastModifiedDateTime": "String (timestamp)",
"location": {"@odata.type": "microsoft.graph.location"},
"meetingMessageType": "microsoft.graph.meetingMessageType",
"meetingRequestType": "microsoft.graph.meetingRequestType ",
"mentionsPreview": {"@odata.type": "microsoft.graph.mentionsPreview"},
"parentFolderId": "string",
"previousEndDateTime": {"@odata.type": "microsoft.graph.dateTimeTimeZone"},
"previousLocation": {"@odata.type": "microsoft.graph.location"},
"previousStartDateTime": {"@odata.type": "microsoft.graph.dateTimeTimeZone"},
"receivedDateTime": "String (timestamp)",
"recurrence": {"@odata.type": "microsoft.graph.patternedRecurrence"},
"replyTo": [{"@odata.type": "microsoft.graph.recipient"}],
"responseRequested": "Boolean",
"sender": {"@odata.type": "microsoft.graph.recipient"},
"sentDateTime": "String (timestamp)",
"startDateTime": {"@odata.type": "microsoft.graph.dateTimeTimeZone"},
"subject": "string",
"toRecipients": [{"@odata.type": "microsoft.graph.recipient"}],
"type": "string",
"uniqueBody": {"@odata.type": "microsoft.graph.itemBody"},
"webLink": "string"
}
Properties
| Property | Type | Description |
|---|---|---|
| allowNewTimeProposals | Boolean | True if the meeting organizer allows invitees to propose a new time when responding, false otherwise. Optional. Default is true. |
| bccRecipients | recipient collection | The Bcc: recipients for the message. |
| body | itemBody | The body of the message. |
| bodyPreview | String | The first 255 characters of the message body. |
| 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 | The index of the conversation the email belongs to. |
| createdDateTime | DateTimeOffset | The date and time the message was created. |
| endDateTime | DateTimeTimeZone | The end time of the requested meeting. |
| 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 | Read-only. |
| importance | String | The importance of the message: Low, Normal, High. |
| inferenceClassification | String | Possible values are: Focused, Other. |
| isDelegated | Boolean | True if this meeting request response 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. |
| meetingRequestType | String | The type of meeting request. Possible values are: none, newMeetingRequest, fullUpdate, informationalUpdate, silentUpdate, outdated, and principalWantsCopy. |
| 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. |
| previousEndDateTime | DateTimeTimeZone | If the meeting update changes the meeting end time, this property specifies the previous meeting end time. |
| previousLocation | Location | If the meeting update changes the meeting location, this property specifies the previous meeting location. |
| previousStartDateTime | DateTimeTimeZone | If the meeting update changes the meeting start time, this property specifies the previous meeting start time. |
| 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. |
| responseRequested | Boolean | Set to true if the sender would like the invitee to send a response to the requested meeting. |
| 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. Find out more about setting the from and sender properties of a message. |
| 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. |
| 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 signed in to your mailbox via Outlook on the web. You are prompted to sign in 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 event message | eventMessage | Read properties and relationships of eventMessage object. |
| Update event message | eventMessage | Update eventMessage object. |
| Delete event message | 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. |
| 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. |