Office.Entities interface

Пакет:

outlook

Представляет коллекцию объектов, обнаруженных в электронном сообщении или сведениях о встрече. Только в режиме чтения.

Объект Entities — это контейнер для массивов сущностей, возвращаемых методами getEntities и getEntitiesByType, если элемент (электронное сообщение или сведения о встрече) содержит одну или несколько сущностей, обнаруженных сервером. Эти сущности можно использовать в коде, чтобы предоставить дополнительные контекстные сведения (например, отобразить адрес на карте или открыть приложение для набора телефонного номера, обнаруженного в элементе).

Если в элементе нет сущностей типа, указанного в свойстве, это свойство возвращает значение null. Например, если сообщение содержит почтовый адрес и номер телефона, свойства addresses и phoneNumbers будут содержать данные, а остальные свойства вернут значение null.

Чтобы строка распознавалась как адрес, она должна содержать почтовый адрес в США с такими элементами, как номер дома, название улицы, город, штат и почтовый индекс.

Чтобы строка распознавалась как номер телефона, она должна содержать номер телефона в формате, принятом в Северной Америке.

Распознавание сущностей опирается на встроенное распознавание языка, основанное на компьютерном осмыслении больших объемов данных. Распознавание сущности является недетерминированным, и успех иногда зависит от конкретного контекста в элементе.

Когда массивы свойств возвращаются методом getEntitiesByType , только свойство для указанной сущности содержит данные; все остальные свойства имеют значение NULL.

Комментарии

Минимальный уровень разрешений: чтение элемента

Применимый режим Outlook: чтение

Важно! Контекстные надстройки Outlook на основе сущностей будут прекращены во 2-м квартале 2024 г. Работа по прекращению использования этой функции начнется в мае и продолжится до конца июня. После июня контекстные надстройки больше не смогут обнаруживать сущности в почтовых элементах для выполнения задач над ними. Следующие 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	Получает 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

Получает URL-адреса в Интернете, присутствующие в сообщении электронной почты или встрече.

urls: string[];

Значение свойства

string[]

Примеры

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