Office.LoadedMessageRead interface

Пакет:: outlook

Представляет сообщение в режиме чтения, загруженное в данный момент. Объект LoadedMessageRead возвращается при Office.context.mailbox.loadItemByIdAsync вызове сообщения в режиме чтения.

При реализации функции множественного выбора элементов определите, можно ли уже получить доступ к требуемым свойствам выбранного элемента с помощью Office.context.mailbox.getSelectedItemsAsync вызова. Если это возможно, вам не нужно вызывать loadItemByIdAsync.
Одновременно можно загрузить только один почтовый элемент. При реализации loadItemByIdAsyncнеобходимо вызвать unloadAsync после обработки элемента. Это необходимо сделать перед вызовом loadItemByIdAsync для другого элемента.

Примеры

// Gets the sender's email address of each selected message.
async function getSenderEmailAddress(item) {
    const itemId = item.itemId;
    await new Promise((resolve) => {
        Office.context.mailbox.loadItemByIdAsync(itemId, (result) => {
            if (result.status === Office.AsyncResultStatus.Failed) {
                console.log(result.error.message);
                return;
            }

            const loadedItem = result.value;
            const sender = loadedItem.from.emailAddress;
            console.log(sender);

            // Unload the current message before processing another selected message.
            loadedItem.unloadAsync((asyncResult) => {
                if (asyncResult.status === Office.AsyncResultStatus.Failed) {
                    console.log(asyncResult.error.message);
                    return;
                }

                resolve();
            });
        });
    });
}

Свойства

attachments	Возвращает вложения элемента в виде массива.
body	Возвращает текст элемента и его формат.
categories	Возвращает объект , предоставляющий методы для управления категориями элемента.
cc	Возвращает получателей в строке Копия (копия) сообщения. Свойство `cc` возвращает массив, содержащий объект EmailAddressDetails для каждого получателя, указанного в строке Копия сообщения. Максимальное число возвращенных получателей зависит от клиента Outlook. Windows (классическая версия): 500 получателей Windows (классическая версия , начиная с версии 2511 (сборка 19426.20000)): 1000 получателей Веб-браузер, Windows (новый): 20 получателей (свернутое представление), 500 получателей (развернутое представление)
conversationId	Получает идентификатор разговора по электронной почте, содержащего конкретное сообщение. Вы можете получить целочисленное значение этого свойства, если ваше почтовое приложение активируется в формах просмотра или формах создания ответов. Если пользователь изменит тему ответа, после его отправки идентификатор беседы будет изменен, и полученное ранее значение будет недействительным.
dateTimeCreated	Получает дату и время создания элемента.
dateTimeModified	Получает дату и время последнего изменения элемента.
end	Возвращает дату и время окончания встречи. Свойство `end` представляет собой объект, выраженный `Date` в виде значения даты и времени в формате UTC. Метод можно использовать для `convertToLocalClientTime` преобразования `end` значения свойства в локальные значения даты и времени клиента. Если вы задаете время окончания с помощью метода `Time.setAsync`, необходимо использовать метод `convertToUtcClientTime` для преобразования местного времени на клиенте в формат UTC для сервера.
from	Получает электронный адрес отправителя сообщения. Свойство `from` возвращает `EmailAddressDetails` объект .
internetMessageId	Возвращает идентификатор сообщения в Интернете.
itemClass	Возвращает класс элементов веб-служб Exchange выбранного сообщения.
itemId	Возвращает идентификатор элемента веб-служб Exchange для текущего элемента.
itemType	Получает тип элемента, который представляет экземпляр. Свойство `itemType` возвращает одно из значений `ItemType` перечисления, указывающее, является ли экземпляр объекта элемента сообщением или встречей.
location	Возвращает расположение приглашения на собрание. Свойство `location` возвращает строку, содержащую сведения о месте встречи.
normalizedSubject	Возвращает тему элемента со всеми удаленными префиксами (включая RE: и FWD:). Свойство `normalizedSubject` получает тему элемента с любыми стандартными префиксами (например, RE: и FW:), которые добавляются программами электронной почты. Для получения темы элемента с неизмененными префиксами используйте свойство `subject`.
notificationMessages	Возвращает уведомления элемента.
recurrence	Возвращает шаблон повторения встречи. Возвращает шаблон повторения приглашения на собрание. Режимы чтения и создания для элементов встреч. Режим чтения для элементов приглашения на собрание. Свойство `recurrence` возвращает `Recurrence` объект для повторяющихся встреч или запросов собраний, если элемент является рядом или экземпляром ряда. `null` возвращается для отдельных встреч и запросов на собрания для отдельных встреч. `undefined` возвращается для сообщений, которые не являются приглашениями на собрание.
sender	Получает электронный адрес отправителя электронного сообщения.
seriesId	Возвращает идентификатор ряда, к которому принадлежит экземпляр. В Outlook в Интернете и в Windows (новая и классическая версия) `seriesId` возвращает идентификатор веб-служб Exchange (EWS) родительского элемента (ряда), к которому принадлежит этот элемент.
start	Возвращает дату и время начала встречи. Свойство `start` представляет собой объект, выраженный `Date` в виде значения даты и времени в формате UTC. Метод можно использовать для `convertToLocalClientTime` преобразования значения в локальные дату и время клиента.
subject	Возвращает описание, отображающееся в поле темы элемента. Свойство `subject` получает всю тему элемента, отправленную сервером электронной почты. Свойство `subject` возвращает строку. Используйте свойство , `normalizedSubject` чтобы получить субъект без всех начальных префиксов, таких как RE: и FW:.
to	Возвращает получателей в строке Кому сообщения. Предоставляет доступ к получателям, указанным в строке Кому сообщения. Тип объекта и уровень доступа зависят от режима текущего элемента. Свойство `to` возвращает массив, содержащий объект EmailAddressDetails для каждого получателя, указанного в строке Кому сообщения. Максимальное число возвращенных получателей зависит от клиента Outlook. Windows (классическая версия): 500 получателей Windows (классическая версия , начиная с версии 2511 (сборка 19426.20000)): 1000 получателей Веб-браузер, Windows (новый): 20 получателей (свернутое представление), 500 получателей (развернутое представление)

