Office.LoadedMessageCompose interface

Пакет:

outlook

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

Комментарии

Набор API: Почтовый ящик 1.15

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

Применимый режим Outlook: Compose сообщений

Важно!

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

• За один раз можно загрузить только один элемент почты. Когда вы реализуете loadItemByIdAsync, необходимо вызвать unloadAsync после обработки элемента. Это необходимо сделать перед вызовом loadItemByIdAsync другого предмета.

Используется

• Office.Mailbox: 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();
            });
        });
    });
}

Свойства

bcc	Получает получателей в строке скрытой копии сообщения.
body	Получает текст и формат элемента.
categories	Получает объект, предоставляющий методы для управления категориями элемента.
cc	Получает получателей в строке "Копия " сообщения.
conversationId	Получает идентификатор разговора по электронной почте, содержащего конкретное сообщение. Вы можете получить целочисленное значение этого свойства, если ваше почтовое приложение активируется в формах просмотра или формах создания ответов. Если пользователь изменит тему ответа, после его отправки идентификатор беседы будет изменен, и полученное ранее значение будет недействительным. Это свойство имеет значение NULL для нового элемента в форме создания.
delayDeliveryTime	Получает отложенную дату и время доставки сообщения.
from	Получает электронный адрес отправителя сообщения.
inReplyTo	Получает идентификатор исходного сообщения, на которое отвечает текущее сообщение.
internetHeaders	Получает настраиваемые интернет-заголовки сообщения. Дополнительные сведения см. в статье Создание и настройка интернет-заголовков в сообщении в надстройке Outlook.
itemType	Получает тип элемента, который представляет экземпляр. Свойство itemTypeItemType возвращает одно из значений перечисления, указывающее, является ли экземпляр объекта элемента сообщением или встречей.
notificationMessages	Получает уведомления об элементе.
sensitivityLabel	Получает метку конфиденциальности сообщения.
seriesId	Получает идентификатор ряда, к которому принадлежит экземпляр. В Outlook в Интернете и в Windows (новой и классической) возвращается seriesId идентификатор веб-служб Exchange (EWS) родительского элемента (серии), к которому принадлежит этот элемент.
subject	Получает описание, отображаемое в поле темы элемента. Свойство subject получает всю тему элемента, отправленную сервером электронной почты.
to	Получение получателей в строке "Кому " сообщения. Предоставляет доступ к получателям, указанным в строке Кому сообщения. Тип объекта и уровень доступа зависят от режима текущего элемента.

Методы

