Office.AppointmentCompose interface

Режим организатора встречи Office.context.mailbox.item.

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

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

Extends

Свойства

body

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

categories

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

end

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

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

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

Важно. В Windows клиенте вы не можете использовать это свойство для обновления окончания повторения.

enhancedLocation

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

isAllDayEvent

Получает или задает Office. Свойство IsAllDayEvent для встречи.

itemType

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

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

location

Получает или задает место встречи. Свойство location возвращает объект Location, который предоставляет методы, используемые для получения и определения расположения встречи.

notificationMessages

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

optionalAttendees

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

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

organizer

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

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

recurrence

Получает или задает шаблон повторения встречи.

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

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

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

requiredAttendees

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

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

sensitivity

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

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 собрание.

sessionData

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

start

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

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

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

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

subject

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

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

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

Методы

addFileAttachmentAsync(uri, attachmentName, options, callback)

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

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

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

Важно. В последних сборках Outlook на Windows была введена ошибка, которая неправильно привносима заголовку к этому действию (как с помощью этого API, так и Authorization: Bearer Outlook пользовательского интерфейса). Чтобы решить эту проблему, можно попробовать использовать API, введенный с набором требований addFileAttachmentFromBase64 1.8.

addFileAttachmentAsync(uri, attachmentName, callback)

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

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

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

Важно. В последних сборках Outlook на Windows была введена ошибка, которая неправильно привносима заголовку к этому действию (как с помощью этого API, так и Authorization: Bearer Outlook пользовательского интерфейса). Чтобы решить эту проблему, можно попробовать использовать API, введенный с набором требований addFileAttachmentFromBase64 1.8.

addFileAttachmentFromBase64Async(base64File, attachmentName, options, callback)

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

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

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

Примечание. Если вы используете API URL-адресов данных (например, readAsDataURL), необходимо раздеть префикс URL-адреса данных, а затем отправить остальную строку в этот API. Например, если полная строка представлена data:image/svg+xml;base64,<rest of base64 string>, удалить data:image/svg+xml;base64,.

addFileAttachmentFromBase64Async(base64File, attachmentName, callback)

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

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

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

Примечание. Если вы используете API URL-адресов данных (например, readAsDataURL), необходимо раздеть префикс URL-адреса данных, а затем отправить остальную строку в этот API. Например, если полная строка представлена data:image/svg+xml;base64,<rest of base64 string>, удалить data:image/svg+xml;base64,.

addHandlerAsync(eventType, handler, options, callback)

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

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

addHandlerAsync(eventType, handler, callback)

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

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

addItemAttachmentAsync(itemId, attachmentName, options, callback)

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

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

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

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

addItemAttachmentAsync(itemId, attachmentName, callback)

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

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

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

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

close()

Закрывает текущий элемент, который составляется

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

Если в клиенте Outlook для настольных ПК сообщение представляет собой ответ в тексте, метод close не работает.

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

disableClientSignatureAsync(options, callback)

Отключает Outlook клиента.

Для Windows и Mac богатые клиенты, этот API задает подпись под разделами "Новое сообщение" и "Ответы / Forwards" для отправки учетной записи в "(нет)", эффективно отключение подписи. Для Outlook в Интернете API должен отключить параметр подписи для новых почт, ответов и пересылаемой почты. Если выбрана подпись, этот вызов API должен отключить его.

disableClientSignatureAsync(callback)

Отключает Outlook клиента.

Для Windows и Mac богатые клиенты, этот API задает подпись под разделами "Новое сообщение" и "Ответы / Forwards" для отправки учетной записи в "(нет)", эффективно отключение подписи. Для Outlook в Интернете API должен отключить параметр подписи для новых почт, ответов и пересылаемой почты. Если выбрана подпись, этот вызов API должен отключить его.

getAttachmentContentAsync(attachmentId, options, callback)

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

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

getAttachmentContentAsync(attachmentId, callback)

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

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

getAttachmentsAsync(options, callback)

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

getAttachmentsAsync(callback)

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

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.

getItemIdAsync(options, callback)

Асинхронно получает ID сохраненного элемента.

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

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

getItemIdAsync(callback)

Асинхронно получает ID сохраненного элемента.

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

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

getSelectedDataAsync(coercionType, options, callback)

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

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

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

getSelectedDataAsync(coercionType, callback)

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

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

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

getSharedPropertiesAsync(options, callback)

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

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

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

getSharedPropertiesAsync(callback)

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

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

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

isClientSignatureEnabledAsync(options, callback)

Получает, если включена подпись клиента.

Для Windows и mac-клиентов вызов API должен возвращаться, если подпись по умолчанию для новых сообщений, ответов или пересылается установлена в шаблоне для Outlook true учетной записи. Для Outlook в Интернете, вызов API должен возвращаться, если подпись включена true для типов составитьnewMail, reply, или forward. Если параметры настроены на "(нет)" в Mac или Windows богатых клиентов или отключены Outlook в Интернете, вызов API должен вернутьсяfalse.

isClientSignatureEnabledAsync(callback)

Получает, если включена подпись клиента.

Для Windows и mac-клиентов вызов API должен возвращаться, если подпись по умолчанию для новых сообщений, ответов или пересылается установлена в шаблоне для Outlook true учетной записи. Для Outlook в Интернете, вызов API должен возвращаться, если подпись включена true для типов составитьnewMail, reply, или forward. Если параметры настроены на "(нет)" в Mac или Windows богатых клиентов или отключены Outlook в Интернете, вызов API должен вернутьсяfalse.

loadCustomPropertiesAsync(callback, userContext)

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

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

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

removeAttachmentAsync(attachmentId, options, callback)

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

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

removeAttachmentAsync(attachmentId, callback)

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

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

removeHandlerAsync(eventType, options, callback)

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

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

removeHandlerAsync(eventType, callback)

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

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

saveAsync(options, callback)

Асинхронно сохраняет элемент.

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

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