Методы

displayReplyAllFormAsync(formData, options, callback)	Отображает форму ответа, включающую отправителя и всех получателей выбранного сообщения либо организатора и всех участников выбранной встречи.
displayReplyAllFormAsync(formData, callback)	Отображает форму ответа, включающую отправителя и всех получателей выбранного сообщения либо организатора и всех участников выбранной встречи.
displayReplyFormAsync(formData, options, callback)	Отображает форму ответа, включающую только отправителя выбранного сообщения или организатора выбранной встречи.
displayReplyFormAsync(formData, callback)	Отображает форму ответа, включающую только отправителя выбранного сообщения или организатора выбранной встречи.
getAllInternetHeadersAsync(options, callback)	Возвращает все заголовки интернета для сообщения в виде строки. Дополнительные сведения см . в статье Получение и настройка заголовков в Интернете для сообщения в надстройке Outlook.
getAllInternetHeadersAsync(callback)	Возвращает все заголовки интернета для сообщения в виде строки. Дополнительные сведения см . в статье Получение и настройка заголовков в Интернете для сообщения в надстройке Outlook.
getAsFileAsync(options, callback)	Возвращает текущее сообщение в формате EML, закодированное в Base64.
getAsFileAsync(callback)	Возвращает текущее сообщение в формате EML, закодированное в Base64.
getAttachmentContentAsync(attachmentId, options, callback)	Получает вложение из сообщения или встречи и возвращает его в `AttachmentContent` виде объекта .
getAttachmentContentAsync(attachmentId, callback)	Получает вложение из сообщения или встречи и возвращает его в `AttachmentContent` виде объекта .
getInitializationContextAsync(options, callback)	Возвращает данные инициализации, передаваемые при активации надстройки с помощью сообщения с действиями.
getInitializationContextAsync(callback)	Возвращает данные инициализации, передаваемые при активации надстройки с помощью сообщения с действиями.
getRegExMatches()	Возвращает строковые значения в выбранном элементе, соответствующие регулярным выражениям, определенным в XML-файле манифеста.
getRegExMatchesByName(name)	Возвращает строковые значения в выбранном элементе, соответствующие именованное регулярное выражение, определенное в XML-файле манифеста.
getSelectedRegExMatches()	Возвращает строковые значения в выделенном совпадении, которые соответствуют регулярным выражениям, определенным в XML-файле манифеста. Выделенные совпадения применяются к контекстным надстройкам.
getSharedPropertiesAsync(options, callback)	Возвращает свойства встречи или сообщения в общей папке или общем почтовом ящике. Дополнительные сведения об использовании этого API см. в статье Включение общих папок и сценариев общих почтовых ящиков в надстройке Outlook.
getSharedPropertiesAsync(callback)	Возвращает свойства встречи или сообщения в общей папке или общем почтовом ящике. Дополнительные сведения об использовании этого API см. в статье Включение общих папок и сценариев общих почтовых ящиков в надстройке Outlook.
loadCustomPropertiesAsync(callback, userContext)	Асинхронно загружает настраиваемые свойства для надстройки для выбранного элемента. Пользовательские свойства хранятся в виде пар "ключ-значение" для каждого приложения и каждого элемента. Этот метод возвращает объект CustomProperties в обратном вызове, который предоставляет методы для доступа к пользовательским свойствам, характерным для текущего элемента и текущей надстройки. Пользовательские свойства не шифруются в элементе, поэтому их не следует использовать в качестве безопасного хранилища. Настраиваемые свойства предоставляются в виде объекта `CustomProperties` в свойстве `asyncResult.value`. Этот объект можно использовать для получения пользовательских свойств из почтового элемента.
unloadAsync(options, callback)	При выборе нескольких почтовых элементов закрывает текущий загруженный элемент, чтобы можно было загрузить другой выбранный почтовый элемент для обработки.
unloadAsync(callback)	При выборе нескольких почтовых элементов закрывает текущий загруженный элемент, чтобы можно было загрузить другой выбранный почтовый элемент для обработки.

