Office.MessageCompose interface

Ссылка

Пакет:: outlook

Режим создания сообщения Office.context.mailbox.item.

Важно!

Это внутренний объект Outlook, который не предоставляется напрямую через существующие интерфейсы. Этот режим следует рассматривать как режим Office.context.mailbox.item. Дополнительные сведения см. на странице Объектная модель .
При вызове Office.context.mailbox.item сообщения обратите внимание, что область чтения в клиенте Outlook должна быть включена. Инструкции по настройке области чтения см. в статье Использование и настройка области чтения для предварительного просмотра сообщений.

Родительские интерфейсы:

Extends: Office.Message

Свойства

bcc	Возвращает объект, предоставляющий методы для получения или обновления получателей в строке ск ( слепой копии) сообщения. В зависимости от клиента или платформы (например, Windows, Mac и т. д.) могут применяться ограничения на количество получателей, которые можно получить или обновить. Дополнительные сведения см. в объекте Recipients .
body	Получает объект, предоставляющий методы для работы с основным текстом элемента.
categories	Возвращает объект , предоставляющий методы для управления категориями элемента. Важно! В Outlook в Интернете и новом Outlook в Windows нельзя использовать API для управления категориями сообщения в режиме Compose.
cc	Предоставляет доступ к получателям копии сообщения. Тип объекта и уровень доступа зависят от режима текущего элемента. Свойство `cc` возвращает объект `Recipients`, предоставляющий методы для получения или обновления получателей, которые указаны в строке Копия сообщения. Однако в зависимости от клиента или платформы (например, Windows, Mac и т. д.) могут применяться ограничения на количество получателей, которые можно получить или обновить. Дополнительные сведения см. в объекте Recipients .
conversationId	Получает идентификатор разговора по электронной почте, содержащего конкретное сообщение. Вы можете получить целочисленное значение этого свойства, если ваше почтовое приложение активируется в формах просмотра или формах создания ответов. Если пользователь изменит тему ответа, после его отправки идентификатор беседы будет изменен, и полученное ранее значение будет недействительным. Это свойство имеет значение NULL для нового элемента в форме создания. Свойство `conversationId` вернет значение, если пользователь задаст тему и сохранит элемент.
delayDeliveryTime	Возвращает или задает отложенную дату и время доставки сообщения. Свойство `delayDeliveryTime` возвращает объект, предоставляющий `DelayDeliveryTime` методы для управления датой и временем доставки сообщения.
from	Получает электронный адрес отправителя сообщения. Свойство `from` возвращает `From` объект, предоставляющий метод для получения значения из .
inReplyTo	Возвращает идентификатор исходного сообщения, на которое отвечает текущее сообщение.
internetHeaders	Возвращает или задает настраиваемые заголовки сообщения в Интернете. Свойство `internetHeaders` возвращает объект, предоставляющий `InternetHeaders` методы для управления заголовками в Интернете в сообщении. Дополнительные сведения см . в статье Получение и настройка заголовков в Интернете для сообщения в надстройке Outlook.
itemType	Получает тип элемента, который представляет экземпляр. Свойство `itemType` возвращает одно из значений `ItemType` перечисления, указывающее, является ли экземпляр объекта элемента сообщением или встречей.
notificationMessages	Получает сообщения уведомления для элемента.
sensitivityLabel	Возвращает объект для получения или задания метки конфиденциальности сообщения.
seriesId	Возвращает идентификатор ряда, к которому принадлежит экземпляр. В Outlook в Интернете, в Windows (новой и классической версии) и в Mac `seriesId` возвращает идентификатор веб-служб Exchange (EWS) родительского элемента (ряда), к которому принадлежит этот элемент. Однако в iOS и Android seriesId возвращает идентификатор REST родительского элемента. Примечание. Идентификатор, возвращаемый свойством `seriesId` , совпадает с идентификатором элемента веб-служб Exchange. Свойство `seriesId` не идентично идентификаторам Outlook, используемым REST API Outlook. Перед выполнением вызовов REST API с использованием этого значения его следует преобразовать с помощью `Office.context.mailbox.convertToRestId`. Дополнительные сведения см. в разделе Использование REST API Outlook из надстройки Outlook. Свойство `seriesId` возвращает `null` для элементов, которые не имеют родительских элементов, таких как отдельные встречи, элементы серий или приглашения на собрание, и возвращает для `undefined` других элементов, которые не являются приглашениями на собрание.
sessionData	Управляет SessionData элемента в режиме Compose. Важно! Весь объект SessionData ограничен 50 000 символами на надстройку.
subject	Получает или задает описание, которое отображается в поле темы элемента. Свойство `subject` получает или задает всю тему элемента для отправки с почтового сервера. Свойство `subject` возвращает объект `Subject`, который предоставляет методы для получения и задания темы.
to	Предоставляет доступ к получателям, указанным в строке Кому сообщения. Тип объекта и уровень доступа зависят от режима текущего элемента. Свойство `to` возвращает объект `Recipients`, предоставляющий методы для получения или обновления получателей, которые указаны в строке Кому сообщения. Однако в зависимости от клиента или платформы (например, Windows, Mac и т. д.) могут применяться ограничения на количество получателей, которые можно получить или обновить. Дополнительные сведения см. в объекте Recipients .

Методы