getAttachmentContentAsync(attachmentId, options, callback)	Получает вложение из сообщения или встречи и возвращает его как AttachmentContent объект.
getAttachmentContentAsync(attachmentId, callback)	Получает вложение из сообщения или встречи и возвращает его как AttachmentContent объект.
getAttachmentsAsync(options, callback)	Получает вложения элемента в виде массива.
getAttachmentsAsync(callback)	Получает вложения элемента в виде массива.
getComposeTypeAsync(options, callback)	Определяет тип создаваемого сообщения и тип приведения. Сообщение может быть новым, ответным или пересланным. Типом приведения может быть HTML или обычный текст.
getComposeTypeAsync(callback)	Определяет тип создаваемого сообщения и тип приведения. Сообщение может быть новым, ответным или пересланным. Типом приведения может быть HTML или обычный текст.
getConversationIndexAsync(options, callback)	Получает позицию текущего сообщения в цепочке беседы в кодировке Base64.
getConversationIndexAsync(callback)	Получает позицию текущего сообщения в цепочке беседы в кодировке Base64.
getInitializationContextAsync(options, callback)	Получает данные инициализации, передаваемые при активации надстройки с помощью интерактивного сообщения.
getInitializationContextAsync(callback)	Получает данные инициализации, передаваемые при активации надстройки с помощью интерактивного сообщения.
getItemClassAsync(options, callback)	Получает класс элемента веб-служб Exchange для выбранного сообщения.
getItemClassAsync(callback)	Получает класс элемента веб-служб Exchange для выбранного сообщения.
getItemIdAsync(options, callback)	Асинхронно получает идентификатор элемента веб-служб Exchange (EWS) сохраненного элемента. При вызове этот метод возвращает идентификатор элемента с помощью функции обратного вызова.
getItemIdAsync(callback)	Асинхронно получает идентификатор сохраненного элемента. При вызове этот метод возвращает идентификатор элемента с помощью функции обратного вызова. Примечание. Если надстройка вызывает getItemIdAsync элемент в режиме создания (например, чтобы использовать его itemId с EWS или REST API), имейте в виду, что когда Outlook находится в режиме кэширования, может потребоваться некоторое время для синхронизации элемента с сервером. Пока элемент не будет синхронизирован, он itemId не будет распознан и его использование вернет ошибку.
getSharedPropertiesAsync(options, callback)	Получает свойства встречи или сообщения в общей папке или общем почтовом ящике. Дополнительные сведения об использовании этого API см. в статье "Включение общих папок и сценариев почтовых ящиков в надстройке Outlook".
getSharedPropertiesAsync(callback)	Получает свойства встречи или сообщения в общей папке или общем почтовом ящике. Дополнительные сведения об использовании этого API см. в статье "Включение общих папок и сценариев почтовых ящиков в надстройке Outlook".
isClientSignatureEnabledAsync(options, callback)	Получает включенную сигнатуру клиента. В Outlook для Windows (классическая версия) вызов API возвращается true , если в качестве подписи по умолчанию для новых сообщений, ответов или пересылаемых сообщений задан шаблон для отправляющей учетной записи Outlook. В Outlook в Интернете и новом Outlook в Windows вызов API возвращаетсяtrue, включена ли подпись для типовnewMail создания ,reply или .forward Если в Outlook для Windows (классическая версия) задано значение "(нет)" или они отключены в Outlook в Интернете или новой версии Outlook для Windows, вызов API возвращаетсяfalse.
isClientSignatureEnabledAsync(callback)	Получает включенную сигнатуру клиента. В Outlook для Windows (классическая версия) вызов API возвращается true , если в качестве подписи по умолчанию для новых сообщений, ответов или пересылаемых сообщений задан шаблон для отправляющей учетной записи Outlook. В Outlook в Интернете и новом Outlook в Windows вызов API возвращаетсяtrue, включена ли подпись для типовnewMail создания ,reply или .forward Если в Outlook для Windows (классическая версия) задано значение "(нет)" или они отключены в Outlook в Интернете или новой версии Outlook для Windows, вызов API возвращаетсяfalse.
loadCustomPropertiesAsync(callback, userContext)	Асинхронно загружает настраиваемые свойства для надстройки для выбранного элемента. Настраиваемые свойства хранятся в виде пар "ключ-значение" для каждого приложения и элемента. Этот метод возвращает объект CustomProperties в обратном вызове, который предоставляет методы для доступа к настраиваемым свойствам, относящимся к текущему элементу и текущей надстройке. Пользовательские свойства элемента не зашифрованы, поэтому его не следует использовать в качестве безопасного хранилища. Настраиваемые свойства предоставляются в виде объекта CustomProperties в свойстве asyncResult.value. Этот объект можно использовать для получения настраиваемых свойств элемента почты.
saveAsync(options, callback)	Асинхронно сохраняет текущее сообщение как черновик.
saveAsync(callback)	Асинхронно сохраняет текущее сообщение как черновик.
unloadAsync(options, callback)	Если выбрано несколько почтовых элементов, закрывает текущий загруженный элемент, чтобы можно было загрузить другой выбранный элемент почты для обработки.
unloadAsync(callback)	Если выбрано несколько почтовых элементов, закрывает текущий загруженный элемент, чтобы можно было загрузить другой выбранный элемент почты для обработки.

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

bcc

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

bcc: Recipients;

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

Office.Recipients

Комментарии

Набор API: Почтовый ящик 1.1

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

Применимый режим Outlook: Compose сообщений

Важно!

• Поддерживается только getAsync метод объекта Recipients.

• В зависимости от клиента и платформы Outlook могут применяться ограничения на количество получателей. Дополнительные сведения см. в объекте Recipients .

body

Получает текст и формат элемента.

