提及资源类型

命名空间:microsoft.graph

重要

Microsoft Graph /beta 版本下的 API 可能会发生更改。 不支持在生产应用程序中使用这些 API。 若要确定 API 是否在 v1.0 中可用,请使用 版本 选择器。

表示基于该人员的电子邮件地址向某人发送的通知。 这种类型的通知也称为 @-提及。

消息资源支持提及。 它包含一个 mentionsPreview 属性,该属性指示是否在该消息实例中提到已登录用户。 它还包括提及导航属性,该属性支持获取提及的详细信息,或删除该实例中的提及。

创建消息时,应用可以在提及属性中包含 提及,从而在同一POST请求中创建提及。 GET使用具有$filter查询参数的请求,应用可以返回已登录用户邮箱中提及用户的所有邮件。 使用GET$expand查询参数的请求允许应用扩展特定消息中的所有提及。

这种让应用在消息中设置和获取提及的机制可实现轻量级通知,其中进行提及的用户可以保留在现有上下文 (例如撰写消息正文) 而应用设置基础提及属性。 被提及的人员可以通过使用 $filter$expand 查询参数的请求轻松找出他们是否和在哪里被提及GET

例如,在 Outlook 邮件客户端中,当用户在撰写邮件时键入@时,Outlook 允许用户选择或输入名称以完成 @-提及。 Outlook 在创建和发送邮件或事件之前设置 提及 属性。 Outlook 还对 和 $expand 使用GET操作$filter,让已登录用户查找提及用户的邮件,提醒用户操作项目或讨论,从而加快响应速度。

方法

方法 返回类型 说明
发布 和发送 创建并发送提及作为新邮件的一部分。
发布到 新草稿 包含一个或多个提及对象的消息 创建新邮件的草稿并包含一个或多个提及对象。
获取 提及我的消息 message 集合 获取已登录用户的邮箱中包含此用户提及的所有邮件。
获取 消息及其提及 message 集合 获取消息并展开消息中每个提及的详细信息。
删除提及 删除已登录用户邮箱中指定邮件中的指定提及。

属性

属性 类型 说明
应用程序 String 在其中创建提及的应用程序的名称。 可选。 未使用,并且 默认为消息的 null。
clientReference String 表示资源实例的父级的唯一标识符。 可选。 未使用,并且 默认为消息的 null。
createdBy emailAddress 进行提及的用户的电子邮件信息。
createdDateTime DateTimeOffset 在客户端上创建提及的日期和时间。
deepLink String 指向资源实例中提及上下文的深层 Web 链接。 可选。 未使用,并且 默认为消息的 null。
id String 资源实例中提及的唯一标识符。
提到 emailAddress 被提及人员的电子邮件信息。 必填。
mentionText String 可选。 未使用,并且 默认为消息的 null。 若要获取消息中的提及,请参阅消息的 bodyPreview 属性。
serverCreatedDateTime DateTimeOffset 在服务器上创建提及的日期和时间。 可选。 未使用,并且 默认为消息的 null。

关系

无。

JSON 表示形式

下面是资源的 JSON 表示形式。

{
  "application": "string",
  "clientReference": "string",
  "createdBy": {"@odata.type": "microsoft.graph.emailAddress"},
  "createdDateTime": "DateTimeOffset",
  "deepLink": "string",
  "id": "string (identifier)",
  "mentioned": {"@odata.type": "microsoft.graph.emailAddress"},
  "mentionText": "string",
  "serverCreatedDateTime": "DateTimeOffset"
}