addFileAttachmentAsync(uri, attachmentName, options, callback)	Добавляет файл в сообщение или встречу в качестве вложения. Метод `addFileAttachmentAsync` передает файл по указанному универсальному коду ресурса (URI) и вкладывает его в элемент в форме создания.
addFileAttachmentAsync(uri, attachmentName, callback)	Добавляет файл в сообщение или встречу в качестве вложения. Метод `addFileAttachmentAsync` передает файл по указанному универсальному коду ресурса (URI) и вкладывает его в элемент в форме создания.
addFileAttachmentFromBase64Async(base64File, attachmentName, options, callback)	Добавляет файл в сообщение или встречу в качестве вложения. Метод `addFileAttachmentFromBase64Async` передает файл из кодировки Base64 и присоединяет его к элементу в форме создания. Этот метод возвращает идентификатор вложения в объекте `asyncResult.value` . Идентификатор можно использовать с методом `removeAttachmentAsync`, чтобы удалить вложение, добавленное во время текущего сеанса.
addFileAttachmentFromBase64Async(base64File, attachmentName, callback)	Добавляет файл в сообщение или встречу в качестве вложения. Метод `addFileAttachmentFromBase64Async` передает файл из кодировки Base64 и присоединяет его к элементу в форме создания. Этот метод возвращает идентификатор вложения в объекте `asyncResult.value` . Идентификатор можно использовать с методом `removeAttachmentAsync`, чтобы удалить вложение, добавленное во время текущего сеанса.
addHandlerAsync(eventType, handler, options, callback)	Добавляет обработчик для поддерживаемого события. Примечание. События доступны только в реализации области задач. Сведения о поддерживаемых событиях см. в разделе События объектной модели элементов.
addHandlerAsync(eventType, handler, callback)	Добавляет обработчик для поддерживаемого события. Примечание. События доступны только в реализации области задач. Сведения о поддерживаемых событиях см. в разделе События объектной модели элементов.
addItemAttachmentAsync(itemId, attachmentName, options, callback)	Добавляет к сообщению элемент Exchange, например сообщение, в виде вложения. С помощью метода `addItemAttachmentAsync` можно в элемент формы создания вложить элемент с указанным идентификатором Exchange. Если указать функцию обратного вызова, метод вызывается с одним параметром , `asyncResult`который содержит идентификатор вложения или код, указывающий на любую ошибку, которая произошла при присоединении элемента. Параметр options можно использовать для передачи сведений о состоянии функции обратного вызова, если это необходимо. Идентификатор можно использовать с методом `removeAttachmentAsync`, чтобы удалить вложение, добавленное во время текущего сеанса. Если надстройка Office работает в Outlook в Интернете или в новом Outlook в Windows, `addItemAttachmentAsync` метод может присоединять элементы к элементам, отличным от редактируется. Однако это не поддерживается и не рекомендуется.
addItemAttachmentAsync(itemId, attachmentName, callback)	Добавляет к сообщению элемент Exchange, например сообщение, в виде вложения. С помощью метода `addItemAttachmentAsync` можно в элемент формы создания вложить элемент с указанным идентификатором Exchange. Если указать функцию обратного вызова, метод вызывается с одним параметром , `asyncResult`который содержит идентификатор вложения или код, указывающий на любую ошибку, которая произошла при присоединении элемента. Параметр options можно использовать для передачи сведений о состоянии функции обратного вызова, если это необходимо. Идентификатор можно использовать с методом `removeAttachmentAsync`, чтобы удалить вложение, добавленное во время текущего сеанса. Если надстройка Office работает в Outlook в Интернете или в новом Outlook в Windows, `addItemAttachmentAsync` метод может присоединять элементы к элементам, отличным от редактируется. Однако это не поддерживается и не рекомендуется.
close()	Закрывает текущий создаваемый элемент. Работа метода `close` зависит от текущего состояния создаваемого элемента. Если элемент содержит несохраненные изменения, клиент предлагает пользователю сохранить, отменить или закрыть действие. В Outlook в Windows (классической) и на Mac `close` метод не влияет на ответ в области чтения.
closeAsync(options, callback)	Закрывает текущее сообщение, создаваемое с параметром отмены несохраненных изменений. Создаваемое сообщение может быть новым сообщением, ответом или существующим черновиком.
closeAsync(callback)	Закрывает текущее новое сообщение, которое создается. Поведение создаваемого сообщения зависит от того, содержит ли сообщение несохраненные изменения. Если изменения не были внесены, сообщение закрывается без диалогового окна сохранения. С другой стороны, если сообщение содержит несохраненные изменения, появится диалоговое окно сохранения с предложением сохранить черновик, отменить изменения или отменить операцию.
disableClientSignatureAsync(options, callback)	Отключает подпись клиента Outlook. Поведение этого метода зависит от того, на каком клиенте выполняется надстройка. В Outlook в Интернете и Outlook в Windows параметр подписи для новых сообщений, ответов и пересылаемых сообщений отключен. Выбранная сигнатура также отключается методом . В Outlook в Windows (классической версии) и на Mac для подписи в разделах Новые сообщения и Ответы и пересылки учетной записи отправки задано значение (нет). В Outlook для Android и iOS сигнатура, сохраненная на мобильном устройстве, очищается.
disableClientSignatureAsync(callback)	Отключает подпись клиента Outlook. Поведение этого метода зависит от того, на каком клиенте выполняется надстройка. В Outlook в Интернете и Outlook в Windows параметр подписи для новых сообщений, ответов и пересылаемых сообщений отключен. Выбранная сигнатура также отключается методом . В Outlook в Windows (классической версии) и на Mac для подписи в разделах Новые сообщения и Ответы и пересылки учетной записи отправки задано значение (нет). В Outlook для Android и iOS сигнатура, сохраненная на мобильном устройстве, очищается.
getAttachmentContentAsync(attachmentId, options, callback)	Получает вложение из сообщения или встречи и возвращает его в `AttachmentContent` виде объекта . Метод `getAttachmentContentAsync` получает вложение с указанным идентификатором из элемента. Рекомендуется получить идентификатор вложения из `getAttachmentsAsync` вызова, а затем в том же сеансе использовать его для получения вложения. В Outlook в Интернете, на мобильных устройствах и в новом Outlook в Windows идентификатор вложения действителен только в рамках одного сеанса. Сеанс завершается, когда пользователь закрывает приложение или если пользователь начинает создавать встроенную форму, затем открывает форму для продолжения в отдельном окне.
getAttachmentContentAsync(attachmentId, callback)	Получает вложение из сообщения или встречи и возвращает его в `AttachmentContent` виде объекта . Метод `getAttachmentContentAsync` получает вложение с указанным идентификатором из элемента. Рекомендуется получить идентификатор вложения из `getAttachmentsAsync` вызова, а затем в том же сеансе использовать его для получения вложения. В Outlook в Интернете, на мобильных устройствах и в новом Outlook в Windows идентификатор вложения действителен только в рамках одного сеанса. Сеанс завершается, когда пользователь закрывает приложение или если пользователь начинает создавать встроенную форму, затем открывает форму для продолжения в отдельном окне.
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)	Асинхронно получает идентификатор элемента веб-служб Exchange (EWS) сохраненного элемента. При вызове этот метод возвращает идентификатор элемента с помощью функции обратного вызова.
getSelectedDataAsync(coercionType, options, callback)	Асинхронно возвращает данные, выбранные в теме или тексте сообщения. Если выделение отсутствует, но курсор находится в тексте или теме, метод возвращает пустую строку для выбранных данных. Если выбраны не текст и не тема, метод возвращает ошибку `InvalidSelection`. Чтобы получить доступ к выбранным данным из функции обратного вызова, вызовите .`asyncResult.value.data` Чтобы получить доступ к свойству источника, из которого происходит выбор, вызовите `asyncResult.value.sourceProperty`, который будет иметь значение `body` или `subject`.
getSelectedDataAsync(coercionType, callback)	Асинхронно возвращает данные, выбранные в теме или тексте сообщения. Если выделение отсутствует, но курсор находится в тексте или теме, метод возвращает пустую строку для выбранных данных. Если выбраны не текст и не тема, метод возвращает ошибку `InvalidSelection`. Чтобы получить доступ к выбранным данным из функции обратного вызова, вызовите .`asyncResult.value.data` Чтобы получить доступ к свойству источника, из которого происходит выбор, вызовите `asyncResult.value.sourceProperty`, который будет иметь значение `body` или `subject`.
getSharedPropertiesAsync(options, callback)	Возвращает свойства встречи или сообщения в общей папке или общем почтовом ящике. Дополнительные сведения об использовании этого API см. в статье Включение общих папок и сценариев общих почтовых ящиков в надстройке Outlook.
getSharedPropertiesAsync(callback)	Возвращает свойства встречи или сообщения в общей папке или общем почтовом ящике. Дополнительные сведения об использовании этого API см. в статье Включение общих папок и сценариев общих почтовых ящиков в надстройке Outlook.
isClientSignatureEnabledAsync(options, callback)	Возвращает значение, если подпись клиента включена. В Outlook в Windows (классической версии) и на Mac вызов API возвращает, `true` если для подписи по умолчанию для новых сообщений, ответов или пересылки задан шаблон для учетной записи Отправляющего Outlook. В Outlook в Интернете и outlook в Windows вызов API возвращает`true`, если сигнатура включена для типов`newMail` создания , `reply`или `forward`. Если для параметров задано значение "(none)" в Outlook в Windows (классическая версия) или на Mac, или они отключены в Outlook в Интернете или новом Outlook в Windows, вызов API возвращает `false`.
isClientSignatureEnabledAsync(callback)	Возвращает значение, если подпись клиента включена. В Outlook в Windows (классической версии) и на Mac вызов API возвращает, `true` если для подписи по умолчанию для новых сообщений, ответов или пересылки задан шаблон для учетной записи Отправляющего Outlook. В Outlook в Интернете и outlook в Windows вызов API возвращает`true`, если сигнатура включена для типов`newMail` создания , `reply`или `forward`. Если для параметров задано значение "(none)" в Outlook в Windows (классическая версия) или на Mac, или они отключены в Outlook в Интернете или новом Outlook в Windows, вызов API возвращает `false`.
loadCustomPropertiesAsync(callback, userContext)	Асинхронно загружает настраиваемые свойства для надстройки для выбранного элемента. Пользовательские свойства хранятся в виде пар "ключ-значение" для каждого приложения и каждого элемента. Этот метод возвращает объект CustomProperties в обратном вызове, который предоставляет методы для доступа к пользовательским свойствам, характерным для текущего элемента и текущей надстройки. Пользовательские свойства не шифруются в элементе, поэтому их не следует использовать в качестве безопасного хранилища. Настраиваемые свойства предоставляются в виде объекта `CustomProperties` в свойстве `asyncResult.value`. Этот объект можно использовать для получения, задания, сохранения и удаления настраиваемых свойств из почтового элемента.
removeAttachmentAsync(attachmentId, options, callback)	Удаляет вложение из сообщения или встречи. Метод `removeAttachmentAsync` удаляет из элемента вложение с указанным идентификатором. Идентификатор вложения рекомендуется использовать для удаления вложения, только если оно добавлено тем же почтовым приложением в ходе текущего сеанса. В Outlook в Интернете, на мобильных устройствах и в новом Outlook в Windows идентификатор вложения действителен только в рамках одного сеанса. Сеанс завершается, когда пользователь закрывает приложение или если пользователь начинает создавать встроенную форму, затем открывает форму для продолжения в отдельном окне.
removeAttachmentAsync(attachmentId, callback)	Удаляет вложение из сообщения или встречи. Метод `removeAttachmentAsync` удаляет из элемента вложение с указанным идентификатором. Идентификатор вложения рекомендуется использовать для удаления вложения, только если оно добавлено тем же почтовым приложением в ходе текущего сеанса. В Outlook в Интернете, на мобильных устройствах и в новом Outlook в Windows идентификатор вложения действителен только в рамках одного сеанса. Сеанс завершается, когда пользователь закрывает приложение или если пользователь начинает создавать встроенную форму, затем открывает форму для продолжения в отдельном окне.
removeHandlerAsync(eventType, options, callback)	Удаляет обработчиков для поддерживаемого типа события. Примечание. События доступны только в реализации области задач. Сведения о поддерживаемых событиях см. в разделе События объектной модели элементов.
removeHandlerAsync(eventType, callback)	Удаляет обработчиков для поддерживаемого типа события. Примечание. События доступны только в реализации области задач. Сведения о поддерживаемых событиях см. в разделе События объектной модели элементов.
saveAsync(options, callback)	Асинхронно сохраняет текущее сообщение в виде черновика.
saveAsync(callback)	Асинхронно сохраняет текущее сообщение в виде черновика.
setSelectedDataAsync(data, options, callback)	Асинхронно вставляет данные в текст или тему сообщения. Метод `setSelectedDataAsync` вставляет указанную строку в положение курсора в теме или тексте элемента или, если текст выделен в редакторе, он заменяет выделенный текст. Если курсор не находится в поле текст или тема, возвращается ошибка. После вставки курсор помещается в конец вставленного содержимого.
setSelectedDataAsync(data, callback)	Асинхронно вставляет данные в текст или тему сообщения. Метод `setSelectedDataAsync` вставляет указанную строку в положение курсора в теме или тексте элемента или, если текст выделен в редакторе, он заменяет выделенный текст. Если курсор не находится в поле текст или тема, возвращается ошибка. После вставки курсор помещается в конец вставленного содержимого.

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