Сведения о свойстве

attachments

Возвращает вложения элемента в виде массива.

attachments: AttachmentDetails[];

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

Office.AttachmentDetails[]

Outlook блокирует определенные типы файлов из-за потенциальных проблем с безопасностью, поэтому они не возвращаются. Дополнительные сведения см. в разделе Заблокированные вложения в Outlook.
Вложения, добавленные с помощью параметра Отправить и поделиться , не возвращаются.

body

Возвращает текст элемента и его формат.

body: Body;

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

Office.Body

cc

Возвращает получателей в строке Копия (копия) сообщения.

Свойство cc возвращает массив, содержащий объект EmailAddressDetails для каждого получателя, указанного в строке Копия сообщения. Максимальное число возвращенных получателей зависит от клиента Outlook.

Windows (классическая версия): 500 получателей
Windows (классическая версия , начиная с версии 2511 (сборка 19426.20000)): 1000 получателей
Веб-браузер, Windows (новый): 20 получателей (свернутое представление), 500 получателей (развернутое представление)

cc: EmailAddressDetails[];

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

Office.EmailAddressDetails[]

conversationId

Получает идентификатор разговора по электронной почте, содержащего конкретное сообщение.

Вы можете получить целочисленное значение этого свойства, если ваше почтовое приложение активируется в формах просмотра или формах создания ответов. Если пользователь изменит тему ответа, после его отправки идентификатор беседы будет изменен, и полученное ранее значение будет недействительным.

conversationId: string;

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

string

dateTimeCreated

Получает дату и время создания элемента.

dateTimeCreated: Date;

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

Date

dateTimeModified

Получает дату и время последнего изменения элемента.

dateTimeModified: Date;

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

Date

Важно! Это свойство не поддерживается в Outlook для Android или iOS. Дополнительные сведения о поддерживаемых API в Outlook Mobile см. в статье API JavaScript Для Outlook, поддерживаемые в Outlook на мобильных устройствах.

end

Возвращает дату и время окончания встречи.

Свойство end представляет собой объект, выраженный Date в виде значения даты и времени в формате UTC. Метод можно использовать для convertToLocalClientTime преобразования end значения свойства в локальные значения даты и времени клиента.

Если вы задаете время окончания с помощью метода Time.setAsync, необходимо использовать метод convertToUtcClientTime для преобразования местного времени на клиенте в формат UTC для сервера.

end: Date;

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

Date

from

Получает электронный адрес отправителя сообщения.

Свойство from возвращает EmailAddressDetails объект .

from: EmailAddressDetails;

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

Office.EmailAddressDetails

Свойства from и sender представляют одно лицо, если сообщение не отправлено представителем. В этом случае from свойство представляет делегатор, а sender свойство представляет делегат.
Свойство recipientTypeEmailAddressDetails объекта в свойстве from не определено.

internetMessageId

Возвращает идентификатор сообщения в Интернете.

internetMessageId: string;

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

string

Важно! В папке "ОтправленныеinternetMessageId" объект может быть еще недоступен для недавно отправленных элементов. В этом случае рассмотрите возможность использования веб-служб Exchange для получения этого свойства с сервера.

itemClass

Возвращает класс элементов веб-служб Exchange выбранного сообщения.

itemClass: string;

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

string

Класс элемента	Описание
IPM.Note	Новые сообщения и ответы на сообщения
IPM.Schedule.Meeting.Request	приглашения на собрания;
IPM.Schedule.Meeting.Canceled	Отмены собраний
IPM.Schedule.Meeting.Resp.Neg	Отклонение приглашений на собрания
IPM.Schedule.Meeting.Resp.Pos	Принятие приглашений на собрания
IPM.Schedule.Meeting.Resp.Tent	Предварительное принятие приглашений на собрания

Можно создать пользовательские классы, расширяющие класс элементов по умолчанию. Например, IPM.Note.Contoso.

itemId

Возвращает идентификатор элемента веб-служб Exchange для текущего элемента.

itemId: string;

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

string

Свойство itemId недоступно в режиме создания. Если идентификатор элемента является обязательным, Office.context.mailbox.item.saveAsync метод можно использовать для сохранения элемента в хранилище, что вернет идентификатор элемента в asyncResult.value параметре функции обратного вызова. Если элемент уже сохранен, вместо этого можно вызвать Office.context.mailbox.item.getItemIdAsync метод .
Идентификатор, возвращаемый свойствомitemId, совпадает с идентификатором элемента веб-служб Exchange. Свойство itemId не идентично идентификатору записи Outlook или идентификатору, используемому REST API Outlook. Перед выполнением вызовов REST API с использованием этого значения его следует преобразовать с помощью Office.context.mailbox.convertToRestId.