Примечание. Если надстройка вызывает элемент в режиме композитации, чтобы получить ID элемента для использования с EWS или API REST, обратите внимание, что, когда Outlook находится в кэшизированном режиме, может потребоваться некоторое время, прежде чем элемент будет фактически синхронизирован с saveAsync сервером. Пока элемент не синхронизирован, с помощью элемента ID возвращается ошибка.

Примечание. В Outlook Mac только сборка 16.35.308 или более поздней сборки поддерживает сохранение собрания. В противном случае метод не удается при призыве с saveAsync собрания в режиме составить. Обходное решение см. в документе Cannot Save a meeting as a draft in Outlook для Mac с помощью API Office JS.

saveAsync(callback)

Асинхронно сохраняет элемент.

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

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

Примечание. Если надстройка вызывает элемент в режиме композитации, чтобы получить ID элемента для использования с EWS или API REST, обратите внимание, что, когда Outlook находится в кэшизированном режиме, может потребоваться некоторое время, прежде чем элемент будет фактически синхронизирован с saveAsync сервером. Пока элемент не синхронизирован, с помощью элемента ID возвращается ошибка.

Примечание. В Outlook Mac только сборка 16.35.308 или более поздней сборки поддерживает сохранение собрания. В противном случае метод не удается при призыве с saveAsync собрания в режиме составить. Обходное решение см. в документе Cannot Save a meeting as a draft in Outlook для Mac с помощью API Office JS.

setSelectedDataAsync(data, options, callback)

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

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

setSelectedDataAsync(data, callback)

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

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

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

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 an object that is passed as the result parameter 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);
  }
});

end

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

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

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

Важно. В Windows клиенте вы не можете использовать это свойство для обновления окончания повторения.

end: Time;

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

Комментарии

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

Применимый Outlook: Организатор встречи

Примеры

// The following example sets the end time of an appointment in compose mode by
// using the `setAsync` method of the `Time` object.
var endTime = new Date("3/14/2015");
var options = {
    // Pass information that can be used in the callback.
    asyncContext: {verb: "Set"}
};
Office.context.mailbox.item.end.setAsync(endTime, options, function(result) {
    if (result.error) {
        console.debug(result.error);
    } else {
        // Access the asyncContext that was passed to the setAsync function.
        console.debug("End Time " + result.asyncContext.verb);
    }
});
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/90-other-item-apis/get-set-end-appointment-organizer.yaml
Office.context.mailbox.item.end.getAsync((result) => {
  if (result.status !== Office.AsyncResultStatus.Succeeded) {
    console.error(`Action failed with message ${result.error.message}`);
    return;
  }
  console.log(`Appointment ends: ${result.value}`);
});
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/90-other-item-apis/get-set-end-appointment-organizer.yaml
Office.context.mailbox.item.start.getAsync((result) => {
  if (result.status !== Office.AsyncResultStatus.Succeeded) {
    console.error(`Get start date failed with message ${result.error.message}`);
    return;
  }

  var end = result.value; // Set end to current start date and time.
  end.setDate(end.getDate() + 1); // Set end as 1 day later than start date.
  Office.context.mailbox.item.end.setAsync(end, (result) => {
    if (result.status !== Office.AsyncResultStatus.Succeeded) {
      console.error(`Set end date failed with message ${result.error.message}`);
      return;
    }
    console.log(`Successfully set end date and time to ${end}`);
  });
});

enhancedLocation

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

enhancedLocation: EnhancedLocation;

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

Комментарии

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

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

Применимый Outlook: Организатор встречи

Примеры

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/90-other-item-apis/get-add-remove-enhancedlocation-appointment.yaml
Office.context.mailbox.item.enhancedLocation.getAsync((result) => {
  if (result.status !== Office.AsyncResultStatus.Succeeded) {
    console.error(`Failed to get locations. Error message: ${result.error.message}`);
    return;
  }
  var places = result.value;
  if (places && places.length > 0) {
    result.value.forEach(function(place) {
      console.log(`Location: ${place.displayName} (type: ${place.locationIdentifier.type})`);
      if (place.locationIdentifier.type === Office.MailboxEnums.LocationType.Room) {
        console.log("Email address: " + place.emailAddress);
      }
    });
  } else {
    console.log("There are no locations.");
  }
});
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/90-other-item-apis/get-add-remove-enhancedlocation-appointment.yaml
var locations = [
  {
    id: "Contoso",
    type: Office.MailboxEnums.LocationType.Custom
  },
  {
    id: "room500@test.com",
    type: Office.MailboxEnums.LocationType.Room
  }
];
Office.context.mailbox.item.enhancedLocation.addAsync(locations, (result) => {
  if (result.status === Office.AsyncResultStatus.Succeeded) {
    console.log(`Successfully added locations ${JSON.stringify(locations)}`);
  } else {
    console.error(`Failed to add locations. Error message: ${result.error.message}`);
  }
});
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/90-other-item-apis/get-add-remove-enhancedlocation-appointment.yaml
var locations = [
  {
    id: "Contoso",
    type: Office.MailboxEnums.LocationType.Custom
  },
  {
    id: "room500@test.com",
    type: Office.MailboxEnums.LocationType.Room
  }
];
Office.context.mailbox.item.enhancedLocation.removeAsync(locations, (result) => {
  if (result.status === Office.AsyncResultStatus.Succeeded) {
    console.log(`Successfully removed locations ${JSON.stringify(locations)}`);
  } else {
    console.error(`Failed to remove locations. Error message: ${result.error.message}`);
  }
});

isAllDayEvent

Примечание

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

Получает или задает Office. Свойство IsAllDayEvent для встречи.

isAllDayEvent: IsAllDayEvent;

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

Комментарии

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

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

Применимый Outlook: Организатор встречи

