Office.MessageRead interface

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

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

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

Extends

Свойства

attachments

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

body

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

categories

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

cc

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

Свойство возвращает массив, содержащий объект cc EmailAddressDetails для каждого получателя, указанный в строке Cc сообщения. Ограничения размера коллекции:

  • Windows: 500 участников

  • Mac: 100 участников

  • Веб-браузер: 20 участников

  • Другое: нет ограничений

conversationId

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

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

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

dateTimeCreated

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

dateTimeModified

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

Примечание. Этот член не поддерживается в Outlook на iOS или Android.

end

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

Свойство — это объект, выраженный в качестве согласованного универсального времени end Date (UTC) даты и времени. С помощью этого метода можно преобразовать значение свойства в локализованную дату и convertToLocalClientTime end время клиента.

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

from

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

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

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

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

internetMessageId

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

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

itemClass

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

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

itemId

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

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

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

itemType

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

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

location

Получает расположение запроса на собрание.

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

normalizedSubject

Получает объект элемента с удалением всех префиксов (включая RE: и FWD:).

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

notificationMessages

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

recurrence

Получает шаблон повторения встречи. Получает шаблон повторения запроса собрания. Режимы чтения и составить для элементов встречи. Режим чтения элементов запроса собраний.

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

Примечание. Запросы собраний имеют значение itemClass IPM.Schedule.Meeting.Request.

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

sender

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

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

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

seriesId

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

В Outlook в Интернете и настольных клиентах возвращается Exchange веб-службы (EWS) родительского (серийного) элемента, к которой seriesId относится этот элемент. Однако на iOS и Android seriesId возвращается rest ID родительского элемента.

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

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

start

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

Свойство — это объект, выраженный в качестве согласованного универсального времени start Date (UTC) даты и времени. Этот метод можно использовать для преобразования значения в локализованную дату и convertToLocalClientTime время клиента.

subject

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

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

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

to

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

Свойство возвращает массив, содержащий to объект EmailAddressDetails для каждого получателя, указанный в строке To сообщения. Ограничения размера коллекции:

  • Windows: 500 участников

  • Mac: 100 участников

  • Веб-браузер: 20 участников

  • Другое: нет ограничений

Методы

addHandlerAsync(eventType, handler, options, callback)

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

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

addHandlerAsync(eventType, handler, callback)

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

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

displayReplyAllForm(formData)

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

В Outlook в Интернете форме ответа отображается в виде всплывающее в представлении 3-столбца и всплывающее представление в представлении 2-column или 1-column.

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

Если в параметре указаны вложения, Outlook все вложения и прикрепите их formData.attachments к форме ответа. Если какие-либо вложения добавить не удается, в форме отображается сообщение об ошибке. Если сообщения об ошибках не предусмотрены, то они не отображаются.

Примечание. Этот метод не поддерживается в Outlook на iOS или Android.

displayReplyAllFormAsync(formData, options, callback)

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

В Outlook в Интернете форме ответа отображается в виде всплывающее в представлении 3-столбца и всплывающее представление в представлении 2-column или 1-column.

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

Если в параметре указаны вложения, Outlook все вложения и прикрепите их formData.attachments к форме ответа. Если какие-либо вложения добавить не удается, в форме отображается сообщение об ошибке. Если сообщения об ошибках не предусмотрены, то они не отображаются.

Примечание. Этот метод не поддерживается в Outlook на iOS или Android.

displayReplyAllFormAsync(formData, callback)

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

В Outlook в Интернете форме ответа отображается в виде всплывающее в представлении 3-столбца и всплывающее представление в представлении 2-column или 1-column.

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

Если в параметре указаны вложения, Outlook все вложения и прикрепите их formData.attachments к форме ответа. Если какие-либо вложения добавить не удается, в форме отображается сообщение об ошибке. Если сообщения об ошибках не предусмотрены, то они не отображаются.

Примечание. Этот метод не поддерживается в Outlook на iOS или Android.

displayReplyForm(formData)

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

В Outlook в Интернете форме ответа отображается в виде всплывающее в представлении 3-столбца и всплывающее представление в представлении 2-column или 1-column.

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

Если в параметре указаны вложения, Outlook все вложения и прикрепите их formData.attachments к форме ответа. Если какие-либо вложения добавить не удается, в форме отображается сообщение об ошибке. Если сообщения об ошибках не предусмотрены, то они не отображаются.

Примечание. Этот метод не поддерживается в Outlook на iOS или Android.

displayReplyFormAsync(formData, options, callback)

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

В Outlook в Интернете форме ответа отображается в виде всплывающее в представлении 3-столбца и всплывающее представление в представлении 2-column или 1-column.

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

Если в параметре указаны вложения, Outlook все вложения и прикрепите их formData.attachments к форме ответа. Если какие-либо вложения добавить не удается, в форме отображается сообщение об ошибке. Если сообщения об ошибках не предусмотрены, то они не отображаются.

Примечание. Этот метод не поддерживается в Outlook на iOS или Android.

displayReplyFormAsync(formData, callback)

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

В Outlook в Интернете форме ответа отображается в виде всплывающее в представлении 3-столбца и всплывающее представление в представлении 2-column или 1-column.

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

Если в параметре указаны вложения, Outlook все вложения и прикрепите их formData.attachments к форме ответа. Если какие-либо вложения добавить не удается, в форме отображается сообщение об ошибке. Если сообщения об ошибках не предусмотрены, то они не отображаются.

Примечание. Этот метод не поддерживается в Outlook на iOS или Android.

getAllInternetHeadersAsync(options, callback)

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