itemType

Получает тип элемента, который представляет экземпляр.

Свойство itemType возвращает одно из значений ItemType перечисления, указывающее, является ли экземпляр объекта элемента сообщением или встречей.

itemType: MailboxEnums.ItemType | string;

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

Office.MailboxEnums.ItemType | string

location

Возвращает расположение приглашения на собрание.

Свойство location возвращает строку, содержащую сведения о месте встречи.

location: string;

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

string

normalizedSubject

Возвращает тему элемента со всеми удаленными префиксами (включая RE: и FWD:).

Свойство normalizedSubject получает тему элемента с любыми стандартными префиксами (например, RE: и FW:), которые добавляются программами электронной почты. Для получения темы элемента с неизмененными префиксами используйте свойство subject.

normalizedSubject: string;

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

string

notificationMessages

Возвращает уведомления элемента.

notificationMessages: NotificationMessages;

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

Office.NotificationMessages

Сведения о различных типах уведомлений, которые можно реализовать, см. в статье Создание уведомлений для надстройки Outlook.
Поддерживается getAllAsync только метод объекта NotificationMessages.

recurrence

Возвращает шаблон повторения встречи. Возвращает шаблон повторения приглашения на собрание. Режимы чтения и создания для элементов встреч. Режим чтения для элементов приглашения на собрание.

Свойство recurrence возвращает Recurrence объект для повторяющихся встреч или запросов собраний, если элемент является рядом или экземпляром ряда. null возвращается для отдельных встреч и запросов на собрания для отдельных встреч. undefined возвращается для сообщений, которые не являются приглашениями на собрание.

recurrence: Recurrence;

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

Office.Recurrence

Запросы на собрание имеют значение itemClass , равное IPM.Schedule.Meeting.Request.
recurrence Если объект имеет значение NULL, это означает, что объект является одной встречей или приглашением на собрание одной встречи, а не частью ряда.
Поддерживаются только propeties и getAsync метод объекта Recurrence.

sender

Получает электронный адрес отправителя электронного сообщения.

sender: EmailAddressDetails;

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

Office.EmailAddressDetails

Свойства from и sender представляют одно лицо, если сообщение не отправлено представителем. В этом случае from свойство представляет делегатор, а sender свойство представляет делегат.
Свойство recipientTypeEmailAddressDetails объекта в свойстве sender не определено.

seriesId

Возвращает идентификатор ряда, к которому принадлежит экземпляр.

В Outlook в Интернете и в Windows (новая и классическая версия) seriesId возвращает идентификатор веб-служб Exchange (EWS) родительского элемента (ряда), к которому принадлежит этот элемент.

seriesId: string;

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

string

Идентификатор, возвращаемый свойством seriesId, совпадает с идентификатором элемента веб-служб Exchange. Свойство seriesId не идентично идентификаторам Outlook, используемым REST API Outlook. Перед выполнением вызовов REST API с использованием этого значения его следует преобразовать с помощью Office.context.mailbox.convertToRestId. Дополнительные сведения см. в разделе Использование REST API Outlook из надстройки Outlook.
Свойство seriesId возвращает null для элементов, которые не имеют родительских элементов, таких как отдельные встречи, элементы рядов или приглашения на собрание, и возвращает для undefined других элементов, которые не являются приглашениями на собрания.

start

Возвращает дату и время начала встречи.

Свойство start представляет собой объект, выраженный Date в виде значения даты и времени в формате UTC. Метод можно использовать для convertToLocalClientTime преобразования значения в локальные дату и время клиента.

start: Date;

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

Date

subject

Возвращает описание, отображающееся в поле темы элемента.

Свойство subject получает всю тему элемента, отправленную сервером электронной почты.

Свойство subject возвращает строку. Используйте свойство , normalizedSubject чтобы получить субъект без всех начальных префиксов, таких как RE: и FW:.

subject: string;

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

string

to

Возвращает получателей в строке Кому сообщения. Предоставляет доступ к получателям, указанным в строке Кому сообщения. Тип объекта и уровень доступа зависят от режима текущего элемента.

Свойство to возвращает массив, содержащий объект EmailAddressDetails для каждого получателя, указанного в строке Кому сообщения. Максимальное число возвращенных получателей зависит от клиента Outlook.

Windows (классическая версия): 500 получателей
Windows (классическая версия , начиная с версии 2511 (сборка 19426.20000)): 1000 получателей
Веб-браузер, Windows (новый): 20 получателей (свернутое представление), 500 получателей (развернутое представление)

to: EmailAddressDetails[];

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

Office.EmailAddressDetails[]

Сведения о методе

displayReplyAllFormAsync(formData, options, callback)

Отображает форму ответа, включающую отправителя и всех получателей выбранного сообщения либо организатора и всех участников выбранной встречи.

displayReplyAllFormAsync(formData: string | ReplyFormData, options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult<void>) => void): void;