Примеры

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/99-preview-apis/calendar-properties-apis.yaml
Office.context.mailbox.item.isAllDayEvent.getAsync(function(asyncResult) {
  if (asyncResult.status === Office.AsyncResultStatus.Succeeded) {
    console.log("Is this an all-day event? " + asyncResult.value);
  } else {
    console.log("Failed to get if this is an all-day event. Error: " + JSON.stringify(asyncResult.error));
  }
});
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/99-preview-apis/calendar-properties-apis.yaml
Office.context.mailbox.item.isAllDayEvent.setAsync(true, function(asyncResult) {
  if (asyncResult.status === Office.AsyncResultStatus.Failed) {
    console.log("Failed to set all-day event: " + JSON.stringify(asyncResult.error));
  } else {
    console.log("Appointment set to all-day event.");
  }
});

itemType

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

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

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, который предоставляет методы, используемые для получения и определения расположения встречи.

location: Location;

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

Комментарии

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

Применимый Outlook: Организатор встречи

Примеры

var userContext = { value : 1 };
Office.context.mailbox.item.location.getAsync( { context: userContext}, callback);

function callback(asyncResult) {
    var context = asyncResult.context;
    var location = asyncResult.value;
}
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/90-other-item-apis/get-set-location-appointment-organizer.yaml
Office.context.mailbox.item.location.getAsync((result) => {
  if (result.status !== Office.AsyncResultStatus.Succeeded) {
    console.error(`Action failed with message ${result.error.message}`);
    return;
  }
  console.log(`Appointment location: ${result.value}`);
});
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/90-other-item-apis/get-set-location-appointment-organizer.yaml
var location = "my office";
Office.context.mailbox.item.location.setAsync(location, (result) => {
  if (result.status !== Office.AsyncResultStatus.Succeeded) {
    console.error(`Action failed with message ${result.error.message}`);
    return;
  }
  console.log(`Successfully set location to ${location}`);
});

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

optionalAttendees

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

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

optionalAttendees: Recipients;

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

Комментарии

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

Применимый Outlook: Организатор встречи

Примеры

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

function callback(asyncResult) {
    var arrayOfOptionalAttendeesRecipients = asyncResult.value;
}
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/30-recipients-and-attendees/get-set-optional-attendees-appointment-organizer.yaml
Office.context.mailbox.item.optionalAttendees.getAsync(function(asyncResult) {
  if (asyncResult.status === Office.AsyncResultStatus.Succeeded) {
    var apptOptionalAttendees = asyncResult.value;
    for (var i = 0; i < apptOptionalAttendees.length; i++) {
      console.log(
        "Optional attendees: " +
          apptOptionalAttendees[i].displayName +
          " (" +
          apptOptionalAttendees[i].emailAddress +
          ") - response: " +
          apptOptionalAttendees[i].appointmentResponse
      );
    }
  } else {
    console.error(asyncResult.error);
  }
});
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/30-recipients-and-attendees/get-set-optional-attendees-appointment-organizer.yaml
var email = $("#emailOptional")
  .val()
  .toString();
var emailArray = [email];
Office.context.mailbox.item.optionalAttendees.setAsync(emailArray, function(asyncResult) {
  if (asyncResult.status === Office.AsyncResultStatus.Succeeded) {
    console.log("Succeeded in setting optional attendees field.");
  } else {
    console.error(asyncResult.error);
  }
});

organizer

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

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

organizer: Organizer;

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

Комментарии

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

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

Применимый Outlook: Организатор встречи

Примеры

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/30-recipients-and-attendees/get-organizer-appointment-organizer.yaml
Office.context.mailbox.item.organizer.getAsync(function(asyncResult) {
  if (asyncResult.status === Office.AsyncResultStatus.Succeeded) {
    var apptOrganizer = asyncResult.value;
    console.log("Organizer: " + apptOrganizer.displayName + " (" + apptOrganizer.emailAddress + ")");
  } else {
    console.error(asyncResult.error);
  }
});

recurrence

Получает или задает шаблон повторения встречи.

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

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

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

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-set-recurrence-appointment-organizer.yaml
Office.context.mailbox.item.recurrence.getAsync(function(asyncResult) {
  if (asyncResult.status === Office.AsyncResultStatus.Succeeded) {
    var recurrence = asyncResult.value;
    if (recurrence === null) {
      console.log("This is a single appointment.");
    } else {
      console.log(`Recurrence pattern: ${JSON.stringify(recurrence)}`);
    }
  } else {
    console.error(asyncResult.error);
  }
});
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/50-recurrence/get-set-recurrence-appointment-organizer.yaml
// Important: Can only set the recurrence pattern of an appointment series.

var currentDate = new Date();
let seriesTimeObject : Office.SeriesTime;
// Set series start date to tomorrow.
seriesTimeObject.setStartDate(
  currentDate.getFullYear(),
  currentDate.getMonth(),
  currentDate.getDay() + 1
);
// Set series end date to 1 month from now.
seriesTimeObject.setEndDate(
  currentDate.getFullYear(),
  currentDate.getMonth() + 1,
  currentDate.getDay()
);
// Set start time to 1:30 PM.
seriesTimeObject.setStartTime(13, 30);
// Set duration to 30 minutes.
seriesTimeObject.setDuration(30);

let pattern : Office.Recurrence = {
  seriesTime: seriesTimeObject,
  recurrenceType: "weekly",
  recurrenceProperties: { interval: 1, days: ["tue", "thu"], firstDayOfWeek: "sun" },
  recurrenceTimeZone: { name: "Pacific Standard Time" }
};

Office.context.mailbox.item.recurrence.setAsync(pattern, (asyncResult) => {
  if (asyncResult.status !== Office.AsyncResultStatus.Succeeded) {
    console.error(`Failed to set recurrence. Error: ${asyncResult.error.message}`);
    return;
  }
  console.log(`Succeeded in setting recurrence pattern ${JSON.stringify(pattern)}`);
});

requiredAttendees

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

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

requiredAttendees: Recipients;

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

Комментарии

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

Применимый Outlook: Организатор встречи

Примеры

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