Дополнительные дополнительные сообщения см. в статью Get and set internet headers on a message in an Outlook-in.

getAllInternetHeadersAsync(callback)

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

Дополнительные дополнительные сообщения см. в статью Get and set internet headers on a message in an Outlook-in.

getAttachmentContentAsync(attachmentId, options, callback)

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

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

getAttachmentContentAsync(attachmentId, callback)

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

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

getEntities()

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

Примечание. Этот метод не поддерживается в Outlook на iOS или Android.

getEntitiesByType(entityType)

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

Примечание. Этот метод не поддерживается в Outlook на iOS или Android.

getFilteredEntitiesByName(name)

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

Метод возвращает объекты, которые соответствуют обычному выражению, определенному в элементе правила в XML-файле манифеста, с указанным getFilteredEntitiesByName ItemHasKnownEntity FilterName значением элемента.

Примечание. Этот метод не поддерживается в Outlook на iOS или Android.

getInitializationContextAsync(options, callback)

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

Примечание. Этот метод поддерживается только Outlook 2016 или более поздней версией Windows (версии click-to-Run больше 16.0.8413.1000) и Outlook в Интернете для Microsoft 365.

getInitializationContextAsync(callback)

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

Примечание. Этот метод поддерживается только Outlook 2016 или более поздней версией Windows (версии click-to-Run больше 16.0.8413.1000) и Outlook в Интернете для Microsoft 365.

getRegExMatches()

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

Метод getRegExMatches возвращает строки, соответствующие регулярному выражению, которое определяется в каждом элементе правила ItemHasRegularExpressionMatch или ItemHasKnownEntity в XML-файле манифеста. Для правила ItemHasRegularExpressionMatch соответствующую строку должно содержать свойство элемента, указанного этим правилом. Простой тип PropertyName определяет поддерживаемые свойства.

Если вы указываете правило ItemHasRegularExpressionMatch для свойства текста элемента, регулярное выражение должно дальше фильтровать текст, а не пытаться вернуть весь текст элемента. Использование регулярного выражения типа .* для получения всего текста элемента не всегда приносит ожидаемые результаты. Лучше используйте метод Body.getAsync для этого.

Примечание. Этот метод не поддерживается в Outlook на iOS или Android.

getRegExMatchesByName(name)

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

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

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

Примечание. Этот метод не поддерживается в Outlook на iOS или Android.

getSelectedEntities()

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

Примечание. Этот метод не поддерживается в Outlook на iOS или Android.

getSelectedRegExMatches()

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

Метод getSelectedRegExMatches возвращает строки, соответствующие регулярному выражению, которое определяется в каждом элементе правила ItemHasRegularExpressionMatch или ItemHasKnownEntity в XML-файле манифеста. Для правила ItemHasRegularExpressionMatch соответствующую строку должно содержать свойство элемента, указанного этим правилом. Простой тип PropertyName определяет поддерживаемые свойства.

Если вы указываете правило ItemHasRegularExpressionMatch для свойства текста элемента, регулярное выражение должно дальше фильтровать текст, а не пытаться вернуть весь текст элемента. Использование регулярного выражения типа .* для получения всего текста элемента не всегда приносит ожидаемые результаты. Лучше используйте метод Body.getAsync для этого.

Примечание. Этот метод не поддерживается в Outlook на iOS или Android.

getSharedPropertiesAsync(options, callback)

Получает свойства встречи или сообщения в общей папке или общем почтовом ящике (теперь в предварительном просмотре).

Дополнительные сведения об использовании этого API см. в статье Общие папки и общие почтовые ящики.

Примечание. Этот метод не поддерживается в Outlook на iOS или Android.

getSharedPropertiesAsync(callback)

Получает свойства встречи или сообщения в общей папке или общем почтовом ящике (теперь в предварительном просмотре).

Дополнительные сведения об использовании этого API см. в статье Общие папки и общие почтовые ящики.

Примечание. Этот метод не поддерживается в Outlook на iOS или Android.

loadCustomPropertiesAsync(callback, userContext)

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

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

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

removeHandlerAsync(eventType, options, callback)

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

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

removeHandlerAsync(eventType, callback)

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

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

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

attachments

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

attachments: AttachmentDetails[];

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

Комментарии

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

Применимый Outlook: чтение сообщений

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

Примеры

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

