eventMessage 资源类型
命名空间:microsoft.graph
重要
Microsoft Graph /beta
版本下的 API 可能会发生更改。 不支持在生产应用程序中使用这些 API。 若要确定 API 是否在 v1.0 中可用,请使用 版本 选择器。
表示会议请求、取消或响应的消息。 可以是以下值之一:接受、暂定接受或拒绝。
eventMessage 实体派生自 message。 eventMessage 是 eventMessageRequest 和 eventMessageResponse 的基类型。 meetingMessageType 属性确定事件邮件类型。
当组织者或应用发送会议请求时,会议请求将作为 eventMessage 实例到达被邀请者的邮箱中,其中包含 meetingRequest 的 meetingMessageType。 此外,Outlook 会在被邀请人的日历中自动创建事件实例,其中 showAs 属性为暂定。
若要获取被邀请者邮箱中关联事件的属性,应用可以使用 eventMessage的事件导航属性,如此 get 事件消息示例所示。 应用还可以通过 接受、 暂时接受或 拒绝 事件,以编程方式代表被邀请者响应事件。
除了会议请求之外,事件组织者取消会议的结果,可以在被邀请者的邮箱中找到 eventMessage 实例,或者在被邀请者响应会议请求后在组织者的邮箱中找到 eventMessage 实例。 应用可以对事件邮件执行操作,就像对邮件执行操作一样,但略有不同。
JSON 表示形式
以下 JSON 表示形式显示了资源类型。
{
"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"
}
属性
属性 | 类型 | 说明 |
---|---|---|
bccRecipients | recipient collection | 邮件的密件抄送收件人。 |
body | itemBody | 邮件的正文。 可以是 HTML 格式或文本格式。 |
bodyPreview | String | 邮件正文中的前 255 个字符。 文本格式。 |
categories | String collection | 与邮件关联的类别。 |
ccRecipients | recipient collection | 邮件的抄送收件人。 |
changeKey | String | 邮件的版本。 |
conversationId | String | 电子邮件所属对话的 ID。 |
conversationIndex | Edm.Binary | 指出消息在对话中的位置。 |
createdDateTime | DateTimeOffset | 创建邮件的日期和时间。 |
endDateTime | dateTimeTimeZone | 请求的会议结束时间。 |
flag | followupFlag | 指示邮件的状态、开始日期、截止日期或完成日期的标志值。 |
发件人 | recipient | 发送邮件邮箱的所有者。 在多数情况中,此数值与“发件人”属性相同,但共享或委派情景除外。 值必须对应于使用的实际邮箱。 查看更多有关为邮件设置 from 和 sender 属性的信息。 |
hasAttachments | Boolean | 指示邮件是否包含附件。 |
id | String | 邮件的唯一标识符。
默认情况下,当项从一个容器(如文件夹或日历)移动到另一个容器时,此值会更改。 若要更改此行为,请使用 Prefer: IdType="ImmutableId" 头。 有关详细信息,请参阅获取 Outlook 资源的不可变标识符。 只读。 |
importance | String | 邮件的重要性:low 、normal 、high 。 |
inferenceClassification | String | 可取值为:focused 、other 。 |
internetMessageHeaders | internetMessageHeader 集合 | 由 RFC5322 定义的邮件头集合,它提供邮件获取的从发件人到收件人的网络路径的详细信息。 只读。 |
internetMessageId | String | 邮件 ID 采用 RFC5322 指定的格式。 |
isAllDay | Boolean | 指示事件是否持续一整天。 调整此属性还需要调整事件的 startDateTime 和 endDateTime 属性。 |
isDelegated | 布尔值 | 如果代理人可以访问此会议请求,则为 True;否则为 false。 默认为 false。 |
isDeliveryReceiptRequested | Boolean | 指示是否需要发送邮件已读回执。 |
isDraft | Boolean | 指示邮件是否为草稿。 如果尚未发送,则此邮件是一封草稿。 |
isOutOfDate | 布尔值 | 指示此会议请求是否已由较新的请求过期。 |
isRead | Boolean | 指示是否已阅读该邮件。 |
isReadReceiptRequested | Boolean | 指示是否需要发送邮件已读回执。 |
lastModifiedDateTime | DateTimeOffset | 上次更改邮件的日期和时间。 |
位置 | 位置 | 请求的会议位置。 |
meetingMessageType | String | 事件消息的类型:none 、meetingRequest 、meetingCancelled 、meetingAccepted 、meetingTentativelyAccepted 、meetingDeclined 。 |
mentionsPreview | mentionsPreview | 邮件中的提及的相关信息。 处理 GET /messages 请求时,服务器会设置此属性并默认将其包含在响应中。 若邮件中无提及,则服务器返回 NULL。 可选。 |
parentFolderId | String | 邮件的父 MailFolder 的唯一标识符。 |
receivedDateTime | DateTimeOffset | 收到邮件的日期和时间。 |
recurrence | patternedRecurrence | 所请求会议的重复模式。 |
replyTo | recipient collection | 在答复时使用的电子邮件地址。 |
sender | recipient | 用于生成消息的帐户。 大多数情况下,此值与“from”属性相同。 从共享邮箱发送邮件时,可以将此属性设置为其他值,对于共享日历,或设置为代理人。 在任何情况下,此值必须对应于使用的实际邮箱。 有关详细信息,请参阅 设置 from 和 sender 属性。 |
sentDateTime | DateTimeOffset | 发送邮件的日期和时间。 |
startDateTime | dateTimeTimeZone | 请求的会议开始时间。 |
subject | String | 邮件的主题。 |
toRecipients | recipient collection | 邮件的收件人。 |
type | String | 请求的会议类型: singleInstance 、 occurence 、 exception 、 seriesMaster 。 |
uniqueBody | itemBody | 当前邮件专用的邮件正文部分。 |
UnsubscribeData | String | 从 List-Unsubscribe 标头中解析的有效条目。 若 UnsubscribeEnabled 属性为 true,则这是 List-Unsubscribe 标头中的邮件命令的数据。 |
UnsubscribeEnabled | 布尔值 | 指示邮件是否已启用取消订阅。 若 list-Unsubscribe 标头符合 rfc-2369,则其值为 True。 |
webLink | String | 要在 Outlook 网页版中打开邮件的 URL。 可以将 ispopout 参数附加到此 URL 的末尾以更改邮件的显示方式。 如果 ispopout 不存在或设置为 1,则消息显示在弹出窗口中。 如果 ispopout 设置为 0,则浏览器在 Outlook 网页版审阅窗格中显示邮件。 如果你通过 Outlook 网页版登录到邮箱,该邮件将在浏览器中打开。 如果尚未使用浏览器登录,系统会提示你登录。 无法从 iFrame 内部访问此 URL。 |
关系
关系 | 类型 | 说明 |
---|---|---|
attachments | 附件集合 | 邮件的 fileAttachment、 itemAttachment 和 referenceAttachment 附件的集合。 此为只读属性。 可为 Null。 |
event | event | 与事件消息相关联的事件。 对于与会者或会议室资源,假定已将日历助理设为在会议请求事件消息到达时自动更新包含事件的日历。 导航属性。 只读。 |
extensions | extension 集合 | 为 eventMessage 定义的开放扩展集合。 只读。 可为空。 |
提及 | mention 集合 | 邮件中的提及集合,按 createdDateTime 由最新到最旧排序。 默认情况下, GET 除非对 属性应用 $expand ,否则 /messages 不会返回此属性。 |
multiValueExtendedProperties | multiValueLegacyExtendedProperty 集合 | 为 eventMessage 定义的多值扩展属性的集合。 只读。 可为 Null。 |
singleValueExtendedProperties | singleValueLegacyExtendedProperty collection | 为 eventMessage 定义的单值扩展属性的集合。 只读。 可为 Null。 |
方法
方法 | 返回类型 | 说明 |
---|---|---|
Get | eventMessage | 读取 eventmessage 对象的属性和关系。 |
更新 | eventMessage | 更新 eventMessage 对象。 |
删除 | 无 | 更新 eventMessage 对象。 |
复制邮件 | 邮件 | 将邮件复制到文件夹。 |
创建草稿以转发邮件 | 邮件 | 创建转发邮件的草稿。 然后,你可以 更新 或 发送 草稿。 |
创建要答复的草稿 | 邮件 | 创建回复邮件的草稿。 然后,你可以 更新 或 发送 草稿。 |
创建草稿以答复全部 | 邮件 | 创建全部答复邮件的草稿。 然后,你可以 更新 或 发送 草稿。 |
转发邮件 | None | 转发邮件。 然后邮件保存在已发送邮件文件夹中。 |
移动消息 | 邮件 | 将邮件移动到文件夹。 该操作会在目标文件夹中创建邮件的新副本。 |
回复消息 | None | 答复邮件的发件人。 然后邮件保存在已发送邮件文件夹中。 |
全部答复邮件 | None | 答复邮件的所有收件人。 然后邮件保存在已发送邮件文件夹中。 |
发送草稿消息 | None | 发送以前创建的邮件草稿。 然后邮件保存在已发送邮件文件夹中。 |
撤回邮件 | 邮件 | 撤回指定用户的邮箱“已发送邮件”文件夹中的邮件。 |
取消订阅 | 无 | 使用 List-Unsubscribe 标头中的第一个 mailto 命令中指定的数据和地址发送邮件。 |
永久删除 | None | 永久删除事件邮件并将其放置在用户邮箱的“可恢复邮件”文件夹中的“清除”文件夹中。 |
附件 | ||
列出附件 | attachment 集合 | 获取 eventMessage 的所有附件。 |
Add attachment | attachment | 通过发布到附件集合,向 eventMessage 添加新附件。 |
开放扩展 | ||
创建开放扩展 | openTypeExtension | 创建开放扩展,并在新建或现有的资源实例中添加自定义属性。 |
获取开放扩展 | openTypeExtension 集合 | 获取按名称标识的开放扩展。 |
扩展属性 | ||
创建单值属性 | eventMessage | 在新建或现有 eventMessage 中创建一个或多个单值扩展属性。 |
获取单值属性 | eventMessage | 通过使用 $expand 或 $filter 获取包含单值扩展属性的 eventMessage。 |
创建多值属性 | eventMessage | 在新建或现有的 eventMessage 中创建一个或多个多值扩展属性。 |
获取多值属性 | eventMessage | 使用 $expand 获取包含一个多值扩展属性的 eventMessage。 |