function callback(asyncResult) {
    var arrayOfRequiredAttendeesRecipients = asyncResult.value;
    console.log(JSON.stringify(arrayOfRequiredAttendeesRecipients));
}
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/30-recipients-and-attendees/get-set-required-attendees-appointment-organizer.yaml
Office.context.mailbox.item.requiredAttendees.getAsync(function(asyncResult) {
  if (asyncResult.status === Office.AsyncResultStatus.Succeeded) {
    var apptRequiredAttendees = asyncResult.value;
    for (var i = 0; i < apptRequiredAttendees.length; i++) {
      console.log(
        "Required attendees: " +
          apptRequiredAttendees[i].displayName +
          " (" +
          apptRequiredAttendees[i].emailAddress +
          ") - response: " +
          apptRequiredAttendees[i].appointmentResponse
      );
    }
  } else {
    console.error(asyncResult.error);
  }
});
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/30-recipients-and-attendees/get-set-required-attendees-appointment-organizer.yaml
var email = $("#emailRequired")
  .val()
  .toString();
var emailArray = [email];
Office.context.mailbox.item.requiredAttendees.setAsync(emailArray, function(asyncResult) {
  if (asyncResult.status === Office.AsyncResultStatus.Succeeded) {
    console.log("Succeeded in setting required attendees field.");
  } else {
    console.error(asyncResult.error);
  }
});

sensitivity

Примечание

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

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

sensitivity: Sensitivity;

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

Комментарии

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

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

Применимый Outlook: Организатор встречи

Примеры

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/99-preview-apis/calendar-properties-apis.yaml
Office.context.mailbox.item.sensitivity.getAsync(function(asyncResult) {
  if (asyncResult.status === Office.AsyncResultStatus.Succeeded) {
    console.log("Sensitivity: " + asyncResult.value);
  } else {
    console.log("Failed to get sensitivity: " + JSON.stringify(asyncResult.error));
  }
});
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/99-preview-apis/calendar-properties-apis.yaml
Office.context.mailbox.item.sensitivity.setAsync(
  Office.MailboxEnums.AppointmentSensitivityType.Confidential,
  function callback(asyncResult) {
    if (asyncResult.status === Office.AsyncResultStatus.Failed) {
      console.log("Failed to set appointment sensitivity: " + JSON.stringify(asyncResult.error));
    } else {
      console.log("Successfully set appointment sensitivity.");
    }
  }
);

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

sessionData

Примечание

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

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

sessionData: SessionData;

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

Комментарии

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

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

Применимый Outlook: Организатор встречи

Примеры

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/99-preview-apis/session-data-apis.yaml
Office.context.mailbox.item.sessionData.getAllAsync(function(asyncResult) {
  if (asyncResult.status === Office.AsyncResultStatus.Succeeded) {
    console.log("The sessionData is " + JSON.stringify(asyncResult.value));
  } else {
    console.log("Failed to get all sessionData. Error: " + JSON.stringify(asyncResult.error));
  }
});

start

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

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

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

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

start: Time;

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

Комментарии

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

Применимый Outlook: Организатор встречи

Примеры

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/90-other-item-apis/get-set-start-appointment-organizer.yaml
Office.context.mailbox.item.start.getAsync((result) => {
  if (result.status !== Office.AsyncResultStatus.Succeeded) {
    console.error(`Action failed with message ${result.error.message}`);
    return;
  }
  console.log(`Appointment starts: ${result.value}`);
});
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/90-other-item-apis/get-set-start-appointment-organizer.yaml
var start = new Date(); // Represents current date and time.
start.setDate(start.getDate() + 2); // Add 2 days to current date.
Office.context.mailbox.item.start.setAsync(start, (result) => {
  if (result.status !== Office.AsyncResultStatus.Succeeded) {
    console.error(`Action failed with message ${result.error.message}`);
    return;
  }
  console.log(`Successfully set start date and time to ${start}`);
});

subject

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

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

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

subject: Subject;

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

Комментарии

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

Применимый Outlook: Организатор встречи

Примеры

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/90-other-item-apis/get-set-subject-compose.yaml
Office.context.mailbox.item.subject.getAsync((result) => {
  if (result.status !== Office.AsyncResultStatus.Succeeded) {
    console.error(`Action failed with message ${result.error.message}`);
    return;
  }
  console.log(`Subject: ${result.value}`);
});
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/90-other-item-apis/get-set-subject-compose.yaml
let subject = "Hello World!";
Office.context.mailbox.item.subject.setAsync(subject, (result) => {
  if (result.status !== Office.AsyncResultStatus.Succeeded) {
    console.error(`Action failed with message ${result.error.message}`);
    return;
  }
  console.log(`Successfully set subject to ${subject}`);
});

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

addFileAttachmentAsync(uri, attachmentName, options, callback)

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

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

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

Важно. В последних сборках Outlook на Windows была введена ошибка, которая неправильно привносима заголовку к этому действию (как с помощью этого API, так и Authorization: Bearer Outlook пользовательского интерфейса). Чтобы решить эту проблему, можно попробовать использовать API, введенный с набором требований addFileAttachmentFromBase64 1.8.

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

Параметры

uri

string

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

attachmentName

string

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

options

Office.AsyncContextOptions & { isInline: boolean }

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

callback

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

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

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

void

Комментарии

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

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

Применимый Outlook: Организатор встречи

Ошибки:

  • AttachmentSizeExceeded. Вложение больше разрешенного размера.

  • FileTypeNotSupported. Вложение имеет расширение, которое не разрешено.

  • NumberOfAttachmentsExceeded: Сообщение или назначение имеет слишком много вложений.

Примеры

function callback(result) {
    if (result.error) {
        console.log(result.error);
    } else {
        console.log("Attachment added");
    }
}