bcc

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

В зависимости от клиента или платформы (например, Windows, Mac и т. д.) могут применяться ограничения на количество получателей, которые можно получить или обновить. Дополнительные сведения см. в объекте Recipients .

bcc: Recipients;

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

Office.Recipients

Примеры

Office.context.mailbox.item.bcc.setAsync( ['alice@contoso.com', 'bob@contoso.com'] );
Office.context.mailbox.item.bcc.addAsync( ['jason@contoso.com'] );
Office.context.mailbox.item.bcc.getAsync(callback);

function callback(asyncResult) {
    const arrayOfBccRecipients = asyncResult.value;
}

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/30-recipients-and-attendees/get-set-bcc-message-compose.yaml

Office.context.mailbox.item.bcc.getAsync(function(asyncResult) {
  if (asyncResult.status === Office.AsyncResultStatus.Succeeded) {
    const msgBcc = asyncResult.value;
    console.log("Message being blind-copied to:");
    for (let i = 0; i < msgBcc.length; i++) {
      console.log(msgBcc[i].displayName + " (" + msgBcc[i].emailAddress + ")");
    }
  } else {
    console.error(asyncResult.error);
  }
});

...

const email = $("#emailBcc")
  .val()
  .toString();
const emailArray = [email];
Office.context.mailbox.item.bcc.setAsync(emailArray, function(asyncResult) {
  if (asyncResult.status === Office.AsyncResultStatus.Succeeded) {
    console.log("Succeeded in setting Bcc field.");
  } else {
    console.error(asyncResult.error);
  }
});

body

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

body: Body;

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

Office.Body

Примеры

// This example gets the body of the item as plain text.
Office.context.mailbox.item.body.getAsync(
    "text",
    { asyncContext: "This is passed to the callback" },
    function callback(result) {
        // Do something with the result.
    });

// The following is an example of the result parameter passed to the callback function.
{
    "value": "TEXT of whole body (including threads below)",
    "status": "succeeded",
    "asyncContext": "This is passed to the callback"
}

cc

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

Свойство cc возвращает объект Recipients, предоставляющий методы для получения или обновления получателей, которые указаны в строке Копия сообщения. Однако в зависимости от клиента или платформы (например, Windows, Mac и т. д.) могут применяться ограничения на количество получателей, которые можно получить или обновить. Дополнительные сведения см. в объекте Recipients .

cc: Recipients;

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

Office.Recipients

Примеры

Office.context.mailbox.item.cc.setAsync( ['alice@contoso.com', 'bob@contoso.com'] );
Office.context.mailbox.item.cc.addAsync( ['jason@contoso.com'] );
Office.context.mailbox.item.cc.getAsync(callback);

function callback(asyncResult) {
    const arrayOfCcRecipients = asyncResult.value;
}

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/30-recipients-and-attendees/get-set-cc-message-compose.yaml

Office.context.mailbox.item.cc.getAsync(function(asyncResult) {
  if (asyncResult.status === Office.AsyncResultStatus.Succeeded) {
    const msgCc = asyncResult.value;
    console.log("Message being copied to:");
    for (let i = 0; i < msgCc.length; i++) {
      console.log(msgCc[i].displayName + " (" + msgCc[i].emailAddress + ")");
    }
  } else {
    console.error(asyncResult.error);
  }
});

...

const email = $("#emailCc")
  .val()
  .toString();
const emailArray = [email];
Office.context.mailbox.item.cc.setAsync(emailArray, function(asyncResult) {
  if (asyncResult.status === Office.AsyncResultStatus.Succeeded) {
    console.log("Succeeded in setting Cc field.");
  } else {
    console.error(asyncResult.error);
  }
});

conversationId

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

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

Это свойство имеет значение NULL для нового элемента в форме создания. Свойство conversationId вернет значение, если пользователь задаст тему и сохранит элемент.

conversationId: string;

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

string

Примеры

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/90-other-item-apis/get-conversation-id-message.yaml

console.log(`Conversation ID: ${Office.context.mailbox.item.conversationId}`);

delayDeliveryTime

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

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

delayDeliveryTime: DelayDeliveryTime;

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

Office.DelayDeliveryTime

Примеры

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/90-other-item-apis/delay-message-delivery.yaml

function setDeliveryDate(minutes) {
  // This snippet sets the delivery date and time of a message.
  const currentTime = new Date().getTime();
  const milliseconds = totalDelay * 60000;
  const timeDelay = new Date(currentTime + milliseconds);
  Office.context.mailbox.item.delayDeliveryTime.setAsync(timeDelay, (asyncResult) => {
    if (asyncResult.status === Office.AsyncResultStatus.Failed) {
      console.log(asyncResult.error.message);
      return;
    }

    if (minutes === 1440) {
      console.log(`Delayed delivery by an additional one day.`);
    } else {
      console.log(`Delayed delivery by an additional ${minutes} minutes.`);
    }
  });
}

from

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

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

from: From;

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

Office.From

Примеры

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/30-recipients-and-attendees/get-from-message-compose.yaml

Office.context.mailbox.item.from.getAsync(function(asyncResult) {
  if (asyncResult.status === Office.AsyncResultStatus.Succeeded) {
    const msgFrom = asyncResult.value;
    console.log("Message from: " + msgFrom.displayName + " (" + msgFrom.emailAddress + ")");
  } else {
    console.error(asyncResult.error);
  }
});

inReplyTo

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

inReplyTo: string;

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

string

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

Примеры

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/90-other-item-apis/get-in-reply-to.yaml

// This snippet gets the ID of the message being replied to by the current message (PR_IN_REPLY_TO_ID).
// The API call is supported on messages being composed and isn't supported on read items.
const inReplyTo = Office.context.mailbox.item.inReplyTo;
if (inReplyTo) {
  console.log("ID of the message being replied to: " + inReplyTo);
} else {
  console.log("No InReplyTo property available for this message");
}

internetHeaders

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

Свойство internetHeaders возвращает объект, предоставляющий InternetHeaders методы для управления заголовками в Интернете в сообщении.

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

internetHeaders: InternetHeaders;

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

Office.InternetHeaders

Важно! API заголовков в Интернете поддерживается в Outlook для Android и iOS, начиная с версии 4.2405.0. Дополнительные сведения о функциях, поддерживаемых в Outlook на мобильных устройствах, см. в статье Api JavaScript Outlook, поддерживаемые в Outlook на мобильных устройствах.

Примеры

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/70-mime-headers/manage-custom-internet-headers-message-compose.yaml

Office.context.mailbox.item.internetHeaders.getAsync(
  ["preferred-fruit", "preferred-vegetable", "best-vegetable", "nonexistent-header"],
  function (asyncResult) {
    if (asyncResult.status === Office.AsyncResultStatus.Succeeded) {
      console.log("Selected headers: " + JSON.stringify(asyncResult.value));
    } else {
      console.log("Error getting selected headers: " + JSON.stringify(asyncResult.error));
    }
  }
);

itemType

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

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

itemType: MailboxEnums.ItemType | string;

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

Office.MailboxEnums.ItemType | string

Примеры

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/90-other-item-apis/get-item-type.yaml

const itemType = Office.context.mailbox.item.itemType;
switch (itemType) {
    case Office.MailboxEnums.ItemType.Appointment:
        console.log(`Current item is an ${itemType}.`);
        break;
    case Office.MailboxEnums.ItemType.Message:
        console.log(`Current item is a ${itemType}. A message could be an email, meeting request, meeting response, or meeting cancellation.`);
        break;
}

notificationMessages

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

notificationMessages: NotificationMessages;

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

Office.NotificationMessages

Примеры

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/35-notifications/add-getall-remove.yaml

// Adds a progress indicator to the mail item.
const id = $("#notificationId").val().toString();
const details =
  {
    type: Office.MailboxEnums.ItemNotificationMessageType.ProgressIndicator,
    message: "Progress indicator with id = " + id
  };
Office.context.mailbox.item.notificationMessages.addAsync(id, details, handleResult);

...

// Adds an informational notification to the mail item.
const id = $("#notificationId").val().toString();
const details =
  {
    type: Office.MailboxEnums.ItemNotificationMessageType.InformationalMessage,
    message: "Non-persistent informational notification message with id = " + id,
    icon: "icon1",
    persistent: false
  };
Office.context.mailbox.item.notificationMessages.addAsync(id, details, handleResult);

...