body: Body;

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

Office.Body

Комментарии

Набор API: Почтовый ящик 1.1

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

Применимый режим Outlook: Compose сообщений

Важно: поддерживаются только getAsync методы и getTypeAsync объекта Body.

categories

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

categories: Categories;

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

Office.Categories

Комментарии

Набор API: Почтовый ящик 1.8

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

Применимый режим Outlook: Compose сообщений

cc

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

cc: Recipients;

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

Office.Recipients

Комментарии

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

Применимый режим Outlook: Compose сообщений

Важно!

• Поддерживается только getAsync метод объекта Recipients.

• В зависимости от клиента и платформы Outlook могут применяться ограничения на количество получателей. Дополнительные сведения см. в объекте Recipients .

conversationId

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

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

Это свойство имеет значение NULL для нового элемента в форме создания.

conversationId: string;

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

string

Комментарии

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

Применимый режим Outlook: Compose сообщений

delayDeliveryTime

Получает отложенную дату и время доставки сообщения.

delayDeliveryTime: DelayDeliveryTime;

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

Office.DelayDeliveryTime

Комментарии

Набор API: почтовый ящик 1.13

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

Применимый режим Outlook: Compose сообщений

Важно! Поддерживается только getAsync метод объекта DelayDeliveryTime.

from

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

from: From;

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

Office.From

Комментарии

Набор API: Почтовый ящик 1.7

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

Применимый режим Outlook: Compose сообщений

inReplyTo

Получает идентификатор исходного сообщения, на которое отвечает текущее сообщение.

inReplyTo: string;

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

string

Комментарии

Набор API: почтовый ящик 1.14

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

Применимый режим Outlook: Compose сообщений

Важно!

• В Outlook для Windows значение inReplyTo сохраняется во всех ответах независимо от изменений, внесенных пользователем, например изменения темы в ответе.

• Свойство inReplyTo возвращает null новые сообщения и приглашения на собрания, пересылаемые пользователем, который также является организатором собрания.

internetHeaders

Получает настраиваемые интернет-заголовки сообщения.

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

internetHeaders: InternetHeaders;

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

Office.InternetHeaders

Комментарии

Набор API: Почтовый ящик 1.8

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

Применимый режим Outlook: Compose сообщений

Важно: Поддерживается только getAsync метод объекта InternetHeaders.

itemType

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

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

itemType: MailboxEnums.ItemType | string;

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

Office.MailboxEnums.ItemType | string

Комментарии

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

Применимый режим Outlook: Compose сообщений

notificationMessages

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

notificationMessages: NotificationMessages;

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

Office.NotificationMessages

Комментарии

Набор API: Почтовый ящик 1.3

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

Применимый режим Outlook: Compose сообщений

Важно!

• Дополнительные сведения о различных типах уведомлений, которые можно реализовать, см. в статье "Создание уведомлений для надстройки Outlook".

• Поддерживается только getAllAsync метод объекта NotificationMessages.

sensitivityLabel

Получает метку конфиденциальности сообщения.

sensitivityLabel: SensitivityLabel;

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

Office.SensitivityLabel

Комментарии

Набор API: почтовый ящик 1.13

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

Применимый режим Outlook: Compose сообщений

Важно!

• Чтобы использовать функцию меток конфиденциальности в надстройке, необходима подписка на Microsoft 365 E5.

• Поддерживается только getAsync метод объекта SensitivityLabel.

Дополнительные сведения об управлении метками конфиденциальности в надстройке см. в разделе Управление меткой конфиденциальности сообщения или встречи в режиме создания.

seriesId

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

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

seriesId: string;

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

string

Комментарии

Набор API: Почтовый ящик 1.7

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

Применимый режим Outlook: Compose сообщений

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

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

subject

Получает описание, отображаемое в поле темы элемента.

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

subject: Subject;

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

Office.Subject

Комментарии

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

Применимый режим Outlook: Compose сообщений

Важно: Поддерживается только getAsync метод объекта Subject.

to

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

to: Recipients;

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

Office.Recipients

Комментарии

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

Применимый режим Outlook: Compose сообщений

Важно!

