Office.MessageRead interface

Ссылка

Пакет:: outlook

Режим чтения сообщений Office.context.mailbox.item.

Важно!

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

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

Extends: Office.Message

// The following code builds an HTML string with details of all attachments on the current item.
 const item = Office.context.mailbox.item;
 let outputString = "";
 if (item.attachments.length > 0) {
     for (let i = 0 ; i < item.attachments.length ; i++) {
         const attachment = item.attachments[i];
         outputString += "<BR>" + i + ". Name: ";
         outputString += attachment.name;
         outputString += "<BR>ID: " + attachment.id;
         outputString += "<BR>contentType: " + attachment.contentType;
         outputString += "<BR>size: " + attachment.size;
         outputString += "<BR>attachmentType: " + attachment.attachmentType;
         outputString += "<BR>isInline: " + attachment.isInline;
     }
 }
 console.log(outputString);

Свойства

attachments	Возвращает вложения элемента в виде массива.
body	Получает объект, предоставляющий методы для работы с основным текстом элемента.
categories	Возвращает объект , предоставляющий методы для управления категориями элемента.
cc	Предоставляет доступ к получателям копии сообщения. Тип объекта и уровень доступа зависят от режима текущего элемента. Свойство `cc` возвращает массив, содержащий объект EmailAddressDetails для каждого получателя, указанного в строке Копия сообщения. Максимальное число возвращенных получателей зависит от клиента Outlook. классическая Windows: 500 получателей Android, классический пользовательский интерфейс Mac, iOS: 100 получателей Веб-браузер, новый Outlook: 20 получателей (свернутое представление), 500 получателей (развернутое представление) Новый пользовательский интерфейс Mac: нет ограничений
conversationId	Получает идентификатор разговора по электронной почте, содержащего конкретное сообщение. Вы можете получить целочисленное значение этого свойства, если ваше почтовое приложение активируется в формах просмотра или формах создания ответов. Если пользователь изменит тему ответа, после его отправки идентификатор беседы будет изменен, и полученное ранее значение будет недействительным. Это свойство имеет значение NULL для нового элемента в форме создания. Свойство `conversationId` вернет значение, если пользователь задаст тему и сохранит элемент.
dateTimeCreated	Получает дату и время создания элемента.
dateTimeModified	Получает дату и время последнего изменения элемента.
end	Возвращает дату и время окончания встречи. Свойство `end` представляет собой объект, выраженный `Date` в виде значения даты и времени в формате UTC. Метод можно использовать для `convertToLocalClientTime` преобразования `end` значения свойства в локальные значения даты и времени клиента. Если вы задаете время окончания с помощью метода `Time.setAsync`, необходимо использовать метод `convertToUtcClientTime` для преобразования местного времени на клиенте в формат UTC для сервера.
from	Получает электронный адрес отправителя сообщения. Свойства `from` и `sender` представляют одно лицо, если сообщение не отправлено представителем. В этом случае `from` свойство представляет делегатор, а `sender` свойство представляет делегат. Примечание. Свойство `recipientTypeEmailAddressDetails` объекта в свойстве `from` не определено. Свойство `from` возвращает `EmailAddressDetails` объект .
internetMessageId	Возвращает идентификатор интернет-сообщения для сообщения электронной почты. Важно! В папке "Отправленные`internetMessageId`" объект может быть еще недоступен для недавно отправленных элементов. В этом случае рассмотрите возможность использования веб-служб Exchange для получения этого свойства с сервера.
itemClass	Возвращает класс элементов веб-служб Exchange выбранного сообщения.
itemId	Возвращает идентификатор элемента веб-служб Exchange (EWS) текущего элемента.
itemType	Получает тип элемента, который представляет экземпляр. Свойство `itemType` возвращает одно из значений `ItemType` перечисления, указывающее, является ли экземпляр объекта элемента сообщением или встречей.
location	Возвращает расположение приглашения на собрание. Свойство `location` возвращает строку, содержащую сведения о месте встречи.
normalizedSubject	Возвращает тему элемента со всеми удаленными префиксами (включая RE: и FWD:). Свойство `normalizedSubject` получает тему элемента с любыми стандартными префиксами (например, RE: и FW:), которые добавляются программами электронной почты. Для получения темы элемента с неизмененными префиксами используйте свойство `subject`.
notificationMessages	Получает сообщения уведомления для элемента.
recurrence	Возвращает шаблон повторения встречи. Возвращает шаблон повторения приглашения на собрание. Режимы чтения и создания для элементов встреч. Режим чтения для элементов приглашения на собрание. Свойство `recurrence` возвращает `Recurrence` объект для повторяющихся встреч или запросов собраний, если элемент является рядом или экземпляром ряда. `null` возвращается для отдельных встреч и запросов на собрания для отдельных встреч. `undefined` возвращается для сообщений, которые не являются приглашениями на собрание. Примечание. В приглашениях на собрание имеется значение itemClass , равное `IPM.Schedule.Meeting.Request`. Примечание. Если `recurrence` объект имеет значение NULL, это означает, что объект является одной встречей или приглашением на собрание одной встречи, а НЕ частью ряда.
sender	Получает электронный адрес отправителя электронного сообщения. Свойства `from` и `sender` представляют одно лицо, если сообщение не отправлено представителем. В этом случае `from` свойство представляет делегатор, а `sender` свойство представляет делегат. Примечание. Свойство `recipientTypeEmailAddressDetails` объекта в свойстве `sender` не определено.
seriesId	Возвращает идентификатор ряда, к которому принадлежит экземпляр. В Outlook в Интернете, в Windows (новой и классической версии) и в Mac `seriesId` возвращает идентификатор веб-служб Exchange (EWS) родительского элемента (ряда), к которому принадлежит этот элемент. Однако в Outlook для Android и в iOS `seriesId` возвращает идентификатор REST родительского элемента. Примечание. Идентификатор, возвращаемый свойством `seriesId` , совпадает с идентификатором элемента веб-служб Exchange. Свойство `seriesId` не идентично идентификаторам Outlook, используемым REST API Outlook. Перед выполнением вызовов REST API с использованием этого значения его следует преобразовать с помощью `Office.context.mailbox.convertToRestId`. Дополнительные сведения см. в разделе Использование REST API Outlook из надстройки Outlook. Свойство `seriesId` возвращает `null` для элементов, которые не имеют родительских элементов, таких как отдельные встречи, элементы рядов или приглашения на собрание, и возвращает для `undefined` других элементов, которые не являются приглашениями на собрания.
start	Возвращает дату и время начала встречи. Свойство `start` представляет собой объект, выраженный `Date` в виде значения даты и времени в формате UTC. Метод можно использовать для `convertToLocalClientTime` преобразования значения в локальные дату и время клиента.
subject	Возвращает описание, отображающееся в поле темы элемента. Свойство `subject` получает или задает всю тему элемента для отправки с почтового сервера. Свойство `subject` возвращает строку. Используйте свойство , `normalizedSubject` чтобы получить субъект без всех начальных префиксов, таких как RE: и FW:.
to	Предоставляет доступ к получателям, указанным в строке Кому сообщения. Тип объекта и уровень доступа зависят от режима текущего элемента. Свойство `to` возвращает массив, содержащий объект EmailAddressDetails для каждого получателя, указанного в строке Кому сообщения. Максимальное число возвращенных получателей зависит от клиента Outlook. классическая Windows: 500 получателей Android, классический пользовательский интерфейс Mac, iOS: 100 получателей Веб-браузер, новый Outlook: 20 получателей (свернутое представление), 500 получателей (развернутое представление) Новый пользовательский интерфейс Mac: нет ограничений