if (item.attachments.length > 0) {
    for (i = 0 ; i < item.attachments.length ; i++) {
        var 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
var attachments = Office.context.mailbox.item.attachments;
console.log(attachments);

body

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

body: Body;

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

Комментарии

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

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

Применимый Outlook: чтение сообщений

Примеры

// 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"
}

categories

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

categories: Categories;

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

Комментарии

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

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

Применимый Outlook: чтение сообщений

Примеры

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/45-categories/work-with-categories.yaml
Office.context.mailbox.item.categories.getAsync(function(asyncResult) {
  if (asyncResult.status === Office.AsyncResultStatus.Succeeded) {
    var categories = asyncResult.value;
    if (categories && categories.length > 0) {
      console.log("Categories assigned to this item:");
      console.log(JSON.stringify(categories));
    } else {
      console.log("There are no categories assigned to this item.");
    }
  } else {
    console.error(asyncResult.error);
  }
});
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/45-categories/work-with-categories.yaml
// Note: In order for you to successfully add a category,
// it must be in the mailbox categories master list.

Office.context.mailbox.masterCategories.getAsync(function(asyncResult) {
  if (asyncResult.status === Office.AsyncResultStatus.Succeeded) {
    var masterCategories = asyncResult.value;
    if (masterCategories && masterCategories.length > 0) {
      // Grab the first category from the master list.
      var categoryToAdd = [masterCategories[0].displayName];
      Office.context.mailbox.item.categories.addAsync(categoryToAdd, function(asyncResult) {
        if (asyncResult.status === Office.AsyncResultStatus.Succeeded) {
          console.log(`Successfully assigned category '${categoryToAdd}' to item.`);
        } else {
          console.log("categories.addAsync call failed with error: " + asyncResult.error.message);
        }
      });
    } else {
      console.log("There are no categories in the master list on this mailbox. You can add categories using Office.context.mailbox.masterCategories.addAsync.");
    }
  } else {
    console.error(asyncResult.error);
  }
});
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/45-categories/work-with-categories.yaml
Office.context.mailbox.item.categories.getAsync(function(asyncResult) {
  if (asyncResult.status === Office.AsyncResultStatus.Succeeded) {
    var categories = asyncResult.value;
    if (categories && categories.length > 0) {
      // Grab the first category assigned to this item.
      var categoryToRemove = [categories[0].displayName];
      Office.context.mailbox.item.categories.removeAsync(categoryToRemove, function(asyncResult) {
        if (asyncResult.status === Office.AsyncResultStatus.Succeeded) {
          console.log(`Successfully unassigned category '${categoryToRemove}' from this item.`);
        } else {
          console.log("categories.removeAsync call failed with error: " + asyncResult.error.message);
        }
      });
    } else {
      console.log("There are no categories assigned to this item.");
    }
  } else {
    console.error(asyncResult.error);
  }
});

cc

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

Свойство возвращает массив, содержащий объект cc EmailAddressDetails для каждого получателя, указанный в строке Cc сообщения. Ограничения размера коллекции:

  • Windows: 500 участников

  • Mac: 100 участников

  • Веб-браузер: 20 участников

  • Другое: нет ограничений

cc: EmailAddressDetails[];

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

Комментарии

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

Применимый Outlook: чтение сообщений

Примеры

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/30-recipients-and-attendees/get-cc-message-read.yaml
var msgCc = Office.context.mailbox.item.cc;
console.log("Message copied to:");
for (var i = 0; i < msgCc.length; i++) {
  console.log(msgCc[i].displayName + " (" + msgCc[i].emailAddress + ")");
}

conversationId

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

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

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

conversationId: string;

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

string

Комментарии

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

Применимый Outlook: чтение сообщений

Примеры

// 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

Комментарии

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

Применимый Outlook: чтение сообщений

Примеры

// 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

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

Примечание. Этот член не поддерживается в Outlook на iOS или Android.

dateTimeModified: Date;

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

Date

Комментарии

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

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

Комментарии

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

Применимый Outlook: чтение сообщений

Примеры

// 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 делегата.

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

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

from: EmailAddressDetails;

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

Комментарии

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

Применимый Outlook: чтение сообщений

Примеры

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/30-recipients-and-attendees/get-from-message-read.yaml
var msgFrom = Office.context.mailbox.item.from;
console.log("Message received from: " + msgFrom.displayName + " (" + msgFrom.emailAddress + ")");

internetMessageId

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

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

internetMessageId: string;

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

string

Комментарии

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

Применимый Outlook: чтение сообщений

Примеры

// 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 для выбранного элемента.

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

itemClass: string;

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

string

Комментарии

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

Применимый Outlook: чтение сообщений

Свойство itemClass указывает класс сообщения выбранного элемента. Ниже приводятся классы сообщения по умолчанию для элемента сообщения или встречи.

Тип Описание Класс item
Элементы встречи Это элементы календаря IPM класса элемента. Назначение или IPM. Appointment.Occurrence. IPM. Назначение, IPM. Appointment.Occurrence
Элементы сообщения Сюда входят сообщения электронной почты с классом сообщения по умолчанию IPM.Note, а также приглашения на собрания, ответы на приглашения и отмены собраний, использующие IPM.Schedule.Meeting в качестве базового класса сообщения. IPM. Примечание, IPM. Schedule.Meeting.Request,IPM. Schedule.Meeting.Neg, IPM. Schedule.Meeting.Pos,IPM. Schedule.Meeting.Tent,IPM. Schedule.Meeting.Canceled

Примеры

// 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 веб-служб для текущего элемента.

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

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

itemId: string;

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

string

Комментарии

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

Применимый Outlook: чтение сообщений

Примеры

// 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.
var 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;

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

Комментарии

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

Применимый Outlook: чтение сообщений

Примеры

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/90-other-item-apis/get-item-type.yaml
console.log(`Item type: ${Office.context.mailbox.item.itemType}`);

location

Получает расположение запроса на собрание.

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

location: string;

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

string

Комментарии

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

Применимый Outlook: чтение сообщений

Примеры

// 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

Комментарии

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

Применимый Outlook: чтение сообщений

Примеры

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

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

Комментарии

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

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

Применимый Outlook: чтение сообщений

Примеры

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/35-notifications/add-getall-remove.yaml
var id = $("#notificationId").val();
var details =
  {
    type: "progressIndicator",
    message: "Progress indicator with id = " + id
  };
Office.context.mailbox.item.notificationMessages.addAsync(id, details, handleResult);
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/35-notifications/add-getall-remove.yaml
var id = $("#notificationId").val();
var details =
  {
    type: "informationalMessage",
    message: "Non-persistent informational notification message with id = " + id,
    icon: "icon1",
    persistent: false
  };
Office.context.mailbox.item.notificationMessages.addAsync(id, details, handleResult);
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/35-notifications/add-getall-remove.yaml
var id = $("#notificationId").val();
var details =
  {
    type: "informationalMessage",
    message: "Persistent informational notification message with id = " + id,
    icon: "icon1",
    persistent: true
  };
Office.context.mailbox.item.notificationMessages.addAsync(id, details, handleResult);
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/35-notifications/add-getall-remove.yaml
Office.context.mailbox.item.notificationMessages.getAllAsync(handleResult);          
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/35-notifications/add-getall-remove.yaml
var id = $("#notificationId").val();
Office.context.mailbox.item.notificationMessages.replaceAsync(
  id,
  {
    type: "informationalMessage",
    message: "Notification message with id = " + id + " has been replaced with an informational message.",
    icon: "icon2",
    persistent: false
  },
  handleResult);
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/35-notifications/add-getall-remove.yaml
var id = $("#notificationId").val();
Office.context.mailbox.item.notificationMessages.removeAsync(id, handleResult);

recurrence

Получает шаблон повторения встречи. Получает шаблон повторения запроса собрания. Режимы чтения и составить для элементов встречи. Режим чтения элементов запроса собраний.

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

Примечание. Запросы собраний имеют значение itemClass IPM.Schedule.Meeting.Request.

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

recurrence: Recurrence;

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

Комментарии

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

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

Применимый Outlook: чтение сообщений

Примеры

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/50-recurrence/get-recurrence-read.yaml
var 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

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

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

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

sender: EmailAddressDetails;

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

Комментарии

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

Применимый Outlook: чтение сообщений

Примеры

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/30-recipients-and-attendees/get-sender-message-read.yaml
var msgSender = Office.context.mailbox.item.sender;
console.log("Sender: " + msgSender.displayName + " (" + msgSender.emailAddress + ")");

seriesId

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

В Outlook в Интернете и настольных клиентах возвращается Exchange веб-службы (EWS) родительского (серийного) элемента, к которой seriesId относится этот элемент. Однако на iOS и Android seriesId возвращается rest ID родительского элемента.

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

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

seriesId: string;

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

string

Комментарии

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

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

Применимый Outlook: чтение сообщений

Примеры

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/50-recurrence/get-series-id.yaml
var 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

Комментарии

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

Применимый Outlook: чтение сообщений

Примеры

// 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

Комментарии

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

Применимый Outlook: чтение сообщений

Примеры

// 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 для каждого получателя, указанный в строке To сообщения. Ограничения размера коллекции:

  • Windows: 500 участников

  • Mac: 100 участников

  • Веб-браузер: 20 участников

  • Другое: нет ограничений

to: EmailAddressDetails[];

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

Комментарии

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

Применимый Outlook: чтение сообщений

Примеры

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/30-recipients-and-attendees/get-to-message-read.yaml
var msgTo = Office.context.mailbox.item.to;
console.log("Message sent to:");
for (var i = 0; i < msgTo.length; i++) {
  console.log(msgTo[i].displayName + " (" + msgTo[i].emailAddress + ")");
}

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

addHandlerAsync(eventType, handler, options, callback)

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

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

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

Параметры

eventType

Office.EventType | string

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

handler

any

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

options
Office.AsyncContextOptions

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

callback

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

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

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

void

Комментарии

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

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

Применимый Outlook: чтение сообщений

Примеры

function myHandlerFunction(eventarg) {
    if (eventarg.attachmentStatus === Office.MailboxEnums.AttachmentStatus.Added) {
        var 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)

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

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

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

Параметры

eventType

Office.EventType | string

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

handler

any

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

callback

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

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

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

void

Комментарии

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

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

Применимый Outlook: чтение сообщений

displayReplyAllForm(formData)

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

В Outlook в Интернете форме ответа отображается в виде всплывающее в представлении 3-столбца и всплывающее представление в представлении 2-column или 1-column.

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

Если в параметре указаны вложения, Outlook все вложения и прикрепите их formData.attachments к форме ответа. Если какие-либо вложения добавить не удается, в форме отображается сообщение об ошибке. Если сообщения об ошибках не предусмотрены, то они не отображаются.

Примечание. Этот метод не поддерживается в Outlook на iOS или Android.

displayReplyAllForm(formData: string | ReplyFormData): void;

Параметры

formData

string | Office.ReplyFormData

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

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

void

Комментарии

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

Применимый Outlook: чтение сообщений

Примеры

// The following code passes a string to the `displayReplyAllForm` function.
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)

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

В Outlook в Интернете форме ответа отображается в виде всплывающее в представлении 3-столбца и всплывающее представление в представлении 2-column или 1-column.

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

Если в параметре указаны вложения, Outlook все вложения и прикрепите их formData.attachments к форме ответа. Если какие-либо вложения добавить не удается, в форме отображается сообщение об ошибке. Если сообщения об ошибках не предусмотрены, то они не отображаются.

Примечание. Этот метод не поддерживается в Outlook на iOS или Android.

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

Параметры

formData

string | Office.ReplyFormData

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

options
Office.AsyncContextOptions

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

callback

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

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

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

void

Комментарии

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

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

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

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

В Outlook в Интернете форме ответа отображается в виде всплывающее в представлении 3-столбца и всплывающее представление в представлении 2-column или 1-column.

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

Если в параметре указаны вложения, Outlook все вложения и прикрепите их formData.attachments к форме ответа. Если какие-либо вложения добавить не удается, в форме отображается сообщение об ошибке. Если сообщения об ошибках не предусмотрены, то они не отображаются.

Примечание. Этот метод не поддерживается в Outlook на iOS или Android.

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

Параметры

formData

string | Office.ReplyFormData

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

callback

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

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

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

void

Комментарии

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

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

Применимый Outlook: чтение сообщений

displayReplyForm(formData)

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

В Outlook в Интернете форме ответа отображается в виде всплывающее в представлении 3-столбца и всплывающее представление в представлении 2-column или 1-column.

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

Если в параметре указаны вложения, Outlook все вложения и прикрепите их formData.attachments к форме ответа. Если какие-либо вложения добавить не удается, в форме отображается сообщение об ошибке. Если сообщения об ошибках не предусмотрены, то они не отображаются.

Примечание. Этот метод не поддерживается в Outlook на iOS или Android.

displayReplyForm(formData: string | ReplyFormData): void;

Параметры

formData

string | Office.ReplyFormData

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

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

void

Комментарии

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

Применимый Outlook: чтение сообщений

Примеры

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

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

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

// Reply with a body and a file attachment.
Office.context.mailbox.item.displayReplyForm(
{
    '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.displayReplyForm(
{
    '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.displayReplyForm(
{
    '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.displayReplyForm("This is a reply with <i>some text in italics</i>.");
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/55-display-items/display-reply-with-attachments.yaml
Office.context.mailbox.item.displayReplyForm({
  htmlBody: "This is a reply with a couple of attachments - an inline image and an item<br><img src='cid:dog.jpg'>",
  attachments: [
    { type: "file", url: "http://i.imgur.com/9S36xvA.jpg", name: "dog.jpg", isInline: true },
    { type: "item", itemId: Office.context.mailbox.item.itemId, name: "test_email.msg" }
  ],
  options: { asyncContext: null },
  callback: function(result) {
    if (result.status !== Office.AsyncResultStatus.Succeeded) {
      console.error(`Action failed with message ${result.error.message}`);
    }
  }
});

displayReplyFormAsync(formData, options, callback)

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

В Outlook в Интернете форме ответа отображается в виде всплывающее в представлении 3-столбца и всплывающее представление в представлении 2-column или 1-column.

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

Если в параметре указаны вложения, Outlook все вложения и прикрепите их formData.attachments к форме ответа. Если какие-либо вложения добавить не удается, в форме отображается сообщение об ошибке. Если сообщения об ошибках не предусмотрены, то они не отображаются.

Примечание. Этот метод не поддерживается в Outlook на iOS или Android.

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

Параметры

formData

string | Office.ReplyFormData

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

options
Office.AsyncContextOptions

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

callback

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

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

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

void

Комментарии

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

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

Применимый 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));
});
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/55-display-items/display-reply-with-attachments.yaml
// The async version is only available starting with requirement set 1.9,
// and provides a callback when the new appointment form has been created.
Office.context.mailbox.item.displayReplyFormAsync(
  {
    htmlBody: "This is a reply with a couple of attachments - an inline image and an item<br><img src='cid:dog.jpg'>",
    attachments: [
      { type: "file", url: "http://i.imgur.com/9S36xvA.jpg", name: "dog.jpg", isInline: true },
      { type: "item", itemId: Office.context.mailbox.item.itemId, name: "test_email.msg" }
    ]
  },
  function(asyncResult) {
    console.log(JSON.stringify(asyncResult));
  }
);

displayReplyFormAsync(formData, callback)

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

В Outlook в Интернете форме ответа отображается в виде всплывающее в представлении 3-столбца и всплывающее представление в представлении 2-column или 1-column.

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

Если в параметре указаны вложения, Outlook все вложения и прикрепите их formData.attachments к форме ответа. Если какие-либо вложения добавить не удается, в форме отображается сообщение об ошибке. Если сообщения об ошибках не предусмотрены, то они не отображаются.

Примечание. Этот метод не поддерживается в Outlook на iOS или Android.

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

Параметры

formData

string | Office.ReplyFormData

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

callback

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

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

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

void

Комментарии

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

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

Применимый Outlook: чтение сообщений

getAllInternetHeadersAsync(options, callback)

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

Дополнительные дополнительные сообщения см. в статью Get and set internet headers on a message in an Outlook-in.

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

Параметры

options
Office.AsyncContextOptions

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

callback

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

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

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

void

Комментарии

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

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

Применимый Outlook: чтение сообщений

Примеры

// 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(/x-preferred-fruit:.*/gim)) {
      console.log("Sender's preferred fruit: " + asyncResult.value.match(/x-preferred-fruit:.*/gim)[0].slice(19));
    } else {
      console.log("Didn't receive header with sender's preferred fruit");
    }
    if (asyncResult.value.match(/x-preferred-vegetable:.*/gim)) {
      console.log(
        "Sender's preferred vegetable: " + asyncResult.value.match(/x-preferred-vegetable:.*/gim)[0].slice(23)
      );
    } 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)

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