• Поддерживается только getAsync метод объекта Recipients.

• В зависимости от клиента и платформы Outlook могут применяться ограничения на количество получателей. Дополнительные сведения см. в объекте Recipients .

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

getAttachmentContentAsync(attachmentId, options, callback)

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

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

Параметры

attachmentId

string

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

options

Office.AsyncContextOptions

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

callback

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

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

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

void

Комментарии

Набор API: Почтовый ящик 1.8

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

Применимый режим Outlook: Compose сообщений

Важно!

• Метод getAttachmentContentAsync получает вложение с указанным идентификатором из элемента. Рекомендуется получить идентификатор вложения из getAttachmentsAsync вызова, а затем в том же сеансе использовать этот идентификатор для извлечения вложения.

• Начиная с 30 марта 2026 г. после завершения вызова addFileAttachmentAsyncaddFileAttachmentFromBase64AsyncisInlinetrue встроенным изображениям в сообщениях в Outlook в Интернете и новом Outlook для Windows локально назначается временный идентификатор вложения при их отправке на сервер. Временному идентификатору вложения предназначается префикс addinId. После отправки изображений на сервер им назначается идентификатор веб-служб Exchange (EWS). Идентификатор временного вложения поддерживается только в течение текущего сеанса создания сообщения. Дополнительные сведения об обработке встроенных изображений см. в статье Изменения идентификаторов вложений для встроенных изображений в надстройках Outlook.

• В 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

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

callback

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

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

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

void

Комментарии

Набор API: Почтовый ящик 1.8

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

Применимый режим Outlook: Compose сообщений

Важно!

• Метод getAttachmentContentAsync получает вложение с указанным идентификатором из элемента. Рекомендуется получить идентификатор вложения из getAttachmentsAsync вызова, а затем в том же сеансе использовать этот идентификатор для извлечения вложения.

• Начиная с 30 марта 2026 г. после завершения вызова addFileAttachmentAsyncaddFileAttachmentFromBase64AsyncisInlinetrue встроенным изображениям в сообщениях в Outlook в Интернете и новом Outlook для Windows локально назначается временный идентификатор вложения при их отправке на сервер. Временному идентификатору вложения предназначается префикс addinId. После отправки изображений на сервер им назначается идентификатор веб-служб Exchange (EWS). Идентификатор временного вложения поддерживается только в течение текущего сеанса создания сообщения. Дополнительные сведения об обработке встроенных изображений см. в статье Изменения идентификаторов вложений для встроенных изображений в надстройках Outlook.

• В Outlook в Интернете и новом Outlook для Windows не поддерживает вложения, getAttachmentContentAsync добавленные с помощью параметра "Отправка и общий доступ".

• В Outlook в Интернете, на мобильных устройствах и в новом Outlook для Windows идентификатор вложения действителен только в рамках одного сеанса. Сеанс завершается, когда пользователь закрывает приложение или если пользователь начинает создавать встроенную форму, а затем открывает форму, чтобы продолжить в отдельном окне.

Ошибки:

• AttachmentTypeNotSupported : тип вложения не поддерживается. К неподдерживаемым типам относятся встроенные изображения в формате RTF или вложения элементов, отличные от элементов электронной почты или календаря (таких как контакт или задача).

• InvalidAttachmentId : идентификатор вложения не существует.

getAttachmentsAsync(options, callback)

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

getAttachmentsAsync(options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult<AttachmentDetailsCompose[]>) => void): void;

Параметры

options

Office.AsyncContextOptions

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

callback

(asyncResult: Office.AsyncResult<Office.AttachmentDetailsCompose[]>) => void

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

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

void

Комментарии

Набор API: Почтовый ящик 1.8

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

Применимый режим Outlook: Compose сообщений

Важно!

• Начиная с 30 марта 2026 г. после завершения вызова addFileAttachmentAsyncaddFileAttachmentFromBase64AsyncisInlinetrue встроенным изображениям в сообщениях в Outlook в Интернете и новом Outlook для Windows локально назначается временный идентификатор вложения при их отправке на сервер. Временному идентификатору вложения предназначается префикс addinId. После отправки изображений на сервер им назначается идентификатор веб-служб Exchange (EWS). Идентификатор временного вложения поддерживается только в течение текущего сеанса создания сообщения. Дополнительные сведения об обработке встроенных изображений см. в статье Изменения идентификаторов вложений для встроенных изображений в надстройках Outlook.