Методы

addHandlerAsync(eventType, handler, options, callback)	Добавляет обработчик для поддерживаемого события. Примечание. События доступны только в реализации области задач. Сведения о поддерживаемых событиях см. в разделе События объектной модели элементов.
addHandlerAsync(eventType, handler, callback)	Добавляет обработчик для поддерживаемого события. Примечание. События доступны только в реализации области задач. Сведения о поддерживаемых событиях см. в разделе События объектной модели элементов.
displayReplyAllForm(formData)	Отображает форму ответа, включающую отправителя и всех получателей выбранного сообщения либо организатора и всех участников выбранной встречи.
displayReplyAllFormAsync(formData, options, callback)	Отображает форму ответа, включающую отправителя и всех получателей выбранного сообщения либо организатора и всех участников выбранной встречи.
displayReplyAllFormAsync(formData, callback)	Отображает форму ответа, включающую отправителя и всех получателей выбранного сообщения либо организатора и всех участников выбранной встречи.
displayReplyForm(formData)	Отображает форму ответа, включающую только отправителя выбранного сообщения или организатора выбранной встречи.
displayReplyFormAsync(formData, options, callback)	Отображает форму ответа, включающую только отправителя выбранного сообщения или организатора выбранной встречи.
displayReplyFormAsync(formData, callback)	Отображает форму ответа, включающую только отправителя выбранного сообщения или организатора выбранной встречи.
getAllInternetHeadersAsync(options, callback)	Возвращает все заголовки интернета для сообщения в виде строки. Дополнительные сведения см . в статье Получение и настройка заголовков в Интернете для сообщения в надстройке Outlook.
getAllInternetHeadersAsync(callback)	Возвращает все заголовки интернета для сообщения в виде строки. Дополнительные сведения см . в статье Получение и настройка заголовков в Интернете для сообщения в надстройке Outlook.
getAsFileAsync(options, callback)	Возвращает текущее сообщение в формате EML, закодированное в Base64.
getAsFileAsync(callback)	Возвращает текущее сообщение в формате EML, закодированное в Base64.
getAttachmentContentAsync(attachmentId, options, callback)	Получает вложение из сообщения или встречи и возвращает его в `AttachmentContent` виде объекта . Метод `getAttachmentContentAsync` получает вложение с указанным идентификатором из элемента. Рекомендуется получить идентификатор вложения из вызова item.attachments , а затем в том же сеансе использовать его для получения вложения. В Outlook в Интернете, на мобильных устройствах и в новом Outlook в Windows идентификатор вложения действителен только в рамках одного сеанса. Сеанс завершается, когда пользователь закрывает приложение или если пользователь начинает создавать встроенную форму, затем открывает форму для продолжения в отдельном окне.
getAttachmentContentAsync(attachmentId, callback)	Получает вложение из сообщения или встречи и возвращает его в `AttachmentContent` виде объекта . Метод `getAttachmentContentAsync` получает вложение с указанным идентификатором из элемента. Рекомендуется получить идентификатор вложения из вызова item.attachments , а затем в том же сеансе использовать его для получения вложения. В Outlook в Интернете, на мобильных устройствах и в новом Outlook в Windows идентификатор вложения действителен только в рамках одного сеанса. Сеанс завершается, когда пользователь закрывает приложение или если пользователь начинает создавать встроенную форму, затем открывает форму для продолжения в отдельном окне.
getEntities()	Получает сущности, обнаруженные в теле выбранного элемента. Предупреждение. Контекстные надстройки Outlook на основе сущностей теперь прекращены. Однако правила регулярных выражений по-прежнему поддерживаются. Мы рекомендуем обновить контекстную надстройку, чтобы использовать правила регулярных выражений в качестве альтернативного решения. Инструкции по реализации этих правил см. в разделе Контекстные надстройки Outlook.
getEntitiesByType(entityType)	Получает массив всех сущностей указанного типа, обнаруженных в теле выбранного элемента. Предупреждение. Контекстные надстройки Outlook на основе сущностей теперь прекращены. Однако правила регулярных выражений по-прежнему поддерживаются. Мы рекомендуем обновить контекстную надстройку, чтобы использовать правила регулярных выражений в качестве альтернативного решения. Инструкции по реализации этих правил см. в разделе Контекстные надстройки Outlook.
getFilteredEntitiesByName(name)	Возвращает известные сущности в выбранном элементе, которые передают именованный фильтр, определенный в файле манифеста только надстройки. Предупреждение. Контекстные надстройки Outlook на основе сущностей теперь прекращены. Однако правила регулярных выражений по-прежнему поддерживаются. Мы рекомендуем обновить контекстную надстройку, чтобы использовать правила регулярных выражений в качестве альтернативного решения. Инструкции по реализации этих правил см. в разделе Контекстные надстройки Outlook.
getInitializationContextAsync(options, callback)	Возвращает данные инициализации, передаваемые при активации надстройки с помощью сообщения с действиями.
getInitializationContextAsync(callback)	Возвращает данные инициализации, передаваемые при активации надстройки с помощью сообщения с действиями.
getRegExMatches()	Возвращает строковые значения в выбранном элементе, соответствующие регулярным выражениям, определенным в файле манифеста только надстройки.
getRegExMatchesByName(name)	Возвращает строковые значения в выбранном элементе, которые соответствуют именованным регулярным выражениям, определенным в файле манифеста только надстройки.
getSelectedEntities()	Возвращает сущности, найденные в выделенном совпадении, выбранном пользователем. Выделенные совпадения применяются к контекстным надстройкам. Предупреждение. Контекстные надстройки Outlook на основе сущностей теперь прекращены. Однако правила регулярных выражений по-прежнему поддерживаются. Мы рекомендуем обновить контекстную надстройку, чтобы использовать правила регулярных выражений в качестве альтернативного решения. Инструкции по реализации этих правил см. в разделе Контекстные надстройки Outlook.
getSelectedRegExMatches()	Возвращает строковые значения в выделенном совпадении, которые соответствуют регулярным выражениям, определенным в файле манифеста только надстройки. Выделенные совпадения применяются к контекстным надстройкам.
getSharedPropertiesAsync(options, callback)	Возвращает свойства встречи или сообщения в общей папке или общем почтовом ящике. Дополнительные сведения об использовании этого API см. в статье Включение общих папок и сценариев общих почтовых ящиков в надстройке Outlook.
getSharedPropertiesAsync(callback)	Возвращает свойства встречи или сообщения в общей папке или общем почтовом ящике. Дополнительные сведения об использовании этого API см. в статье Включение общих папок и сценариев общих почтовых ящиков в надстройке Outlook.
loadCustomPropertiesAsync(callback, userContext)	Асинхронно загружает настраиваемые свойства для надстройки для выбранного элемента. Пользовательские свойства хранятся в виде пар "ключ-значение" для каждого приложения и каждого элемента. Этот метод возвращает объект CustomProperties в обратном вызове, который предоставляет методы для доступа к пользовательским свойствам, характерным для текущего элемента и текущей надстройки. Пользовательские свойства не шифруются в элементе, поэтому их не следует использовать в качестве безопасного хранилища. Настраиваемые свойства предоставляются в виде объекта `CustomProperties` в свойстве `asyncResult.value`. Этот объект можно использовать для получения, задания, сохранения и удаления настраиваемых свойств из почтового элемента.
removeHandlerAsync(eventType, options, callback)	Удаляет обработчиков для поддерживаемого типа события. Примечание. События доступны только в реализации области задач. Сведения о поддерживаемых событиях см. в разделе События объектной модели элементов.
removeHandlerAsync(eventType, callback)	Удаляет обработчиков для поддерживаемого типа события. Примечание. События доступны только в реализации области задач. Сведения о поддерживаемых событиях см. в разделе События объектной модели элементов.

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