Параметры

formData: string | Office.ReplyFormData

Строка, содержащая текст и HTML-код, представляющие собой основной текст формы ответа. Строка ограничена 32 КБ или объектом ReplyFormData , который содержит данные текста или вложения и функцию обратного вызова.

options: Office.AsyncContextOptions

Литерал объекта, содержащий одно или несколько следующих свойств:- asyncContext: разработчики могут предоставить любой объект, к которому они хотят получить доступ в функции обратного вызова.

callback: (asyncResult: Office.AsyncResult<void>) => void

Возвращаемое значение

void

В Outlook в Интернете и в новом Outlook в Windows форма ответа отображается в виде всплывающей формы в представлении из трех столбцов и всплывающей формы в представлении из двух столбцов или 1 столбца.
Если любой строковый параметр превышает указанные для него ограничения, displayReplyAllFormAsync возвращает исключение.
Если вложения указаны в параметре formData.attachments , Outlook пытается скачать все вложения и вложить их в форму ответа. Если какие-либо вложения добавить не удается, в форме отображается сообщение об ошибке. Если сообщения об ошибках не предусмотрены, то они не отображаются.

displayReplyAllFormAsync(formData, callback)

displayReplyAllFormAsync(formData: string | ReplyFormData, callback?: (asyncResult: Office.AsyncResult<void>) => void): void;

Параметры

formData: string | Office.ReplyFormData

callback: (asyncResult: Office.AsyncResult<void>) => void

Возвращаемое значение

void

В Outlook в Интернете и в новом Outlook в Windows форма ответа отображается в виде всплывающей формы в представлении из трех столбцов и всплывающей формы в представлении из двух столбцов или 1 столбца.
Если любой строковый параметр превышает указанные для него ограничения, displayReplyAllFormAsync возвращает исключение.
Если вложения указаны в параметре formData.attachments , Outlook пытается скачать все вложения и вложить их в форму ответа. Если какие-либо вложения добавить не удается, в форме отображается сообщение об ошибке. Если сообщения об ошибках не предусмотрены, то они не отображаются.

displayReplyFormAsync(formData, options, callback)

Отображает форму ответа, включающую только отправителя выбранного сообщения или организатора выбранной встречи.

displayReplyFormAsync(formData: string | ReplyFormData, options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult<void>) => void): void;

Параметры

formData: string | Office.ReplyFormData

options: Office.AsyncContextOptions

callback: (asyncResult: Office.AsyncResult<void>) => void

Возвращаемое значение

void

В Outlook в Интернете и в новом Outlook в Windows форма ответа отображается в виде всплывающей формы в представлении из трех столбцов и всплывающей формы в представлении из двух столбцов или 1 столбца.
Если любой строковый параметр превышает указанные для него ограничения, displayReplyFormAsync возвращает исключение.
Если вложения указаны в параметре formData.attachments , Outlook пытается скачать все вложения и вложить их в форму ответа. Если какие-либо вложения добавить не удается, в форме отображается сообщение об ошибке. Если сообщения об ошибках не предусмотрены, то они не отображаются.

displayReplyFormAsync(formData, callback)

displayReplyFormAsync(formData: string | ReplyFormData, callback?: (asyncResult: Office.AsyncResult<void>) => void): void;

Параметры

formData: string | Office.ReplyFormData

callback: (asyncResult: Office.AsyncResult<void>) => void

Возвращаемое значение

void

В Outlook в Интернете и в новом Outlook в Windows форма ответа отображается в виде всплывающей формы в представлении из трех столбцов и всплывающей формы в представлении из двух столбцов или 1 столбца.
Если любой строковый параметр превышает указанные для него ограничения, displayReplyFormAsync возвращает исключение.
Если вложения указаны в параметре formData.attachments , Outlook пытается скачать все вложения и вложить их в форму ответа. Если какие-либо вложения добавить не удается, в форме отображается сообщение об ошибке. Если сообщения об ошибках не предусмотрены, то они не отображаются.

getAllInternetHeadersAsync(options, callback)

Возвращает все заголовки интернета для сообщения в виде строки.

Дополнительные сведения см . в статье Получение и настройка заголовков в Интернете для сообщения в надстройке Outlook.

getAllInternetHeadersAsync(options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult<string>) => void): void;

Параметры

options: Office.AsyncContextOptions

callback: (asyncResult: Office.AsyncResult<string>) => void

Необязательный параметр. После завершения метода функция, переданная в callback параметре, вызывается с одним параметром Office.AsyncResult , asyncResultкоторый является объектом . При успешном выполнении данные заголовков Интернета предоставляются в свойстве в asyncResult.value виде строки. Сведения о форматировании возвращаемого строкового значения см. в документе RFC 2183 . В случае сбоя asyncResult.error вызова свойство будет содержать код ошибки с причиной сбоя.

Возвращаемое значение

void

getAllInternetHeadersAsync(callback)

