Office.LoadedMessageRead interface
Представляет сообщение в режиме чтения, которое загружено в данный момент. Объект LoadedMessageRead возвращается при Office.context.mailbox.loadItemByIdAsync вызове сообщения в режиме чтения.
Комментарии
Минимальный уровень разрешений: элемент для чтения и записи
Применимый режим Outlook: чтение сообщения
Важно!
При реализации функции множественного выбора элемента определите, можно ли уже получить доступ к необходимым свойствам выбранного элемента с помощью
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 | Получает получателей в строке "Копия " сообщения. Свойство
|
| conversation |
Получает идентификатор разговора по электронной почте, содержащего конкретное сообщение. Вы можете получить целочисленное значение этого свойства, если ваше почтовое приложение активируется в формах просмотра или формах создания ответов. Если пользователь изменит тему ответа, после его отправки идентификатор беседы будет изменен, и полученное ранее значение будет недействительным. |
| date |
Получает дату и время создания элемента. |
| date |
Получает дату и время последнего изменения элемента. |
| end | Получает дату и время окончания встречи. Это Если вы задаете время окончания с помощью метода |
| from | Получает электронный адрес отправителя сообщения. Свойство |
| internet |
Получает идентификатор интернет-сообщения сообщения. |
| item |
Получает класс элемента веб-служб Exchange для выбранного сообщения. |
| item |
Получает идентификатор элемента веб-служб Exchange для текущего элемента. |
| item |
Получает тип элемента, который представляет экземпляр. Свойство |
| location | Получает расположение приглашения на собрание. Свойство |
| normalized |
Получает тему элемента с удалением всех префиксов (включая RE: и FWD:). Свойство |
| notification |
Получает уведомления об элементе. |
| recurrence | Получает схему повторения встречи. Получает шаблон повторения приглашения на собрание. Режимы чтения и создания для элементов встречи. Режим чтения для элементов приглашения на собрание. Свойство |
| sender | Получает электронный адрес отправителя электронного сообщения. |
| series |
Получает идентификатор ряда, к которому принадлежит экземпляр. В Outlook в Интернете и в Windows (новой и классической) возвращается |
| start | Получает дату и время начала встречи. Это |
| subject | Получает описание, отображаемое в поле темы элемента. Свойство Свойство |
| to | Получение получателей в строке "Кому " сообщения. Предоставляет доступ к получателям, указанным в строке Кому сообщения. Тип объекта и уровень доступа зависят от режима текущего элемента. Свойство
|
Методы
| display |
Отображает форму ответа, в которой указаны либо отправитель и все получатели выбранного сообщения, либо организатор и все участники выбранной встречи. |
| display |
Отображает форму ответа, в которой указаны либо отправитель и все получатели выбранного сообщения, либо организатор и все участники выбранной встречи. |
| display |
Отображает форму ответа, включающую только отправителя выбранного сообщения или организатора выбранной встречи. |
| display |
Отображает форму ответа, включающую только отправителя выбранного сообщения или организатора выбранной встречи. |
| get |
Получает все интернет-заголовки для сообщения в виде строки. Дополнительные сведения см. в статье Создание и настройка интернет-заголовков в сообщении в надстройке Outlook. |
| get |
Получает все интернет-заголовки для сообщения в виде строки. Дополнительные сведения см. в статье Создание и настройка интернет-заголовков в сообщении в надстройке Outlook. |
| get |
Получает текущее сообщение в формате EML в кодировке Base64. |
| get |
Получает текущее сообщение в формате EML в кодировке Base64. |
| get |
Получает вложение из сообщения или встречи и возвращает его как |
| get |
Получает вложение из сообщения или встречи и возвращает его как |
| get |
Получает данные инициализации, передаваемые при активации надстройки с помощью интерактивного сообщения. |
| get |
Получает данные инициализации, передаваемые при активации надстройки с помощью интерактивного сообщения. |
| get |
Возвращает строковые значения в выбранном элементе, соответствующие регулярным выражениям, определенным в XML-файле манифеста. |
| get |
Возвращает строковые значения в выбранном элементе, соответствующие именованному регулярному выражению, определенному в XML-файле манифеста. |
| get |
Возвращает строковые значения с выделенным соответствием, соответствующие регулярным выражениям, определенным в XML-файле манифеста. Выделенные совпадения применяются к контекстным надстройкам. |
| get |
Получает свойства встречи или сообщения в общей папке или общем почтовом ящике. Дополнительные сведения об использовании этого API см. в статье "Включение общих папок и сценариев почтовых ящиков в надстройке Outlook". |
| get |
Получает свойства встречи или сообщения в общей папке или общем почтовом ящике. Дополнительные сведения об использовании этого API см. в статье "Включение общих папок и сценариев почтовых ящиков в надстройке Outlook". |
| load |
Асинхронно загружает настраиваемые свойства для надстройки для выбранного элемента. Настраиваемые свойства хранятся в виде пар "ключ-значение" для каждого приложения и элемента. Этот метод возвращает объект CustomProperties в обратном вызове, который предоставляет методы для доступа к настраиваемым свойствам, относящимся к текущему элементу и текущей надстройке. Пользовательские свойства элемента не зашифрованы, поэтому его не следует использовать в качестве безопасного хранилища. Настраиваемые свойства предоставляются в виде объекта |
| unload |
Если выбрано несколько почтовых элементов, закрывает текущий загруженный элемент, чтобы можно было загрузить другой выбранный элемент почты для обработки. |
| unload |
Если выбрано несколько почтовых элементов, закрывает текущий загруженный элемент, чтобы можно было загрузить другой выбранный элемент почты для обработки. |
Сведения о свойстве
attachments
Получает вложения элемента в виде массива.
attachments: AttachmentDetails[];
Значение свойства
Комментарии
Минимальный уровень разрешений: чтение элемента
Применимый режим Outlook: чтение сообщения
Важно!
Outlook блокирует определенные типы файлов из-за потенциальных проблем с безопасностью, поэтому они не возвращаются. Дополнительные сведения см. в статье Блокировка вложений в Outlook.
Вложения, добавленные с помощью параметра "Отправка и общий доступ", не возвращаются.
body
Получает текст и формат элемента.
body: Body;
Значение свойства
Комментарии
Минимальный уровень разрешений: чтение элемента
Применимый режим Outlook: чтение сообщения
Важно: поддерживаются только getAsync методы и getTypeAsync объекта Body.
categories
Получает объект, предоставляющий методы для управления категориями элемента.
categories: Categories;
Значение свойства
Комментарии
Минимальный уровень разрешений: чтение элемента
Применимый режим Outlook: чтение сообщения
cc
Получает получателей в строке "Копия " сообщения.
Свойство cc возвращает массив, содержащий объект EmailAddressDetails для каждого получателя, указанного в строке "Копия " сообщения. Максимальное число возвращаемых получателей зависит от клиента Outlook.
Windows (классическая версия): 500 получателей
Windows (классическая версия — в предварительной версии, начиная с версии 2511 (сборка 19426.20000)): 1000 получателей
Веб-браузер, Windows (новый): 20 получателей (свернутое представление), 500 получателей (развернутое представление)
cc: EmailAddressDetails[];
Значение свойства
Комментарии
Минимальный уровень разрешений: чтение элемента
Применимый режим Outlook: чтение сообщения
conversationId
Получает идентификатор разговора по электронной почте, содержащего конкретное сообщение.
Вы можете получить целочисленное значение этого свойства, если ваше почтовое приложение активируется в формах просмотра или формах создания ответов. Если пользователь изменит тему ответа, после его отправки идентификатор беседы будет изменен, и полученное ранее значение будет недействительным.
conversationId: string;
Значение свойства
string
Комментарии
Минимальный уровень разрешений: чтение элемента
Применимый режим Outlook: чтение сообщения
dateTimeCreated
Получает дату и время создания элемента.
dateTimeCreated: Date;
Значение свойства
Date
Комментарии
Минимальный уровень разрешений: чтение элемента
Применимый режим Outlook: чтение сообщения
dateTimeModified
Получает дату и время последнего изменения элемента.
dateTimeModified: Date;
Значение свойства
Date
Комментарии
Минимальный уровень разрешений: чтение элемента
Применимый режим Outlook: Участник встречи
Важно! Это свойство не поддерживается в Outlook для Android или в iOS. Дополнительные сведения о поддерживаемых API в Outlook Mobile см. в статье API JavaScript Outlook, поддерживаемые Outlook на мобильных устройствах.
end
Получает дату и время окончания встречи.
Это end свойство представляет собой объект, Date выраженный в формате даты и времени в формате UTC. Метод можно использовать для convertToLocalClientTime преобразования end значения свойства в местную дату и время клиента.
Если вы задаете время окончания с помощью метода Time.setAsync, необходимо использовать метод convertToUtcClientTime для преобразования местного времени на клиенте в формат UTC для сервера.
end: Date;
Значение свойства
Date
Комментарии
Минимальный уровень разрешений: чтение элемента
Применимый режим Outlook: чтение сообщения
from
Получает электронный адрес отправителя сообщения.
Свойство fromEmailAddressDetails возвращает объект.
from: EmailAddressDetails;
Значение свойства
Комментарии
Минимальный уровень разрешений: чтение элемента
Применимый режим Outlook: чтение сообщения
Важно!
Свойства
fromandsenderпредставляют одного и того же пользователя, если только сообщение не отправлено делегатом с разрешениями " Отправить от имени ". В этом случае свойствоfromвозвращает адрес электронной почты владельца почтового ящика или общего почтового ящика, аsenderсвойство возвращает адрес делегата. Если у делегата есть разрешения " Отправить от имени " и "Отправить как ", применяется разрешение " Отправить как ". Сведения о делегировании почтовых ящиков см. в статье Управление разрешениями для получателей в Exchange Online.Свойство
recipientTypeEmailAddressDetailsобъекта в свойствеfromне определено.
internetMessageId
Получает идентификатор интернет-сообщения сообщения.
internetMessageId: string;
Значение свойства
string
Комментарии
Минимальный уровень разрешений: чтение элемента
Применимый режим Outlook: чтение сообщения
Важно! В папке "Отправленные " параметр internetMessageId для недавно отправленных элементов может быть еще недоступен. В этом случае рассмотрите возможность использования одного из следующих вариантов в зависимости от среды Exchange.
Для Exchange Online используйте Microsoft Graph, чтобы получить свойство internetMessageId.
Для Exchange Server (локального) используйте веб-службы Exchange для получения свойства InternetMessageId с сервера.
itemClass
Получает класс элемента веб-служб Exchange для выбранного сообщения.
itemClass: string;
Значение свойства
string
Комментарии
Минимальный уровень разрешений: чтение элемента
Применимый режим Outlook: чтение сообщения
Важно!
В следующей таблице перечислены классы элементов по умолчанию для сообщений.
| Класс элемента | Описание |
|---|---|
| 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
Комментарии
Минимальный уровень разрешений: чтение элемента
Применимый режим Outlook: чтение сообщения
Важно!
Свойство
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
Получает тип элемента, который представляет экземпляр.
Свойство itemTypeItemType возвращает одно из значений перечисления, указывающее, является ли экземпляр объекта элемента сообщением или встречей.
itemType: MailboxEnums.ItemType | string;
Значение свойства
Office.MailboxEnums.ItemType | string
Комментарии
Минимальный уровень разрешений: чтение элемента
Применимый режим Outlook: чтение сообщения
location
Получает расположение приглашения на собрание.
Свойство location возвращает строку, содержащую сведения о месте встречи.
location: string;
Значение свойства
string
Комментарии
Минимальный уровень разрешений: чтение элемента
Применимый режим Outlook: чтение сообщения
normalizedSubject
Получает тему элемента с удалением всех префиксов (включая RE: и FWD:).
Свойство normalizedSubject получает тему элемента с любыми стандартными префиксами (например, RE: и FW:), добавляемыми почтовыми программами. Для получения темы элемента с неизмененными префиксами используйте свойство subject.
normalizedSubject: string;
Значение свойства
string
Комментарии
Минимальный уровень разрешений: чтение элемента
Применимый режим Outlook: чтение сообщения
notificationMessages
Получает уведомления об элементе.
notificationMessages: NotificationMessages;
Значение свойства
Комментарии
Минимальный уровень разрешений: чтение элемента
Применимый режим Outlook: чтение сообщения
Важно!
Дополнительные сведения о различных типах уведомлений, которые можно реализовать, см. в статье "Создание уведомлений для надстройки Outlook".
Поддерживается только
getAllAsyncметод объекта NotificationMessages.
recurrence
Получает схему повторения встречи. Получает шаблон повторения приглашения на собрание. Режимы чтения и создания для элементов встречи. Режим чтения для элементов приглашения на собрание.
Свойство recurrenceRecurrence возвращает объект для повторяющихся встреч или приглашений на собрания, если элемент является рядом или экземпляром ряда.
null возвращается для отдельных встреч и приглашений на собрания отдельных встреч.
undefined возвращается для сообщений, которые не являются приглашениями на собрание.
recurrence: Recurrence;
Значение свойства
Комментарии
Минимальный уровень разрешений: чтение элемента
Применимый режим Outlook: чтение сообщения
Важно!
Приглашения на собрания имеют значение itemClass равным
IPM.Schedule.Meeting.Request.recurrenceЕсли объект имеет значение null, это означает, что объект является единственной встречей или приглашением на собрание одной встречи и не является частью ряда.Поддерживаются только петиции и
getAsyncметод объекта Recurrence.
sender
Получает электронный адрес отправителя электронного сообщения.
sender: EmailAddressDetails;
Значение свойства
Комментарии
Минимальный уровень разрешений: чтение элемента
Применимый режим Outlook: чтение сообщения
Важно!
Свойства
fromandsenderпредставляют одного и того же пользователя, если только сообщение не отправлено делегатом с разрешениями " Отправить от имени ". В этом случае свойствоfromвозвращает адрес электронной почты владельца почтового ящика или общего почтового ящика, аsenderсвойство возвращает адрес делегата. Если у делегата есть разрешения " Отправить от имени " и "Отправить как ", применяется разрешение " Отправить как ". Сведения о делегировании почтовых ящиков см. в статье Управление разрешениями для получателей в Exchange Online.Свойство
recipientTypeEmailAddressDetailsобъекта в свойствеsenderне определено.
seriesId
Получает идентификатор ряда, к которому принадлежит экземпляр.
В Outlook в Интернете и в Windows (новой и классической) возвращается seriesId идентификатор веб-служб Exchange (EWS) родительского элемента (серии), к которому принадлежит этот элемент.
seriesId: string;
Значение свойства
string
Комментарии
Минимальный уровень разрешений: чтение элемента
Применимый режим Outlook: чтение сообщения
Важно!
Идентификатор, возвращаемый свойством
seriesId, совпадает с идентификатором элемента веб-служб Exchange. ЭтоseriesIdсвойство не идентично идентификаторам Outlook, используемым REST API Outlook. Перед вызовами REST API с использованием этого значения его следует преобразовать с помощьюOffice.context.mailbox.convertToRestId. Дополнительные сведения см. в статье Использование Outlook REST API из надстройки Outlook.Свойство
seriesIdвозвращаетnullэлементы, которые не имеют родительских элементов, таких как отдельные встречи, элементы ряда или приглашения на собрания, и возвращаетundefinedвсе другие элементы, не являющиеся приглашениями на собрания.
start
Получает дату и время начала встречи.
Это start свойство представляет собой объект, Date выраженный в формате даты и времени в формате UTC. Метод можно использовать для convertToLocalClientTime преобразования значения в местную дату и время клиента.
start: Date;
Значение свойства
Date
Комментарии
Минимальный уровень разрешений: чтение элемента
Применимый режим Outlook: чтение сообщения
subject
Получает описание, отображаемое в поле темы элемента.
Свойство subject получает всю тему элемента, отправленную сервером электронной почты.
Свойство subject возвращает строку. Используйте свойство normalizedSubject , чтобы получить тему за вычетом любых начальных префиксов, таких как RE: и FW:.
subject: string;
Значение свойства
string
Комментарии
Минимальный уровень разрешений: чтение элемента
Применимый режим Outlook: чтение сообщения
to
Получение получателей в строке "Кому " сообщения. Предоставляет доступ к получателям, указанным в строке Кому сообщения. Тип объекта и уровень доступа зависят от режима текущего элемента.
Свойство to возвращает массив, содержащий объект EmailAddressDetails для каждого получателя, указанного в строке "Кому " сообщения. Максимальное число возвращаемых получателей зависит от клиента Outlook.
Windows (классическая версия): 500 получателей
Windows (классическая версия — в предварительной версии, начиная с версии 2511 (сборка 19426.20000)): 1000 получателей
Веб-браузер, Windows (новый): 20 получателей (свернутое представление), 500 получателей (развернутое представление)
to: EmailAddressDetails[];
Значение свойства
Комментарии
Минимальный уровень разрешений: чтение элемента
Применимый режим Outlook: чтение сообщения
Сведения о методе
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
Необязательный параметр. Когда метод завершается, функция, переданная в параметре callback , вызывается с единственным параметром, asyncResultкоторый является объектом Office.AsyncResult .
Возвращаемое значение
void
Комментарии
Минимальный уровень разрешений: чтение элемента
Применимый режим Outlook: чтение сообщения
Важно!
В Outlook в Интернете и новом Outlook для Windows форма ответа отображается как всплывающая форма в представлении с 3 столбцами и всплывающая форма в представлении с 2 или 1 столбцом.
Если любой строковый параметр превышает указанные для него ограничения,
displayReplyAllFormAsyncвозвращает исключение.Если в параметре
formData.attachmentsуказано вложение, Outlook пытается скачать все вложения и вложить их в форму ответа. Если какие-либо вложения добавить не удается, в форме отображается сообщение об ошибке. Если сообщения об ошибках не предусмотрены, то они не отображаются.
displayReplyAllFormAsync(formData, callback)
Отображает форму ответа, в которой указаны либо отправитель и все получатели выбранного сообщения, либо организатор и все участники выбранной встречи.
displayReplyAllFormAsync(formData: string | ReplyFormData, callback?: (asyncResult: Office.AsyncResult<void>) => void): void;
Параметры
- formData
-
string | Office.ReplyFormData
Строка, содержащая текст и HTML-код, представляющие собой основной текст формы ответа. Строка ограничена 32 КБ ИЛИ объектом ReplyFormData , который содержит данные текста или вложения и функцию обратного вызова.
- callback
-
(asyncResult: Office.AsyncResult<void>) => void
Необязательный параметр. Когда метод завершается, функция, переданная в параметре callback , вызывается с единственным параметром, asyncResultкоторый является объектом Office.AsyncResult .
Возвращаемое значение
void
Комментарии
Минимальный уровень разрешений: чтение элемента
Применимый режим Outlook: чтение сообщения
Важно!
В Outlook в Интернете и новом Outlook для Windows форма ответа отображается как всплывающая форма в представлении с 3 столбцами и всплывающая форма в представлении с 2 или 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
Строка, содержащая текст и HTML-код, представляющие собой основной текст формы ответа. Строка ограничена 32 КБ ИЛИ объектом ReplyFormData , который содержит данные текста или вложения и функцию обратного вызова.
- options
- Office.AsyncContextOptions
Объектный литерал, содержащий одно или несколько из следующих свойств:- asyncContext: Разработчики могут предоставить любой объект, к которому они хотят получить доступ, в функции обратного вызова.
- callback
-
(asyncResult: Office.AsyncResult<void>) => void
Необязательный параметр. Когда метод завершается, функция, переданная в параметре callback , вызывается с единственным параметром, asyncResultкоторый является объектом Office.AsyncResult .
Возвращаемое значение
void
Комментарии
Минимальный уровень разрешений: чтение элемента
Применимый режим Outlook: чтение сообщения
Важно!
В Outlook в Интернете и новом Outlook для Windows форма ответа отображается как всплывающая форма в представлении с 3 столбцами и всплывающая форма в представлении с 2 или 1 столбцом.
Если любой строковый параметр превышает указанные для него ограничения,
displayReplyFormAsyncвозвращает исключение.Если в параметре
formData.attachmentsуказано вложение, Outlook пытается скачать все вложения и вложить их в форму ответа. Если какие-либо вложения добавить не удается, в форме отображается сообщение об ошибке. Если сообщения об ошибках не предусмотрены, то они не отображаются.
displayReplyFormAsync(formData, callback)
Отображает форму ответа, включающую только отправителя выбранного сообщения или организатора выбранной встречи.
displayReplyFormAsync(formData: string | ReplyFormData, callback?: (asyncResult: Office.AsyncResult<void>) => void): void;
Параметры
- formData
-
string | Office.ReplyFormData
Строка, содержащая текст и HTML-код, представляющие собой основной текст формы ответа. Строка ограничена 32 КБ ИЛИ объектом ReplyFormData , который содержит данные текста или вложения и функцию обратного вызова.
- callback
-
(asyncResult: Office.AsyncResult<void>) => void
Необязательный параметр. Когда метод завершается, функция, переданная в параметре callback , вызывается с единственным параметром, asyncResultкоторый является объектом Office.AsyncResult .
Возвращаемое значение
void
Комментарии
Минимальный уровень разрешений: чтение элемента
Применимый режим Outlook: чтение сообщения
Важно!
В Outlook в Интернете и новом Outlook для Windows форма ответа отображается как всплывающая форма в представлении с 3 столбцами и всплывающая форма в представлении с 2 или 1 столбцом.
Если любой строковый параметр превышает указанные для него ограничения,
displayReplyFormAsyncвозвращает исключение.Если в параметре
formData.attachmentsуказано вложение, Outlook пытается скачать все вложения и вложить их в форму ответа. Если какие-либо вложения добавить не удается, в форме отображается сообщение об ошибке. Если сообщения об ошибках не предусмотрены, то они не отображаются.
getAllInternetHeadersAsync(options, callback)
Получает все интернет-заголовки для сообщения в виде строки.
Дополнительные сведения см. в статье Создание и настройка интернет-заголовков в сообщении в надстройке Outlook.
getAllInternetHeadersAsync(options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult<string>) => void): void;
Параметры
- options
- Office.AsyncContextOptions
Объектный литерал, содержащий одно или несколько из следующих свойств:- asyncContext: Разработчики могут предоставить любой объект, к которому они хотят получить доступ, в функции обратного вызова.
- callback
-
(asyncResult: Office.AsyncResult<string>) => void
Необязательный параметр. Когда метод завершается, функция, переданная в параметре callback , вызывается с единственным параметром, asyncResultкоторый является объектом Office.AsyncResult . При успешном выполнении данные интернет-заголовков предоставляются в свойстве asyncResult.value в виде строки. Сведения о форматировании возвращаемого строкового значения см. в RFC 2183 . Если вызов завершится с ошибкой, свойство asyncResult.error будет содержать код ошибки с указанием причины сбоя.
Возвращаемое значение
void
Комментарии
Минимальный уровень разрешений: чтение элемента
Применимый режим Outlook: чтение сообщения
getAllInternetHeadersAsync(callback)
Получает все интернет-заголовки для сообщения в виде строки.
Дополнительные сведения см. в статье Создание и настройка интернет-заголовков в сообщении в надстройке Outlook.
getAllInternetHeadersAsync(callback?: (asyncResult: Office.AsyncResult<string>) => void): void;
Параметры
- callback
-
(asyncResult: Office.AsyncResult<string>) => void
Необязательный параметр. Когда метод завершается, функция, переданная в параметре callback , вызывается с единственным параметром, asyncResultкоторый является объектом Office.AsyncResult . При успешном выполнении данные интернет-заголовков предоставляются в свойстве asyncResult.value в виде строки. Сведения о форматировании возвращаемого строкового значения см. в RFC 2183 . Если вызов завершится с ошибкой, свойство asyncResult.error будет содержать код ошибки с указанием причины сбоя.
Возвращаемое значение
void
Комментарии
Минимальный уровень разрешений: чтение элемента
Применимый режим Outlook: чтение сообщения
getAsFileAsync(options, callback)
Получает текущее сообщение в формате EML в кодировке Base64.
getAsFileAsync(options: Office.AsyncContextOptions, callback: (asyncResult: Office.AsyncResult<string>) => void): void;
Параметры
- options
- Office.AsyncContextOptions
Объектный литерал, содержащий одно или несколько из следующих свойств:- asyncContext: Разработчики могут предоставить любой объект, к которому они хотят получить доступ, в функции обратного вызова.
- callback
-
(asyncResult: Office.AsyncResult<string>) => void
Когда метод завершается, функция, переданная в параметре обратного вызова, вызывается с единственным параметром, asyncResultкоторый является объектом Office.AsyncResult . В свойстве asyncResult.value возвращается EML-формат сообщения в кодировке Base64. Все возникшие ошибки возвращаются в свойстве asyncResult.error .
Возвращаемое значение
void
Комментарии
Минимальный уровень разрешений: чтение элемента
Применимый режим Outlook: чтение сообщения
getAsFileAsync(callback)
Получает текущее сообщение в формате EML в кодировке Base64.
getAsFileAsync(callback: (asyncResult: Office.AsyncResult<string>) => void): void;
Параметры
- callback
-
(asyncResult: Office.AsyncResult<string>) => void
Когда метод завершается, функция, переданная в параметре обратного вызова, вызывается с единственным параметром, asyncResultкоторый является объектом Office.AsyncResult . В свойстве asyncResult.value возвращается EML-формат сообщения в кодировке Base64. Все возникшие ошибки возвращаются в свойстве asyncResult.error .
Возвращаемое значение
void
Комментарии
Минимальный уровень разрешений: чтение элемента
Применимый режим Outlook: чтение сообщения
getAttachmentContentAsync(attachmentId, options, callback)
Получает вложение из сообщения или встречи и возвращает его как AttachmentContent объект.
getAttachmentContentAsync(attachmentId: string, options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult<AttachmentContent>) => void): void;
Параметры
- attachmentId
-
string
Идентификатор вложения, которое нужно получить.
- options
- Office.AsyncContextOptions
Объектный литерал, содержащий одно или несколько из следующих свойств:- asyncContext: Разработчики могут предоставить любой объект, к которому они хотят получить доступ, в функции обратного вызова.
- callback
-
(asyncResult: Office.AsyncResult<Office.AttachmentContent>) => void
Необязательный параметр. Когда метод завершается, функция, переданная в параметре callback , вызывается с единственным параметром, asyncResultкоторый является объектом Office.AsyncResult . Если вызов завершится с ошибкой, свойство asyncResult.error будет содержать код ошибки с указанием причины сбоя.
Возвращаемое значение
void
Комментарии
Минимальный уровень разрешений: чтение элемента
Применимый режим Outlook: чтение сообщения
Важно!
Метод
getAttachmentContentAsyncполучает вложение с указанным идентификатором из элемента. Рекомендуется получить идентификатор вложения из вызова item.attachments , а затем в том же сеансе использовать этот идентификатор для извлечения вложения.В Outlook в Интернете и новом Outlook для Windows не поддерживает вложения,
getAttachmentContentAsyncдобавленные с помощью параметра "Отправка и общий доступ".В Outlook в Интернете, на мобильных устройствах и в новом Outlook для Windows идентификатор вложения действителен только в рамках одного сеанса. Сеанс завершается, когда пользователь закрывает приложение или если пользователь начинает создавать встроенную форму, а затем открывает форму, чтобы продолжить в отдельном окне.
Ошибки:
AttachmentTypeNotSupported: тип вложения не поддерживается. К неподдерживаемым типам относятся встроенные изображения в формате RTF или вложения элементов, отличные от элементов электронной почты или календаря (таких как контакт или задача).InvalidAttachmentId: идентификатор вложения не существует.
getAttachmentContentAsync(attachmentId, callback)
Получает вложение из сообщения или встречи и возвращает его как AttachmentContent объект.
getAttachmentContentAsync(attachmentId: string, callback?: (asyncResult: Office.AsyncResult<AttachmentContent>) => void): void;
Параметры
- attachmentId
-
string
Идентификатор вложения, которое нужно получить.
- callback
-
(asyncResult: Office.AsyncResult<Office.AttachmentContent>) => void
Необязательный параметр. Когда метод завершается, функция, переданная в параметре callback , вызывается с единственным параметром, asyncResultкоторый является объектом Office.AsyncResult . Если вызов завершится с ошибкой, свойство asyncResult.error будет содержать код ошибки с указанием причины сбоя.
Возвращаемое значение
void
Комментарии
Минимальный уровень разрешений: чтение элемента
Применимый режим Outlook: чтение сообщения
Важно!
Метод
getAttachmentContentAsyncполучает вложение с указанным идентификатором из элемента. Рекомендуется получить идентификатор вложения из вызова item.attachments , а затем в том же сеансе использовать этот идентификатор для извлечения вложения.В Outlook в Интернете и новом Outlook для Windows не поддерживает вложения,
getAttachmentContentAsyncдобавленные с помощью параметра "Отправка и общий доступ".В Outlook в Интернете, на мобильных устройствах и в новом Outlook для Windows идентификатор вложения действителен только в рамках одного сеанса. Сеанс завершается, когда пользователь закрывает приложение или если пользователь начинает создавать встроенную форму, а затем открывает форму, чтобы продолжить в отдельном окне.
Ошибки:
AttachmentTypeNotSupported: тип вложения не поддерживается. К неподдерживаемым типам относятся встроенные изображения в формате RTF или вложения элементов, отличные от элементов электронной почты или календаря (таких как контакт или задача).InvalidAttachmentId: идентификатор вложения не существует.
getInitializationContextAsync(options, callback)
Получает данные инициализации, передаваемые при активации надстройки с помощью интерактивного сообщения.
getInitializationContextAsync(options: Office.AsyncContextOptions, callback: (asyncResult: Office.AsyncResult<string>) => void): void;
Параметры
- options
- Office.AsyncContextOptions
Объектный литерал, содержащий одно или несколько из следующих свойств:- asyncContext: Разработчики могут предоставить любой объект, к которому они хотят получить доступ, в функции обратного вызова.
- callback
-
(asyncResult: Office.AsyncResult<string>) => void
После завершения метода вызывается функция, переданная в параметре callback , с одним параметром типа Office.AsyncResult. При успешном выполнении данные контекста инициализации предоставляются в виде строки (или пустой строки, если контекста инициализации нет) в свойстве asyncResult.value .
Возвращаемое значение
void
Комментарии
Минимальный уровень разрешений: чтение элемента
Применимый режим Outlook: чтение сообщения
getInitializationContextAsync(callback)
Получает данные инициализации, передаваемые при активации надстройки с помощью интерактивного сообщения.
getInitializationContextAsync(callback: (asyncResult: Office.AsyncResult<string>) => void): void;
Параметры
- callback
-
(asyncResult: Office.AsyncResult<string>) => void
После завершения метода вызывается функция, переданная в параметре callback , с одним параметром типа Office.AsyncResult. При успешном выполнении данные контекста инициализации предоставляются в виде строки (или пустой строки, если контекста инициализации нет) в свойстве asyncResult.value .
Возвращаемое значение
void
Комментарии
Минимальный уровень разрешений: чтение элемента
Применимый режим Outlook: чтение сообщения
getRegExMatches()
Возвращает строковые значения в выбранном элементе, соответствующие регулярным выражениям, определенным в XML-файле манифеста.
getRegExMatches(): any;
Возвращаемое значение
any
Объект, содержащий массив строк, которые соответствуют регулярным выражениям, определяемым в XML-файле манифеста. Имя каждого массива равно соответствующему значению атрибута RegExName правила сопоставления ItemHasRegularExpressionMatch или атрибута FilterName правила сопоставления ItemHasKnownEntity . Для правила ItemHasRegularExpressionMatch соответствующую строку должно содержать свойство элемента, указанного этим правилом. Простой тип PropertyName определяет поддерживаемые свойства.
Комментарии
Минимальный уровень разрешений: чтение элемента
Применимый режим Outlook: Участник встречи
Важно!
Контекстно-зависимые надстройки Outlook на основе сущностей теперь упразднены. Однако правила регулярных выражений по-прежнему поддерживаются. Мы рекомендуем обновить контекстную надстройку, чтобы использовать правила регулярных выражений в качестве альтернативного решения. Рекомендации по реализации этих правил см. в статье "Контекстные надстройки Outlook".
Этот метод используется с функцией правил активации для надстроек Outlook, которая не поддерживается единым манифестом для Microsoft 365.
Если задано
ItemHasRegularExpressionMatchправило для свойства текста элемента, регулярное выражение должно дополнительно фильтровать текст и не должно пытаться вернуть все тело элемента. Использование регулярных выражений,.*например для получения всего текста элемента, не всегда возвращает ожидаемые результаты. Лучше используйте методBody.getAsyncдля этого.
getRegExMatchesByName(name)
Возвращает строковые значения в выбранном элементе, соответствующие именованному регулярному выражению, определенному в XML-файле манифеста.
getRegExMatchesByName(name: string): string[];
Параметры
- name
-
string
Имя элемента правила ItemHasRegularExpressionMatch, определяющее соответствующий фильтр.
Возвращаемое значение
string[]
Массив, содержащий строки, соответствующие регулярному выражению, определенному в элементе ItemHasRegularExpressionMatch правила в XML-файле манифеста, с указанным RegExName значением элемента.
Комментарии
Минимальный уровень разрешений: чтение элемента
Применимый режим Outlook: Участник встречи
Важно!
Контекстно-зависимые надстройки Outlook на основе сущностей теперь упразднены. Однако правила регулярных выражений по-прежнему поддерживаются. Мы рекомендуем обновить контекстную надстройку, чтобы использовать правила регулярных выражений в качестве альтернативного решения. Рекомендации по реализации этих правил см. в статье "Контекстные надстройки Outlook".
Этот метод используется с функцией правил активации для надстроек Outlook, которая не поддерживается единым манифестом для Microsoft 365.
Если задано
ItemHasRegularExpressionMatchправило для свойства текста элемента, регулярное выражение должно дополнительно фильтровать текст и не должно пытаться вернуть все тело элемента. Использование регулярных выражений,.*например для получения всего текста элемента, не всегда возвращает ожидаемые результаты. Лучше используйте методBody.getAsyncдля этого.
getSelectedRegExMatches()
Возвращает строковые значения с выделенным соответствием, соответствующие регулярным выражениям, определенным в XML-файле манифеста. Выделенные совпадения применяются к контекстным надстройкам.
getSelectedRegExMatches(): any;
Возвращаемое значение
any
Объект, содержащий массив строк, которые соответствуют регулярным выражениям, определяемым в XML-файле манифеста. Имя каждого массива равно соответствующему значению атрибута RegExName подходящего правила ItemHasRegularExpressionMatch или атрибута FilterName соответствующего правила ItemHasKnownEntity. Для правила ItemHasRegularExpressionMatch соответствующую строку должно содержать свойство элемента, указанного этим правилом. Простой тип PropertyName определяет поддерживаемые свойства.
Комментарии
Минимальный уровень разрешений: чтение элемента
Применимый режим Outlook: чтение сообщения
Важно!
Контекстно-зависимые надстройки Outlook на основе сущностей теперь упразднены. Однако правила регулярных выражений по-прежнему поддерживаются. Мы рекомендуем обновить контекстную надстройку, чтобы использовать правила регулярных выражений в качестве альтернативного решения. Рекомендации по реализации этих правил см. в статье "Контекстные надстройки Outlook".
Этот метод используется с функцией правил активации для надстроек Outlook, которая не поддерживается единым манифестом для Microsoft 365.
Если задано
ItemHasRegularExpressionMatchправило для свойства текста элемента, регулярное выражение должно дополнительно фильтровать текст и не должно пытаться вернуть все тело элемента. Использование регулярного выражения, например .*, для получения всего текста элемента не всегда возвращает ожидаемые результаты. Лучше используйте методBody.getAsyncдля этого.
getSharedPropertiesAsync(options, callback)
Получает свойства встречи или сообщения в общей папке или общем почтовом ящике.
Дополнительные сведения об использовании этого API см. в статье "Включение общих папок и сценариев почтовых ящиков в надстройке Outlook".
getSharedPropertiesAsync(options: Office.AsyncContextOptions, callback: (asyncResult: Office.AsyncResult<SharedProperties>) => void): void;
Параметры
- options
- Office.AsyncContextOptions
Объектный литерал, содержащий одно или несколько из следующих свойств:- asyncContext: Разработчики могут предоставить любой объект, к которому они хотят получить доступ, в функции обратного вызова.
- callback
-
(asyncResult: Office.AsyncResult<Office.SharedProperties>) => void
Когда метод завершается, функция, переданная в параметре callback , вызывается с единственным параметром, asyncResultкоторый является объектом Office.AsyncResult . Свойство asyncResult.value предоставляет свойства общего элемента.
Возвращаемое значение
void
Комментарии
Минимальный уровень разрешений: чтение элемента
Применимый режим Outlook: чтение сообщения
getSharedPropertiesAsync(callback)
Получает свойства встречи или сообщения в общей папке или общем почтовом ящике.
Дополнительные сведения об использовании этого API см. в статье "Включение общих папок и сценариев почтовых ящиков в надстройке Outlook".
getSharedPropertiesAsync(callback: (asyncResult: Office.AsyncResult<SharedProperties>) => void): void;
Параметры
- callback
-
(asyncResult: Office.AsyncResult<Office.SharedProperties>) => void
Когда метод завершается, функция, переданная в параметре callback , вызывается с единственным параметром, asyncResultкоторый является объектом Office.AsyncResult . Свойство asyncResult.value предоставляет свойства общего элемента.
Возвращаемое значение
void
Комментарии
Минимальный уровень разрешений: чтение элемента
Применимый режим Outlook: чтение сообщения
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
Комментарии
Дополнительные сведения о настраиваемых свойствах см. в статье Получение и настройка метаданных надстройки для надстройки Outlook.
Минимальный уровень разрешений: чтение элемента
Применимый режим Outlook: чтение сообщения
Важно! Поддерживаются только get методы и getAll объекта CustomProperties.
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
Необязательный параметр. Когда метод завершается, функция, переданная в параметре обратного вызова, вызывается с единственным параметром, asyncResultкоторый является объектом Office.AsyncResult .
Возвращаемое значение
void
Комментарии
Минимальный уровень разрешений: элемент для чтения и записи
Применимый режим Outlook: Compose сообщений
Важно!
Дополнительные сведения об обработке нескольких выбранных сообщений см. в статье "Активация надстройки Outlook для нескольких сообщений".
Когда выбранный элемент почты загружается с помощью
loadItemByIdAsync, необходимо вызватьunloadAsyncего после обработки. Это необходимо сделать перед вызовомloadItemByIdAsyncдругого выбранного элемента.
unloadAsync(callback)
Если выбрано несколько почтовых элементов, закрывает текущий загруженный элемент, чтобы можно было загрузить другой выбранный элемент почты для обработки.
unloadAsync(callback?: (asyncResult: Office.AsyncResult<void>) => void): void;
Параметры
- callback
-
(asyncResult: Office.AsyncResult<void>) => void
Необязательный параметр. Когда метод завершается, функция, переданная в параметре обратного вызова, вызывается с единственным параметром, asyncResultкоторый является объектом Office.AsyncResult .
Возвращаемое значение
void
Комментарии
Минимальный уровень разрешений: элемент для чтения и записи
Применимый режим Outlook: Compose сообщений
Важно!
Дополнительные сведения об обработке нескольких выбранных сообщений см. в статье "Активация надстройки Outlook для нескольких сообщений".
Когда выбранный элемент почты загружается с помощью
loadItemByIdAsync, необходимо вызватьunloadAsyncего после обработки. Это необходимо сделать перед вызовомloadItemByIdAsyncдругого выбранного элемента.