attachments

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

attachments: AttachmentDetails[];

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

Office.AttachmentDetails[]

Примечание. Некоторые типы файлов блокируются Outlook из-за потенциальных проблем с безопасностью и поэтому не возвращаются. Дополнительные сведения см. в разделе Заблокированные вложения в Outlook.

Примеры

// The following code builds an HTML string with details of all attachments on the current item.
const item = Office.context.mailbox.item;
let outputString = "";

if (item.attachments.length > 0) {
    for (let i = 0 ; i < item.attachments.length ; i++) {
        const attachment = item.attachments[i];
        outputString += "<BR>" + i + ". Name: ";
        outputString += attachment.name;
        outputString += "<BR>ID: " + attachment.id;
        outputString += "<BR>contentType: " + attachment.contentType;
        outputString += "<BR>size: " + attachment.size;
        outputString += "<BR>attachmentType: " + attachment.attachmentType;
        outputString += "<BR>isInline: " + attachment.isInline;
    }
}

console.log(outputString);

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

const attachments = Office.context.mailbox.item.attachments;
console.log(attachments);

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 возвращает массив, содержащий объект EmailAddressDetails для каждого получателя, указанного в строке Копия сообщения. Максимальное число возвращенных получателей зависит от клиента Outlook.

классическая Windows: 500 получателей
Android, классический пользовательский интерфейс Mac, iOS: 100 получателей
Веб-браузер, новый Outlook: 20 получателей (свернутое представление), 500 получателей (развернутое представление)
Новый пользовательский интерфейс Mac: нет ограничений

cc: EmailAddressDetails[];

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

Office.EmailAddressDetails[]

Примеры

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