// Adds a persistent information notification to the mail item.
const id = $("#notificationId").val().toString();
const details =
  {
    type: Office.MailboxEnums.ItemNotificationMessageType.InformationalMessage,
    message: "Persistent informational notification message with id = " + id,
    icon: "icon1",
    persistent: true
  };
Office.context.mailbox.item.notificationMessages.addAsync(id, details, handleResult);

...

// Gets all the notification messages and their keys for the current mail item.
Office.context.mailbox.item.notificationMessages.getAllAsync((asyncResult) => {
  if (asyncResult.status === Office.AsyncResultStatus.Failed) {
    console.log(asyncResult.error.message);
    return;
  }

  console.log(asyncResult.value);
});

...

// Replaces a notification message of a given key with another message.
const id = $("#notificationId").val().toString();
Office.context.mailbox.item.notificationMessages.replaceAsync(
  id,
  {
    type: Office.MailboxEnums.ItemNotificationMessageType.InformationalMessage,
    message: "Notification message with id = " + id + " has been replaced with an informational message.",
    icon: "icon2",
    persistent: false
  },
  handleResult);

...

// Removes a notification message from the current mail item.
const id = $("#notificationId").val().toString();
Office.context.mailbox.item.notificationMessages.removeAsync(id, handleResult);

sensitivityLabel

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

sensitivityLabel: SensitivityLabel;

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

Office.SensitivityLabel

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

Примеры

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/60-sensitivity-label/sensitivity-label.yaml

// This snippet gets the current mail item's sensitivity label.
Office.context.sensitivityLabelsCatalog.getIsEnabledAsync((asyncResult) => {
  if (asyncResult.status === Office.AsyncResultStatus.Succeeded && asyncResult.value == true) {
    Office.context.mailbox.item.sensitivityLabel.getAsync((asyncResult) => {
      if (asyncResult.status === Office.AsyncResultStatus.Succeeded) {
        console.log(asyncResult.value);
      } else {
        console.log("Action failed with error: " + asyncResult.error.message);
      }
    });
  } else {
    console.log("Action failed with error: " + asyncResult.error.message);
  }
});

seriesId

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

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

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

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

seriesId: string;

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

string

Примеры

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/50-recurrence/get-series-id.yaml

const seriesId = Office.context.mailbox.item.seriesId;

if (seriesId === undefined) {
  console.log("This is a message that's not a meeting request.");
} else if (seriesId === null) {
  console.log("This is a single appointment, a parent series, or a meeting request for a series or single meeting.");
} else {
  console.log("This is an instance belonging to series with ID " + seriesId);
}

sessionData

Управляет SessionData элемента в режиме Compose.

Важно! Весь объект SessionData ограничен 50 000 символами на надстройку.

sessionData: SessionData;

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

Office.SessionData

Примеры

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/90-other-item-apis/session-data-apis.yaml

Office.context.mailbox.item.sessionData.getAllAsync(function(asyncResult) {
  if (asyncResult.status === Office.AsyncResultStatus.Succeeded) {
    console.log("The sessionData is " + JSON.stringify(asyncResult.value));
  } else {
    console.log("Failed to get all sessionData. Error: " + JSON.stringify(asyncResult.error));
  }
});

subject

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

Свойство subject получает или задает всю тему элемента для отправки с почтового сервера.

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

subject: Subject;

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

Office.Subject

Примеры

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/90-other-item-apis/get-set-subject-compose.yaml

Office.context.mailbox.item.subject.getAsync((result) => {
  if (result.status !== Office.AsyncResultStatus.Succeeded) {
    console.error(`Action failed with message ${result.error.message}`);
    return;
  }
  console.log(`Subject: ${result.value}`);
});

...

let subject = "Hello World!";
Office.context.mailbox.item.subject.setAsync(subject, (result) => {
  if (result.status !== Office.AsyncResultStatus.Succeeded) {
    console.error(`Action failed with message ${result.error.message}`);
    return;
  }
  console.log(`Successfully set subject to ${subject}`);
});

to

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

Свойство to возвращает объект Recipients, предоставляющий методы для получения или обновления получателей, которые указаны в строке Кому сообщения. Однако в зависимости от клиента или платформы (например, Windows, Mac и т. д.) могут применяться ограничения на количество получателей, которые можно получить или обновить. Дополнительные сведения см. в объекте Recipients .

to: Recipients;

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

Office.Recipients

Примеры

Office.context.mailbox.item.to.setAsync( ['alice@contoso.com', 'bob@contoso.com'] );
Office.context.mailbox.item.to.addAsync( ['jason@contoso.com'] );
Office.context.mailbox.item.to.getAsync(callback);

function callback(asyncResult) {
    const arrayOfToRecipients = asyncResult.value;
}

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/30-recipients-and-attendees/get-set-to-message-compose.yaml

Office.context.mailbox.item.to.getAsync(function(asyncResult) {
  if (asyncResult.status === Office.AsyncResultStatus.Succeeded) {
    const msgTo = asyncResult.value;
    console.log("Message being sent to:");
    for (let i = 0; i < msgTo.length; i++) {
      console.log(msgTo[i].displayName + " (" + msgTo[i].emailAddress + ")");
    }
  } else {
    console.error(asyncResult.error);
  }
});

...

const email = $("#emailTo")
  .val()
  .toString();
const emailArray = [email];
Office.context.mailbox.item.to.setAsync(emailArray, function(asyncResult) {
  if (asyncResult.status === Office.AsyncResultStatus.Succeeded) {
    console.log("Succeeded in setting To field.");
  } else {
    console.error(asyncResult.error);
  }
});

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

addFileAttachmentAsync(uri, attachmentName, options, callback)

Добавляет файл в сообщение или встречу в качестве вложения.

Метод addFileAttachmentAsync передает файл по указанному универсальному коду ресурса (URI) и вкладывает его в элемент в форме создания.

addFileAttachmentAsync(uri: string, attachmentName: string, options: Office.AsyncContextOptions & { isInline: boolean }, callback?: (asyncResult: Office.AsyncResult<string>) => void): void;

Параметры

uri: string

Универсальный код ресурса (URI), представляющий расположение файла, который нужно вложить в сообщение или встречу. Максимальная длина — 2048 символов.

attachmentName: string

Имя вложения, которое отображается при передаче вложения. Максимальная длина: 255 символов.

options: Office.AsyncContextOptions & { isInline: boolean }

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

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

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

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

void

В последних сборках классического Outlook для Windows была введена ошибка, которая неправильно добавляет Authorization: Bearer заголовок к этому действию (будь то с помощью этого API или пользовательского интерфейса Outlook). Чтобы обойти эту проблему, попробуйте использовать API, представленный addFileAttachmentFromBase64 с набором требований 1.8.
Универсальный код ресурса (URI) присоединяемого файла должен поддерживать кэширование в рабочей среде. Сервер, на котором размещен образ, не должен возвращать заголовок, указывающий Cache-Controlno-cache, no-storeили аналогичные параметры в HTTP-ответе. Однако при разработке надстройки и внесении изменений в файлы кэширование может помешать просмотру изменений. Мы рекомендуем использовать Cache-Control заголовки во время разработки.
Вы можете использовать тот же URI с методом removeAttachmentAsync для удаления вложения в том же сеансе.

Ошибки:

AttachmentSizeExceeded : вложение больше допустимого размера.
FileTypeNotSupported : вложение имеет расширение, которое запрещено.
NumberOfAttachmentsExceeded : сообщение или встреча содержит слишком много вложений.

Примеры

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/40-attachments/attachments-compose.yaml

const attachmentUrl = $("#attachmentUrl")
  .val()
  .toString();
Office.context.mailbox.item.addFileAttachmentAsync(
  attachmentUrl,
  getFileName(attachmentUrl),
  { isInline: false },
  (result) => {
    console.log(result);
  }
);

addFileAttachmentAsync(uri, attachmentName, callback)

Добавляет файл в сообщение или встречу в качестве вложения.

addFileAttachmentAsync(uri: string, attachmentName: string, callback?: (asyncResult: Office.AsyncResult<string>) => void): void;

Параметры

uri: string

attachmentName: string

Имя вложения, которое отображается при передаче вложения. Максимальная длина: 255 символов.

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

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

void

В последних сборках классического Outlook для Windows была введена ошибка, которая неправильно добавляет Authorization: Bearer заголовок к этому действию (будь то с помощью этого API или пользовательского интерфейса Outlook). Чтобы обойти эту проблему, попробуйте использовать API, представленный addFileAttachmentFromBase64 с набором требований 1.8.
Универсальный код ресурса (URI) присоединяемого файла должен поддерживать кэширование в рабочей среде. Сервер, на котором размещен образ, не должен возвращать заголовок, указывающий Cache-Controlno-cache, no-storeили аналогичные параметры в HTTP-ответе. Однако при разработке надстройки и внесении изменений в файлы кэширование может помешать просмотру изменений. Мы рекомендуем использовать Cache-Control заголовки во время разработки.
Вы можете использовать тот же URI с методом removeAttachmentAsync для удаления вложения в том же сеансе.

Ошибки:

AttachmentSizeExceeded : вложение больше допустимого размера.
FileTypeNotSupported : вложение имеет расширение, которое запрещено.
NumberOfAttachmentsExceeded : сообщение или встреча содержит слишком много вложений.