Дополнительные дополнительные сообщения см. в статью Get and set internet headers on a message in an Outlook-in.

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

Параметры

callback

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

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

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

void

Комментарии

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

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

Применимый Outlook: чтение сообщений

getAttachmentContentAsync(attachmentId, options, callback)

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

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

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

Параметры

attachmentId

string

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

options
Office.AsyncContextOptions

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

callback

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

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

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

void

Комментарии

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

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

Применимый Outlook: чтение сообщений

Ошибки:

  • AttachmentTypeNotSupported. Тип вложения не поддерживается. Неподкрепленные типы включают встроенные изображения в формате Rich Text Или типы вложений элементов, кроме элементов электронной почты или календаря (например, контакт или элемент задачи).

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

Примеры

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/40-attachments/get-attachment-content.yaml
var item = Office.context.mailbox.item;
var options = {asyncContext: {currentItem: item}};
item.getAttachmentsAsync(options, callback);

function callback(result) {
    if (result.value.length > 0) {
        for (i = 0 ; i < result.value.length ; i++) {
            result.asyncContext.currentItem.getAttachmentContentAsync(result.value[i].id, handleAttachmentsCallback);
        }
    }
}

function handleAttachmentsCallback(result) {
    // Parse string to be a url, an .eml file, a base64-encoded string, or an .icalendar file.
    switch (result.value.format) {
        case Office.MailboxEnums.AttachmentContentFormat.Base64:
            // Handle file attachment.
            console.log(result.value.content);
            break;
        case Office.MailboxEnums.AttachmentContentFormat.Eml:
            // Handle email item attachment.
            console.log("Attachment is a message.");
            break;
        case Office.MailboxEnums.AttachmentContentFormat.ICalendar:
            // Handle .icalender attachment.
            console.log("Attachment is a calendar item.");
            break;
        case Office.MailboxEnums.AttachmentContentFormat.Url:
            // Handle cloud attachment.
            console.log("Attachment is a cloud attachment.");
            break;
        default:
            // Handle attachment formats that are not supported.
    }
}