Возвращает все заголовки интернета для сообщения в виде строки.

getAllInternetHeadersAsync(callback?: (asyncResult: Office.AsyncResult<string>) => void): void;

Параметры

callback: (asyncResult: Office.AsyncResult<string>) => void

Возвращаемое значение

void

getAsFileAsync(options, callback)

Возвращает текущее сообщение в формате EML, закодированное в Base64.

getAsFileAsync(options: Office.AsyncContextOptions, callback: (asyncResult: Office.AsyncResult<string>) => void): void;

Параметры

options: Office.AsyncContextOptions

callback: (asyncResult: Office.AsyncResult<string>) => void

После завершения метода функция, переданная в параметре обратного вызова, вызывается с одним параметром Office.AsyncResult , asyncResultкоторый является объектом . В свойстве возвращается формат EML сообщения в кодировке asyncResult.value Base64. Все возникшие ошибки возвращаются в свойстве asyncResult.error .

Возвращаемое значение

void

getAsFileAsync(callback)

Возвращает текущее сообщение в формате EML, закодированное в Base64.

getAsFileAsync(callback: (asyncResult: Office.AsyncResult<string>) => void): void;

Параметры

callback: (asyncResult: Office.AsyncResult<string>) => void

Возвращаемое значение

void

getAttachmentContentAsync(attachmentId, options, callback)

Получает вложение из сообщения или встречи и возвращает его в AttachmentContent виде объекта .

getAttachmentContentAsync(attachmentId: string, options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult<AttachmentContent>) => void): void;

Параметры

attachmentId: string

Идентификатор вложения, которое требуется получить.

options: Office.AsyncContextOptions

callback: (asyncResult: Office.AsyncResult<Office.AttachmentContent>) => void

Возвращаемое значение

void

Метод getAttachmentContentAsync получает вложение с указанным идентификатором из элемента. Рекомендуется получить идентификатор вложения из вызова item.attachments , а затем в том же сеансе использовать его для получения вложения.
В Outlook в Интернете и новом Outlook для Windows не поддерживает вложения, getAttachmentContentAsync добавленные с помощью параметра Отправить и поделиться.
В Outlook в Интернете, на мобильных устройствах и в новом Outlook для Windows идентификатор вложения действителен только в том же сеансе. Сеанс завершается, когда пользователь закрывает приложение или если пользователь начинает создавать встроенную форму, затем открывает форму для продолжения в отдельном окне.

Ошибки:

AttachmentTypeNotSupported : тип вложения не поддерживается. Неподдерживаемые типы включают внедренные изображения в формате форматированного текста или типы вложений элементов, отличные от сообщений электронной почты или элементов календаря (например, контакт или элемент задачи).
InvalidAttachmentId : идентификатор вложения не существует.

getAttachmentContentAsync(attachmentId, callback)

Получает вложение из сообщения или встречи и возвращает его в AttachmentContent виде объекта .

getAttachmentContentAsync(attachmentId: string, callback?: (asyncResult: Office.AsyncResult<AttachmentContent>) => void): void;

Параметры

attachmentId: string

Идентификатор вложения, которое требуется получить.

callback: (asyncResult: Office.AsyncResult<Office.AttachmentContent>) => void

Возвращаемое значение

void

Метод getAttachmentContentAsync получает вложение с указанным идентификатором из элемента. Рекомендуется получить идентификатор вложения из вызова item.attachments , а затем в том же сеансе использовать его для получения вложения.
В Outlook в Интернете и новом Outlook для Windows не поддерживает вложения, getAttachmentContentAsync добавленные с помощью параметра Отправить и поделиться.
В Outlook в Интернете, на мобильных устройствах и в новом Outlook для Windows идентификатор вложения действителен только в том же сеансе. Сеанс завершается, когда пользователь закрывает приложение или если пользователь начинает создавать встроенную форму, затем открывает форму для продолжения в отдельном окне.

Ошибки:

AttachmentTypeNotSupported : тип вложения не поддерживается. Неподдерживаемые типы включают внедренные изображения в формате форматированного текста или типы вложений элементов, отличные от сообщений электронной почты или элементов календаря (например, контакт или элемент задачи).
InvalidAttachmentId : идентификатор вложения не существует.

getInitializationContextAsync(options, callback)

Возвращает данные инициализации, передаваемые при активации надстройки с помощью сообщения с действиями.

getInitializationContextAsync(options: Office.AsyncContextOptions, callback: (asyncResult: Office.AsyncResult<string>) => void): void;

Параметры

options: Office.AsyncContextOptions

callback: (asyncResult: Office.AsyncResult<string>) => void

После завершения метода функция, переданная в callback параметре, вызывается с одним параметром типа Office.AsyncResult. При успешном выполнении данные контекста инициализации предоставляются в качестве строки (или пустой строки, если контекст инициализации отсутствует) в свойстве asyncResult.value .

Возвращаемое значение

void

getInitializationContextAsync(callback)