addFileAttachmentFromBase64Async(base64File, attachmentName, options, callback)

Добавляет файл в сообщение или встречу в качестве вложения.

Метод addFileAttachmentFromBase64Async передает файл из кодировки Base64 и присоединяет его к элементу в форме создания. Этот метод возвращает идентификатор вложения в объекте asyncResult.value .

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

addFileAttachmentFromBase64Async(base64File: string, attachmentName: string, options: Office.AsyncContextOptions & { isInline: boolean }, callback?: (asyncResult: Office.AsyncResult<string>) => void): void;

Параметры

base64File: string

Содержимое изображения или файла в кодировке Base64, добавляемое в сообщение электронной почты или событие. Максимальная длина закодированной строки составляет 27 892 122 символа (около 25 МБ).

attachmentName: string

Имя вложения, которое отображается при передаче вложения. Максимальная длина: 255 символов.

options: Office.AsyncContextOptions & { isInline: boolean }

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

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

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

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

void

Добавление встроенного файла Base64 в сообщение в режиме создания поддерживается в Outlook для Android и iOS. Дополнительные сведения о поддерживаемых API в Outlook Mobile см. в статье API JavaScript Для Outlook, поддерживаемые в Outlook на мобильных устройствах.
Если вы используете API URL-адреса данных (например, readAsDataURL), необходимо удалить префикс URL-адреса данных, а затем отправить оставшуюся часть строки в этот API. Например, если полная строка представлена , data:image/svg+xml;base64,<rest of Base64 string>удалите data:image/svg+xml;base64,.
Если вы добавляете встроенное изображение Base64 в текст создаваемого сообщения или встречи, перед вставкой изображения с помощью метода Office.context.mailbox.item.body.getAsync необходимо сначала получить текст текущего элемента addFileAttachmentFromBase64Asyncс помощью метода Office.context.mailbox.item.body.getAsync. В противном случае изображение не будет отображаться в тексте после вставки. Дополнительные рекомендации см. в разделе Вложение файла.

Ошибки:

AttachmentSizeExceeded : вложение больше допустимого размера.
FileTypeNotSupported : вложение имеет расширение, которое запрещено.
NumberOfAttachmentsExceeded : сообщение или встреча содержит слишком много вложений.

Примеры

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/40-attachments/attachments-compose.yaml

const base64String =
  "iVBORw0KGgoAAAANSUhEUgAAACAAAAAgCAYAAABzenr0AAAACXBIWXMAAAsSAAALEgHS3X78AAACRUlEQVRYw82XzXHbMBCFP2F8tzsQc8Ixyh0zoiuIXIGdCsxUYKqC0B04FdiuwMoM7mGOOIXqQGoAymXhgSX+itJM9kIRFLAP+3YXD5Pdbscx5oxaAIW8Ztr6l2PWmQwF4IyaieP53qdfAqQ8CwBn1JU4vpWhrbxXQA5MZfynANmcDIAzKgcy4FKGXsVJFf3nLgKyBQptfT4KQMRz2N0fcbxqmRMDWXflx0VPnrdArq0vekQ1Dv0UeHZGNebHhwjU8AzwKM43RyZnbAf58Q6ghudeWd0Aus0+5EcMIIRi3beua0D3Nm39BEAx3i7HTK4DEBJn5YxKOnaRA5+ErpMBWMpzDvx1RuXCcxOISlufAjfC7zgAsqsvUvMAD0ApPaEtGi9AIlUzKgJo60tt/SyKRkzLrAXERluf7W1gOICWaMyB386oooOWsIHvXbSoHuUSFovtHqicUVnH3EJoeT0aQEf5/XBGlc6otIOWBXAtPeZkAIJ9Bt6cUU9tZautX2nrk3MACHYr1ZKProKRtDw4o8pzAPjWo+NtpXTTvoteDDg8noDAcwbcRedAkGdFXyk2GEDcegVAFp2gyVDHjRQ4o6q2smoqtR5Hd+qMqtoALCWUUymr1m43QMZfOaMK4C0SrMsDANJ2E5FNcbdbjHC+ENl+H0myJFbLtaq4Rt8dyPBYRQV1E40nMv9rl7xrOw3DGb+Whcqu3i/OM6CUOWvgRlufNmnLYy4m77uJI7AXtdNcTDrU71LEyv7v01/N/ovL6bmu5/8A1tNWZldH0W4AAAAASUVORK5CYII=";
Office.context.mailbox.item.addFileAttachmentFromBase64Async(
  base64String,
  "logo.png",
  { isInline: false },
  (result) => {
    console.log(result);
  }
);

...

// Set the signature for the current item with inline image.
const modIcon1Base64 = "iVBORw0KGgoAAAANSUhEUgAAABwAAAAcCAYAAAByDd+UAAAAGXRFWHRTb2Z0d2FyZQBBZG9iZSBJbWFnZVJlYWR5ccllPAAAA2ZpVFh0WE1MOmNvbS5hZG9iZS54bXAAAAAAADw/eHBhY2tldCBiZWdpbj0i77u/IiBpZD0iVzVNME1wQ2VoaUh6cmVTek5UY3prYzlkIj8+IDx4OnhtcG1ldGEgeG1sbnM6eD0iYWRvYmU6bnM6bWV0YS8iIHg6eG1wdGs9IkFkb2JlIFhNUCBDb3JlIDUuMC1jMDYxIDY0LjE0MDk0OSwgMjAxMC8xMi8wNy0xMDo1NzowMSAgICAgICAgIj4gPHJkZjpSREYgeG1sbnM6cmRmPSJodHRwOi8vd3d3LnczLm9yZy8xOTk5LzAyLzIyLXJkZi1zeW50YXgtbnMjIj4gPHJkZjpEZXNjcmlwdGlvbiByZGY6YWJvdXQ9IiIgeG1sbnM6eG1wTU09Imh0dHA6Ly9ucy5hZG9iZS5jb20veGFwLzEuMC9tbS8iIHhtbG5zOnN0UmVmPSJodHRwOi8vbnMuYWRvYmUuY29tL3hhcC8xLjAvc1R5cGUvUmVzb3VyY2VSZWYjIiB4bWxuczp4bXA9Imh0dHA6Ly9ucy5hZG9iZS5jb20veGFwLzEuMC8iIHhtcE1NOk9yaWdpbmFsRG9jdW1lbnRJRD0ieG1wLmRpZDpDRDMxMDg1MjBCNDZFMTExODE2MkM1RUI2M0M4MDYxRCIgeG1wTU06RG9jdW1lbnRJRD0ieG1wLmRpZDpFMTUxQjgyRjQ2MEQxMUUxODlFMkQwNTYzQ0YwMTUxMiIgeG1wTU06SW5zdGFuY2VJRD0ieG1wLmlpZDpFMTUxQjgyRTQ2MEQxMUUxODlFMkQwNTYzQ0YwMTUxMiIgeG1wOkNyZWF0b3JUb29sPSJBZG9iZSBQaG90b3Nob3AgQ1M1LjEgV2luZG93cyI+IDx4bXBNTTpEZXJpdmVkRnJvbSBzdFJlZjppbnN0YW5jZUlEPSJ4bXAuaWlkOkQxMzEwODUyMEI0NkUxMTE4MTYyQzVFQjYzQzgwNjFEIiBzdFJlZjpkb2N1bWVudElEPSJ4bXAuZGlkOkNEMzEwODUyMEI0NkUxMTE4MTYyQzVFQjYzQzgwNjFEIi8+IDwvcmRmOkRlc2NyaXB0aW9uPiA8L3JkZjpSREY+IDwveDp4bXBtZXRhPiA8P3hwYWNrZXQgZW5kPSJyIj8+uC/WfAAAAehJREFUeNpilCzfwEAEkAbiECA2A2J1IOaHin8E4ptAfBaIVwLxU0IGMRKw0B6IW4DYhoE4cASIK6E0VsCEQ1wUiNcB8QESLGOAqj0MxBuhZhBloS4QnwHiQAbygR/UDF1CFupCXSjHQDmQg5qli8tCUBBsQUoQ1AD8UDNFsVk4n0o+w+bT+egWglKjNymmeGhLkqLcG2oHAwtUoIuQDj5OVgZPLUmwRe5aEmAxqYqNpFgKssOcCeplM0KqdST5GfpDDRm0JfkYrj3/SE7QguyQY4ImYYLgCtAS10kHGMw6dzNsv/qC7OwCClJXYlR++v6b4er3j5QmIFcmaNlIL6AOslCIjhYKMTHQGTBBqxh6gXcgC6/R0cKbIAv30dHCfaAKGJTxHxJSqS3Fz9DkowNmywpyMcgA8fF7b8D8VWcfM6w8+4gYC+VB+RCk8hSh0gaUD4/dewvlvUWRe/z+GzGWgex4BGtiOAHxXhoHpzMoSGHZAhSPW2lo2VZYWkHOh4nEtLrIAE+hZmNUwK+B2BOIv1PRsu9QM1/jatNcBtVZ0IREKXgENesyoVYbzNIdFFi2A5tl+NqlL6BB4QBNzsSCU1A9nlAzMAALAQMOQl0qB23qWwKxIlIrDBQ394H4OBCvISYqAAIMACVibHDqsO7zAAAAAElFTkSuQmCC";
Office.context.mailbox.item.addFileAttachmentFromBase64Async(
  modIcon1Base64,
  "myImage.png",
  { isInline: true },
  function(result) {
    if (result.status == Office.AsyncResultStatus.Succeeded) {
      const signature = $("#signature").val() + "<img src='cid:myImage.png'>";
      console.log(`Setting signature to "${signature}".`);
      Office.context.mailbox.item.body.setSignatureAsync(
        signature,
        { coercionType: "html" },
        function(asyncResult) {
          console.log(`setSignatureAsync: ${asyncResult.status}`);
        }
      );
    } else {
      console.error(`addFileAttachmentFromBase64Async: ${result.error}`);
    }
  }
);

