Office.Entities interface

  • 参考
包:
outlook

表示电子邮件或约会中找到的实体集合。 仅限阅读模式。

Entities 对象是项目（电子邮件或约会）包含一个或多个服务器找到的实体时由 getEntities 和 getEntitiesByType 方法返回的实体数组的容器。 可以使用代码中的这些实体为查看器提供附加上下文信息，如对项目中找到的地址的映射或打开项目中找到的电话号码的拨号程序。

如果项中没有属性中指定的类型的实体，则与该实体关联的属性为 null。 例如，如果邮件包含街道地址和电话号码，则 address 属性和 phoneNumbers 属性将包含信息，其他属性将为 null。

若要被识别为地址，字符串必须包含至少具有街道编号、街道名称、城市、州和邮政编码等元素的子集的美国通讯地址。

若要被识别为电话号码，字符串必须包含北美电话号码格式。

实体识别有赖于基于计算机了解大量数据的自然语言识别。 实体的识别是不确定的，其成功有时取决于项中的特定上下文。

当 方法返回 getEntitiesByType 属性数组时，只有指定实体的 属性包含数据;所有其他属性均为 null。

注解

最低权限级别： 读取项

适用的 Outlook 模式：读取

重要提示：基于实体的上下文 Outlook 加载项将在 2024 年第 2 季度停用。 停用此功能的工作将于 5 月开始，并持续到 6 月底。 6 月之后，上下文加载项将无法再检测邮件项目中的实体以对其执行任务。 以下 API 也将停用。

  • Office.context.mailbox.item.getEntities - Office.context.mailbox.item.getEntitiesByType - Office.context.mailbox.item.getFilteredEntitiesByName - Office.context.mailbox.item.getSelectedEntities

为了帮助最大程度地减少潜在的中断，在基于实体的上下文加载项停用后，仍支持以下内容。

  • 正在开发由联机会议加载项激活的 “加入 会议”按钮的替代实现。 结束对基于实体的上下文加载项的支持后，联机会议加载项将自动转换为替代实现，以激活“ 加入会议 ”按钮。

  • 基于实体的上下文加载项停用后，将继续支持正则表达式规则。 建议更新上下文加载项，以使用正则表达式规则作为替代解决方案。 有关如何实现这些规则的指南，请参阅 使用正则表达式激活规则显示 Outlook 加载项。

有关详细信息，请参阅 基于实体的上下文 Outlook 加载项的停用。

属性

addresses

获取在电子邮件或约会中找到的物理地址（街道或邮寄地址）。
contacts

获取电子邮件地址或约会中找到的联系人。
emailAddresses

获取电子邮件或约会中找到的电子邮件地址。
meetingSuggestions

获取电子邮件中找到的会议建议。
phoneNumbers

获取电子邮件或约会中找到的电话号码。
taskSuggestions

获取电子邮件或约会中找到的任务建议。
urls

获取电子邮件或约会中呈现的 Internet URL。

属性详细信息

addresses

获取在电子邮件或约会中找到的物理地址（街道或邮寄地址）。

addresses: string[];

属性值

string[]

示例

const item = Office.context.mailbox.item;
const addresses = item.getEntitiesByType(Office.MailboxEnums.EntityType.Address);

contacts

获取电子邮件地址或约会中找到的联系人。

contacts: Contact[];

属性值

Office.Contact[]

示例

const item = Office.context.mailbox.item;
const contacts = item.getEntitiesByType(Office.MailboxEnums.EntityType.Contact);

emailAddresses

获取电子邮件或约会中找到的电子邮件地址。

emailAddresses: string[];

属性值

string[]

示例

const item = Office.context.mailbox.item;
const emailAddresses = item.getEntitiesByType(Office.MailboxEnums.EntityType.EmailAddress);

meetingSuggestions

获取电子邮件中找到的会议建议。

meetingSuggestions: MeetingSuggestion[];

属性值

Office.MeetingSuggestion[]

示例

const item = Office.context.mailbox.item;
const meetingSuggestions = item.getEntitiesByType(Office.MailboxEnums.EntityType.MeetingSuggestion);

phoneNumbers

获取电子邮件或约会中找到的电话号码。

phoneNumbers: PhoneNumber[];

属性值

Office.PhoneNumber[]

示例

const item = Office.context.mailbox.item;
const phoneNumbers = item.getEntitiesByType(Office.MailboxEnums.EntityType.PhoneNumber);

taskSuggestions

获取电子邮件或约会中找到的任务建议。

taskSuggestions: string[];

属性值

string[]

示例

const item = Office.context.mailbox.item;
const taskSuggestions = item.getEntitiesByType(Office.MailboxEnums.EntityType.TaskSuggestion);

urls

获取电子邮件或约会中呈现的 Internet URL。

urls: string[];

属性值

string[]

示例

const item = Office.context.mailbox.item;
const urls = item.getEntitiesByType(Office.MailboxEnums.EntityType.Url);