Office.LoadedMessageCompose interface

Ссылка

Пакет:: outlook

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

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

Примеры

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

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

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

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

Свойства

bcc	Возвращает получателей в строке ск ( слепой копии) сообщения.
body	Возвращает текст и формат элемента.
categories	Возвращает объект , предоставляющий методы для управления категориями элемента.
cc	Возвращает получателей в строке Копия (копия) сообщения.
conversationId	Получает идентификатор разговора по электронной почте, содержащего конкретное сообщение. Вы можете получить целочисленное значение этого свойства, если ваше почтовое приложение активируется в формах просмотра или формах создания ответов. Если пользователь изменит тему ответа, после его отправки идентификатор беседы будет изменен, и полученное ранее значение будет недействительным. Это свойство имеет значение NULL для нового элемента в форме создания.
delayDeliveryTime	Возвращает отложенную дату и время доставки сообщения.
from	Получает электронный адрес отправителя сообщения.
inReplyTo	Возвращает идентификатор исходного сообщения, на которое отвечает текущее сообщение.
internetHeaders	Возвращает настраиваемые заголовки сообщения в Интернете. Дополнительные сведения см . в статье Получение и настройка заголовков в Интернете для сообщения в надстройке Outlook.
itemType	Получает тип элемента, который представляет экземпляр. Свойство `itemType` возвращает одно из значений `ItemType` перечисления, указывающее, является ли экземпляр объекта элемента сообщением или встречей.
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`. Если для параметров задано значение "(none)" в Outlook в Windows (классическая версия) или они отключены в Outlook в Интернете или новом Outlook в Windows, вызов API возвращает `false`.
isClientSignatureEnabledAsync(callback)	Возвращает значение, если подпись клиента включена. В Outlook для Windows (классическая модель) вызов API возвращает, `true` если для подписи по умолчанию для новых сообщений, ответов или пересылки задан шаблон для учетной записи Отправляющего Outlook. В Outlook в Интернете и outlook в Windows вызов API возвращает`true`, если сигнатура включена для типов`newMail` создания , `reply`или `forward`. Если для параметров задано значение "(none)" в 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

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

body

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

body: Body;

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

Office.Body

cc

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

cc: Recipients;

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

Office.Recipients

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

conversationId

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

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

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

conversationId: string;

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

string

delayDeliveryTime

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

delayDeliveryTime: DelayDeliveryTime;

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

Office.DelayDeliveryTime

from

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

from: From;

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

Office.From

inReplyTo

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

inReplyTo: string;

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

string

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

internetHeaders

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

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

internetHeaders: InternetHeaders;

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

Office.InternetHeaders

itemType

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

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

itemType: MailboxEnums.ItemType | string;

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

Office.MailboxEnums.ItemType | string

notificationMessages

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

notificationMessages: NotificationMessages;

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

Office.NotificationMessages

sensitivityLabel

Возвращает метку конфиденциальности сообщения.

sensitivityLabel: SensitivityLabel;

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

Office.SensitivityLabel

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

seriesId

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

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

seriesId: string;

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

string

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

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

subject

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

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

subject: Subject;

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

Office.Subject

to

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

to: Recipients;

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

Office.Recipients

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

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

getAttachmentContentAsync(attachmentId, options, callback)

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

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

Параметры

attachmentId: string

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

options: Office.AsyncContextOptions

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

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

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

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

void

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

Ошибки:

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

getAttachmentContentAsync(attachmentId, callback)

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

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

Параметры

attachmentId: string

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

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

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

void

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

Ошибки:

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

getAttachmentsAsync(options, callback)

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

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

Параметры

options: Office.AsyncContextOptions

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

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

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

void

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

getAttachmentsAsync(callback)

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

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

Параметры

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

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

void

getComposeTypeAsync(options, callback)

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

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

Параметры

options: Office.AsyncContextOptions

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

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

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

void

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

getComposeTypeAsync(callback)

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

Параметры

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

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

void

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

getConversationIndexAsync(options, callback)

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

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

Параметры

options: Office.AsyncContextOptions

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

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

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

void

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

getConversationIndexAsync(callback)

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

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

Параметры

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

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

void

getInitializationContextAsync(options, callback)

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

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

Параметры

options: Office.AsyncContextOptions

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

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

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

void

getInitializationContextAsync(callback)

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

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

Параметры

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

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

void

getItemClassAsync(options, callback)

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

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

Параметры

options: Office.AsyncContextOptions

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

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

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

void

Класс элемента	Описание
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)

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

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

Параметры

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

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

void

Класс элемента	Описание
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)

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

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

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

Параметры

options: Office.AsyncContextOptions

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

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

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

void

Возвращенный идентификатор элемента не идентичен идентификатору записи 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

getSharedPropertiesAsync(options, callback)

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

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

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

Параметры

options: Office.AsyncContextOptions

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

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

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

void

Владелец почтового ящика запускает сообщение. Это может быть новое сообщение, ответ или пересылка.
Они сохраняют сообщение, а затем перемещают его из собственной папки Черновики в папку, к которой предоставлен общий доступ делегату.
Делегат открывает черновик из общей папки, а затем продолжает создание.

Б. Общий почтовый ящик

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

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

getSharedPropertiesAsync(callback)

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

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

Параметры

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

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

void

Владелец почтового ящика запускает сообщение. Это может быть новое сообщение, ответ или пересылка.
Они сохраняют сообщение, а затем перемещают его из собственной папки Черновики в папку, к которой предоставлен общий доступ делегату.
Делегат открывает черновик из общей папки, а затем продолжает создание.

Б. Общий почтовый ящик

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

isClientSignatureEnabledAsync(options, callback)

Возвращает значение, если подпись клиента включена.

В 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

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

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

void

isClientSignatureEnabledAsync(callback)

Возвращает значение, если подпись клиента включена.

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

Параметры

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

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

void

loadCustomPropertiesAsync(callback, userContext)

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

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

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

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

Параметры

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

userContext: any

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

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

void

saveAsync(options, callback)

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

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

Параметры

options: Office.AsyncContextOptions

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

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

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

void

В 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

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

void

В 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

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

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

void

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

unloadAsync(callback)

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

Параметры

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

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

void

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

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

Office.LoadedMessageCompose interface

Комментарии

Примеры

Свойства

Методы

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

bcc

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

Комментарии

body

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

Комментарии

categories

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

Комментарии

cc

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

Комментарии

conversationId

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

Комментарии

delayDeliveryTime

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

Комментарии

from

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

Комментарии

inReplyTo

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

Комментарии

internetHeaders

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

Комментарии

itemType

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

Комментарии

notificationMessages

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

Комментарии

sensitivityLabel

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

Комментарии

seriesId

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

Комментарии

subject

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

Комментарии

to

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

Комментарии

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

getAttachmentContentAsync(attachmentId, options, callback)

Параметры

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

Комментарии

getAttachmentContentAsync(attachmentId, callback)

Параметры

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

Комментарии

getAttachmentsAsync(options, callback)

Параметры

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

Комментарии

getAttachmentsAsync(callback)

Параметры

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

Комментарии

getComposeTypeAsync(options, callback)

Параметры

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

Комментарии

getComposeTypeAsync(callback)

Параметры

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

Комментарии

getConversationIndexAsync(options, callback)

Параметры

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