Возвращает данные инициализации, передаваемые при активации надстройки с помощью сообщения с действиями.

getInitializationContextAsync(callback: (asyncResult: Office.AsyncResult<string>) => void): void;

Параметры

callback: (asyncResult: Office.AsyncResult<string>) => void

Возвращаемое значение

void

getRegExMatches()

Возвращает строковые значения в выбранном элементе, соответствующие регулярным выражениям, определенным в XML-файле манифеста.

getRegExMatches(): any;

Возвращаемое значение

any

Объект, содержащий массив строк, которые соответствуют регулярным выражениям, определяемым в XML-файле манифеста. Имя каждого массива равно соответствующему значению атрибута RegExName соответствующего правила или ItemHasRegularExpressionMatchFilterName атрибута соответствующего ItemHasKnownEntity правила. Для правила ItemHasRegularExpressionMatch соответствующую строку должно содержать свойство элемента, указанного этим правилом. Простой тип PropertyName определяет поддерживаемые свойства.

Контекстные надстройки Outlook на основе сущностей теперь сняты с учета. Однако правила регулярных выражений по-прежнему поддерживаются. Мы рекомендуем обновить контекстную надстройку, чтобы использовать правила регулярных выражений в качестве альтернативного решения. Инструкции по реализации этих правил см. в разделе Контекстные надстройки Outlook.
Этот метод используется с функцией правил активации для надстроек Outlook, которая не поддерживается в унифицированном манифесте Microsoft 365.
Если указать ItemHasRegularExpressionMatch правило для свойства body элемента, регулярное выражение должно дополнительно фильтровать текст и не пытаться вернуть весь текст элемента. Использование регулярного выражения, например .* для получения всего текста элемента, не всегда возвращает ожидаемые результаты. Лучше используйте метод Body.getAsync для этого.

getRegExMatchesByName(name)

Возвращает строковые значения в выбранном элементе, соответствующие именованное регулярное выражение, определенное в XML-файле манифеста.

getRegExMatchesByName(name: string): string[];

Параметры

name: string

Имя элемента правила ItemHasRegularExpressionMatch, определяющее соответствующий фильтр.

Возвращаемое значение

string[]

Массив, содержащий строки, соответствующие регулярному выражению, определенному в элементе ItemHasRegularExpressionMatch rule в XML-файле манифеста, с указанным RegExName значением элемента.

Контекстные надстройки Outlook на основе сущностей теперь сняты с учета. Однако правила регулярных выражений по-прежнему поддерживаются. Мы рекомендуем обновить контекстную надстройку, чтобы использовать правила регулярных выражений в качестве альтернативного решения. Инструкции по реализации этих правил см. в разделе Контекстные надстройки Outlook.
Этот метод используется с функцией правил активации для надстроек Outlook, которая не поддерживается в унифицированном манифесте Microsoft 365.
Если указать ItemHasRegularExpressionMatch правило для свойства body элемента, регулярное выражение должно дополнительно фильтровать текст и не пытаться вернуть весь текст элемента. Использование регулярного выражения, например .* для получения всего текста элемента, не всегда возвращает ожидаемые результаты. Лучше используйте метод Body.getAsync для этого.

getSelectedRegExMatches()

Возвращает строковые значения в выделенном совпадении, которые соответствуют регулярным выражениям, определенным в XML-файле манифеста. Выделенные совпадения применяются к контекстным надстройкам.

getSelectedRegExMatches(): any;

Возвращаемое значение

any

Объект, содержащий массив строк, которые соответствуют регулярным выражениям, определяемым в XML-файле манифеста. Имя каждого массива равно соответствующему значению атрибута RegExName подходящего правила ItemHasRegularExpressionMatch или атрибута FilterName соответствующего правила ItemHasKnownEntity. Для правила ItemHasRegularExpressionMatch соответствующую строку должно содержать свойство элемента, указанного этим правилом. Простой тип PropertyName определяет поддерживаемые свойства.

Контекстные надстройки Outlook на основе сущностей теперь сняты с учета. Однако правила регулярных выражений по-прежнему поддерживаются. Мы рекомендуем обновить контекстную надстройку, чтобы использовать правила регулярных выражений в качестве альтернативного решения. Инструкции по реализации этих правил см. в разделе Контекстные надстройки Outlook.
Этот метод используется с функцией правил активации для надстроек Outlook, которая не поддерживается в унифицированном манифесте Microsoft 365.
Если указать ItemHasRegularExpressionMatch правило для свойства body элемента, регулярное выражение должно дополнительно фильтровать текст и не пытаться вернуть весь текст элемента. Использование регулярного выражения, такого как .* для получения всего текста элемента, не всегда возвращает ожидаемые результаты. Лучше используйте метод Body.getAsync для этого.

getSharedPropertiesAsync(options, callback)

Возвращает свойства встречи или сообщения в общей папке или общем почтовом ящике.

Дополнительные сведения об использовании этого API см. в статье Включение общих папок и сценариев общих почтовых ящиков в надстройке Outlook.