function addAttachment() {
    // The values in asyncContext can be accessed in the callback.
    var options = { 'asyncContext': { var1: 1, var2: 2 } };

    var attachmentURL = "https://contoso.com/rtm/icon.png";
    Office.context.mailbox.item.addFileAttachmentAsync(attachmentURL, attachmentURL, options, callback);
}
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/40-attachments/attachments-compose.yaml
var attachmentUrl = $("#attachmentUrl").val();
Office.context.mailbox.item.addFileAttachmentAsync(
    attachmentUrl,
    getFileName(attachmentUrl),
    { "asyncContext" : { var1: 1, var2: true } },
    function(result) { console.log(result); });

addFileAttachmentAsync(uri, attachmentName, callback)

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

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

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

Важно. В последних сборках Outlook на Windows была введена ошибка, которая неправильно привносима заголовку к этому действию (как с помощью этого API, так и Authorization: Bearer Outlook пользовательского интерфейса). Чтобы решить эту проблему, можно попробовать использовать API, введенный с набором требований addFileAttachmentFromBase64 1.8.

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

Параметры

uri

string

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

attachmentName

string

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

callback

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

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

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

void

Комментарии

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

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

Применимый Outlook: Организатор встречи

Ошибки:

  • AttachmentSizeExceeded. Вложение больше разрешенного размера.

  • FileTypeNotSupported. Вложение имеет расширение, которое не разрешено.

  • NumberOfAttachmentsExceeded: Сообщение или назначение имеет слишком много вложений.

addFileAttachmentFromBase64Async(base64File, attachmentName, options, callback)

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

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

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

Примечание. Если вы используете API URL-адресов данных (например, readAsDataURL), необходимо раздеть префикс URL-адреса данных, а затем отправить остальную строку в этот API. Например, если полная строка представлена data:image/svg+xml;base64,<rest of base64 string>, удалить data:image/svg+xml;base64,.

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

Параметры

base64File

string

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

attachmentName

string

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

options

Office.AsyncContextOptions & { isInline: boolean }

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

callback

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

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

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

void

Комментарии

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

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

Применимый Outlook: Организатор встречи

Ошибки:

  • AttachmentSizeExceeded. Вложение больше разрешенного размера.

  • FileTypeNotSupported. Вложение имеет расширение, которое не разрешено.

  • NumberOfAttachmentsExceeded: Сообщение или назначение имеет слишком много вложений.