getAttachmentContentAsync(attachmentId, callback)

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

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

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

Параметры

attachmentId

string

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

callback

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

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

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

void

Комментарии

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

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

Применимый Outlook: чтение сообщений

Ошибки:

  • AttachmentTypeNotSupported. Тип вложения не поддерживается. Неподкрепленные типы включают встроенные изображения в формате Rich Text Или типы вложений элементов, кроме элементов электронной почты или календаря (например, контакт или элемент задачи).

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

getEntities()

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

Примечание. Этот метод не поддерживается в Outlook на iOS или Android.

getEntities(): Entities;

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

Комментарии

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

Применимый Outlook: чтение сообщений

Примеры

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/75-entities-and-regex-matches/basic-entities.yaml
var entities = Office.context.mailbox.item.getEntities();
var entityTypesFound = 0;
if (entities.addresses.length > 0) {
    console.warn("physical addresses: ");
    console.log(entities.addresses);
    entityTypesFound++;
}
if (entities.contacts.length > 0) {
    console.warn("contacts: ");
    entities.contacts.forEach(function (contact) { console.log(contact.personName); })
    entityTypesFound++;
}
if (entities.emailAddresses.length > 0) {
    console.warn("email addresses: ");
    console.log(entities.emailAddresses);
    entityTypesFound++;
}
if (entities.meetingSuggestions.length > 0) {
    console.warn("meetings suggestions: ");
    entities.meetingSuggestions.forEach(function (meetingSuggestion) { console.log(meetingSuggestion.meetingString); })
    entityTypesFound++;
}
if (entities.phoneNumbers.length > 0) {
    console.warn("phone numbers: ");
    entities.phoneNumbers.forEach(function (phoneNumber) { console.log(phoneNumber.originalPhoneString); })
    entityTypesFound++;
}
if (entities.taskSuggestions.length > 0) {
    console.warn("task suggestions: ");
    entities.taskSuggestions.forEach(function (taskSuggestion) { console.log(taskSuggestion.taskString); })
    entityTypesFound++;
}
if (entities.urls.length > 0) {
    console.warn("URLs: ");
    console.log(entities.urls);
    entityTypesFound++;
}
if (entityTypesFound == 0)
{
    console.log("No entities found on this item.");
}

