eventMessage 资源类型eventMessage resource type


Microsoft Graph 中/beta的版本下的 api 可能会发生更改。APIs under the /beta version in Microsoft Graph are subject to change. 不支持在生产应用程序中使用这些 API。Use of these APIs in production applications is not supported.

表示会议请求、取消或响应(可以是下列任一行为:接受、暂定接受或拒绝)的邮件。A message that represents a meeting request, cancellation, or response (which can be one of the following: acceptance, tentative acceptance, or decline).

eventMessage 实体派生自 messageThe eventMessage entity is derived from message. eventMessageeventMessageRequesteventMessageResponse的基本类型。eventMessage is the base type for eventMessageRequest and eventMessageResponse. meetingMessageType 属性确定事件邮件类型。The meetingMessageType property identifies the type of the event message.

当组织者或应用发送会议请求时,会议请求以eventMessage实例的形式到达被邀请者的邮箱中, meetingMessageTypemeetingRequestWhen 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. 此外,Outlook 会自动在被邀请者的日历中创建一个事件实例,并将showAs属性为 "暂定"。In addition, Outlook automatically creates an event instance in the invitee's calendar, with the showAs property as tentative.

若要获取被邀请者邮箱中关联事件的属性,应用可以使用eventMessage事件导航属性,如此get 事件消息示例中所示。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.

除了会议请求之外,在被邀请者的邮箱中可以找到eventMessage实例,因为事件组织者取消了会议,或者由于与会者响应会议请求而在组织者邮箱中。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 表示形式JSON representation

下面是资源的 JSON 表示形式。Here is a JSON representation of the resource

  "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"