Примеры

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/40-attachments/attachments-compose.yaml
base64String = "iVBORw0KGgoAAAANSUhEUgAAACAAAAAgCAYAAABzenr0AAAACXBIWXMAAAsSAAALEgHS3X78AAACRUlEQVRYw82XzXHbMBCFP2F8tzsQc8Ixyh0zoiuIXIGdCsxUYKqC0B04FdiuwMoM7mGOOIXqQGoAymXhgSX+itJM9kIRFLAP+3YXD5Pdbscx5oxaAIW8Ztr6l2PWmQwF4IyaieP53qdfAqQ8CwBn1JU4vpWhrbxXQA5MZfynANmcDIAzKgcy4FKGXsVJFf3nLgKyBQptfT4KQMRz2N0fcbxqmRMDWXflx0VPnrdArq0vekQ1Dv0UeHZGNebHhwjU8AzwKM43RyZnbAf58Q6ghudeWd0Aus0+5EcMIIRi3beua0D3Nm39BEAx3i7HTK4DEBJn5YxKOnaRA5+ErpMBWMpzDvx1RuXCcxOISlufAjfC7zgAsqsvUvMAD0ApPaEtGi9AIlUzKgJo60tt/SyKRkzLrAXERluf7W1gOICWaMyB386oooOWsIHvXbSoHuUSFovtHqicUVnH3EJoeT0aQEf5/XBGlc6otIOWBXAtPeZkAIJ9Bt6cUU9tZautX2nrk3MACHYr1ZKProKRtDw4o8pzAPjWo+NtpXTTvoteDDg8noDAcwbcRedAkGdFXyk2GEDcegVAFp2gyVDHjRQ4o6q2smoqtR5Hd+qMqtoALCWUUymr1m43QMZfOaMK4C0SrMsDANJ2E5FNcbdbjHC+ENl+H0myJFbLtaq4Rt8dyPBYRQV1E40nMv9rl7xrOw3DGb+Whcqu3i/OM6CUOWvgRlufNmnLYy4m77uJI7AXtdNcTDrU71LEyv7v01/N/ovL6bmu5/8A1tNWZldH0W4AAAAASUVORK5CYII=";
Office.context.mailbox.item.addFileAttachmentFromBase64Async(
    base64String,
    "logo.png",
    { isInline: false },
    function(result) { console.log(result); });
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/60-event-based-activation/work-with-client-signatures.yaml
// Set the signature for the current item with inline image.
var modIcon1Base64 = "iVBORw0KGgoAAAANSUhEUgAAABwAAAAcCAYAAAByDd+UAAAAGXRFWHRTb2Z0d2FyZQBBZG9iZSBJbWFnZVJlYWR5ccllPAAAA2ZpVFh0WE1MOmNvbS5hZG9iZS54bXAAAAAAADw/eHBhY2tldCBiZWdpbj0i77u/IiBpZD0iVzVNME1wQ2VoaUh6cmVTek5UY3prYzlkIj8+IDx4OnhtcG1ldGEgeG1sbnM6eD0iYWRvYmU6bnM6bWV0YS8iIHg6eG1wdGs9IkFkb2JlIFhNUCBDb3JlIDUuMC1jMDYxIDY0LjE0MDk0OSwgMjAxMC8xMi8wNy0xMDo1NzowMSAgICAgICAgIj4gPHJkZjpSREYgeG1sbnM6cmRmPSJodHRwOi8vd3d3LnczLm9yZy8xOTk5LzAyLzIyLXJkZi1zeW50YXgtbnMjIj4gPHJkZjpEZXNjcmlwdGlvbiByZGY6YWJvdXQ9IiIgeG1sbnM6eG1wTU09Imh0dHA6Ly9ucy5hZG9iZS5jb20veGFwLzEuMC9tbS8iIHhtbG5zOnN0UmVmPSJodHRwOi8vbnMuYWRvYmUuY29tL3hhcC8xLjAvc1R5cGUvUmVzb3VyY2VSZWYjIiB4bWxuczp4bXA9Imh0dHA6Ly9ucy5hZG9iZS5jb20veGFwLzEuMC8iIHhtcE1NOk9yaWdpbmFsRG9jdW1lbnRJRD0ieG1wLmRpZDpDRDMxMDg1MjBCNDZFMTExODE2MkM1RUI2M0M4MDYxRCIgeG1wTU06RG9jdW1lbnRJRD0ieG1wLmRpZDpFMTUxQjgyRjQ2MEQxMUUxODlFMkQwNTYzQ0YwMTUxMiIgeG1wTU06SW5zdGFuY2VJRD0ieG1wLmlpZDpFMTUxQjgyRTQ2MEQxMUUxODlFMkQwNTYzQ0YwMTUxMiIgeG1wOkNyZWF0b3JUb29sPSJBZG9iZSBQaG90b3Nob3AgQ1M1LjEgV2luZG93cyI+IDx4bXBNTTpEZXJpdmVkRnJvbSBzdFJlZjppbnN0YW5jZUlEPSJ4bXAuaWlkOkQxMzEwODUyMEI0NkUxMTE4MTYyQzVFQjYzQzgwNjFEIiBzdFJlZjpkb2N1bWVudElEPSJ4bXAuZGlkOkNEMzEwODUyMEI0NkUxMTE4MTYyQzVFQjYzQzgwNjFEIi8+IDwvcmRmOkRlc2NyaXB0aW9uPiA8L3JkZjpSREY+IDwveDp4bXBtZXRhPiA8P3hwYWNrZXQgZW5kPSJyIj8+uC/WfAAAAehJREFUeNpilCzfwEAEkAbiECA2A2J1IOaHin8E4ptAfBaIVwLxU0IGMRKw0B6IW4DYhoE4cASIK6E0VsCEQ1wUiNcB8QESLGOAqj0MxBuhZhBloS4QnwHiQAbygR/UDF1CFupCXSjHQDmQg5qli8tCUBBsQUoQ1AD8UDNFsVk4n0o+w+bT+egWglKjNymmeGhLkqLcG2oHAwtUoIuQDj5OVgZPLUmwRe5aEmAxqYqNpFgKssOcCeplM0KqdST5GfpDDRm0JfkYrj3/SE7QguyQY4ImYYLgCtAS10kHGMw6dzNsv/qC7OwCClJXYlR++v6b4er3j5QmIFcmaNlIL6AOslCIjhYKMTHQGTBBqxh6gXcgC6/R0cKbIAv30dHCfaAKGJTxHxJSqS3Fz9DkowNmywpyMcgA8fF7b8D8VWcfM6w8+4gYC+VB+RCk8hSh0gaUD4/dewvlvUWRe/z+GzGWgex4BGtiOAHxXhoHpzMoSGHZAhSPW2lo2VZYWkHOh4nEtLrIAE+hZmNUwK+B2BOIv1PRsu9QM1/jatNcBtVZ0IREKXgENesyoVYbzNIdFFi2A5tl+NqlL6BB4QBNzsSCU1A9nlAzMAALAQMOQl0qB23qWwKxIlIrDBQ394H4OBCvISYqAAIMACVibHDqsO7zAAAAAElFTkSuQmCC";
Office.context.mailbox.item.addFileAttachmentFromBase64Async(
  modIcon1Base64,
  "myImage.png",
  { isInline: true },
  function(result) {
    if (result.status == Office.AsyncResultStatus.Succeeded) {
      var signature = $("#signature").val() + "<img src='cid:myImage.png'>";
      console.log(`Setting signature to "${signature}".`);
      Office.context.mailbox.item.body.setSignatureAsync(
        signature,
        { coercionType: "html" },
        function(asyncResult) {
          console.log(`setSignatureAsync: ${asyncResult.status}`);
        }
      );
    } else {
      console.error(`addFileAttachmentFromBase64Async: ${result.error}`);
    }
  }
);

addFileAttachmentFromBase64Async(base64File, attachmentName, callback)

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

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

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

Примечание. Если вы используете API URL-адресов данных (например, readAsDataURL), необходимо раздеть префикс URL-адреса данных, а затем отправить остальную строку в этот API. Например, если полная строка представлена data:image/svg+xml;base64,<rest of base64 string>, удалить data:image/svg+xml;base64,.

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

Параметры

base64File

string

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

attachmentName

string

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

callback

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

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

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

void

Комментарии

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

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

Применимый Outlook: Организатор встречи

Ошибки:

  • AttachmentSizeExceeded. Вложение больше разрешенного размера.

  • FileTypeNotSupported. Вложение имеет расширение, которое не разрешено.

  • NumberOfAttachmentsExceeded: Сообщение или назначение имеет слишком много вложений.

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 параметра будет соответствовать eventType параметру 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 параметра будет соответствовать eventType параметру addHandlerAsync.

callback

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

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

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

void

Комментарии

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

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

Применимый Outlook: Организатор встречи

addItemAttachmentAsync(itemId, attachmentName, options, callback)

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

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

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

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

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

Параметры

itemId

any

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

attachmentName

string

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

options
Office.AsyncContextOptions

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

callback

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

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

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

void

Комментарии

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

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

Применимый Outlook: Организатор встречи

Ошибки:

  • NumberOfAttachmentsExceeded: Сообщение или назначение имеет слишком много вложений.

Примеры

// The following example adds an existing Outlook item as an attachment
// with the name `My Attachment`.
function callback(result) {
    if (result.error) {
        console.log(result.error);
    } else {
        console.log("Attachment added");
    }
}