getEntitiesByType(entityType)

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

Примечание. Этот метод не поддерживается в Outlook на iOS или Android.

getEntitiesByType(entityType: MailboxEnums.EntityType | string): (string | Contact | MeetingSuggestion | PhoneNumber | TaskSuggestion)[];

Параметры

entityType

Office.MailboxEnums.EntityType | string

Одно из EntityType значений переумерия.

Хотя минимальный уровень разрешений для использования этого метода Restricted, некоторые типы сущности требуют ReadItem доступа, как указано в следующей таблице.

Значение entityType Тип объектов в возвращаемом массиве Необходимый уровень разрешений
Address String Restricted
Контакт Контакт ReadItem
EmailAddress String ReadItem
MeetingSuggestion MeetingSuggestion ReadItem
PhoneNumber PhoneNumber Restricted
TaskSuggestion TaskSuggestion ReadItem
URL String Restricted

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

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

Комментарии

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

Применимый Outlook: чтение сообщений

Примеры

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/75-entities-and-regex-matches/basic-entities.yaml
console.log(Office.context.mailbox.item.getEntitiesByType(Office.MailboxEnums.EntityType.Address));

getFilteredEntitiesByName(name)

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

Метод возвращает объекты, которые соответствуют обычному выражению, определенному в элементе правила в XML-файле манифеста, с указанным getFilteredEntitiesByName ItemHasKnownEntity FilterName значением элемента.

Примечание. Этот метод не поддерживается в Outlook на iOS или Android.

getFilteredEntitiesByName(name: string): (string | Contact | MeetingSuggestion | PhoneNumber | TaskSuggestion)[];

Параметры

name

string

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

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

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

Комментарии

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

Применимый Outlook: чтение сообщений

Примеры

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/75-entities-and-regex-matches/contextual.yaml
// This API would only work when you click on highlighted physical address that has the word "Way" in it.
console.log(Office.context.mailbox.item.getFilteredEntitiesByName("sampleFilterName"));

getInitializationContextAsync(options, callback)

Примечание

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

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

Примечание. Этот метод поддерживается только Outlook 2016 или более поздней версией Windows (версии click-to-Run больше 16.0.8413.1000) и Outlook в Интернете для Microsoft 365.

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

Параметры