addFileAttachmentFromBase64Async(base64File, attachmentName, callback)

Добавляет файл в сообщение или встречу в качестве вложения.

addFileAttachmentFromBase64Async(base64File: string, attachmentName: string, callback?: (asyncResult: Office.AsyncResult<string>) => void): void;

Параметры

base64File: string

attachmentName: string

Имя вложения, которое отображается при передаче вложения. Максимальная длина: 255 символов.

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

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

void

Добавление встроенного файла Base64 в сообщение в режиме создания поддерживается в Outlook для Android и iOS. Дополнительные сведения о поддерживаемых API в Outlook Mobile см. в статье API JavaScript Для Outlook, поддерживаемые в Outlook на мобильных устройствах.
Если вы используете API URL-адреса данных (например, readAsDataURL), необходимо удалить префикс URL-адреса данных, а затем отправить оставшуюся часть строки в этот API. Например, если полная строка представлена , data:image/svg+xml;base64,<rest of Base64 string>удалите data:image/svg+xml;base64,.
Если вы добавляете встроенное изображение Base64 в текст создаваемого сообщения или встречи, перед вставкой изображения с помощью метода Office.context.mailbox.item.body.getAsync необходимо сначала получить текст текущего элемента addFileAttachmentFromBase64Asyncс помощью метода Office.context.mailbox.item.body.getAsync. В противном случае изображение не будет отображаться в тексте после вставки. Дополнительные рекомендации см. в разделе Вложение файла.

Ошибки:

AttachmentSizeExceeded : вложение больше допустимого размера.
FileTypeNotSupported : вложение имеет расширение, которое запрещено.
NumberOfAttachmentsExceeded : сообщение или встреча содержит слишком много вложений.

addHandlerAsync(eventType, handler, options, callback)

Добавляет обработчик для поддерживаемого события. Примечание. События доступны только в реализации области задач.

Сведения о поддерживаемых событиях см. в разделе События объектной модели элементов.

addHandlerAsync(eventType: Office.EventType | string, handler: any, options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult<void>) => void): void;

Параметры

eventType: Office.EventType | string

Событие, которое должно вызвать обработчик.

handler: any

Функция для обработки события. Функция должна принимать один параметр, представляющий собой объектный литерал. Свойство type параметра будет соответствовать параметру, eventType переданного в addHandlerAsync.

options: Office.AsyncContextOptions

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

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

void

Примеры

function myHandlerFunction(eventarg) {
    if (eventarg.attachmentStatus === Office.MailboxEnums.AttachmentStatus.Added) {
        const attachment = eventarg.attachmentDetails;
        console.log("Event Fired and Attachment Added!");
        getAttachmentContentAsync(attachment.id, options, callback);
    }
}

Office.context.mailbox.item.addHandlerAsync(Office.EventType.AttachmentsChanged, myHandlerFunction, myCallback);

addHandlerAsync(eventType, handler, callback)

Сведения о поддерживаемых событиях см. в разделе События объектной модели элементов.

addHandlerAsync(eventType: Office.EventType | string, handler: any, callback?: (asyncResult: Office.AsyncResult<void>) => void): void;

Параметры

eventType: Office.EventType | string

Событие, которое должно вызвать обработчик.

handler: any

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

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

void

addItemAttachmentAsync(itemId, attachmentName, options, callback)

Добавляет к сообщению элемент Exchange, например сообщение, в виде вложения.

С помощью метода addItemAttachmentAsync можно в элемент формы создания вложить элемент с указанным идентификатором Exchange. Если указать функцию обратного вызова, метод вызывается с одним параметром , asyncResultкоторый содержит идентификатор вложения или код, указывающий на любую ошибку, которая произошла при присоединении элемента. Параметр options можно использовать для передачи сведений о состоянии функции обратного вызова, если это необходимо.

Если надстройка Office работает в Outlook в Интернете или в новом Outlook в Windows, addItemAttachmentAsync метод может присоединять элементы к элементам, отличным от редактируется. Однако это не поддерживается и не рекомендуется.

addItemAttachmentAsync(itemId: any, attachmentName: string, options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult<string>) => void): void;

Параметры

itemId: any

Идентификатор Exchange для вкладываемого элемента. Максимальная длина — 100 символов.

attachmentName: string

Имя вложения, которое отображается при передаче вложения. Максимальная длина: 255 символов.

options: Office.AsyncContextOptions

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

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

void

Примеры

// The following example adds an existing Outlook item as an attachment
// with the name "My Attachment".
function addAttachment() {
    // EWS ID of item to attach (shortened for readability).
    const itemId = "AAMkADI1...AAA=";

    // The values in asyncContext can be accessed in the callback.
    const options = { asyncContext: { var1: 1, var2: 2 } };

    Office.context.mailbox.item.addItemAttachmentAsync(itemId, "My Attachment", options, (result) => {
        if (result.status === Office.AsyncResultStatus.Failed) {
            console.error("Failed to add attachment: " + result.error.message);
            return;
        }

        console.log("Attachment added successfully.");
        console.log("var1: " + result.asyncContext.var1);
        console.log("var2: " + result.asyncContext.var2);
    });
}

addItemAttachmentAsync(itemId, attachmentName, callback)

Добавляет к сообщению элемент Exchange, например сообщение, в виде вложения.

addItemAttachmentAsync(itemId: any, attachmentName: string, callback?: (asyncResult: Office.AsyncResult<string>) => void): void;

Параметры

itemId: any

Идентификатор Exchange для вкладываемого элемента. Максимальная длина — 100 символов.

attachmentName: string

Имя вложения, которое отображается при передаче вложения. Максимальная длина: 255 символов.

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

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

void

close()

Закрывает текущий создаваемый элемент.

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

В Outlook в Windows (классической) и на Mac close метод не влияет на ответ в области чтения.

close(): void;

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

void

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

Совет. Используйте метод closeAsync вместо метода , close если вы хотите, чтобы надстройка:

Автоматически отменяйте создаваемое сообщение, не запрашивая у пользователя диалоговое окно сохранения.
Определите, когда пользователь отменяет диалоговое окно сохранения элемента в создаваемом сообщении.
Закройте ответ в области чтения или существующий черновик.

Примеры

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/25-item-save-and-close/close.yaml

Office.context.mailbox.item.close();

closeAsync(options, callback)

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

closeAsync(options: Office.AsyncContextOptions & { discardItem: boolean }, callback?: (asyncResult: Office.AsyncResult<void>) => void): void;

Параметры

options: Office.AsyncContextOptions & { discardItem: boolean }

Литерал объекта, содержащий одно или несколько следующих свойств:- asyncContext: разработчики могут предоставить любой объект, к которому они хотят получить доступ в функции обратного вызова. discardItem : если trueзадано значение , текущее создаваемое сообщение закрывается, а несохраненные изменения удаляются. Если параметр не объявлен или имеет значение false, появляется диалоговое окно сохранения с предложением сохранить черновик, отменить изменения или отменить операцию. Такое поведение возникает для новых сообщений и ответов, полученных из области чтения. Если вы хотите закрыть ответ в области чтения или существующем черновике, необходимо задать значение discardItemtrue. В противном случае вызов вернет ошибку. Дополнительные сведения об ошибке см. в разделе Примечания.

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

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

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

void

The operation was cancelled by the user : пользователь выбирает отмену в диалоговом окне сохранения, а discardItem свойство не определено или имеет значение false.
The operation is not supported closeAsync: метод пытается закрыть ответ в области чтения или существующем черновикеdiscardItem, а свойство не определено или имеет значение false.

closeAsync(callback)

Закрывает текущее новое сообщение, которое создается.

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

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

Параметры

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

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

void

The operation was cancelled by the user : пользователь выбирает Отмена в диалоговом окне сохранения.
The operation is not supported closeAsync: метод пытается закрыть ответ в области чтения или существующий черновик.

Примеры

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/25-item-save-and-close/close-async.yaml