function addAttachment() {
    // EWS ID of item to attach (shortened for readability).
    var itemId = "AAMkADI1...AAA=";

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

    Office.context.mailbox.item.addItemAttachmentAsync(itemId, "My Attachment", options, callback);
}
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/40-attachments/attachments-compose.yaml
var attachmentItemId = $("#attachmentItemId").val();
Office.context.mailbox.item.addItemAttachmentAsync(
    attachmentItemId,
    "My attachment",
    { "asyncContext" : { var3: 3, var4: false } },
    function(result) { console.log(result); });

addItemAttachmentAsync(itemId, attachmentName, callback)

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

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

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

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

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

Параметры

itemId

any

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

attachmentName

string

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

callback

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

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

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

void

Комментарии

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

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

Применимый Outlook: Организатор встречи

Ошибки:

  • NumberOfAttachmentsExceeded: Сообщение или назначение имеет слишком много вложений.

close()

Закрывает текущий элемент, который составляется

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

Если в клиенте Outlook для настольных ПК сообщение представляет собой ответ в тексте, метод close не работает.

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

close(): void;

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

void

Комментарии

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

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

Применимый Outlook: Организатор встречи

Примеры

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

disableClientSignatureAsync(options, callback)

Отключает Outlook клиента.

Для Windows и Mac богатые клиенты, этот API задает подпись под разделами "Новое сообщение" и "Ответы / Forwards" для отправки учетной записи в "(нет)", эффективно отключение подписи. Для Outlook в Интернете API должен отключить параметр подписи для новых почт, ответов и пересылаемой почты. Если выбрана подпись, этот вызов API должен отключить его.

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

Параметры

options
Office.AsyncContextOptions

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

callback

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

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

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

void

Комментарии

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

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

Применимый Outlook: Организатор встречи

Примеры

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/60-event-based-activation/work-with-client-signatures.yaml
// Disable the client signature.
Office.context.mailbox.item.disableClientSignatureAsync(function(asyncResult) {
  if (asyncResult.status === Office.AsyncResultStatus.Succeeded) {
    console.log("disableClientSignatureAsync succeeded");
  } else {
    console.error(asyncResult.error);
  }
});

disableClientSignatureAsync(callback)

Отключает Outlook клиента.

Для Windows и Mac богатые клиенты, этот API задает подпись под разделами "Новое сообщение" и "Ответы / Forwards" для отправки учетной записи в "(нет)", эффективно отключение подписи. Для Outlook в Интернете API должен отключить параметр подписи для новых почт, ответов и пересылаемой почты. Если выбрана подпись, этот вызов API должен отключить его.

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

Параметры

callback

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

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

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

void

Комментарии

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

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

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

getAttachmentsAsync(options, callback)

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

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

Параметры

options
Office.AsyncContextOptions

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

callback

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

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

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

void

Комментарии

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

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

Применимый Outlook: Организатор встречи

Примеры

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/40-attachments/attachments-compose.yaml
Office.context.mailbox.item.getAttachmentsAsync(function (result) {
    if (result.status !== Office.AsyncResultStatus.Succeeded) {
        console.error(result.error.message);
    } else {
        if (result.value.length > 0) {
            for (var i = 0; i < result.value.length; i++) {
                var attachment = result.value[i];
                console.log(`${attachment.id}. Name: ${attachment.name}, size: ${attachment.size}, isInline: ${attachment.isInline}`);
            }
        }
        else {
            console.log("No attachments on this message.");
        }
    }
});

getAttachmentsAsync(callback)

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

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

Параметры

callback

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

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

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

void

Комментарии

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

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

Применимый Outlook: Организатор встречи

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: Организатор встречи

Дополнительные сведения о действиях сообщений.

getItemIdAsync(options, callback)

Асинхронно получает ID сохраненного элемента.

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

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

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

Параметры

options
Office.AsyncContextOptions

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

callback

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

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

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

void

Комментарии

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

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

Применимый Outlook: Организатор встречи

Ошибки:

  • ItemNotSaved: Id не может быть извлечен до тех пор, пока элемент не будет сохранен.

getItemIdAsync(callback)

Асинхронно получает ID сохраненного элемента.

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

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

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

Параметры

callback

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

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

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

void

Комментарии

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

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

Применимый Outlook: Организатор встречи

Ошибки:

  • ItemNotSaved: Id не может быть извлечен до тех пор, пока элемент не будет сохранен.

Примеры

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/85-tokens-and-service-calls/item-id-compose.yaml
Office.context.mailbox.item.getItemIdAsync(function (result) {
    if (result.status !== Office.AsyncResultStatus.Succeeded) {
        console.error(`getItemIdAsync failed with message: ${result.error.message}`);
    } else {
        console.log(result.value);
    }
});

getSelectedDataAsync(coercionType, options, callback)

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

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

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

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

Параметры

coercionType

Office.CoercionType | string

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

options
Office.AsyncContextOptions

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

callback

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

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

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

void

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

Комментарии

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

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

Применимый Outlook: Организатор встречи

Примеры

// Get selected data.
Office.initialize = function () {
    Office.context.mailbox.item.getSelectedDataAsync(Office.CoercionType.Text, {}, getCallback);
};

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

    console.log("Selected text in " + prop + ": " + text);
}

getSelectedDataAsync(coercionType, callback)

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

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

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

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

Параметры

coercionType

Office.CoercionType | string

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

callback

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

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

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

void

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

Комментарии

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

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

Применимый Outlook: Организатор встречи

Примеры

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/20-item-body/get-selected-data.yaml
Office.context.mailbox.item.getSelectedDataAsync(Office.CoercionType.Text, function(asyncResult) {
  if (asyncResult.status === Office.AsyncResultStatus.Succeeded) {
    var text = asyncResult.value.data;
    var prop = asyncResult.value.sourceProperty;
    console.log("Selected text in " + prop + ": " + text);
  } else {
    console.error(asyncResult.error);
  }
});

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 an appointment 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 + "/events/" + 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);
});

isClientSignatureEnabledAsync(options, callback)

Получает, если включена подпись клиента.