options
Office.AsyncContextOptions

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

callback

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

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

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

void

Комментарии

[Набор API: предварительный просмотр почтовых ящиков ]

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

Применимый Outlook: чтение сообщений

Примеры

// Get the initialization context (if present).
Office.context.mailbox.item.getInitializationContextAsync(
    function(asyncResult) {
        if (asyncResult.status === Office.AsyncResultStatus.Succeeded) {
            if (asyncResult.value != null && asyncResult.value.length > 0) {
                // The value is a string, parse to an object.
                var context = JSON.parse(asyncResult.value);
                // Do something with context.
            } else {
                // Empty context, treat as no context.
            }
        } else {
            if (asyncResult.error.code == 9020) {
                // GenericResponseError returned when there is no context.
                // Treat as no context.
            } else {
                // Handle the error.
            }
        }
    }
);

getInitializationContextAsync(callback)

Примечание

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

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

Примечание. Этот метод поддерживается только Outlook 2016 или более поздней версией Windows (версии click-to-Run больше 16.0.8413.1000) и Outlook в Интернете для Microsoft 365.

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

Параметры

callback

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

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

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

void

Комментарии

[Набор API: предварительный просмотр почтовых ящиков ]

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

Применимый Outlook: чтение сообщений

getRegExMatches()

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

Метод getRegExMatches возвращает строки, соответствующие регулярному выражению, которое определяется в каждом элементе правила ItemHasRegularExpressionMatch или ItemHasKnownEntity в XML-файле манифеста. Для правила ItemHasRegularExpressionMatch соответствующую строку должно содержать свойство элемента, указанного этим правилом. Простой тип PropertyName определяет поддерживаемые свойства.

Если вы указываете правило ItemHasRegularExpressionMatch для свойства текста элемента, регулярное выражение должно дальше фильтровать текст, а не пытаться вернуть весь текст элемента. Использование регулярного выражения типа .* для получения всего текста элемента не всегда приносит ожидаемые результаты. Лучше используйте метод Body.getAsync для этого.

Примечание. Этот метод не поддерживается в Outlook на iOS или Android.

getRegExMatches(): any;

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

any

Объект, содержащий массив строк, которые соответствуют регулярным выражениям, определяемым в XML-файле манифеста. Имя каждого массива равно соответствующему значению атрибута RegExName подходящего правила ItemHasRegularExpressionMatch или атрибута FilterName соответствующего правила ItemHasKnownEntity.

Комментарии

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

Применимый 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.
var allMatches = Office.context.mailbox.item.getRegExMatches();
var fruits = allMatches.fruits;
var veggies = allMatches.veggies;
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/75-entities-and-regex-matches/contextual.yaml
// This API would only work when you click on highlighted word "ScriptLab".
console.log(Office.context.mailbox.item.getRegExMatches());

getRegExMatchesByName(name)

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

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

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

Примечание. Этот метод не поддерживается в Outlook на iOS или Android.

getRegExMatchesByName(name: string): string[];

Параметры

name

string

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

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

string[]

Массив строк, соответствующих регулярному выражению, определяемому в XML-файле манифеста.

Комментарии

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

Применимый 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']
//}

var fruits = Office.context.mailbox.item.getRegExMatchesByName("fruits");
var veggies = Office.context.mailbox.item.getRegExMatchesByName("veggies");
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/75-entities-and-regex-matches/contextual.yaml
// This API would only work when you click on highlighted word "ScriptLab".
console.log(Office.context.mailbox.item.getRegExMatchesByName("sampleRegexName"));

getSelectedEntities()

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

Примечание. Этот метод не поддерживается в Outlook на iOS или Android.

getSelectedEntities(): Entities;

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

Комментарии

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

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

Применимый Outlook: чтение сообщений

Примеры

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/75-entities-and-regex-matches/selected.yaml
var entities = Office.context.mailbox.item.getSelectedEntities();
var entityTypesFound = 0;
if (entities.addresses.length > 0) {
    console.warn("physical addresses: ");
    console.log(entities.addresses);
    entityTypesFound++;
}
if (entities.contacts.length > 0) {
    console.warn("contacts: ");
    entities.contacts.forEach(function (contact) { console.log(contact.personName); })
    entityTypesFound++;
}
if (entities.emailAddresses.length > 0) {
    console.warn("email addresses: ");
    console.log(entities.emailAddresses);
    entityTypesFound++;
}
if (entities.meetingSuggestions.length > 0) {
    console.warn("meetings suggestions: ");
    entities.meetingSuggestions.forEach(function (meetingSuggestion) { console.log(meetingSuggestion.meetingString); })
    entityTypesFound++;
}
if (entities.phoneNumbers.length > 0) {
    console.warn("phone numbers: ");
    entities.phoneNumbers.forEach(function (phoneNumber) { console.log(phoneNumber.originalPhoneString); })
    entityTypesFound++;
}
if (entities.taskSuggestions.length > 0) {
    console.warn("task suggestions: ");
    entities.taskSuggestions.forEach(function (taskSuggestion) { console.log(taskSuggestion.taskString); })
    entityTypesFound++;
}
if (entities.urls.length > 0) {
    console.warn("URLs: ");
    console.log(entities.urls);
    entityTypesFound++;
}
if (entityTypesFound == 0)
{
    console.error("Open add-in by clicking on a highlighted entity, for this API to return something useful.");
}

getSelectedRegExMatches()

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

Метод getSelectedRegExMatches возвращает строки, соответствующие регулярному выражению, которое определяется в каждом элементе правила ItemHasRegularExpressionMatch или ItemHasKnownEntity в XML-файле манифеста. Для правила ItemHasRegularExpressionMatch соответствующую строку должно содержать свойство элемента, указанного этим правилом. Простой тип PropertyName определяет поддерживаемые свойства.