属性Property 类型Type 说明Description
bccRecipientsbccRecipients recipient collectionrecipient collection 邮件的密件抄送收件人。The Bcc: recipients for the message.
bodybody itemBodyitemBody 邮件的正文。可以是 HTML 格式或文本格式。The body of the message. It can be in HTML or text format.
bodyPreviewbodyPreview 字符串String 邮件正文中的前 255 个字符。文本格式。The first 255 characters of the message body. It is in text format.
categoriescategories String collectionString collection 与邮件关联的类别。The categories associated with the message.
ccRecipientsccRecipients recipient collectionrecipient collection 邮件的抄送收件人。The Cc: recipients for the message.
changeKeychangeKey 字符串String 邮件的版本。The version of the message.
conversationIdconversationId StringString 电子邮件所属对话的 ID。The ID of the conversation the email belongs to.
conversationIndexconversationIndex Edm.BinaryEdm.Binary 电子邮件所属对话的索引。The index of the conversation the email belongs to.
createdDateTimecreatedDateTime DateTimeOffsetDateTimeOffset 创建邮件的日期和时间。The date and time the message was created.
endDateTimeendDateTime dateTimeTimeZonedateTimeTimeZone 请求的会议的结束时间。The end time of the requested meeting.
flagflag followUpFlagfollowUpFlag 指示邮件的状态、开始日期、截止日期或完成日期的标志值。The flag value that indicates the status, start date, due date, or completion date for the message.
发件人from recipientrecipient 邮箱所有者和邮件发件人。The mailbox owner and sender of the message.
hasAttachmentshasAttachments BooleanBoolean 指示邮件是否包含附件。Indicates whether the message has attachments.
idid StringString 邮件的唯一标识符。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. 若要更改此行为,请Prefer: IdType="ImmutableId"使用标头。To change this behavior, use the Prefer: IdType="ImmutableId" header. 有关详细信息,请参阅获取 Outlook 资源的不可变标识符See Get immutable identifiers for Outlook resources for more information. 只读。默认情况下,在将项目从一个容器(如文件夹或日历)移动到另一个容器时,此值会发生更改。By default, this value changes when the item is moved from one container (such as a folder or calendar) to another. 若要更改此行为,请Prefer: IdType="ImmutableId"使用标头。To change this behavior, use the Prefer: IdType="ImmutableId" header. 有关详细信息,请参阅获取 Outlook 资源的不可变标识符See Get immutable identifiers for Outlook resources for more information. Read-only.
importanceimportance StringString 邮件的重要性:lownormalhighThe importance of the message: low, normal, high.
inferenceClassificationinferenceClassification StringString 可取值为:focusedotherPossible values are: focused, other.
internetMessageHeadersinternetMessageHeaders internetMessageHeader 集合internetMessageHeader collection RFC5322 定义的邮件头集合,它提供邮件获取的从发件人到收件人的网络路径的详细信息。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.
internetMessageIdinternetMessageId StringString 邮件 ID 采用 RFC5322 指定的格式。The message ID in the format specified by RFC5322.
isAllDayisAllDay BooleanBoolean 指示事件是否持续一整天。Indicates whether the event lasts the entire day. 调整此属性还需要调整事件的startDateTimeendDateTime属性。Adjusting this property requires adjusting the startDateTime and endDateTime properties of the event as well.
isDelegatedisDelegated BooleanBoolean 如果代理可访问此会议请求,则为 True,否则为 false。True if this meeting request is accessible to a delegate, false otherwise. 默认为 false。Default is false.
isDeliveryReceiptRequestedisDeliveryReceiptRequested BooleanBoolean 指示是否需要发送邮件已读回执。Indicates whether a read receipt is requested for the message.
isDraftisDraft BooleanBoolean 指示邮件是否为草稿。如果尚未发送,则此邮件是一封草稿。Indicates whether the message is a draft. A message is a draft if it hasn't been sent yet.
isOutOfDateisOutOfDate BooleanBoolean 指示此会议请求是否已由较新的请求发出。Indicates whether this meeting request has been made out-of-date by a more recent request.
isReadisRead BooleanBoolean 指示是否已阅读该邮件。Indicates whether the message has been read.
isReadReceiptRequestedisReadReceiptRequested BooleanBoolean 指示是否需要发送邮件已读回执。Indicates whether a read receipt is requested for the message.
lastModifiedDateTimelastModifiedDateTime DateTimeOffsetDateTimeOffset 上次更改邮件的日期和时间。The date and time the message was last changed.
locationlocation 位置location 请求的会议的位置。The location of the requested meeting.
meetingMessageTypemeetingMessageType StringString 事件消息的类型:nonemeetingRequestmeetingCancelledmeetingAcceptedmeetingTentativelyAcceptedmeetingDeclinedThe type of event message: none, meetingRequest, meetingCancelled, meetingAccepted, meetingTentativelyAccepted, meetingDeclined.
mentionsPreviewmentionsPreview mentionsPreviewmentionsPreview 邮件中的提及的相关信息。处理 GET /messages 请求时,服务器会设置此属性并默认将其包含在响应中。若邮件中无提及,则服务器返回 NULL。可选。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.
parentFolderIdparentFolderId StringString 邮件的父 MailFolder 的唯一标识符。The unique identifier for the message's parent mailFolder.
receivedDateTimereceivedDateTime DateTimeOffsetDateTimeOffset 收到邮件的日期和时间。The date and time the message was received.
recurrencerecurrence patternedRecurrencepatternedRecurrence 请求的会议的定期模式。The recurrence pattern of the requested meeting.
replyToreplyTo recipient collectionrecipient collection 在答复时使用的电子邮件地址。The email addresses to use when replying.
sendersender recipientrecipient 实际用于生成邮件的帐户。The account that is actually used to generate the message.
sentDateTimesentDateTime DateTimeOffsetDateTimeOffset 发送邮件的日期和时间。The date and time the message was sent.
startDateTimestartDateTime dateTimeTimeZonedateTimeTimeZone 请求的会议的开始时间。The start time of the requested meeting.
subjectsubject StringString 邮件的主题。The subject of the message.
toRecipientstoRecipients recipient collectionrecipient collection 邮件的收件人。The To: recipients for the message.
typetype StringString 所需会议的类型: singleInstanceoccurenceexceptionseriesMasterThe type of requested meeting: singleInstance, occurence, exception, seriesMaster.
uniqueBodyuniqueBody itemBodyitemBody 当前邮件专用的邮件正文部分。The part of the body of the message that is unique to the current message.
UnsubscribeDataUnsubscribeData StringString 从 List-Unsubscribe 标头中解析的有效条目。若 UnsubscribeEnabled 属性为 true,则这是 List-Unsubscribe 标头中的邮件命令的数据。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.
UnsubscribeEnabledUnsubscribeEnabled BooleanBoolean 指示邮件是否已启用取消订阅。若 list-Unsubscribe 标头符合 rfc-2369,则其值为 True。Indicates whether the message is enabled for unsubscribe. Its valueTrue if the list-Unsubscribe header conforms to rfc-2369.
webLinkwebLink StringString 要在 Outlook Web App 中打开邮件的 URL。The URL to open the message in Outlook Web App.

可以将 ispopout 参数附加到此 URL 的末尾以更改邮件的显示方式。如果 ispopout 不存在或设置为 1,则邮件显示在弹出窗口中。如果 ispopout 设置为 0,则浏览器将在 Outlook Web App 审阅窗格中显示邮件。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, then the browser will show the message in the Outlook Web App review pane.

如果通过 Outlook Web App 登录邮箱,该邮件将在浏览器中打开。如果尚未使用浏览器登录,系统将提示你登录。The message will open in the browser if you are logged in to your mailbox via Outlook Web App. You will be prompted to login if you are not already logged in with the browser.

可以从 iFrame 中访问此 URL。This URL can be accessed from within an iFrame.