Для Windows и mac-клиентов вызов API должен возвращаться, если подпись по умолчанию для новых сообщений, ответов или пересылается установлена в шаблоне для Outlook true учетной записи. Для Outlook в Интернете, вызов API должен возвращаться, если подпись включена true для типов составитьnewMail, reply, или forward. Если параметры настроены на "(нет)" в Mac или Windows богатых клиентов или отключены Outlook в Интернете, вызов API должен вернутьсяfalse.

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

Параметры

options
Office.AsyncContextOptions

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

callback

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

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

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

void

Комментарии

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

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

Применимый Outlook: Организатор встречи

Примеры

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/60-event-based-activation/work-with-client-signatures.yaml
// Check if the client signature is currently enabled.
Office.context.mailbox.item.isClientSignatureEnabledAsync(function(asyncResult) {
  if (asyncResult.status === Office.AsyncResultStatus.Succeeded) {
    console.log("isClientSignatureEnabledAsync succeeded with result: " + asyncResult.value);
  } else {
    console.error(asyncResult.error);
  }
});

isClientSignatureEnabledAsync(callback)

Получает, если включена подпись клиента.

Для Windows и mac-клиентов вызов API должен возвращаться, если подпись по умолчанию для новых сообщений, ответов или пересылается установлена в шаблоне для Outlook true учетной записи. Для Outlook в Интернете, вызов API должен возвращаться, если подпись включена true для типов составитьnewMail, reply, или forward. Если параметры настроены на "(нет)" в Mac или Windows богатых клиентов или отключены Outlook в Интернете, вызов API должен вернутьсяfalse.

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

Параметры

callback

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

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

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

void

Комментарии

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

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

Применимый Outlook: Организатор встречи

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

removeAttachmentAsync(attachmentId, options, callback)

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

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

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

Параметры

attachmentId

string

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

options
Office.AsyncContextOptions

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

callback

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

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

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

void

Комментарии

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

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

Применимый Outlook: Организатор встречи

Ошибки:

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

Примеры

// The following code removes an attachment with an identifier of '0'.
Office.context.mailbox.item.removeAttachmentAsync(
    '0',
    { asyncContext : null },
    function (asyncResult)
    {
        console.log(asyncResult.status);
    }
);
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/40-attachments/attachments-compose.yaml
Office.context.mailbox.item.removeAttachmentAsync(
    $("#attachmentId").val(),
    { asyncContext : null },
    function(result)
    {
        if (result.status !== Office.AsyncResultStatus.Succeeded) {
            console.error(`${result.error.message}`);
        } else {
            console.log(`Attachment removed successfully.`);
        }
    }
);

removeAttachmentAsync(attachmentId, callback)

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

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

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

Параметры

attachmentId

string

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

callback

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

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

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

void

Комментарии

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

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

Применимый Outlook: Организатор встречи

Ошибки:

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

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: Организатор встречи

saveAsync(options, callback)

Асинхронно сохраняет элемент.

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

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

Примечание. Если надстройка вызывает элемент в режиме композитации, чтобы получить ID элемента для использования с EWS или API REST, обратите внимание, что, когда Outlook находится в кэшизированном режиме, может потребоваться некоторое время, прежде чем элемент будет фактически синхронизирован с saveAsync сервером. Пока элемент не синхронизирован, с помощью элемента ID возвращается ошибка.

Примечание. В Outlook Mac только сборка 16.35.308 или более поздней сборки поддерживает сохранение собрания. В противном случае метод не удается при призыве с saveAsync собрания в режиме составить. Обходное решение см. в документе Cannot Save a meeting as a draft in Outlook для Mac с помощью API Office JS.

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

Параметры

options
Office.AsyncContextOptions

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

callback

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

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

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

void

Комментарии

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

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

Применимый Outlook: Организатор встречи

Ошибки:

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

Примеры

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/25-item-save-and-close/save.yaml
Office.context.mailbox.item.saveAsync(function (result) {
  if (result.status === Office.AsyncResultStatus.Succeeded) {
    console.log(`saveAsync succeeded, itemId is ${result.value}`);
  }
  else {
    console.error(`saveAsync failed with message ${result.error.message}`);
  }
});

saveAsync(callback)

Асинхронно сохраняет элемент.

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

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

Примечание. Если надстройка вызывает элемент в режиме композитации, чтобы получить ID элемента для использования с EWS или API REST, обратите внимание, что, когда Outlook находится в кэшизированном режиме, может потребоваться некоторое время, прежде чем элемент будет фактически синхронизирован с saveAsync сервером. Пока элемент не синхронизирован, с помощью элемента ID возвращается ошибка.

Примечание. В Outlook Mac только сборка 16.35.308 или более поздней сборки поддерживает сохранение собрания. В противном случае метод не удается при призыве с saveAsync собрания в режиме составить. Обходное решение см. в документе Cannot Save a meeting as a draft in Outlook для Mac с помощью API Office JS.

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

Параметры

callback

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

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

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

void

Комментарии

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

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

Применимый Outlook: Организатор встречи

Ошибки:

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

Примеры

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

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

setSelectedDataAsync(data, options, callback)

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

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

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

Параметры

data

string

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

options

Office.AsyncContextOptions & Office.CoercionTypeOptions

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

callback

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

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

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

void

Комментарии

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

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

Применимый Outlook: Организатор встречи

Ошибки:

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

Примеры

Office.context.mailbox.item.setSelectedDataAsync("<b>Hello World!</b>", { coercionType : "html" });
Office.context.mailbox.item.setSelectedDataAsync("Hello World!");
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/20-item-body/set-selected-data.yaml
Office.context.mailbox.item.setSelectedDataAsync("Replaced", function(asyncResult) {
  if (asyncResult.status === Office.AsyncResultStatus.Succeeded) {
    console.log("Selected text has been updated successfully.");
  } else {
    console.error(asyncResult.error);
  }
});

setSelectedDataAsync(data, callback)

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

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

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

Параметры

data

string

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

callback

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

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

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

void

Комментарии

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

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

Применимый Outlook: Организатор встречи

Ошибки:

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