Если вы указываете правило ItemHasRegularExpressionMatch для свойства текста элемента, регулярное выражение должно дальше фильтровать текст, а не пытаться вернуть весь текст элемента. Использование регулярного выражения типа .* для получения всего текста элемента не всегда приносит ожидаемые результаты. Лучше используйте метод Body.getAsync для этого.

Примечание. Этот метод не поддерживается в Outlook на iOS или Android.

getSelectedRegExMatches(): any;

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

any

Объект, содержащий массив строк, которые соответствуют регулярным выражениям, определяемым в XML-файле манифеста. Имя каждого массива равно соответствующему значению атрибута RegExName подходящего правила ItemHasRegularExpressionMatch или атрибута FilterName соответствующего правила ItemHasKnownEntity.

Комментарии

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

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

Применимый 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.
var selectedMatches = Office.context.mailbox.item.getSelectedRegExMatches();
var fruits = selectedMatches.fruits;
var veggies = selectedMatches.veggies;
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/75-entities-and-regex-matches/selected.yaml
var 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 на iOS или Android.

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

Параметры

options
Office.AsyncContextOptions

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

callback

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

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

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

void

Комментарии

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

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

Применимый Outlook: чтение сообщений

Примеры

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/65-delegates-and-shared-folders/get-shared-properties.yaml
if (!Office.context.mailbox.item.getSharedPropertiesAsync) {
  console.error("Try this sample on a message from a shared folder.");
  return;
}

Office.context.mailbox.getCallbackTokenAsync({ isRest: true }, function(result) {
  if (result.status === Office.AsyncResultStatus.Succeeded && result.value !== "") {
    Office.context.mailbox.item.getSharedPropertiesAsync(
      {
        // Pass auth token along.
        asyncContext: result.value
      },
      function(result2) {
        let sharedProperties = result2.value;
        let delegatePermissions = sharedProperties.delegatePermissions;

        // Determine if user has the appropriate permission to do the operation.
        if ((delegatePermissions & Office.MailboxEnums.DelegatePermissions.Read) != 0) {
          var ewsId = Office.context.mailbox.item.itemId;
          var restId = Office.context.mailbox.convertToRestId(ewsId, Office.MailboxEnums.RestVersion.v2_0);
          let rest_url =
            sharedProperties.targetRestUrl + "/v2.0/users/" + sharedProperties.targetMailbox + "/messages/" + restId;

          $.ajax({
            url: rest_url,
            dataType: "json",
            headers: { Authorization: "Bearer " + result2.asyncContext }
          })
            .done(function(response) {
              console.log(response);
            })
            .fail(function(error) {
              console.error(error);
            });
        }
      }
    );
  }
});

getSharedPropertiesAsync(callback)

Получает свойства встречи или сообщения в общей папке или общем почтовом ящике (теперь в предварительном просмотре).

Дополнительные сведения об использовании этого API см. в статье Общие папки и общие почтовые ящики.

Примечание. Этот метод не поддерживается в Outlook на iOS или Android.

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

Параметры

callback

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

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

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

void

Комментарии

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

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

Применимый Outlook: чтение сообщений

Примеры

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/65-delegates-and-shared-folders/get-shared-properties.yaml
if (!Office.context.mailbox.item.getSharedPropertiesAsync) {
  console.error("Try this sample on an item from a shared folder.");
  return;
}

Office.context.mailbox.item.getSharedPropertiesAsync(function(result) {
  console.log(result.value);
});

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

Комментарии

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

Применимый Outlook: чтение сообщений

Примеры

// The following example shows how to use the loadCustomPropertiesAsync method
// to asynchronously load custom properties that are specific to the current item.
// The example also shows how to use the saveAsync method to save these properties
// back to the server. After loading the custom properties, the example uses the
// get method to read the custom property myProp, the set method to write the
// custom property otherProp, and then finally calls the saveAsync method to save
// the custom properties.
Office.initialize = function () {
    // Checks for the DOM to load using the jQuery ready function.
    $(document).ready(function () {
        // After the DOM is loaded, add-in-specific code can run.
        var mailbox = Office.context.mailbox;
        mailbox.item.loadCustomPropertiesAsync(customPropsCallback);
    });
};

function customPropsCallback(asyncResult) {
    var customProps = asyncResult.value;
    var myProp = customProps.get("myProp");

    customProps.set("otherProp", "value");
    customProps.saveAsync(saveCallback);
}

function saveCallback(asyncResult) {
}
// 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(function (result) {
  if (result.status === Office.AsyncResultStatus.Succeeded) {
    console.log("Loaded following custom properties:");
    customProps = result.value;
    var dataKey = Object.keys(customProps)[0];
    var data = customProps[dataKey];
    for (var propertyName in data)
    {
      var propertyValue = data[propertyName];
      console.log(`${propertyName}: ${propertyValue}`);
    }              
  }
  else {
    console.error(`loadCustomPropertiesAsync failed with message ${result.error.message}`);
  }
});

removeHandlerAsync(eventType, options, callback)

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

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

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

Параметры

eventType

Office.EventType | string

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

options
Office.AsyncContextOptions

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

callback

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

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

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

void

Комментарии

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

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

Применимый Outlook: чтение сообщений

removeHandlerAsync(eventType, callback)

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

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

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

Параметры

eventType

Office.EventType | string

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

callback

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

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

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

void

Комментарии

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

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

Применимый Outlook: чтение сообщений