// This snippet closes the current message being composed and discards any unsaved changes when the optional property, discardItem, is set to true.
// The API call works on a new message being composed, a reply, or an existing draft.
// When discardItem is set to false or isn't defined on a new message with unsaved changes, the user is prompted to save a draft, discard the changes, or cancel the close operation.
Office.context.mailbox.item.closeAsync(
  { discardItem: true },
  (asyncResult) => {
    if (asyncResult.status === Office.AsyncResultStatus.Failed) {
      console.log("Action failed with error: " + asyncResult.error.message);
      return;
    }
  });

disableClientSignatureAsync(options, callback)

Отключает подпись клиента Outlook.

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

В Outlook в Интернете и Outlook в Windows параметр подписи для новых сообщений, ответов и пересылаемых сообщений отключен. Выбранная сигнатура также отключается методом .
В Outlook в Windows (классической версии) и на Mac для подписи в разделах Новые сообщения и Ответы и пересылки учетной записи отправки задано значение (нет).
В Outlook для Android и iOS сигнатура, сохраненная на мобильном устройстве, очищается.

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

Параметры

options: Office.AsyncContextOptions

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

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

void

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

Примеры

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/90-other-item-apis/work-with-client-signatures.yaml

// Disable the client signature.
Office.context.mailbox.item.disableClientSignatureAsync(function(asyncResult) {
  if (asyncResult.status === Office.AsyncResultStatus.Succeeded) {
    console.log("disableClientSignatureAsync succeeded");
  } else {
    console.error(asyncResult.error);
  }
});

disableClientSignatureAsync(callback)

Отключает подпись клиента Outlook.

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

В Outlook в Интернете и Outlook в Windows параметр подписи для новых сообщений, ответов и пересылаемых сообщений отключен. Выбранная сигнатура также отключается методом .
В Outlook в Windows (классической версии) и на Mac для подписи в разделах Новые сообщения и Ответы и пересылки учетной записи отправки задано значение (нет).
В Outlook для Android и iOS сигнатура, сохраненная на мобильном устройстве, очищается.

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

Параметры

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

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

void

getAttachmentContentAsync(attachmentId, options, callback)

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

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

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

Параметры

attachmentId: string

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

options: Office.AsyncContextOptions

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

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

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

void

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

Примеры

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/40-attachments/get-attachment-content.yaml

// Gets the attachments of the current message or appointment in compose mode.
const options = { asyncContext: { currentItem: item } };
// The getAttachmentsAsync call can only be used in compose mode.
item.getAttachmentsAsync(options, callback);

function callback(result) {
  if (result.status === Office.AsyncResultStatus.Failed) {
    console.log(result.error.message);
    return;
  }

  if (result.value.length <= 0) {
    console.log("Mail item has no attachments.");
    return;
  }

  for (let i = 0; i < result.value.length; i++) {
    // Log the attachment type and its contents to the console.
    result.asyncContext.currentItem.getAttachmentContentAsync(result.value[i].id, handleAttachmentsCallback);
  }
}

getAttachmentContentAsync(attachmentId, callback)

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

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

Параметры

attachmentId: string

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

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

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

void

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

Примеры

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/40-attachments/attachments-compose.yaml

Office.context.mailbox.item.getAttachmentsAsync((result) => {
  if (result.status === Office.AsyncResultStatus.Failed) {
    console.error(result.error.message);
    return;
  }

  if (result.value.length > 0) {
    for (let i = 0; i < result.value.length; i++) {
      const attachment = result.value[i];
      let attachmentType;
      switch (attachment.attachmentType) {
        case Office.MailboxEnums.AttachmentType.Cloud:
          attachmentType = "Attachment is stored in a cloud location";
          break;
        case Office.MailboxEnums.AttachmentType.File:
          attachmentType = "Attachment is a file";
          break;
        case Office.MailboxEnums.AttachmentType.Item:
          attachmentType = "Attachment is an Exchange item";
          break;
      }
      console.log(
        "ID: " +
          attachment.id +
          "\n" +
          "Type: " +
          attachmentType +
          "\n" +
          "Name: " +
          attachment.name +
          "\n" +
          "Size: " +
          attachment.size +
          "\n" +
          "isInline: " +
          attachment.isInline
      );
    }
  } else {
    console.log("No attachments on this message.");
  }
});

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 для элемента сообщения.

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

getComposeTypeAsync(callback)

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

Параметры

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

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

void

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

Примеры

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/90-other-item-apis/work-with-client-signatures.yaml

// Get the compose type of the current message.
Office.context.mailbox.item.getComposeTypeAsync(function(asyncResult) {
  if (asyncResult.status === Office.AsyncResultStatus.Succeeded) {
    console.log(
      "getComposeTypeAsync succeeded with composeType: " +
        asyncResult.value.composeType +
        " and coercionType: " +
        asyncResult.value.coercionType
    );
  } else {
    console.error(asyncResult.error);
  }
});

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

Примеры

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/90-other-item-apis/get-conversation-index.yaml

// This snippet returns the Base64-encoded position of the current message in a conversation thread (PR_CONVERSATION_INDEX).
// The API call is supported on a message being composed and isn't supported on read items or appointments.
Office.context.mailbox.item.getConversationIndexAsync((result) => {
   if (result.status === Office.AsyncResultStatus.Failed) {
      console.log(result.error.message);
      return;
   }
   
   const conversationIndex = result.value;
   if (conversationIndex) {
      console.log("Position in the conversation thread: " + conversationIndex);
   } else {
      console.log("The current message doesn't belong to a conversation thread.");
   }
});

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

Примеры

// Get the initialization context (if present).
Office.context.mailbox.item.getInitializationContextAsync((asyncResult) => {
    if (asyncResult.status === Office.AsyncResultStatus.Succeeded) {
        if (asyncResult.value.length > 0) {
            // The value is a string, parse to an object.
            const context = JSON.parse(asyncResult.value);
            // Do something with context.
        } else {
            // Empty context, treat as no context.
        }
    } else {
        // Handle the error.
    }
});

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.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.Schedule.Meeting.Request	приглашения на собрания;
IPM.Schedule.Meeting.Canceled	Отмены собраний
IPM.Schedule.Meeting.Resp.Neg	Отклонение приглашений на собрания
IPM.Schedule.Meeting.Resp.Pos	Принятие приглашений на собрания
IPM.Schedule.Meeting.Resp.Tent	Предварительное принятие приглашений на собрания

Примеры

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/90-other-item-apis/get-item-class-async.yaml

// This snippet returns the Exchange Web Services item class property (PR_MESSAGE_CLASS) of the current message.
// The API call is only supported on a message being composed.
Office.context.mailbox.item.getItemClassAsync((asyncResult) => {
  if (asyncResult.status === Office.AsyncResultStatus.Failed) {
    console.log("Action failed with error: " + asyncResult.error.message);
    return;
  }

  console.log("Item class of the current message: " + asyncResult.value);
});

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 (например, чтобы получить идентификатор элемента для использования с EWS или REST API), имейте в виду, что когда Outlook находится в кэшированном режиме, может потребоваться некоторое время, прежде чем элемент будет синхронизирован с сервером. Пока элемент не будет синхронизирован, идентификатор элемента не распознается и при его использовании возвращается ошибка.

Ошибки:

ItemNotSaved : идентификатор не может быть получен до сохранения элемента.

getItemIdAsync(callback)

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

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

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

Параметры

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

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

void

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

Ошибки:

ItemNotSaved : идентификатор не может быть получен до сохранения элемента.

Примеры

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/90-other-item-apis/item-id-compose.yaml

Office.context.mailbox.item.getItemIdAsync((result) => {
    if (result.status === Office.AsyncResultStatus.Failed) {
        console.error(`getItemIdAsync failed with message: ${result.error.message}`);
        return;
    }

    console.log(result.value);
});

getSelectedDataAsync(coercionType, options, callback)

Асинхронно возвращает данные, выбранные в теме или тексте сообщения.

Если выделение отсутствует, но курсор находится в тексте или теме, метод возвращает пустую строку для выбранных данных. Если выбраны не текст и не тема, метод возвращает ошибку InvalidSelection.

Чтобы получить доступ к выбранным данным из функции обратного вызова, вызовите .asyncResult.value.data Чтобы получить доступ к свойству источника, из которого происходит выбор, вызовите asyncResult.value.sourceProperty, который будет иметь значение body или subject.

getSelectedDataAsync(coercionType: Office.CoercionType | string, options: Office.AsyncContextOptions, callback: (asyncResult: Office.AsyncResult<any>) => void): void;

Параметры

coercionType: Office.CoercionType | string

Запрашивает формат данных. Если Textзадано значение , метод возвращает обычный текст в виде строки, удаляя все присутствующие HTML-теги. Если Htmlзадано значение , метод возвращает выделенный текст, будь то обычный текст или HTML.

options: Office.AsyncContextOptions

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

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

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

void

Выбранные данные в виде строки с форматом, определенным .coercionType

Примеры

// Get selected data.
Office.context.mailbox.item.getSelectedDataAsync(Office.CoercionType.Text, { option1: "option1"}, getCallback);

function getCallback(asyncResult) {
    const text = asyncResult.value.data;
    const prop = asyncResult.value.sourceProperty;

    console.log(`Selected text in ${prop}: ${text}`);
}