getSharedPropertiesAsync(options: Office.AsyncContextOptions, callback: (asyncResult: Office.AsyncResult<SharedProperties>) => void): void;

Параметры

options: Office.AsyncContextOptions

callback: (asyncResult: Office.AsyncResult<Office.SharedProperties>) => void

После завершения метода функция, переданная в callback параметре, вызывается с одним параметром Office.AsyncResult , asyncResultкоторый является объектом . Свойство asyncResult.value предоставляет свойства общего элемента.

Возвращаемое значение

void

getSharedPropertiesAsync(callback)

Возвращает свойства встречи или сообщения в общей папке или общем почтовом ящике.

getSharedPropertiesAsync(callback: (asyncResult: Office.AsyncResult<SharedProperties>) => void): void;

Параметры

callback: (asyncResult: Office.AsyncResult<Office.SharedProperties>) => void

Возвращаемое значение

void

loadCustomPropertiesAsync(callback, userContext)

Асинхронно загружает настраиваемые свойства для надстройки для выбранного элемента.

Пользовательские свойства хранятся в виде пар "ключ-значение" для каждого приложения и каждого элемента. Этот метод возвращает объект CustomProperties в обратном вызове, который предоставляет методы для доступа к пользовательским свойствам, характерным для текущего элемента и текущей надстройки. Пользовательские свойства не шифруются в элементе, поэтому их не следует использовать в качестве безопасного хранилища.

Настраиваемые свойства предоставляются в виде объекта CustomProperties в свойстве asyncResult.value. Этот объект можно использовать для получения пользовательских свойств из почтового элемента.

loadCustomPropertiesAsync(callback: (asyncResult: Office.AsyncResult<CustomProperties>) => void, userContext?: any): void;

Параметры

callback: (asyncResult: Office.AsyncResult<Office.CustomProperties>) => void

После завершения метода функция, переданная в callback параметре, вызывается с одним параметром типа Office.AsyncResult.

userContext: any

Необязательный параметр. Разработчики могут указать любой объект, к которому необходимо получить доступ, в функции обратного вызова. Доступ к этому объекту можно получить с помощью свойства asyncResult.asyncContext в функции обратного вызова.

Возвращаемое значение

void

unloadAsync(options, callback)

При выборе нескольких почтовых элементов закрывает текущий загруженный элемент, чтобы можно было загрузить другой выбранный почтовый элемент для обработки.

unloadAsync(options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult<void>) => void): void;

Параметры

options: Office.AsyncContextOptions

Литерал объекта, содержащий asyncContext свойство . Назначьте свойству любой объект, к которому вы хотите получить доступ в функции обратного asyncContext вызова.

callback: (asyncResult: Office.AsyncResult<void>) => void

Необязательный параметр. После завершения метода функция, переданная в параметре обратного вызова, вызывается с одним параметром Office.AsyncResult , asyncResultкоторый является объектом .

Возвращаемое значение

void

Дополнительные сведения об обработке нескольких выбранных сообщений см. в статье Активация надстройки Outlook для нескольких сообщений.
При загрузке выбранного почтового элемента с помощью loadItemByIdAsyncнеобходимо вызвать unloadAsync после обработки. Это необходимо сделать перед вызовом loadItemByIdAsync другого выбранного элемента.

unloadAsync(callback)

unloadAsync(callback?: (asyncResult: Office.AsyncResult<void>) => void): void;

Параметры

callback: (asyncResult: Office.AsyncResult<void>) => void

Возвращаемое значение

void

Дополнительные сведения об обработке нескольких выбранных сообщений см. в статье Активация надстройки Outlook для нескольких сообщений.
При загрузке выбранного почтового элемента с помощью loadItemByIdAsyncнеобходимо вызвать unloadAsync после обработки. Это необходимо сделать перед вызовом loadItemByIdAsync другого выбранного элемента.

Обратная связь

Была ли эта страница полезна?

Поделиться через

Office.LoadedMessageRead interface

Комментарии

Примеры

Свойства

Методы

Сведения о свойстве

attachments

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

Комментарии

body

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

Комментарии

categories

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

Комментарии

cc

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

Комментарии

conversationId

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

Комментарии

dateTimeCreated

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

Комментарии

dateTimeModified

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

Комментарии

end

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

Комментарии

from

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

Комментарии

internetMessageId

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

Комментарии

itemClass

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

Комментарии

itemId

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

Комментарии

itemType

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

Комментарии

location

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

Комментарии

normalizedSubject

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

Комментарии

notificationMessages

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

Комментарии

recurrence

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

Комментарии

sender

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

Комментарии

seriesId

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

Комментарии

start

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

Комментарии

subject

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

Комментарии

to

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

Комментарии

Сведения о методе

displayReplyAllFormAsync(formData, options, callback)

Параметры

Возвращаемое значение

Комментарии

displayReplyAllFormAsync(formData, callback)

Параметры