关系Relationship 类型Type 说明Description
attachmentsattachments 附件 集合attachment collection 邮件的fileAttachmentitemAttachmentreferenceAttachment附件的集合。The collection of fileAttachment, itemAttachment, and referenceAttachment attachments for the message. 只读。Read-only. 可为 Null。Nullable.
eventevent eventevent 与事件消息相关联的事件。对于与会者或会议室资源,假定已将日历助理设为在会议请求事件消息到达时自动更新包含事件的日历。导航属性。只读。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.
extensionsextensions 扩展集合extension collection 为 eventMessage 定义的开放扩展集合。只读。可为 NULL。The collection of open extensions defined for the eventMessage. Read-only. Nullable.
提及mentions mention 集合mention collection 邮件中的提及集合,按 createdDateTime 由最新到最旧排序。默认情况下,GET /messages 不会返回此属性,在该属性上应用 $expand 时除外。A collection of mentions in the message, ordered by the createdDateTime from the newest to the oldest. By default, a GET /messages does not return this property unless you apply $expand on the property.
multiValueExtendedPropertiesmultiValueExtendedProperties multiValueLegacyExtendedProperty 集合multiValueLegacyExtendedProperty collection 为 eventMessage 定义的多值扩展属性的集合。只读。可为 Null。The collection of multi-value extended properties defined for the eventMessage. Read-only. Nullable.
singleValueExtendedPropertiessingleValueExtendedProperties singleValueLegacyExtendedProperty collectionsingleValueLegacyExtendedProperty collection 为 eventMessage 定义的单值扩展属性的集合。只读。可为 Null。The collection of single-value extended properties defined for the eventMessage. Read-only. Nullable.


方法Method 返回类型Return Type 说明Description
获取 eventMessageGet eventMessage eventMessageeventMessage 读取 eventmessage 对象的属性和关系。Read properties and relationships of eventMessage object.
更新Update eventMessageeventMessage 更新 eventMessage 对象。Update eventMessage object.
删除Delete NoneNone 更新 eventMessage 对象。Delete eventMessage object.
copycopy 邮件message 将邮件复制到文件夹。Copy a message to a folder.
createForwardcreateForward 邮件message 创建转发邮件的草稿。然后,你可以 更新发送 草稿。Create a draft of the Forward message. You can then update or send the draft.
createReplycreateReply 邮件message 创建回复邮件的草稿。然后,你可以 更新发送 草稿。Create a draft of the Reply message. You can then update or send the draft.
createReplyAllcreateReplyAll 邮件message 创建全部答复邮件的草稿。然后,可以更新发送草稿。Create a draft of the Reply All message. You can then update or send the draft.
转发forward None 转发邮件。然后邮件保存在已发送邮件文件夹中。Forward a message. The message is then saved in the Sent Items folder.
移动move messagemessage 将邮件移到文件夹。此操作会在目标文件夹中新建邮件副本。Move a message to a folder. This creates a new copy of the message in the destination folder.
回复reply None 答复邮件发件人然后邮件保存在已发送邮件文件夹中。Reply to the sender of a message. The message is then saved in the Sent Items folder.
replyAllreplyAll None 答复邮件的所有收件人。然后邮件保存在已发送邮件文件夹中。Reply to all recipients of a message. The message is then saved in the Sent Items folder.
发送send None 发送以前创建的邮件草稿。然后邮件保存在已发送邮件文件夹中。Sends a previously created message draft. The message is then saved in the Sent Items folder.
取消订阅unsubscribe None 使用 List-Unsubscribe 标头中的第一个 mailto 命令中指定的数据和地址发送邮件。Send a message using the data and address specified in the first mailto command in the List-Unsubscribe header.
列出附件List attachments attachment 集合attachment collection 获取 eventMessage 的所有附件。Get all attachments on an eventMessage.
Add attachmentAdd attachment attachmentattachment 通过发布到附件集合,向 eventMessage 添加新附件。Add a new attachment to an eventMessage by posting to the attachments collection.
开放扩展Open extensions
创建开放扩展Create open extension openTypeExtensionopenTypeExtension 创建开放扩展,并在新建或现有的资源实例中添加自定义属性。Create an open extension and add custom properties in a new or existing instance of a resource.
获取开放扩展Get open extension openTypeExtension 集合openTypeExtension collection 获取按名称标识的开放扩展。Get an open extension identified by name.
扩展属性Extended properties
创建单值扩展属性Create single-value extended property eventMessageeventMessage 在新建或现有 eventMessage 中创建一个或多个单值扩展属性。Create one or more single-value extended properties in a new or existing eventMessage.
获取具有单值扩展属性的 eventMessageGet eventMessage with single-value extended property eventMessageeventMessage 通过使用 $expand$filter 获取包含单值扩展属性的 eventMessage。Get eventMessages that contain a single-value extended property by using $expand or $filter.
创建多值扩展属性Create multi-value extended property eventMessageeventMessage 在新建或现有的 eventMessage 中创建一个或多个多值扩展属性。Create one or more multi-value extended properties in a new or existing eventMessage.
获取具有多值扩展属性的 eventMessageGet eventMessage with multi-value extended property eventMessageeventMessage 使用 $expand 获取包含一个多值扩展属性的 eventMessage。Get an eventMessage that contains a multi-value extended property by using $expand.