getSelectedDataAsync(coercionType, callback)

Асинхронно возвращает данные, выбранные в теме или тексте сообщения.

getSelectedDataAsync(coercionType: Office.CoercionType | string, callback: (asyncResult: Office.AsyncResult<any>) => void): void;

Параметры

coercionType: Office.CoercionType | string

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

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

void

Выбранные данные в виде строки с форматом, определенным .coercionType

Примеры

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/20-item-body/get-selected-data.yaml

Office.context.mailbox.item.getSelectedDataAsync(Office.CoercionType.Text, function(asyncResult) {
  if (asyncResult.status === Office.AsyncResultStatus.Succeeded) {
    const text = asyncResult.value.data;
    const prop = asyncResult.value.sourceProperty;
    console.log("Selected text in " + prop + ": " + text);
  } else {
    console.error(asyncResult.error);
  }
});

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

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

Б. Общий почтовый ящик (применяется только к Outlook в Windows)

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

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

getSharedPropertiesAsync(callback)

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

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

Параметры

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

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

void

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

Б. Общий почтовый ящик (применяется только к Outlook в Windows)

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

Примеры

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/65-delegates-and-shared-folders/get-shared-properties.yaml

Office.context.mailbox.item.getSharedPropertiesAsync((result) => {
  if (result.status === Office.AsyncResultStatus.Failed) {
    console.error("The current folder or mailbox isn't shared.");
    return;
  }
  const sharedProperties = result.value;
  console.log(`Owner: ${sharedProperties.owner}`);
  console.log(`Permissions: ${sharedProperties.delegatePermissions}`);
  console.log(`Target mailbox: ${sharedProperties.targetMailbox}`);
});

isClientSignatureEnabledAsync(options, callback)

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

В Outlook в Windows (классической версии) и на Mac вызов API возвращает, true если для подписи по умолчанию для новых сообщений, ответов или пересылки задан шаблон для учетной записи Отправляющего Outlook. В Outlook в Интернете и outlook в Windows вызов API возвращаетtrue, если сигнатура включена для типовnewMail создания , replyили forward. Если для параметров задано значение "(none)" в Outlook в Windows (классическая версия) или на Mac, или они отключены в 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

Примеры

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/90-other-item-apis/work-with-client-signatures.yaml

// Check if the client signature is currently enabled.
Office.context.mailbox.item.isClientSignatureEnabledAsync(function(asyncResult) {
  if (asyncResult.status === Office.AsyncResultStatus.Succeeded) {
    console.log("isClientSignatureEnabledAsync succeeded with result: " + asyncResult.value);
  } else {
    console.error(asyncResult.error);
  }
});

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

Примеры

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/15-item-custom-properties/load-set-get-save.yaml

Office.context.mailbox.item.loadCustomPropertiesAsync((result) => {
  if (result.status === Office.AsyncResultStatus.Failed) {
    console.error(`loadCustomPropertiesAsync failed with message ${result.error.message}`);
    return;
  }

  customProps = result.value;
  console.log("Loaded the CustomProperties object.");
});

removeAttachmentAsync(attachmentId, options, callback)

Удаляет вложение из сообщения или встречи.

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

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

Параметры

attachmentId: string

Идентификатор удаляемого вложения. Максимальная длина attachmentId строки составляет 200 символов в Outlook в Интернете и в Windows (новые и классические).

options: Office.AsyncContextOptions

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

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

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

void

Важно*. Метод removeAttachmentAsync не удаляет встроенные вложения из почтового элемента. Чтобы удалить встроенное вложение, сначала получите текст элемента, а затем удалите все ссылки на вложение из его содержимого. Используйте API Office.Body , чтобы получить и задать текст элемента.

Ошибки:

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

Примеры

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/40-attachments/attachments-compose.yaml

Office.context.mailbox.item.removeAttachmentAsync(
  $("#attachmentId")
    .val()
    .toString(),
  (result) => {
    if (result.status === Office.AsyncResultStatus.Failed) {
      console.error(result.error.message);
      return;
    }

    console.log(`Attachment removed successfully.`);
  }
);

removeAttachmentAsync(attachmentId, callback)

Удаляет вложение из сообщения или встречи.

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

Параметры

attachmentId: string

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

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

void

removeHandlerAsync(eventType, options, callback)

Удаляет обработчиков для поддерживаемого типа события. Примечание. События доступны только в реализации области задач.

Сведения о поддерживаемых событиях см. в разделе События объектной модели элементов.

removeHandlerAsync(eventType: Office.EventType | string, options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult<void>) => void): void;

Параметры

eventType: Office.EventType | string

Событие, которое должно отменить обработчик.

options: Office.AsyncContextOptions

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

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

void

removeHandlerAsync(eventType, callback)

Сведения о поддерживаемых событиях см. в разделе События объектной модели элементов.

removeHandlerAsync(eventType: Office.EventType | string, callback?: (asyncResult: Office.AsyncResult<void>) => void): void;

Параметры

eventType: Office.EventType | string

Событие, которое должно отменить обработчик.

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

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

void

Примеры

Office.context.mailbox.item.removeHandlerAsync(Office.EventType.ItemChanged, (asyncResult) => {
    if (asyncResult.status === Office.AsyncResultStatus.Failed) {
        console.error("Failed to remove event handler: " + asyncResult.error.message);
        return;
    }

    console.log("Event handler removed successfully.");
});

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 : идентификатор вложения не существует.

Примеры

Office.context.mailbox.item.saveAsync(
    function callback(result) {
        // Process the result.
    });

// The following is an example of the
// `result` parameter passed to the
// callback function. The `value`
// property contains the item ID of
// the item.
{
    "value": "AAMkADI5...AAA=",
    "status": "succeeded"
}

setSelectedDataAsync(data, options, callback)

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

Метод setSelectedDataAsync вставляет указанную строку в положение курсора в теме или тексте элемента или, если текст выделен в редакторе, он заменяет выделенный текст. Если курсор не находится в поле текст или тема, возвращается ошибка. После вставки курсор помещается в конец вставленного содержимого.

setSelectedDataAsync(data: string, options: Office.AsyncContextOptions & CoercionTypeOptions, callback?: (asyncResult: Office.AsyncResult<void>) => void): void;

Параметры

data: string

Вставляемые данные. Объем данных не должен превышать 1 000 000 символов. Если передано больше 1 000 000 символов, возвращается исключение ArgumentOutOfRange.

options: Office.AsyncContextOptions & Office.CoercionTypeOptions

Литерал объекта, содержащий одно или несколько следующих свойств:- asyncContext: разработчики могут предоставить любой объект, к которому они хотят получить доступ в функции обратного вызова. coercionType : если текст, текущий стиль применяется в Outlook в Интернете, в Windows (новая и классическая версия) и на Mac. Если поле представляет собой редактор HTML, вставляются только текстовые данные, даже если они имеют формат HTML. Если данные являются HTML и поле поддерживает HTML (тема не поддерживает), текущий стиль применяется в Outlook в Интернете и новом Outlook в Windows. Стиль по умолчанию применяется в Outlook в Windows (классической) и на Mac. Если поле является текстовым, возвращается ошибка InvalidDataFormat. Если свойство coercionType не задано, результат зависит от поля: если поле имеет формат HTML, используется текст в формате HTML, а если поле текстовое, применяется обычный текст.

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

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

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

void

Примеры

Office.context.mailbox.item.setSelectedDataAsync("<b>Hello World!</b>", { coercionType : "html" });

Office.context.mailbox.item.setSelectedDataAsync("Hello World!");

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/90-other-item-apis/set-selected-data.yaml

Office.context.mailbox.item.setSelectedDataAsync("Replaced", function(asyncResult) {
  if (asyncResult.status === Office.AsyncResultStatus.Succeeded) {
    console.log("Selected text has been updated successfully.");
  } else {
    console.error(asyncResult.error);
  }
});

setSelectedDataAsync(data, callback)

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

setSelectedDataAsync(data: string, callback?: (asyncResult: Office.AsyncResult<void>) => void): void;

Параметры

data: string

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

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

void

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

Office.MessageCompose interface

Свойства

Методы

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

bcc

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

Комментарии

Примеры

body

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

Комментарии

Примеры

categories

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

Комментарии

Примеры

cc

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

Комментарии

Примеры

conversationId

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

Комментарии

Примеры

delayDeliveryTime

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

Комментарии

Примеры

from

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

Комментарии

Примеры

inReplyTo

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

Комментарии

Примеры

internetHeaders

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

Комментарии

Примеры

itemType

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

Комментарии

Примеры

notificationMessages

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

Комментарии

Примеры

sensitivityLabel

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

Комментарии

Примеры

seriesId

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

Комментарии

Примеры

sessionData

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

Комментарии

Примеры

subject

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

Комментарии

Примеры

to

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

Комментарии

Примеры

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

addFileAttachmentAsync(uri, attachmentName, options, callback)

Параметры

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

Комментарии

Примеры

addFileAttachmentAsync(uri, attachmentName, callback)

Параметры

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

Комментарии

addFileAttachmentFromBase64Async(base64File, attachmentName, options, callback)