• В Outlook в Интернете и в новой версии Outlook для Windows пользователи могут выбрать параметр «Отправка и общий доступ», чтобы отправить вложение в OneDrive и включить ссылку на файл в элемент письма. Однако, поскольку включена только ссылка, getAttachmentsAsync это вложение не возвращается.

getAttachmentsAsync(callback)

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

getAttachmentsAsync(callback?: (asyncResult: Office.AsyncResult<AttachmentDetailsCompose[]>) => void): void;

Параметры

callback

(asyncResult: Office.AsyncResult<Office.AttachmentDetailsCompose[]>) => void

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

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

void

Комментарии

Набор API: Почтовый ящик 1.8

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

Применимый режим Outlook: Compose сообщений

Важно!

• Начиная с 30 марта 2026 г. после завершения вызова addFileAttachmentAsyncaddFileAttachmentFromBase64AsyncisInlinetrue встроенным изображениям в сообщениях в Outlook в Интернете и новом Outlook для Windows локально назначается временный идентификатор вложения при их отправке на сервер. Временному идентификатору вложения предназначается префикс addinId. После отправки изображений на сервер им назначается идентификатор веб-служб Exchange (EWS). Идентификатор временного вложения поддерживается только в течение текущего сеанса создания сообщения. Дополнительные сведения об обработке встроенных изображений см. в статье Изменения идентификаторов вложений для встроенных изображений в надстройках Outlook.

• В Outlook в Интернете и в новой версии Outlook для Windows пользователи могут выбрать параметр «Отправка и общий доступ», чтобы отправить вложение в OneDrive и включить ссылку на файл в элемент письма. Однако, поскольку включена только ссылка, getAttachmentsAsync это вложение не возвращается.

getComposeTypeAsync(options, callback)

Определяет тип создаваемого сообщения и тип приведения. Сообщение может быть новым, ответным или пересланным. Типом приведения может быть HTML или обычный текст.

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

Параметры

options

Office.AsyncContextOptions

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

callback

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

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

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

void

Объект со ComposeType значениями и CoercionType перечислением для элемента сообщения.

Комментарии

Набор API: почтовый ящик 1.10

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

Применимый режим Outlook: Compose сообщений

getComposeTypeAsync(callback)

Определяет тип создаваемого сообщения и тип приведения. Сообщение может быть новым, ответным или пересланным. Типом приведения может быть HTML или обычный текст.

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

Параметры

callback

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

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

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

void

Объект со ComposeType значениями и CoercionType перечислением для элемента сообщения.

Комментарии

Набор API: почтовый ящик 1.10

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

Применимый режим Outlook: Compose сообщений

getConversationIndexAsync(options, callback)

Получает позицию текущего сообщения в цепочке беседы в кодировке Base64.