const msgCc = Office.context.mailbox.item.cc;
console.log("Message copied to:");
for (let i = 0; i < msgCc.length; i++) {
  console.log(msgCc[i].displayName + " (" + msgCc[i].emailAddress + ")");
}

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}`);

dateTimeCreated

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

dateTimeCreated: Date;

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

Date

Примеры

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

console.log(`Creation date and time: ${Office.context.mailbox.item.dateTimeCreated}`);

dateTimeModified

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

dateTimeModified: Date;

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

Date

Важно! Это свойство не поддерживается в Outlook для Android или iOS. Дополнительные сведения о поддерживаемых 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/get-date-time-modified-read.yaml

console.log(`Date and time item last modified: ${Office.context.mailbox.item.dateTimeModified}`);

end

Возвращает дату и время окончания встречи.

Свойство end представляет собой объект, выраженный Date в виде значения даты и времени в формате UTC. Метод можно использовать для convertToLocalClientTime преобразования end значения свойства в локальные значения даты и времени клиента.

Если вы задаете время окончания с помощью метода Time.setAsync, необходимо использовать метод convertToUtcClientTime для преобразования местного времени на клиенте в формат UTC для сервера.

end: Date;

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

Date

Примеры

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

console.log(`Appointment ends: ${Office.context.mailbox.item.end}`);

from

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

Свойства from и sender представляют одно лицо, если сообщение не отправлено представителем. В этом случае from свойство представляет делегатор, а sender свойство представляет делегат.

Примечание. Свойство recipientTypeEmailAddressDetails объекта в свойстве from не определено.

Свойство from возвращает EmailAddressDetails объект .

from: EmailAddressDetails;

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

Office.EmailAddressDetails

Примеры

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

const msgFrom = Office.context.mailbox.item.from;
console.log("Message received from: " + msgFrom.displayName + " (" + msgFrom.emailAddress + ")");

internetMessageId

Возвращает идентификатор интернет-сообщения для сообщения электронной почты.

Важно! В папке "ОтправленныеinternetMessageId" объект может быть еще недоступен для недавно отправленных элементов. В этом случае рассмотрите возможность использования веб-служб Exchange для получения этого свойства с сервера.

internetMessageId: string;

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

string

Примеры

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

console.log(`Internet message ID: ${Office.context.mailbox.item.internetMessageId}`);

itemClass

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

itemClass: string;

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

string

Класс элемента	Описание
IPM.Note	Новые сообщения и ответы на сообщения
IPM. Примечание.SMIME	Зашифрованные сообщения, которые также могут быть подписаны
IPM. Примечание.SMIME.MultipartSigned	Сообщения с открытой подписью
IPM.Schedule.Meeting.Request	приглашения на собрания;
IPM.Schedule.Meeting.Canceled	Отмены собраний
IPM.Schedule.Meeting.Resp.Neg	Отклонение приглашений на собрания
IPM.Schedule.Meeting.Resp.Pos	Принятие приглашений на собрания
IPM.Schedule.Meeting.Resp.Tent	Предварительное принятие приглашений на собрания

Можно создать пользовательские классы, расширяющие класс элементов по умолчанию. Например, IPM.Note.Contoso.

Примеры

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

console.log(`Item class: ${Office.context.mailbox.item.itemClass}`);

itemId

Возвращает идентификатор элемента веб-служб Exchange (EWS) текущего элемента.

itemId: string;

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

string

Свойство itemId недоступно в режиме создания. Если идентификатор элемента является обязательным, Office.context.mailbox.item.saveAsync метод можно использовать для сохранения элемента в хранилище, что вернет идентификатор элемента в asyncResult.value параметре функции обратного вызова. Если элемент уже сохранен, вместо этого можно вызвать Office.context.mailbox.item.getItemIdAsync метод .
Возвращенный идентификатор элемента не идентичен идентификатору записи Outlook или идентификатору, используемому REST API Outlook. Перед выполнением вызовов REST API с использованием этого значения его следует преобразовать с помощью Office.context.mailbox.convertToRestId.

Примеры

// The following code checks for the presence of an item
// identifier. If the `itemId` property returns `null` or
// `undefined`, it saves the item to the store and gets the
// item identifier from the asynchronous result.
// **Important**: `saveAsync` was introduced with requirement set 1.3
// so you can't get the `itemId` in Compose mode in earlier sets.
let itemId = Office.context.mailbox.item.itemId;
if (itemId === null || itemId == undefined) {
    Office.context.mailbox.item.saveAsync(function(result) {
        itemId = result.value;
    });
}

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;
}

location

Возвращает расположение приглашения на собрание.

Свойство location возвращает строку, содержащую сведения о месте встречи.

location: string;

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

string

Примеры

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

console.log(`Appointment location: ${Office.context.mailbox.item.location}`);

normalizedSubject

Возвращает тему элемента со всеми удаленными префиксами (включая RE: и FWD:).

Свойство normalizedSubject получает тему элемента с любыми стандартными префиксами (например, RE: и FW:), которые добавляются программами электронной почты. Для получения темы элемента с неизмененными префиксами используйте свойство subject.

normalizedSubject: string;

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

string

Примеры

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

console.log(`Normalized subject: ${Office.context.mailbox.item.normalizedSubject}`);

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);

recurrence

Возвращает шаблон повторения встречи. Возвращает шаблон повторения приглашения на собрание. Режимы чтения и создания для элементов встреч. Режим чтения для элементов приглашения на собрание.

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

Примечание. В приглашениях на собрание имеется значение itemClass , равное IPM.Schedule.Meeting.Request.

Примечание. Если recurrence объект имеет значение NULL, это означает, что объект является одной встречей или приглашением на собрание одной встречи, а НЕ частью ряда.

recurrence: Recurrence;

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

Office.Recurrence

Примеры

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

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

if (recurrence === undefined) {
  console.log("This item is a message but not a meeting request.");
} else if (recurrence === null) {
  console.log("This is a single appointment.");
} else {
  console.log(JSON.stringify(recurrence));
}

sender

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

Примечание. Свойство recipientTypeEmailAddressDetails объекта в свойстве sender не определено.

sender: EmailAddressDetails;

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

Office.EmailAddressDetails

Примеры

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

const msgSender = Office.context.mailbox.item.sender;
console.log("Sender: " + msgSender.displayName + " (" + msgSender.emailAddress + ")");

seriesId

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

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

start

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

Свойство start представляет собой объект, выраженный Date в виде значения даты и времени в формате UTC. Метод можно использовать для convertToLocalClientTime преобразования значения в локальные дату и время клиента.

start: Date;

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

Date

Примеры

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

console.log(`Appointment starts: ${Office.context.mailbox.item.start}`);

subject

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

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

Свойство subject возвращает строку. Используйте свойство , normalizedSubject чтобы получить субъект без всех начальных префиксов, таких как RE: и FW:.

subject: string;

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

string

Примеры

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

console.log(`Subject: ${Office.context.mailbox.item.subject}`);

to

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

Свойство to возвращает массив, содержащий объект EmailAddressDetails для каждого получателя, указанного в строке Кому сообщения. Максимальное число возвращенных получателей зависит от клиента Outlook.

классическая Windows: 500 получателей
Android, классический пользовательский интерфейс Mac, iOS: 100 получателей
Веб-браузер, новый Outlook: 20 получателей (свернутое представление), 500 получателей (развернутое представление)
Новый пользовательский интерфейс Mac: нет ограничений

to: EmailAddressDetails[];

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

Office.EmailAddressDetails[]

Примеры

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

const msgTo = Office.context.mailbox.item.to;
const distributionLists = [];
const externalRecipients = [];
const internalRecipients = [];
const otherRecipients = [];
for (let i = 0; i < msgTo.length; i++) {
    switch (msgTo[i].recipientType) {
    case Office.MailboxEnums.RecipientType.DistributionList:
        distributionLists.push(msgTo[i]);
        break;
    case Office.MailboxEnums.RecipientType.ExternalUser:
        externalRecipients.push(msgTo[i]);
        break;
    case Office.MailboxEnums.RecipientType.User:
        internalRecipients.push(msgTo[i]);
        break;
    case Office.MailboxEnums.RecipientType.Other:
        otherRecipients.push(msgTo[i]);
    }
}

if (distributionLists.length > 0) {
    console.log("Distribution Lists:");
    distributionLists.forEach((recipient) => console.log(`${recipient.displayName}, ${recipient.emailAddress}`));
}

if (externalRecipients.length > 0) {
    console.log("External Recipients:");
    externalRecipients.forEach((recipient) => console.log(`${recipient.displayName}, ${recipient.emailAddress}`));
}

if (internalRecipients.length > 0) {
    console.log("Internal Recipients:");
    internalRecipients.forEach((recipient) => console.log(`${recipient.displayName}, ${recipient.emailAddress}`));
}

if (otherRecipients.length > 0) {
    console.log("Other Recipients:");
    otherRecipients.forEach((recipient) => console.log(`${recipient.displayName}, ${recipient.emailAddress}`));
}

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

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 parameter , переданное в addHandlerAsync.

options: Office.AsyncContextOptions

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

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

displayReplyAllForm(formData)

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

displayReplyAllForm(formData: string | ReplyFormData): void;

Параметры

formData: string | Office.ReplyFormData

Строка, содержащая текст и HTML-код, представляющие собой основной текст формы ответа. Строка ограничена 32 КБ или объектом ReplyFormData , который содержит данные текста или вложения и функцию обратного вызова.

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

void

В Outlook в Интернете и в новом Outlook в Windows форма ответа отображается в виде всплывающей формы в представлении из трех столбцов и всплывающей формы в представлении из двух столбцов или 1 столбца.
Если любой строковый параметр превышает указанные для него ограничения, displayReplyAllForm возвращает исключение.
Если вложения указаны в параметре formData.attachments , Outlook пытается скачать все вложения и вложить их в форму ответа. Если какие-либо вложения добавить не удается, в форме отображается сообщение об ошибке. Если сообщения об ошибках не предусмотрены, то они не отображаются.
Этот метод не поддерживается в Outlook для Android или в iOS. Дополнительные сведения о поддерживаемых API в Outlook Mobile см. в статье API JavaScript Для Outlook, поддерживаемые в Outlook на мобильных устройствах.

Примеры

// The following code passes a string to the `displayReplyAllForm` method.
Office.context.mailbox.item.displayReplyAllForm('hello there');
Office.context.mailbox.item.displayReplyAllForm('<b>hello there</b>');

// Reply with an empty body.
Office.context.mailbox.item.displayReplyAllForm({});

// Reply with just a body.
Office.context.mailbox.item.displayReplyAllForm(
{
'htmlBody' : 'hi'
});

// Reply with a body and a file attachment.
Office.context.mailbox.item.displayReplyAllForm(
{
    'htmlBody' : 'hi',
    'attachments' :
    [
        {
        'type' : Office.MailboxEnums.AttachmentType.File,
        'name' : 'squirrel.png',
        'url' : 'http://i.imgur.com/sRgTlGR.jpg'
        }
    ]
});

// Reply with a body and an item attachment.
Office.context.mailbox.item.displayReplyAllForm(
{
    'htmlBody' : 'hi',
    'attachments' :
    [
        {
        'type' : 'item',
        'name' : 'rand',
        'itemId' : Office.context.mailbox.item.itemId
        }
    ]
});

// Reply with a body, file attachment, item attachment, and a callback.
Office.context.mailbox.item.displayReplyAllForm(
{
    'htmlBody' : 'hi',
    'attachments' :
    [
        {
            'type' : Office.MailboxEnums.AttachmentType.File,
            'name' : 'squirrel.png',
            'url' : 'http://i.imgur.com/sRgTlGR.jpg'
        },
        {
            'type' : 'item',
            'name' : 'rand',
            'itemId' : Office.context.mailbox.item.itemId
        }
    ],
    'callback' : function(asyncResult)
    {
        console.log(asyncResult.value);
    }
});

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/55-display-items/display-reply-forms.yaml

Office.context.mailbox.item.displayReplyAllForm("This is a reply ALL with <b>some bold text</b>.");

displayReplyAllFormAsync(formData, options, callback)

displayReplyAllFormAsync(formData: string | ReplyFormData, options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult<void>) => void): void;

Параметры

formData: string | Office.ReplyFormData

options: Office.AsyncContextOptions

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

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

void

В Outlook в Интернете и в новом Outlook в Windows форма ответа отображается в виде всплывающей формы в представлении из трех столбцов и всплывающей формы в представлении из двух столбцов или 1 столбца.
Если любой строковый параметр превышает указанные для него ограничения, displayReplyAllFormAsync возвращает исключение.
Если вложения указаны в параметре formData.attachments , Outlook пытается скачать все вложения и вложить их в форму ответа. Если какие-либо вложения добавить не удается, в форме отображается сообщение об ошибке. Если сообщения об ошибках не предусмотрены, то они не отображаются.
Этот метод не поддерживается в Outlook для Android или в iOS. Дополнительные сведения о поддерживаемых API в Outlook Mobile см. в статье API JavaScript Для Outlook, поддерживаемые в Outlook на мобильных устройствах.

Примеры

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/55-display-items/display-reply-forms.yaml

Office.context.mailbox.item.displayReplyAllFormAsync("This is a reply ALL with <b>some bold text</b>.", function(
  asyncResult
) {
  console.log(JSON.stringify(asyncResult));
});

displayReplyAllFormAsync(formData, callback)

displayReplyAllFormAsync(formData: string | ReplyFormData, callback?: (asyncResult: Office.AsyncResult<void>) => void): void;

Параметры

formData: string | Office.ReplyFormData

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

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

void

В Outlook в Интернете и в новом Outlook в Windows форма ответа отображается в виде всплывающей формы в представлении из трех столбцов и всплывающей формы в представлении из двух столбцов или 1 столбца.
Если любой строковый параметр превышает указанные для него ограничения, displayReplyAllFormAsync возвращает исключение.
Если вложения указаны в параметре formData.attachments , Outlook пытается скачать все вложения и вложить их в форму ответа. Если какие-либо вложения добавить не удается, в форме отображается сообщение об ошибке. Если сообщения об ошибках не предусмотрены, то они не отображаются.
Этот метод не поддерживается в Outlook для Android или в iOS. Дополнительные сведения о поддерживаемых API в Outlook Mobile см. в статье API JavaScript Для Outlook, поддерживаемые в Outlook на мобильных устройствах.

displayReplyForm(formData)

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

displayReplyForm(formData: string | ReplyFormData): void;

Параметры

formData: string | Office.ReplyFormData

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

void

В Outlook в Интернете и в новом Outlook в Windows форма ответа отображается в виде всплывающей формы в представлении из трех столбцов и всплывающей формы в представлении из двух столбцов или 1 столбца.
Если любой строковый параметр превышает указанные для него ограничения, displayReplyForm возвращает исключение.
Если вложения указаны в параметре formData.attachments , Outlook пытается скачать все вложения и вложить их в форму ответа. Если какие-либо вложения добавить не удается, в форме отображается сообщение об ошибке. Если сообщения об ошибках не предусмотрены, то они не отображаются.
Этот метод не поддерживается в Outlook для Android или в iOS. Дополнительные сведения о поддерживаемых API в Outlook Mobile см. в статье API JavaScript Для Outlook, поддерживаемые в Outlook на мобильных устройствах.

Примеры

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/55-display-items/display-reply-forms.yaml

Office.context.mailbox.item.displayReplyForm("This is a reply with <i>some text in italics</i>.");

...

Office.context.mailbox.item.displayReplyForm({
  htmlBody: "This is a reply with an inline image and an item attachment.<br><img src='cid:dog.jpg'>",
  attachments: [
    { type: "file", url: "https://i.imgur.com/9S36xvA.jpg", name: "dog.jpg", inLine: true },
    { type: "item", itemId: Office.context.mailbox.item.itemId, name: "test_email.msg" }
  ],
  callback: (result) => {
    if (result.status === Office.AsyncResultStatus.Failed) {
      console.error(`Action failed with message ${result.error.message}`);
      return;
    }

    console.log("Created reply with attachments.");
  }
});

displayReplyFormAsync(formData, options, callback)

displayReplyFormAsync(formData: string | ReplyFormData, options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult<void>) => void): void;

Параметры

formData: string | Office.ReplyFormData

options: Office.AsyncContextOptions

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

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

void

В Outlook в Интернете и в новом Outlook в Windows форма ответа отображается в виде всплывающей формы в представлении из трех столбцов и всплывающей формы в представлении из двух столбцов или 1 столбца.
Если любой строковый параметр превышает указанные для него ограничения, displayReplyFormAsync возвращает исключение.
Если вложения указаны в параметре formData.attachments , Outlook пытается скачать все вложения и вложить их в форму ответа. Если какие-либо вложения добавить не удается, в форме отображается сообщение об ошибке. Если сообщения об ошибках не предусмотрены, то они не отображаются.
Этот метод не поддерживается в Outlook для Android или в iOS. Дополнительные сведения о поддерживаемых API в Outlook Mobile см. в статье API JavaScript Для Outlook, поддерживаемые в Outlook на мобильных устройствах.

Примеры

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/55-display-items/display-reply-forms.yaml

Office.context.mailbox.item.displayReplyFormAsync("This is a reply with <i>some text in italics</i>.", function(
  asyncResult
) {
  console.log(JSON.stringify(asyncResult));
});

...

// The async version is only available starting with requirement set 1.9.
// It provides a callback when the new appointment form has been created.
Office.context.mailbox.item.displayReplyFormAsync(
  {
    htmlBody: "This is a reply with an inline image and an item attachment.<br><img src='cid:dog.jpg'>",
    attachments: [
      { type: "file", url: "http://i.imgur.com/9S36xvA.jpg", name: "dog.jpg", inLine: true },
      { type: "item", itemId: Office.context.mailbox.item.itemId, name: "test_email.msg" }
    ]
  },
  (asyncResult) => {
    console.log(JSON.stringify(asyncResult));
  }
);

displayReplyFormAsync(formData, callback)

displayReplyFormAsync(formData: string | ReplyFormData, callback?: (asyncResult: Office.AsyncResult<void>) => void): void;

Параметры

formData: string | Office.ReplyFormData

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

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

void

В Outlook в Интернете и в новом Outlook в Windows форма ответа отображается в виде всплывающей формы в представлении из трех столбцов и всплывающей формы в представлении из двух столбцов или 1 столбца.
Если любой строковый параметр превышает указанные для него ограничения, displayReplyFormAsync возвращает исключение.
Если вложения указаны в параметре formData.attachments , Outlook пытается скачать все вложения и вложить их в форму ответа. Если какие-либо вложения добавить не удается, в форме отображается сообщение об ошибке. Если сообщения об ошибках не предусмотрены, то они не отображаются.
Этот метод не поддерживается в Outlook для Android или в iOS. Дополнительные сведения о поддерживаемых API в Outlook Mobile см. в статье API JavaScript Для Outlook, поддерживаемые в Outlook на мобильных устройствах.

getAllInternetHeadersAsync(options, callback)

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

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

getAllInternetHeadersAsync(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 виде строки. Сведения о форматировании возвращаемого строкового значения см. в документе RFC 2183 . В случае сбоя asyncResult.error вызова свойство будет содержать код ошибки с причиной сбоя.

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

void

Примеры

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

Office.context.mailbox.item.getAllInternetHeadersAsync(function (asyncResult) {
  if (asyncResult.status === Office.AsyncResultStatus.Succeeded) {
    console.log("Internet headers received successfully");
    if (asyncResult.value.match(/preferred-fruit:.*/gim)) {
      console.log("Sender's preferred fruit: " + asyncResult.value.match(/preferred-fruit:.*/gim)[0].slice(17));
    } else {
      console.log("Didn't receive header with sender's preferred fruit");
    }
    if (asyncResult.value.match(/preferred-vegetable:.*/gim)) {
      console.log(
        "Sender's preferred vegetable: " + asyncResult.value.match(/preferred-vegetable:.*/gim)[0].slice(21)
      );
    } else {
      console.log("Didn't receive header with sender's preferred vegetable");
    }
  } else {
    console.log("Error getting internet headers: " + JSON.stringify(asyncResult.error));
  }
});

getAllInternetHeadersAsync(callback)

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

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

Параметры

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

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

void

getAsFileAsync(options, callback)

Возвращает текущее сообщение в формате EML, закодированное в Base64.

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

Параметры

options: Office.AsyncContextOptions

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

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

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

void

getAsFileAsync(callback)

Возвращает текущее сообщение в формате EML, закодированное в Base64.

getAsFileAsync(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-eml-format.yaml

Office.context.mailbox.item.getAsFileAsync((asyncResult) => {
  if (asyncResult.status === Office.AsyncResultStatus.Failed) {
    console.log(`Error encountered during processing: ${asyncResult.error.message}`);
    return;
  }

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

getAttachmentContentAsync(attachmentId, options, callback)

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

Метод getAttachmentContentAsync получает вложение с указанным идентификатором из элемента. Рекомендуется получить идентификатор вложения из вызова item.attachments , а затем в том же сеансе использовать его для получения вложения. В 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

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

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 read mode.
// The item.attachments call can only be used in read mode.
const attachments = item.attachments;
if (attachments.length <= 0) {
  console.log("Mail item has no attachments.");
  return;
}

for (let i = 0; i < attachments.length; i++) {
  // Log the attachment type and its contents to the console.
  item.getAttachmentContentAsync(attachments[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 : идентификатор вложения не существует.

getEntities()

Предупреждение

Теперь этот API является нерекомендуемым.

Use regular expression rules instead.

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

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

getEntities(): Entities;

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

Office.Entities

getEntitiesByType(entityType)

Предупреждение

Теперь этот API является нерекомендуемым.

Use regular expression rules instead.

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

getEntitiesByType(entityType: MailboxEnums.EntityType | string): Array<string | Contact | MeetingSuggestion | PhoneNumber | TaskSuggestion>;

Параметры

entityType: Office.MailboxEnums.EntityType | string

Одно из значений EntityType перечисления.

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

Array<string | Office.Contact | Office.MeetingSuggestion | Office.PhoneNumber | Office.TaskSuggestion>

Если переданное entityType значение не является допустимым членом перечисления EntityType , метод возвращает null. Если в теле элемента отсутствуют сущности указанного типа, метод возвращает пустой массив. В противном случае тип объектов в возвращаемом массиве зависит от типа сущности, запрошенной в параметре entityType.

getFilteredEntitiesByName(name)

Предупреждение

Теперь этот API является нерекомендуемым.

Use regular expression rules instead.

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

getFilteredEntitiesByName(name: string): Array<string | Contact | MeetingSuggestion | PhoneNumber | TaskSuggestion>;

Параметры

name: string

Имя элемента правила ItemHasKnownEntity, определяющее соответствующий фильтр.

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

Array<string | Office.Contact | Office.MeetingSuggestion | Office.PhoneNumber | Office.TaskSuggestion>

Сущности, которые соответствуют регулярному выражению, определенному в элементе ItemHasKnownEntity rule в файле манифеста надстройки, с указанным FilterName значением элемента. Если в манифесте нет ItemHasKnownEntity элемента со значением FilterName элемента, соответствующее параметру name , метод возвращает null. name Если параметр соответствует элементу ItemHasKnownEntity манифеста, но в текущем элементе нет совпадающих сущностей, метод возвращает пустой массив.

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

getRegExMatches()

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

getRegExMatches(): any;

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

any

Объект , содержащий массивы строк, которые соответствуют регулярным выражениям, определенным в файле манифеста надстройки. Имя каждого массива равно соответствующему значению атрибута RegExName соответствующего ItemHasRegularExpressionMatch правила. Для правила ItemHasRegularExpressionMatch соответствующая строка должна находиться в свойстве элемента, заданного этим правилом. Простой тип PropertyName определяет поддерживаемые свойства.

Контекстные надстройки Outlook на основе сущностей теперь сняты с учета. Однако правила регулярных выражений по-прежнему поддерживаются. Мы рекомендуем обновить контекстную надстройку, чтобы использовать правила регулярных выражений в качестве альтернативного решения. Инструкции по реализации этих правил см. в разделе Контекстные надстройки Outlook.
Этот метод используется с функцией правил активации для надстроек Outlook, которая не поддерживается в унифицированном манифесте Microsoft 365.
Если указать ItemHasRegularExpressionMatch правило для свойства body элемента, регулярное выражение должно дополнительно фильтровать текст и не пытаться вернуть весь текст элемента. Использование регулярного выражения, например .* для получения всего текста элемента, не всегда возвращает ожидаемые результаты. Лучше используйте метод Body.getAsync для этого.
Этот метод не поддерживается в Outlook для Android или в iOS. Дополнительные сведения о поддерживаемых API в Outlook Mobile см. в статье API JavaScript Для Outlook, поддерживаемые в Outlook на мобильных устройствах.

Примеры

// Consider an add-in manifest has the following `Rule` element:
//<Rule xsi:type="RuleCollection" Mode="And">
//  <Rule xsi:type="ItemIs" FormType="Read" ItemType="Message" />
//  <Rule xsi:type="RuleCollection" Mode="Or">
//    <Rule xsi:type="ItemHasRegularExpressionMatch" RegExName="fruits" RegExValue="apple|banana|coconut" PropertyName="BodyAsPlaintext" IgnoreCase="true" />
//    <Rule xsi:type="ItemHasRegularExpressionMatch" RegExName="veggies" RegExValue="tomato|onion|spinach|broccoli" PropertyName="BodyAsPlaintext" IgnoreCase="true" />
//  </Rule>
//</Rule>

// The object returned from `getRegExMatches` would have two properties: `fruits` and `veggies`.
//{
//'fruits': ['apple','banana','Banana','coconut'],
//'veggies': ['tomato','onion','spinach','broccoli']
//}

// The following example shows how to access the array of
// matches for the regular expression rule elements `fruits`
// and `veggies`, which are specified in the manifest.
const allMatches = Office.context.mailbox.item.getRegExMatches();
const fruits = allMatches.fruits;
const veggies = allMatches.veggies;

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/75-regex-matches/contextual.yaml

// This API only works when you click on the highlighted word "ScriptLab".
console.log(Office.context.mailbox.item.getRegExMatches());

getRegExMatchesByName(name)

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

getRegExMatchesByName(name: string): string[];

Параметры

name: string

Имя элемента правила ItemHasRegularExpressionMatch, определяющее соответствующий фильтр.

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

string[]

Массив, содержащий строки, соответствующие регулярному выражению, определенному в элементе ItemHasRegularExpressionMatch rule в файле манифеста надстройки, с указанным RegExName значением элемента.

Контекстные надстройки Outlook на основе сущностей теперь сняты с учета. Однако правила регулярных выражений по-прежнему поддерживаются. Мы рекомендуем обновить контекстную надстройку, чтобы использовать правила регулярных выражений в качестве альтернативного решения. Инструкции по реализации этих правил см. в разделе Контекстные надстройки Outlook.
Этот метод используется с функцией правил активации для надстроек Outlook, которая не поддерживается в унифицированном манифесте Microsoft 365.
Если указать ItemHasRegularExpressionMatch правило для свойства body элемента, регулярное выражение должно дополнительно фильтровать текст и не пытаться вернуть весь текст элемента. Использование регулярного выражения, например .* для получения всего текста элемента, не всегда возвращает ожидаемые результаты. Лучше используйте метод Body.getAsync для этого.
Этот метод не поддерживается в Outlook для Android или в iOS. Дополнительные сведения о поддерживаемых API в Outlook Mobile см. в статье API JavaScript Для Outlook, поддерживаемые в Outlook на мобильных устройствах.

Примеры

// Consider an add-in manifest has the following `Rule` element:
//<Rule xsi:type="RuleCollection" Mode="And">
//  <Rule xsi:type="ItemIs" FormType="Read" ItemType="Message" />
//  <Rule xsi:type="RuleCollection" Mode="Or">
//    <Rule xsi:type="ItemHasRegularExpressionMatch" RegExName="fruits" RegExValue="apple|banana|coconut" PropertyName="BodyAsPlaintext" IgnoreCase="true" />
//    <Rule xsi:type="ItemHasRegularExpressionMatch" RegExName="veggies" RegExValue="tomato|onion|spinach|broccoli" PropertyName="BodyAsPlaintext" IgnoreCase="true" />
//  </Rule>
//</Rule>

// The object returned from `getRegExMatches` would have two properties: `fruits` and `veggies`.
//{
//'fruits': ['apple','banana','Banana','coconut'],
//'veggies': ['tomato','onion','spinach','broccoli']
//}

const fruits = Office.context.mailbox.item.getRegExMatchesByName("fruits");
const veggies = Office.context.mailbox.item.getRegExMatchesByName("veggies");

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/75-regex-matches/contextual.yaml

// This API only works when you click on the highlighted word "ScriptLab".
console.log(Office.context.mailbox.item.getRegExMatchesByName("sampleRegexName"));

getSelectedEntities()

Предупреждение

Теперь этот API является нерекомендуемым.

Use regular expression rules instead.

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

getSelectedEntities(): Entities;

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

Office.Entities

getSelectedRegExMatches()

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

getSelectedRegExMatches(): any;

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

any

Объект , содержащий массивы строк, которые соответствуют регулярным выражениям, определенным в файле манифеста надстройки. Имя каждого массива равно соответствующему значению RegExName атрибута правила сопоставления ItemHasRegularExpressionMatch . Для правила ItemHasRegularExpressionMatch соответствующая строка должна находиться в свойстве элемента, заданного этим правилом. Простой тип PropertyName определяет поддерживаемые свойства.

Контекстные надстройки Outlook на основе сущностей теперь сняты с учета. Однако правила регулярных выражений по-прежнему поддерживаются. Мы рекомендуем обновить контекстную надстройку, чтобы использовать правила регулярных выражений в качестве альтернативного решения. Инструкции по реализации этих правил см. в разделе Контекстные надстройки Outlook.
Этот метод используется с функцией правил активации для надстроек Outlook, которая не поддерживается в унифицированном манифесте Microsoft 365.
Этот метод не поддерживается в Outlook для iOS или Android. Дополнительные сведения о поддерживаемых API в Outlook Mobile см. в статье API JavaScript Для Outlook, поддерживаемые в Outlook на мобильных устройствах.
Если указать ItemHasRegularExpressionMatch правило для свойства body элемента, регулярное выражение должно дополнительно фильтровать текст и не пытаться вернуть весь текст элемента. Использование регулярного выражения, такого как .* для получения всего текста элемента, не всегда возвращает ожидаемые результаты. Лучше используйте метод Body.getAsync для этого.

Примеры

// Consider an add-in manifest has the following `Rule` element:
//<Rule xsi:type="RuleCollection" Mode="And">
//  <Rule xsi:type="ItemIs" FormType="Read" ItemType="Message" />
//  <Rule xsi:type="RuleCollection" Mode="Or">
//    <Rule xsi:type="ItemHasRegularExpressionMatch" RegExName="fruits" RegExValue="apple|banana|coconut" PropertyName="BodyAsPlaintext" IgnoreCase="true" />
//    <Rule xsi:type="ItemHasRegularExpressionMatch" RegExName="veggies" RegExValue="tomato|onion|spinach|broccoli" PropertyName="BodyAsPlaintext" IgnoreCase="true" />
//  </Rule>
//</Rule>

// The object returned from `getRegExMatches` would have two properties: `fruits` and `veggies`.
//{
//'fruits': ['apple','banana','Banana','coconut'],
//'veggies': ['tomato','onion','spinach','broccoli']
//}

// The following example shows how to access the array of matches for the
// regular expression rule elements `fruits` and `veggies`, which are
// specified in the manifest.
const selectedMatches = Office.context.mailbox.item.getSelectedRegExMatches();
const fruits = selectedMatches.fruits;
const veggies = selectedMatches.veggies;

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/75-regex-matches/contextual.yaml

const matches = Office.context.mailbox.item.getSelectedRegExMatches();
if (matches) {
    console.log(matches);
} else {
    console.error("Open add-in by clicking on a highlighted regex match, for this API to return something useful.");
}

getSharedPropertiesAsync(options, callback)

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

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

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

Параметры

options: Office.AsyncContextOptions

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

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

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

void

getSharedPropertiesAsync(callback)

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

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

Параметры

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

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

void

Примеры

// 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}`);
});

loadCustomPropertiesAsync(callback, userContext)

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

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

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

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

Параметры

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

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

userContext: any

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

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

void

Примеры

// 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.");
});

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.");
});

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

Office.MessageRead interface

Комментарии

Примеры

Свойства

Методы

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

attachments

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

Комментарии

Примеры

body

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

Комментарии

Примеры

categories

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

Комментарии

Примеры

cc

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

Комментарии

Примеры

conversationId

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

Комментарии

Примеры

dateTimeCreated

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

Комментарии

Примеры

dateTimeModified

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

Комментарии

Примеры

end

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

Комментарии

Примеры

from

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

Комментарии

Примеры

internetMessageId

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

Комментарии

Примеры

itemClass

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

Комментарии

Примеры

itemId

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

Комментарии

Примеры

itemType

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

Комментарии

Примеры

location

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

Комментарии

Примеры

normalizedSubject

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

Комментарии

Примеры

notificationMessages

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

Комментарии

Примеры

recurrence

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

Комментарии

Примеры

sender

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

Комментарии

Примеры

seriesId