Office.LoadedMessageCompose interface
Примечание
Этот API предоставляется в качестве предварительной версии для разработчиков и может быть изменен на основе полученных нами отзывов. Не используйте этот API в рабочей среде.
Представляет сообщение в режиме создания, загруженное в данный момент. Объект LoadedMessageCompose
возвращается при Office.context.mailbox.loadItemByIdAsync
вызове сообщения в режиме создания.
Комментарии
[ Набор API: предварительная версия почтового ящика ]
Минимальный уровень разрешений: чтение и запись элемента
Применимый режим Outlook: Compose сообщений
Важно!
При реализации функции множественного выбора элементов определите, можно ли уже получить доступ к требуемым свойствам выбранного элемента с помощью
Office.context.mailbox.getSelectedItemsAsync
вызова. Если это возможно, вам не нужно вызыватьloadItemByIdAsync
.Одновременно можно загрузить только один почтовый элемент. При реализации
loadItemByIdAsync
необходимо вызватьunloadAsync
после обработки элемента. Это необходимо сделать перед вызовомloadItemByIdAsync
для другого элемента.
Свойства
bcc | Возвращает получателей в строке ск ( слепой копии) сообщения. |
body | Возвращает текст и формат элемента. |
categories | Возвращает объект , предоставляющий методы для управления категориями элемента. |
cc | Возвращает получателей в строке Копия (копия) сообщения. |
conversation |
Получает идентификатор разговора по электронной почте, содержащего конкретное сообщение. Вы можете получить целочисленное значение этого свойства, если ваше почтовое приложение активируется в формах просмотра или формах создания ответов. Если пользователь изменит тему ответа, после его отправки идентификатор беседы будет изменен, и полученное ранее значение будет недействительным. Это свойство имеет значение NULL для нового элемента в форме создания. |
delay |
Возвращает отложенную дату и время доставки сообщения. |
from | Получает электронный адрес отправителя сообщения. |
in |
Возвращает идентификатор исходного сообщения, на которое отвечает текущее сообщение. |
internet |
Возвращает настраиваемые заголовки сообщения в Интернете. Дополнительные сведения см . в статье Получение и настройка заголовков в Интернете для сообщения в надстройке Outlook. |
item |
Получает тип элемента, который представляет экземпляр. Свойство |
notification |
Возвращает уведомления элемента. |
sensitivity |
Возвращает метку конфиденциальности сообщения. |
series |
Возвращает идентификатор ряда, к которому принадлежит экземпляр. В Outlook в Интернете и в Windows (новая и классическая версия) |
subject | Возвращает описание, отображающееся в поле темы элемента. Свойство |
to | Возвращает получателей в строке Кому сообщения. Предоставляет доступ к получателям, указанным в строке Кому сообщения. Тип объекта и уровень доступа зависят от режима текущего элемента. |
Методы
get |
Получает вложение из сообщения или встречи и возвращает его в Метод |
get |
Получает вложение из сообщения или встречи и возвращает его в Метод |
get |
Возвращает вложения элемента в виде массива. |
get |
Возвращает вложения элемента в виде массива. |
get |
Указывает тип создания сообщения и его тип приведения. Сообщение может быть новым или ответным или пересылать. Тип приведения может быть HTML или обычный текст. |
get |
Указывает тип создания сообщения и его тип приведения. Сообщение может быть новым или ответным или пересылать. Тип приведения может быть HTML или обычный текст. |
get |
Возвращает позицию текущего сообщения в потоке диалога в кодировке Base64. |
get |
Возвращает позицию текущего сообщения в потоке диалога в кодировке Base64. |
get |
Возвращает данные инициализации, передаваемые при активации надстройки с помощью сообщения с действиями. |
get |
Возвращает данные инициализации, передаваемые при активации надстройки с помощью сообщения с действиями. |
get |
Возвращает класс элементов веб-служб Exchange выбранного сообщения. |
get |
Возвращает класс элементов веб-служб Exchange выбранного сообщения. |
get |
Асинхронно получает идентификатор элемента веб-служб Exchange (EWS) сохраненного элемента. При вызове этот метод возвращает идентификатор элемента с помощью функции обратного вызова. |
get |
Асинхронно получает идентификатор сохраненного элемента. При вызове этот метод возвращает идентификатор элемента с помощью функции обратного вызова.
Примечание. Если надстройка вызывает |
get |
Возвращает свойства встречи или сообщения в общей папке или общем почтовом ящике. Дополнительные сведения об использовании этого API см. в статье Включение общих папок и сценариев общих почтовых ящиков в надстройке Outlook. |
get |
Возвращает свойства встречи или сообщения в общей папке или общем почтовом ящике. Дополнительные сведения об использовании этого API см. в статье Включение общих папок и сценариев общих почтовых ящиков в надстройке Outlook. |
is |
Возвращает значение, если подпись клиента включена. В Outlook для Windows (классическая модель) вызов API возвращает, |
is |
Возвращает значение, если подпись клиента включена. В Outlook для Windows (классическая модель) вызов API возвращает, |
load |
Асинхронно загружает настраиваемые свойства для надстройки для выбранного элемента. Пользовательские свойства хранятся в виде пар "ключ-значение" для каждого приложения и каждого элемента. Этот метод возвращает объект CustomProperties в обратном вызове, который предоставляет методы для доступа к пользовательским свойствам, характерным для текущего элемента и текущей надстройки. Пользовательские свойства не шифруются в элементе, поэтому их не следует использовать в качестве безопасного хранилища. Настраиваемые свойства предоставляются в виде объекта |
save |
Асинхронно сохраняет текущее сообщение в виде черновика. |
save |
Асинхронно сохраняет текущее сообщение в виде черновика. |
unload |
При выборе нескольких почтовых элементов закрывает текущий загруженный элемент, чтобы можно было загрузить другой выбранный почтовый элемент для обработки. |
unload |
При выборе нескольких почтовых элементов закрывает текущий загруженный элемент, чтобы можно было загрузить другой выбранный почтовый элемент для обработки. |
Сведения о свойстве
bcc
Примечание
Этот API предоставляется в качестве предварительной версии для разработчиков и может быть изменен на основе полученных нами отзывов. Не используйте этот API в рабочей среде.
Возвращает получателей в строке ск ( слепой копии) сообщения.
bcc: Recipients;
Значение свойства
Комментарии
[ Набор API: Почтовый ящик 1.1 ]
Минимальный уровень разрешений: чтение элемента
Применимый режим Outlook: Compose сообщений
Важно!
Поддерживается
getAsync
только метод объекта Recipients.В зависимости от клиента и платформы Outlook могут применяться ограничения на количество получателей, которые можно получить. Дополнительные сведения см. в разделе Объект Recipients .
body
Примечание
Этот API предоставляется в качестве предварительной версии для разработчиков и может быть изменен на основе полученных нами отзывов. Не используйте этот API в рабочей среде.
Возвращает текст и формат элемента.
body: Body;
Значение свойства
Комментарии
[ Набор API: Почтовый ящик 1.1 ]
Минимальный уровень разрешений: чтение элемента
Применимый режим Outlook: Compose сообщений
Важно! Поддерживаются только getAsync
методы и getTypeAsync
объекта Body.
categories
Примечание
Этот API предоставляется в качестве предварительной версии для разработчиков и может быть изменен на основе полученных нами отзывов. Не используйте этот API в рабочей среде.
Возвращает объект , предоставляющий методы для управления категориями элемента.
categories: Categories;
Значение свойства
Комментарии
[ Набор API: Почтовый ящик 1.8 ]
Минимальный уровень разрешений: чтение элемента
Применимый режим Outlook: Compose сообщений
cc
Примечание
Этот API предоставляется в качестве предварительной версии для разработчиков и может быть изменен на основе полученных нами отзывов. Не используйте этот API в рабочей среде.
Возвращает получателей в строке Копия (копия) сообщения.
cc: Recipients;
Значение свойства
Комментарии
Минимальный уровень разрешений: чтение элемента
Применимый режим Outlook: Compose сообщений
Важно!
Поддерживается
getAsync
только метод объекта Recipients.В зависимости от клиента и платформы Outlook могут применяться ограничения на количество получателей, которые можно получить. Дополнительные сведения см. в разделе Объект Recipients .
conversationId
Примечание
Этот API предоставляется в качестве предварительной версии для разработчиков и может быть изменен на основе полученных нами отзывов. Не используйте этот API в рабочей среде.
Получает идентификатор разговора по электронной почте, содержащего конкретное сообщение.
Вы можете получить целочисленное значение этого свойства, если ваше почтовое приложение активируется в формах просмотра или формах создания ответов. Если пользователь изменит тему ответа, после его отправки идентификатор беседы будет изменен, и полученное ранее значение будет недействительным.
Это свойство имеет значение NULL для нового элемента в форме создания.
conversationId: string;
Значение свойства
string
Комментарии
Минимальный уровень разрешений: чтение элемента
Применимый режим Outlook: Compose сообщений
delayDeliveryTime
Примечание
Этот API предоставляется в качестве предварительной версии для разработчиков и может быть изменен на основе полученных нами отзывов. Не используйте этот API в рабочей среде.
Возвращает отложенную дату и время доставки сообщения.
delayDeliveryTime: DelayDeliveryTime;
Значение свойства
Комментарии
[ Набор API: Почтовый ящик 1.13 ]
Минимальный уровень разрешений: чтение элемента
Применимый режим Outlook: Compose сообщений
Важно! Поддерживается getAsync
только метод объекта DelayDeliveryTime.
from
Примечание
Этот API предоставляется в качестве предварительной версии для разработчиков и может быть изменен на основе полученных нами отзывов. Не используйте этот API в рабочей среде.
Получает электронный адрес отправителя сообщения.
from: From;
Значение свойства
Комментарии
[ Набор API: Почтовый ящик 1.7 ]
Минимальный уровень разрешений: чтение элемента
Применимый режим Outlook: Compose сообщений
inReplyTo
Примечание
Этот API предоставляется в качестве предварительной версии для разработчиков и может быть изменен на основе полученных нами отзывов. Не используйте этот API в рабочей среде.
Возвращает идентификатор исходного сообщения, на которое отвечает текущее сообщение.
inReplyTo: string;
Значение свойства
string
Комментарии
[ Набор API: Почтовый ящик 1.14 ]
Минимальный уровень разрешений: чтение элемента
Применимый режим Outlook: Compose сообщений
Важно!
В Outlook для Windows значение сохраняется во всех ответах,
inReplyTo
независимо от внесенных пользователем изменений, таких как изменение темы в ответе.Свойство
inReplyTo
возвращаетnull
для новых сообщений и приглашений на собрание, пересылаемых пользователем, который также является организатором собрания.
internetHeaders
Примечание
Этот API предоставляется в качестве предварительной версии для разработчиков и может быть изменен на основе полученных нами отзывов. Не используйте этот API в рабочей среде.
Возвращает настраиваемые заголовки сообщения в Интернете.
Дополнительные сведения см . в статье Получение и настройка заголовков в Интернете для сообщения в надстройке Outlook.
internetHeaders: InternetHeaders;
Значение свойства
Комментарии
[ Набор API: Почтовый ящик 1.8 ]
Минимальный уровень разрешений: чтение элемента
Применимый режим Outlook: Compose сообщений
Важно! Поддерживается getAsync
только метод объекта InternetHeaders.
itemType
Примечание
Этот API предоставляется в качестве предварительной версии для разработчиков и может быть изменен на основе полученных нами отзывов. Не используйте этот API в рабочей среде.
Получает тип элемента, который представляет экземпляр.
Свойство itemType
возвращает одно из значений ItemType
перечисления, указывающее, является ли экземпляр объекта элемента сообщением или встречей.
itemType: MailboxEnums.ItemType | string;
Значение свойства
Office.MailboxEnums.ItemType | string
Комментарии
Минимальный уровень разрешений: чтение элемента
Применимый режим Outlook: Compose сообщений
notificationMessages
Примечание
Этот API предоставляется в качестве предварительной версии для разработчиков и может быть изменен на основе полученных нами отзывов. Не используйте этот API в рабочей среде.
Возвращает уведомления элемента.
notificationMessages: NotificationMessages;
Значение свойства
Комментарии
[ Набор API: Почтовый ящик 1.3 ]
Минимальный уровень разрешений: чтение элемента
Применимый режим Outlook: Compose сообщений
Важно!
- Поддерживается
getAllAsync
только метод объекта NotificationMessages.
sensitivityLabel
Примечание
Этот API предоставляется в качестве предварительной версии для разработчиков и может быть изменен на основе полученных нами отзывов. Не используйте этот API в рабочей среде.
Возвращает метку конфиденциальности сообщения.
sensitivityLabel: SensitivityLabel;
Значение свойства
Комментарии
[ Набор API: Почтовый ящик 1.13 ]
Минимальный уровень разрешений: чтение и запись элемента
Применимый режим Outlook: Compose сообщений
Важно!
Чтобы использовать функцию метки конфиденциальности в надстройке, у вас должна быть Microsoft 365 E5 подписка.
Поддерживается
getAsync
только метод объекта SensitivityLabel.
Дополнительные сведения об управлении метками конфиденциальности в надстройке см. в статье Управление метками конфиденциальности сообщения или встречи в режиме создания.
seriesId
Примечание
Этот API предоставляется в качестве предварительной версии для разработчиков и может быть изменен на основе полученных нами отзывов. Не используйте этот API в рабочей среде.
Возвращает идентификатор ряда, к которому принадлежит экземпляр.
В 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
. Дополнительные сведения см. в разделе Использование REST API Outlook из надстройки Outlook.
Свойство seriesId
возвращает null
для элементов, которые не имеют родительских элементов, таких как отдельные встречи, элементы рядов или приглашения на собрание, и возвращает для undefined
других элементов, которые не являются приглашениями на собрания.
subject
Примечание
Этот API предоставляется в качестве предварительной версии для разработчиков и может быть изменен на основе полученных нами отзывов. Не используйте этот API в рабочей среде.
Возвращает описание, отображающееся в поле темы элемента.
Свойство subject
получает всю тему элемента, отправленную сервером электронной почты.
subject: Subject;
Значение свойства
Комментарии
Минимальный уровень разрешений: чтение элемента
Применимый режим Outlook: Compose сообщений
Важно! Поддерживается getAsync
только метод объекта Subject.
to
Примечание
Этот API предоставляется в качестве предварительной версии для разработчиков и может быть изменен на основе полученных нами отзывов. Не используйте этот API в рабочей среде.
Возвращает получателей в строке Кому сообщения. Предоставляет доступ к получателям, указанным в строке Кому сообщения. Тип объекта и уровень доступа зависят от режима текущего элемента.
to: Recipients;
Значение свойства
Комментарии
Минимальный уровень разрешений: чтение элемента
Применимый режим Outlook: Compose сообщений
Важно!
Поддерживается
getAsync
только метод объекта Recipients.В зависимости от клиента и платформы Outlook могут применяться ограничения на количество получателей, которые можно получить. Дополнительные сведения см. в разделе Объект Recipients .
Сведения о методе
getAttachmentContentAsync(attachmentId, options, callback)
Примечание
Этот API предоставляется в качестве предварительной версии для разработчиков и может быть изменен на основе полученных нами отзывов. Не используйте этот API в рабочей среде.
Получает вложение из сообщения или встречи и возвращает его в AttachmentContent
виде объекта .
Метод getAttachmentContentAsync
получает вложение с указанным идентификатором из элемента. Рекомендуется получить идентификатор вложения из getAttachmentsAsync
вызова, а затем в том же сеансе использовать его для получения вложения. В Outlook в Интернете и новом Outlook в Windows идентификатор вложения действителен только в рамках одного сеанса. Сеанс завершается, когда пользователь закрывает приложение или если пользователь начинает создавать встроенную форму, затем открывает форму для продолжения в отдельном окне.
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
параметре, вызывается с одним параметром Office.AsyncResult
, asyncResult
который является объектом . В случае сбоя asyncResult.error
вызова свойство будет содержать код ошибки с причиной сбоя.
Возвращаемое значение
void
Комментарии
[ Набор API: Почтовый ящик 1.8 ]
Минимальный уровень разрешений: чтение элемента
Применимый режим Outlook: Compose сообщений
Ошибки:
AttachmentTypeNotSupported
: тип вложения не поддерживается. Неподдерживаемые типы включают внедренные изображения в формате форматированного текста или типы вложений элементов, отличные от сообщений электронной почты или элементов календаря (например, контакт или элемент задачи).InvalidAttachmentId
: идентификатор вложения не существует.
getAttachmentContentAsync(attachmentId, callback)
Примечание
Этот API предоставляется в качестве предварительной версии для разработчиков и может быть изменен на основе полученных нами отзывов. Не используйте этот API в рабочей среде.
Получает вложение из сообщения или встречи и возвращает его в AttachmentContent
виде объекта .
Метод getAttachmentContentAsync
получает вложение с указанным идентификатором из элемента. Рекомендуется получить идентификатор вложения из getAttachmentsAsync
вызова, а затем в том же сеансе использовать его для получения вложения. В Outlook в Интернете и новом Outlook в Windows идентификатор вложения действителен только в рамках одного сеанса. Сеанс завершается, когда пользователь закрывает приложение или если пользователь начинает создавать встроенную форму, затем открывает форму для продолжения в отдельном окне.
getAttachmentContentAsync(attachmentId: string, callback?: (asyncResult: Office.AsyncResult<AttachmentContent>) => void): void;
Параметры
- attachmentId
-
string
Идентификатор вложения, которое требуется получить.
- callback
-
(asyncResult: Office.AsyncResult<Office.AttachmentContent>) => void
Необязательный параметр. После завершения метода функция, переданная в callback
параметре, вызывается с одним параметром Office.AsyncResult
, asyncResult
который является объектом . В случае сбоя asyncResult.error
вызова свойство будет содержать код ошибки с причиной сбоя.
Возвращаемое значение
void
Комментарии
[ Набор API: Почтовый ящик 1.8 ]
Минимальный уровень разрешений: чтение элемента
Применимый режим Outlook: Compose сообщений
Ошибки:
AttachmentTypeNotSupported
: тип вложения не поддерживается. Неподдерживаемые типы включают внедренные изображения в формате форматированного текста или типы вложений элементов, отличные от сообщений электронной почты или элементов календаря (например, контакт или элемент задачи).InvalidAttachmentId
: идентификатор вложения не существует.
getAttachmentsAsync(options, callback)
Примечание
Этот API предоставляется в качестве предварительной версии для разработчиков и может быть изменен на основе полученных нами отзывов. Не используйте этот API в рабочей среде.
Возвращает вложения элемента в виде массива.
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
вызова свойство будет содержать код ошибки с причиной сбоя.
Возвращаемое значение
void
Комментарии
[ Набор API: Почтовый ящик 1.8 ]
Минимальный уровень разрешений: чтение элемента
Применимый режим Outlook: Compose сообщений
getAttachmentsAsync(callback)
Примечание
Этот API предоставляется в качестве предварительной версии для разработчиков и может быть изменен на основе полученных нами отзывов. Не используйте этот API в рабочей среде.
Возвращает вложения элемента в виде массива.
getAttachmentsAsync(callback?: (asyncResult: Office.AsyncResult<AttachmentDetailsCompose[]>) => void): void;
Параметры
- callback
-
(asyncResult: Office.AsyncResult<Office.AttachmentDetailsCompose[]>) => void
Необязательный параметр. После завершения метода функция, переданная в callback
параметре, вызывается с одним параметром типа Office.AsyncResult
. В случае сбоя asyncResult.error
вызова свойство будет содержать код ошибки с причиной сбоя.
Возвращаемое значение
void
Комментарии
[ Набор API: Почтовый ящик 1.8 ]
Минимальный уровень разрешений: чтение элемента
Применимый режим Outlook: Compose сообщений
getComposeTypeAsync(options, callback)
Примечание
Этот API предоставляется в качестве предварительной версии для разработчиков и может быть изменен на основе полученных нами отзывов. Не используйте этот API в рабочей среде.
Указывает тип создания сообщения и его тип приведения. Сообщение может быть новым или ответным или пересылать. Тип приведения может быть 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)
Примечание
Этот API предоставляется в качестве предварительной версии для разработчиков и может быть изменен на основе полученных нами отзывов. Не используйте этот API в рабочей среде.
Указывает тип создания сообщения и его тип приведения. Сообщение может быть новым или ответным или пересылать. Тип приведения может быть 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)
Примечание
Этот API предоставляется в качестве предварительной версии для разработчиков и может быть изменен на основе полученных нами отзывов. Не используйте этот API в рабочей среде.
Возвращает позицию текущего сообщения в потоке диалога в кодировке Base64.
getConversationIndexAsync(options: Office.AsyncContextOptions, callback: (asyncResult: Office.AsyncResult<string>) => void): void;
Параметры
- options
- Office.AsyncContextOptions
Литерал объекта, содержащий одно или несколько следующих свойств:- asyncContext
: разработчики могут предоставить любой объект, к которому они хотят получить доступ в функции обратного вызова.
- callback
-
(asyncResult: Office.AsyncResult<string>) => void
После завершения метода функция, переданная в callback
параметре, вызывается с одним параметром Office.AsyncResult
, asyncResult
который является объектом . В свойстве возвращается позиция текущего сообщения в диалоге в кодировке asyncResult.value
Base64.
Возвращаемое значение
void
Комментарии
[ Набор API: Почтовый ящик 1.14 ]
Минимальный уровень разрешений: чтение элемента
Применимый режим Outlook: Compose сообщений
Совет. Вы можете использовать индекс беседы для поиска сообщения в потоке беседы. Затем используйте его содержимое, чтобы предоставить контекст для текущего создаваемого сообщения.
getConversationIndexAsync(callback)
Примечание
Этот API предоставляется в качестве предварительной версии для разработчиков и может быть изменен на основе полученных нами отзывов. Не используйте этот API в рабочей среде.
Возвращает позицию текущего сообщения в потоке диалога в кодировке Base64.
getConversationIndexAsync(callback: (asyncResult: Office.AsyncResult<string>) => void): void;
Параметры
- callback
-
(asyncResult: Office.AsyncResult<string>) => void
После завершения метода функция, переданная в callback
параметре, вызывается с одним параметром Office.AsyncResult
, asyncResult
который является объектом . В свойстве возвращается позиция текущего сообщения в диалоге в кодировке asyncResult.value
Base64.
Возвращаемое значение
void
Комментарии
[ Набор API: Почтовый ящик 1.14 ]
Минимальный уровень разрешений: чтение элемента
Применимый режим Outlook: Compose сообщений
Совет. Вы можете использовать индекс беседы для поиска сообщения в потоке беседы. Затем используйте его содержимое, чтобы предоставить контекст для текущего создаваемого сообщения.
getInitializationContextAsync(options, callback)
Примечание
Этот API предоставляется в качестве предварительной версии для разработчиков и может быть изменен на основе полученных нами отзывов. Не используйте этот API в рабочей среде.
Возвращает данные инициализации, передаваемые при активации надстройки с помощью сообщения с действиями.
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)
Примечание
Этот API предоставляется в качестве предварительной версии для разработчиков и может быть изменен на основе полученных нами отзывов. Не используйте этот API в рабочей среде.
Возвращает данные инициализации, передаваемые при активации надстройки с помощью сообщения с действиями.
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)
Примечание
Этот API предоставляется в качестве предварительной версии для разработчиков и может быть изменен на основе полученных нами отзывов. Не используйте этот API в рабочей среде.
Возвращает класс элементов веб-служб Exchange выбранного сообщения.
getItemClassAsync(options: Office.AsyncContextOptions, callback: (asyncResult: Office.AsyncResult<string>) => void): void;
Параметры
- options
- Office.AsyncContextOptions
Литерал объекта, содержащий одно или несколько следующих свойств:- asyncContext
: разработчики могут предоставить любой объект, к которому они хотят получить доступ в функции обратного вызова.
- callback
-
(asyncResult: Office.AsyncResult<string>) => void
После завершения метода функция, переданная в callback
параметре, вызывается с одним параметром Office.AsyncResult
, asyncResult
который является объектом . Класс сообщения возвращается в свойстве asyncResult.value
.
Возвращаемое значение
void
Комментарии
[ Набор API: Почтовый ящик 1.14 ]
Минимальный уровень разрешений: чтение элемента
Применимый режим Outlook: Compose сообщений
Важно!
В следующей таблице перечислены классы сообщений по умолчанию.
Класс элемента | Описание |
---|---|
IPM.Note | Новые сообщения и ответы на сообщения |
IPM. Примечание.SMIME | Зашифрованные сообщения, которые также могут быть подписаны |
IPM. Примечание.SMIME.MultipartSigned | Сообщения с открытой подписью |
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)
Примечание
Этот API предоставляется в качестве предварительной версии для разработчиков и может быть изменен на основе полученных нами отзывов. Не используйте этот API в рабочей среде.
Возвращает класс элементов веб-служб Exchange выбранного сообщения.
getItemClassAsync(callback: (asyncResult: Office.AsyncResult<string>) => void): void;
Параметры
- callback
-
(asyncResult: Office.AsyncResult<string>) => void
После завершения метода функция, переданная в callback
параметре, вызывается с одним параметром Office.AsyncResult
, asyncResult
который является объектом . Класс сообщения возвращается в свойстве asyncResult.value
.
Возвращаемое значение
void
Комментарии
[ Набор API: Почтовый ящик 1.14 ]
Минимальный уровень разрешений: чтение элемента
Применимый режим Outlook: Compose сообщений
Важно!
В следующей таблице перечислены классы сообщений по умолчанию.
Класс элемента | Описание |
---|---|
IPM.Note | Новые сообщения и ответы на сообщения |
IPM. Примечание.SMIME | Зашифрованные сообщения, которые также могут быть подписаны |
IPM. Примечание.SMIME.MultipartSigned | Сообщения с открытой подписью |
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)
Примечание
Этот API предоставляется в качестве предварительной версии для разработчиков и может быть изменен на основе полученных нами отзывов. Не используйте этот API в рабочей среде.
Асинхронно получает идентификатор элемента веб-служб 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)
Примечание
Этот API предоставляется в качестве предварительной версии для разработчиков и может быть изменен на основе полученных нами отзывов. Не используйте этот API в рабочей среде.
Асинхронно получает идентификатор сохраненного элемента.
При вызове этот метод возвращает идентификатор элемента с помощью функции обратного вызова.
Примечание. Если надстройка вызывает 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 предоставляется в качестве предварительной версии для разработчиков и может быть изменен на основе полученных нами отзывов. Не используйте этот API в рабочей среде.
Возвращает свойства встречи или сообщения в общей папке или общем почтовом ящике.
Дополнительные сведения об использовании этого 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
параметре, вызывается с одним параметром Office.AsyncResult
, asyncResult
который является объектом . Свойство asyncResult.value
предоставляет свойства общего элемента.
Возвращаемое значение
void
Комментарии
Минимальный уровень разрешений: чтение элемента
Применимый режим Outlook: Compose сообщений
Важно! В режиме Compose сообщений этот API не поддерживается в Outlook в Интернете или Windows (новая и классическая версия), если не выполнены следующие условия.
А. Делегирование доступа или общие папки
Владелец почтового ящика запускает сообщение. Это может быть новое сообщение, ответ или пересылка.
Они сохраняют сообщение, а затем перемещают его из собственной папки Черновики в папку, к которой предоставлен общий доступ делегату.
Делегат открывает черновик из общей папки, а затем продолжает создание.
Б. Общий почтовый ящик (применяется только к классической версии Outlook в Windows)
Пользователь общего почтового ящика запускает сообщение. Это может быть новое сообщение, ответ или пересылка.
Они сохраняют сообщение, а затем перемещают его из собственной папки Черновики в папку в общем почтовом ящике.
Другой пользователь общего почтового ящика открывает черновик из общего почтового ящика, а затем продолжает создавать.
Теперь сообщение находится в общем контексте, и надстройки, поддерживающие эти общие сценарии, могут получить общие свойства элемента. После отправки сообщение обычно находится в папке Отправленные .
getSharedPropertiesAsync(callback)
Примечание
Этот API предоставляется в качестве предварительной версии для разработчиков и может быть изменен на основе полученных нами отзывов. Не используйте этот API в рабочей среде.
Возвращает свойства встречи или сообщения в общей папке или общем почтовом ящике.
Дополнительные сведения об использовании этого API см. в статье Включение общих папок и сценариев общих почтовых ящиков в надстройке Outlook.
getSharedPropertiesAsync(callback: (asyncResult: Office.AsyncResult<SharedProperties>) => void): void;
Параметры
- callback
-
(asyncResult: Office.AsyncResult<Office.SharedProperties>) => void
После завершения метода функция, переданная в callback
параметре, вызывается с одним параметром Office.AsyncResult
, asyncResult
который является объектом . Свойство asyncResult.value
предоставляет свойства общего элемента.
Возвращаемое значение
void
Комментарии
Минимальный уровень разрешений: чтение элемента
Применимый режим Outlook: Compose сообщений
Важно! В режиме Compose сообщений этот API не поддерживается в Outlook в Интернете или Windows (новая и классическая версия), если не выполнены следующие условия.
А. Делегирование доступа или общие папки
Владелец почтового ящика запускает сообщение. Это может быть новое сообщение, ответ или пересылка.
Они сохраняют сообщение, а затем перемещают его из собственной папки Черновики в папку, к которой предоставлен общий доступ делегату.
Делегат открывает черновик из общей папки, а затем продолжает создание.
Б. Общий почтовый ящик (применяется только к Outlook в Windows)
Пользователь общего почтового ящика запускает сообщение. Это может быть новое сообщение, ответ или пересылка.
Они сохраняют сообщение, а затем перемещают его из собственной папки Черновики в папку в общем почтовом ящике.
Другой пользователь общего почтового ящика открывает черновик из общего почтового ящика, а затем продолжает создавать.
Теперь сообщение находится в общем контексте, и надстройки, поддерживающие эти общие сценарии, могут получить общие свойства элемента. После отправки сообщение обычно находится в папке Отправленные .
isClientSignatureEnabledAsync(options, callback)
Примечание
Этот API предоставляется в качестве предварительной версии для разработчиков и может быть изменен на основе полученных нами отзывов. Не используйте этот API в рабочей среде.
Возвращает значение, если подпись клиента включена.
В Outlook для Windows (классическая модель) вызов API возвращает, true
если для подписи по умолчанию для новых сообщений, ответов или пересылки задан шаблон для учетной записи Отправляющего Outlook. В Outlook в Интернете и outlook в Windows вызов API возвращаетtrue
, если сигнатура включена для типовnewMail
создания , reply
или forward
. Если для параметров задано значение "(none)" в 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)
Примечание
Этот API предоставляется в качестве предварительной версии для разработчиков и может быть изменен на основе полученных нами отзывов. Не используйте этот API в рабочей среде.
Возвращает значение, если подпись клиента включена.
В Outlook для Windows (классическая модель) вызов API возвращает, true
если для подписи по умолчанию для новых сообщений, ответов или пересылки задан шаблон для учетной записи Отправляющего Outlook. В Outlook в Интернете и outlook в Windows вызов API возвращаетtrue
, если сигнатура включена для типовnewMail
создания , reply
или forward
. Если для параметров задано значение "(none)" в 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)
Примечание
Этот API предоставляется в качестве предварительной версии для разработчиков и может быть изменен на основе полученных нами отзывов. Не используйте этот API в рабочей среде.
Асинхронно загружает настраиваемые свойства для надстройки для выбранного элемента.
Пользовательские свойства хранятся в виде пар "ключ-значение" для каждого приложения и каждого элемента. Этот метод возвращает объект 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)
Примечание
Этот API предоставляется в качестве предварительной версии для разработчиков и может быть изменен на основе полученных нами отзывов. Не используйте этот API в рабочей среде.
Асинхронно сохраняет текущее сообщение в виде черновика.
saveAsync(options: Office.AsyncContextOptions, callback: (asyncResult: Office.AsyncResult<string>) => void): void;
Параметры
- options
- Office.AsyncContextOptions
Литерал объекта, содержащий одно или несколько следующих свойств:- asyncContext
: разработчики могут предоставить любой объект, к которому они хотят получить доступ в функции обратного вызова.
- callback
-
(asyncResult: Office.AsyncResult<string>) => void
После завершения метода функция, переданная в callback
параметре, вызывается с одним параметром Office.AsyncResult
, 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)
Примечание
Этот API предоставляется в качестве предварительной версии для разработчиков и может быть изменен на основе полученных нами отзывов. Не используйте этот API в рабочей среде.
Асинхронно сохраняет текущее сообщение в виде черновика.
saveAsync(callback: (asyncResult: Office.AsyncResult<string>) => void): void;
Параметры
- callback
-
(asyncResult: Office.AsyncResult<string>) => void
После завершения метода функция, переданная в callback
параметре, вызывается с одним параметром Office.AsyncResult
, 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)
Примечание
Этот API предоставляется в качестве предварительной версии для разработчиков и может быть изменен на основе полученных нами отзывов. Не используйте этот API в рабочей среде.
При выборе нескольких почтовых элементов закрывает текущий загруженный элемент, чтобы можно было загрузить другой выбранный почтовый элемент для обработки.
unloadAsync(options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult<void>) => void): void;
Параметры
- options
- Office.AsyncContextOptions
Литерал объекта, содержащий asyncContext
свойство . Назначьте свойству любой объект, к которому вы хотите получить доступ в функции обратного asyncContext
вызова.
- callback
-
(asyncResult: Office.AsyncResult<void>) => void
Необязательный параметр. После завершения метода функция, переданная в параметре обратного вызова, вызывается с одним параметром Office.AsyncResult
, asyncResult
который является объектом .
Возвращаемое значение
void
Комментарии
[ Набор API: предварительная версия почтового ящика ]
Минимальный уровень разрешений: чтение и запись элемента
Применимый режим Outlook: Compose сообщений
Важно!
Дополнительные сведения об обработке нескольких выбранных сообщений см. в статье Активация надстройки Outlook для нескольких сообщений.
При загрузке выбранного почтового элемента с помощью
loadItemByIdAsync
необходимо вызватьunloadAsync
после обработки. Это необходимо сделать перед вызовомloadItemByIdAsync
другого выбранного элемента.
unloadAsync(callback)
Примечание
Этот API предоставляется в качестве предварительной версии для разработчиков и может быть изменен на основе полученных нами отзывов. Не используйте этот API в рабочей среде.
При выборе нескольких почтовых элементов закрывает текущий загруженный элемент, чтобы можно было загрузить другой выбранный почтовый элемент для обработки.
unloadAsync(callback?: (asyncResult: Office.AsyncResult<void>) => void): void;
Параметры
- callback
-
(asyncResult: Office.AsyncResult<void>) => void
Необязательный параметр. После завершения метода функция, переданная в параметре обратного вызова, вызывается с одним параметром Office.AsyncResult
, asyncResult
который является объектом .
Возвращаемое значение
void
Комментарии
[ Набор API: предварительная версия почтового ящика ]
Минимальный уровень разрешений: чтение и запись элемента
Применимый режим Outlook: Compose сообщений
Важно!
Дополнительные сведения об обработке нескольких выбранных сообщений см. в статье Активация надстройки Outlook для нескольких сообщений.
При загрузке выбранного почтового элемента с помощью
loadItemByIdAsync
необходимо вызватьunloadAsync
после обработки. Это необходимо сделать перед вызовомloadItemByIdAsync
другого выбранного элемента.
Office Add-ins