getConversationIndexAsync(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 возвращается позиция текущего сообщения в беседе в кодировке Base64.

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

void

Комментарии

Набор API: почтовый ящик 1.14

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

Применимый режим Outlook: Compose сообщений

Совет. Индекс беседы можно использовать для поиска сообщения в цепочке беседы. Затем используйте его содержимое, чтобы предоставить контекст для создаваемого сообщения.

getConversationIndexAsync(callback)

Получает позицию текущего сообщения в цепочке беседы в кодировке Base64.

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

Параметры

callback

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

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

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

void

Комментарии

Набор API: почтовый ящик 1.14

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

Применимый режим Outlook: Compose сообщений

Совет. Индекс беседы можно использовать для поиска сообщения в цепочке беседы. Затем используйте его содержимое, чтобы предоставить контекст для создаваемого сообщения.

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

Комментарии

Набор API: Почтовый ящик 1.8

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

Применимый режим Outlook: Compose сообщений

getInitializationContextAsync(callback)

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

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

Параметры

callback

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

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

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

void

Комментарии

Набор API: Почтовый ящик 1.8

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

Применимый режим Outlook: Compose сообщений

getItemClassAsync(options, callback)

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

getItemClassAsync(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

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

void

Комментарии

Набор API: почтовый ящик 1.14

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

Применимый режим Outlook: Compose сообщений

Важно!

В следующей таблице перечислены классы сообщений по умолчанию.

Класс элемента	Описание
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	Предварительное принятие приглашений на собрания

getItemClassAsync(callback)

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

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

Параметры

callback

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

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

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

void

Комментарии

Набор API: почтовый ящик 1.14

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

Применимый режим Outlook: Compose сообщений

Важно!

В следующей таблице перечислены классы сообщений по умолчанию.

Класс элемента	Описание
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	Предварительное принятие приглашений на собрания

getItemIdAsync(options, callback)

Асинхронно получает идентификатор элемента веб-служб Exchange (EWS) сохраненного элемента.

При вызове этот метод возвращает идентификатор элемента с помощью функции обратного вызова.

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

Параметры

options

Office.AsyncContextOptions

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

callback

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

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

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

void

Комментарии

Набор API: Почтовый ящик 1.8

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

Применимый режим Outlook: Compose сообщений

Важно!

• Возвращаемый идентификатор элемента не идентичен идентификатору записи Outlook или идентификатору, используемому REST API Outlook. Перед вызовами REST API с использованием этого значения его следует преобразовать с помощью Office.context.mailbox.convertToRestId.

• Если надстройка вызывает getItemIdAsync элемент в режиме создания (например, чтобы использовать itemId его с EWS или REST API), имейте в виду, что когда Outlook находится в режиме кэширования, может потребоваться некоторое время для синхронизации элемента с сервером. Пока элемент не будет синхронизирован, он itemId не будет распознан и его использование вернет ошибку.

Ошибки:

• ItemNotSaved : идентификатор нельзя получить, пока элемент не сохранен.

getItemIdAsync(callback)

Асинхронно получает идентификатор сохраненного элемента.

При вызове этот метод возвращает идентификатор элемента с помощью функции обратного вызова.

Примечание. Если надстройка вызывает getItemIdAsync элемент в режиме создания (например, чтобы использовать его itemId с EWS или REST API), имейте в виду, что когда Outlook находится в режиме кэширования, может потребоваться некоторое время для синхронизации элемента с сервером. Пока элемент не будет синхронизирован, он itemId не будет распознан и его использование вернет ошибку.

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

Параметры

callback

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

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

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

void

Комментарии

Набор API: Почтовый ящик 1.8

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

Применимый режим Outlook: Compose сообщений

Ошибки:

• ItemNotSaved : идентификатор нельзя получить, пока элемент не сохранен.

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

Комментарии

Набор API: почтовый ящик 1.8 для поддержки общих папок, почтовый ящик 1.13 для поддержки общих почтовых ящиков

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

Применимый режим Outlook: Compose сообщений

Важно! В режиме Compose сообщений этот API не поддерживается в Outlook в Интернете и в Windows (новой и классической версиях), если не выполнены следующие условия.

А. Делегирование доступа и общие папки

1. Владелец почтового ящика начинает писать сообщения. Это может быть новое сообщение, ответ или пересылка.

2. Они сохраняют сообщение, а затем перемещают его из своей папки "Черновики " в папку, к которой предоставлен общий доступ делегату.

3. Делегат открывает черновик из общей папки, а затем продолжает его создавать.

Б. Общий почтовый ящик, открытый на той же панели, что и основной почтовый ящик пользователя (веб-версия, классическая версия Windows) или общий почтовый ящик, который не был преобразован в полную учетную запись (новая Windows)

1. Пользователь общего почтового ящика пишет сообщение. Это может быть новое сообщение, ответ или пересылка.

2. Они сохраняют сообщение, а затем перемещают его из своей папки " Черновики " в папку общего почтового ящика.

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

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

Способ getSharedPropertiesAsync поддерживается на следующих платформах без дополнительных условий.

• Когда общий почтовый ящик открыт в отдельной вкладке или окне с помощью параметра "Открыть другой почтовый ящик", Outlook в Интернете.

• Новый Outlook в Windows, когда общий почтовый ящик повышен до полной учетной записи.

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

Комментарии

Набор API: почтовый ящик 1.8 для поддержки общих папок, почтовый ящик 1.13 для поддержки общих почтовых ящиков

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

Применимый режим Outlook: Compose сообщений

Важно! В режиме Compose сообщений этот API не поддерживается в Outlook в Интернете и в Windows (новой и классической версиях), если не выполнены следующие условия.

А. Делегирование доступа и общие папки

1. Владелец почтового ящика начинает писать сообщения. Это может быть новое сообщение, ответ или пересылка.

2. Они сохраняют сообщение, а затем перемещают его из своей папки "Черновики " в папку, к которой предоставлен общий доступ делегату.

3. Делегат открывает черновик из общей папки, а затем продолжает его создавать.

Б. Общий почтовый ящик, открытый на той же панели, что и основной почтовый ящик пользователя (веб-версия, классическая версия Windows) или общий почтовый ящик, который не был преобразован в полную учетную запись (новая Windows)

1. Пользователь общего почтового ящика пишет сообщение. Это может быть новое сообщение, ответ или пересылка.

2. Они сохраняют сообщение, а затем перемещают его из своей папки " Черновики " в папку общего почтового ящика.

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

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

Способ getSharedPropertiesAsync поддерживается на следующих платформах без дополнительных условий.

• Когда общий почтовый ящик открыт в отдельной вкладке или окне с помощью параметра "Открыть другой почтовый ящик", Outlook в Интернете.

• Новый Outlook в Windows, когда общий почтовый ящик повышен до полной учетной записи.

isClientSignatureEnabledAsync(options, callback)

Получает включенную сигнатуру клиента.

В Outlook для Windows (классическая версия) вызов API возвращается true , если в качестве подписи по умолчанию для новых сообщений, ответов или пересылаемых сообщений задан шаблон для отправляющей учетной записи Outlook. В Outlook в Интернете и новом Outlook в Windows вызов API возвращаетсяtrue, включена ли подпись для типовnewMail создания ,reply или .forward Если в Outlook для Windows (классическая версия) задано значение "(нет)" или они отключены в Outlook в Интернете или новой версии Outlook для Windows, вызов API возвращаетсяfalse.

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

Параметры

options

Office.AsyncContextOptions

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

callback

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

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

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

void

Комментарии

Набор API: почтовый ящик 1.10

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

Применимый режим Outlook: Compose сообщений

isClientSignatureEnabledAsync(callback)

Получает включенную сигнатуру клиента.

В Outlook для Windows (классическая версия) вызов API возвращается true , если в качестве подписи по умолчанию для новых сообщений, ответов или пересылаемых сообщений задан шаблон для отправляющей учетной записи Outlook. В Outlook в Интернете и новом Outlook в Windows вызов API возвращаетсяtrue, включена ли подпись для типовnewMail создания ,reply или .forward Если в Outlook для Windows (классическая версия) задано значение "(нет)" или они отключены в Outlook в Интернете или новой версии Outlook для Windows, вызов API возвращаетсяfalse.

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

Параметры

callback

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

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

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

void

Комментарии

Набор API: почтовый ящик 1.10

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

Применимый режим Outlook: Compose сообщений

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

Комментарии

Набор API: Почтовый ящик 1.1

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

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

Применимый режим Outlook: Compose сообщений

saveAsync(options, callback)

Асинхронно сохраняет текущее сообщение как черновик.

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

Параметры

options

Office.AsyncContextOptions

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

callback

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

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

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

void

Комментарии

Набор API: Почтовый ящик 1.3

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

Применимый режим Outlook: Compose сообщений

Важно!

• В Outlook в Интернете, новом Outlook для Windows или классическом Outlook в Windows в сетевом режиме (без кэширования) элемент сохраняется на сервере. В Outlook в режиме кэширования этот элемент сохраняется в локальном кэше.

• При работе с содержимым в формате HTML важно учитывать, что клиент Outlook может изменять содержимое. Это означает, что последующие вызовы таких методов, как Body.getAsync, Body.setAsync, и даже saveAsync могут не приводить к тому же содержимому.

• Возвращаемый идентификатор совпадает с идентификатором элемента веб-служб Exchange (EWS). Возвращаемый идентификатор элемента не идентичен идентификатору записи Outlook или идентификатору, используемому REST API Outlook. Перед вызовами REST API с использованием этого значения его следует преобразовать с помощью Office.context.mailbox.convertToRestId.

• Если надстройка вызывает saveAsync элемент в режиме создания, чтобы получить идентификатор элемента для использования с EWS или REST API, имейте в виду, что когда Outlook находится в режиме кэширования, может потребоваться некоторое время для фактической синхронизации элемента с сервером. Пока элемент не будет синхронизирован, использование кода элемента будет возвращать ошибку.

• В Outlook в Интернете и новом Outlook для Windows учетная запись почтового ящика, в которую сохраняется черновик, зависит от saveAsync вызова в сообщении, отправляемом из общей учетной записи почтового ящика. Если отправитель создает новое сообщение из своего личного почтового ящика и выбирает учетную запись общего почтового ящика в поле "От ", saveAsync черновик сохраняется в папке "Черновики " личного почтового ящика пользователя. Если отправитель открывает учетную запись общего почтового ящика в отдельной вкладке браузера (например, с помощью параметра " Открыть другой почтовый ящик ") и создает там новое сообщение, saveAsync сохраняет черновик в папке "Черновики " общего почтового ящика.

Ошибки:

• InvalidAttachmentId : идентификатор вложения не существует.

saveAsync(callback)

Асинхронно сохраняет текущее сообщение как черновик.

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

Параметры

callback

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

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

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

void

Комментарии

Набор API: Почтовый ящик 1.3

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

Применимый режим Outlook: Compose сообщений

Важно!

• В Outlook в Интернете, новом Outlook для Windows или классическом Outlook в Windows в сетевом режиме (без кэширования) элемент сохраняется на сервере. В Outlook в режиме кэширования этот элемент сохраняется в локальном кэше.

• При работе с содержимым в формате HTML важно учитывать, что клиент Outlook может изменять содержимое. Это означает, что последующие вызовы таких методов, как Body.getAsync, Body.setAsync, и даже saveAsync могут не приводить к тому же содержимому.

• Возвращаемый идентификатор совпадает с идентификатором элемента веб-служб Exchange (EWS). Возвращаемый идентификатор элемента не идентичен идентификатору записи Outlook или идентификатору, используемому REST API Outlook. Перед вызовами REST API с использованием этого значения его следует преобразовать с помощью Office.context.mailbox.convertToRestId.

• Если надстройка вызывает saveAsync элемент в режиме создания, чтобы получить идентификатор элемента для использования с EWS или REST API, имейте в виду, что когда Outlook находится в режиме кэширования, может потребоваться некоторое время для фактической синхронизации элемента с сервером. Пока элемент не будет синхронизирован, использование кода элемента будет возвращать ошибку.

• В Outlook в Интернете и новом Outlook для Windows учетная запись почтового ящика, в которую сохраняется черновик, зависит от saveAsync вызова в сообщении, отправляемом из общей учетной записи почтового ящика. Если отправитель создает новое сообщение из своего личного почтового ящика и выбирает учетную запись общего почтового ящика в поле "От ", saveAsync черновик сохраняется в папке "Черновики " личного почтового ящика пользователя. Если отправитель открывает учетную запись общего почтового ящика в отдельной вкладке браузера (например, с помощью параметра " Открыть другой почтовый ящик ") и создает там новое сообщение, saveAsync сохраняет черновик в папке "Черновики " общего почтового ящика.

Ошибки:

• InvalidAttachmentId : идентификатор вложения не существует.

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

Комментарии

Набор API: Почтовый ящик 1.15

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

Применимый режим 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

Комментарии

Набор API: Почтовый ящик 1.15

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

Применимый режим Outlook: Compose сообщений

Важно!

• Дополнительные сведения об обработке нескольких выбранных сообщений см. в статье "Активация надстройки Outlook для нескольких сообщений".

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