Office.AppointmentCompose interface

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

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

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

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

const 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 one year from now.
seriesTimeObject.setEndDate(currentDate.getFullYear() + 1, currentDate.getMonth() + 1, currentDate.getDay());
// Set start time to 1:30 PM.
seriesTimeObject.setStartTime(13, 30);
// Set duration to 30 minutes.
seriesTimeObject.setDuration(30);

const pattern = {
  seriesTime: seriesTimeObject,
  recurrenceType: Office.MailboxEnums.RecurrenceType.Yearly,
  recurrenceProperties: {
    interval: 1,
    dayOfWeek: Office.MailboxEnums.Days.Tue,
    weekNumber: Office.MailboxEnums.WeekNumber.Second,
    month: Office.MailboxEnums.Month.Sep
  },
  recurrenceTimeZone: { name: Office.MailboxEnums.RecurrenceTimeZone.PacificStandardTime }
};

Office.context.mailbox.item.recurrence.setAsync(pattern as any, (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)}`);
});

Свойства

body	Получает объект, предоставляющий методы для работы с основным текстом элемента.
categories	Получает объект, предоставляющий методы для управления категориями элемента.
end	Получает или задает дату и время окончания встречи. Это `end` свойство представляет собой объект Time , выраженный в виде даты и времени в формате 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 и т. д.) могут применяться ограничения на количество получателей, которых вы можете получить или обновить. Дополнительные сведения см. в объекте "Получатели ".
organizer	Получает организатора указанного собрания. Свойство `organizer` возвращает объект Organizer , предоставляющий метод для получения значения организатора.
recurrence	Получает или задает шаблон повторения встречи. Свойство `recurrence` возвращает объект повторяемости для повторяющихся встреч или приглашений на собрания, если элемент является рядом или экземпляром ряда. `null` возвращается для отдельных встреч и приглашений на собрания отдельных встреч. Примечание. Приглашения на собрание `itemClass` имеют значение, равное `IPM.Schedule.Meeting.Request`. Примечание. Если объект повторения имеет значение null, это означает, что объект является единственной встречей или приглашением на собрание одной встречи и НЕ является частью ряда.
requiredAttendees	Предоставляет доступ к обязательным участникам события. Тип объекта и уровень доступа зависят от режима текущего элемента. Свойство `requiredAttendees` возвращает объект `Recipients`, предоставляющий методы, с помощью которых можно получить или обновить сведения об обязательных участниках собрания. Однако в зависимости от клиента/платформы (например, Windows, Mac и т. д.) могут применяться ограничения на количество получателей, которых вы можете получить или обновить. Дополнительные сведения см. в объекте "Получатели ".
sensitivity	Получение или настройка уровня конфиденциальности встречи. Сведения об уровнях конфиденциальности см. в статье "Пометка сообщения как обычного", "личного", "частного" или "конфиденциального".
sensitivityLabel	Получает объект, чтобы получить или установить метку конфиденциальности встречи.
seriesId	Получает идентификатор ряда, к которому принадлежит экземпляр. В Outlook в Интернете, в Windows (новой и классической версии) и в Mac свойство `seriesId` возвращает идентификатор веб-служб Exchange (EWS) родительского элемента (серии), к которому принадлежит этот элемент. Однако в Outlook для Android и iOS `seriesId` возвращает REST ID родительского элемента. Примечание. Идентификатор, возвращаемый свойством `seriesId` , совпадает с идентификатором элемента веб-служб Exchange. Это `seriesId` свойство не идентично идентификаторам Outlook, используемым REST API Outlook. Перед вызовами REST API с использованием этого значения его следует преобразовать с помощью `Office.context.mailbox.convertToRestId`. Дополнительные сведения см. в статье Использование Outlook REST API из надстройки Outlook. Свойство `seriesId` возвращает `null` элементы, которые не имеют родительских элементов, таких как отдельные встречи, элементы ряда или приглашения на собрания, и возвращает `undefined` все другие элементы, не являющиеся приглашениями на собрания.
sessionData	Управляет данными сеанса элемента в режиме Compose. Важно! В клиентах Outlook, поддерживающих почтовый ящик 1.15 или более ранних версий, длина всего объекта SessionData для каждого элемента почты ограничена 50 000 символов на надстройку. В клиентах, поддерживающих почтовые ящики версии 1.16 или более поздней версии, максимальная длина одной надстройки составляет 2 621 440 символов.
start	Получает или задает дату и время начала встречи. Это `start` свойство представляет собой объект Time , выраженный в виде даты и времени в формате UTC. Метод можно использовать для `convertToLocalClientTime` преобразования значения в местную дату и время клиента. Если вы задаете время начала с помощью метода `Time.setAsync`, необходимо использовать метод `convertToUtcClientTime` для преобразования местного времени на клиенте в формат UTC для сервера. Важно! В клиенте Windows это свойство нельзя использовать для обновления начала повторения.
subject	Получает или задает описание, которое отображается в поле темы элемента. Свойство `subject` получает или задает всю тему элемента для отправки с почтового сервера. Свойство `subject` возвращает объект `Subject`, который предоставляет методы для получения и задания темы.

Методы

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

body

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

body: Body;

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

Office.Body

Примеры

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

// The following is an example of 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"
}

end

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

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

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

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

end: Time;

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

Office.Time

Примеры

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

  const time = result.value;
  const localTime = Office.context.mailbox.convertToLocalClientTime(time);
  console.log(`Appointment ends (local): ${localTime.month + 1}/${localTime.date}/${localTime.year}, ${localTime.hours}:${localTime.minutes}:${localTime.seconds}`);
});

...

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

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

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

Office.EnhancedLocation

Важно! Для управления расположениями встреч в клиентах Outlook, которые не поддерживают набор требований к почтовому ящику 1.8, используйте свойство location . Рекомендации по выбору правильного API расположения для вашего сценария см. в статье Получение или настройка расположения при создании назначения.

Примеры

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

...

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

...

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

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

Office.IsAllDayEvent

Примеры

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/99-preview-apis/get-set-isalldayevent.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));
  }
});

...

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;

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

Office.MailboxEnums.ItemType | string

Примеры

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

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

location

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

location: Location;

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

Office.Location

Важно! Свойство было добавлено enhancedLocation в набор требований к почтовому ящику 1.8. Используйте свойство enhancedLocation для более точного определения мест встреч и управления ими, особенно если необходимо определить тип расположения. Рекомендации по выбору правильного API расположения для вашего сценария см. в статье Получение или настройка расположения при создании назначения.

Примеры

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

...

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

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

Office.NotificationMessages

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

Примеры

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

// Adds a progress indicator to the mail item.
const id = (document.getElementById("notificationId") as HTMLInputElement).value;
const details =
  {
    type: Office.MailboxEnums.ItemNotificationMessageType.ProgressIndicator,
    message: "Progress indicator with id = " + id
  };
Office.context.mailbox.item.notificationMessages.addAsync(id, details, (result) => {
  if (result.status === Office.AsyncResultStatus.Failed) {
    console.log(`Failed to add progress notification with id = ${id}. Try using a different ID.`);
    return;
  }
  console.log(`Added progress notification with id = ${id}.`);
});

...

// Adds an informational notification to the mail item.
const id = (document.getElementById("notificationId") as HTMLInputElement).value;
const details =
  {
    type: Office.MailboxEnums.ItemNotificationMessageType.InformationalMessage,
    message: "Non-persistent informational notification message with id = " + id,
    icon: "PG.Icon.16",
    persistent: false
  };
Office.context.mailbox.item.notificationMessages.addAsync(id, details, (result) => {
  if (result.status === Office.AsyncResultStatus.Failed) {
    console.log(`Failed to add informational notification with id = ${id}. Try using a different ID.`);
    return;
  }
  console.log(`Added informational notification with id = ${id}.`);
});

...

// Adds a persistent information notification to the mail item.
const id = (document.getElementById("notificationId") as HTMLInputElement).value;
const details =
  {
    type: Office.MailboxEnums.ItemNotificationMessageType.InformationalMessage,
    message: "Persistent informational notification message with id = " + id,
    icon: "PG.Icon.16",
    persistent: true
  };
Office.context.mailbox.item.notificationMessages.addAsync(id, details, (result) => {
  if (result.status === Office.AsyncResultStatus.Failed) {
    console.log(`Failed to add persistent informational notification with id = ${id}. Try using a different ID.`);
    return;
  }
  console.log(`Added persistent informational notification with id = ${id}.`);
});

...

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

...

// Replaces a notification message of a given key with another message.
const id = (document.getElementById("notificationId") as HTMLInputElement).value;
Office.context.mailbox.item.notificationMessages.replaceAsync(
  id,
  {
    type: Office.MailboxEnums.ItemNotificationMessageType.InformationalMessage,
    message: "Notification message with id = " + id + " has been replaced with an informational message.",
    icon: "icon2",
    persistent: false
  },
  (result) => {
    if (result.status === Office.AsyncResultStatus.Failed) {
      console.log(`Failed to replace notification with id = ${id}. ${result.error.message}.`);
      return;
    }
    console.log(`Replaced notification with id = ${id}.`);
  });

...

// Removes a notification message from the current mail item.
const id = (document.getElementById("notificationId") as HTMLInputElement).value;
Office.context.mailbox.item.notificationMessages.removeAsync(id, (result) => {
  if (result.status === Office.AsyncResultStatus.Failed) {
    console.log(`Failed to remove notification with id = ${id}. ${result.error.message}.`);
    return;
  }
  console.log(`Removed notification with id = ${id}.`);
});

optionalAttendees

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

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

optionalAttendees: Recipients;

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

Office.Recipients

Примеры

// 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) {
    const apptOptionalAttendees = asyncResult.value;
    for (let 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);
  }
});

...

const email = (document.getElementById("emailOptional") as HTMLInputElement).value;
const 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;

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

Office.Organizer

Примеры

// 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) {
    const 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;

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

Office.Recurrence

Примеры

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

...

// Important: Can only set the recurrence pattern of an appointment series.

const 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 one year from now.
seriesTimeObject.setEndDate(currentDate.getFullYear() + 1, currentDate.getMonth() + 1, currentDate.getDay());
// Set start time to 1:30 PM.
seriesTimeObject.setStartTime(13, 30);
// Set duration to 30 minutes.
seriesTimeObject.setDuration(30);

const pattern = {
  seriesTime: seriesTimeObject,
  recurrenceType: Office.MailboxEnums.RecurrenceType.Yearly,
  recurrenceProperties: {
    interval: 1,
    dayOfWeek: Office.MailboxEnums.Days.Tue,
    weekNumber: Office.MailboxEnums.WeekNumber.Second,
    month: Office.MailboxEnums.Month.Sep
  },
  recurrenceTimeZone: { name: Office.MailboxEnums.RecurrenceTimeZone.PacificStandardTime }
};

Office.context.mailbox.item.recurrence.setAsync(pattern as any, (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 и т. д.) могут применяться ограничения на количество получателей, которых вы можете получить или обновить. Дополнительные сведения см. в объекте "Получатели ".

requiredAttendees: Recipients;

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

Office.Recipients

Примеры

// 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) {
    const apptRequiredAttendees = asyncResult.value;
    for (let 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);
  }
});

...

const email = (document.getElementById("emailRequired") as HTMLInputElement).value;
const 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

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

sensitivity: Sensitivity;

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

Office.Sensitivity

Примеры

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/90-other-item-apis/get-set-sensitivity-level.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));
  }
});

...

Office.context.mailbox.item.sensitivity.setAsync(
  Office.MailboxEnums.AppointmentSensitivityType.Private,
  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.");
    }
  }
);

sensitivityLabel

Получает объект, чтобы получить или установить метку конфиденциальности встречи.

sensitivityLabel: SensitivityLabel;

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

Office.SensitivityLabel

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

Примеры

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

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

seriesId

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

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

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

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

seriesId: string;

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

string

Примеры

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

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

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

sessionData

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

Важно! В клиентах Outlook, поддерживающих почтовый ящик 1.15 или более ранних версий, длина всего объекта SessionData для каждого элемента почты ограничена 50 000 символов на надстройку. В клиентах, поддерживающих почтовые ящики версии 1.16 или более поздней версии, максимальная длина одной надстройки составляет 2 621 440 символов.

sessionData: SessionData;

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

Office.SessionData

Примеры

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

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

start

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

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

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

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

start: Time;

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

Office.Time

Примеры

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

  const time = result.value;
  const localTime = Office.context.mailbox.convertToLocalClientTime(time);
  console.log(`Appointment starts (local): ${localTime.month + 1}/${localTime.date}/${localTime.year}, ${localTime.hours}:${localTime.minutes}:${localTime.seconds}`);
});

...

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

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

Office.Subject

Примеры

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

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

...

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

addFileAttachmentAsync(uri, attachmentName, options, callback)

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

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

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

Параметры

uri: string

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

attachmentName: string

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

options: Office.AsyncContextOptions & { isInline: boolean }

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

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

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

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

void

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

Ошибки:

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

Примеры

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

const attachmentUrl = (document.getElementById("attachmentUrl") as HTMLInputElement).value;
Office.context.mailbox.item.addFileAttachmentAsync(
  attachmentUrl,
  getFileName(attachmentUrl),
  { isInline: false },
  (result) => {
    if (result.status === Office.AsyncResultStatus.Failed) {
      console.log(`Failed to add attachment: ${result.error.message}.`);
      return;
    }
    console.log(`Added attachment with ID: ${result.value}`);
  }
);

addFileAttachmentAsync(uri, attachmentName, callback)

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

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

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

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

Ошибки:

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

addFileAttachmentFromBase64Async(base64File, attachmentName, options, callback)

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

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

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

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

Параметры

base64File: string

Содержимое изображения или файла в кодировке Base64, которое должно быть добавлено к сообщению электронной почты или событию. Максимальная длина кодированной строки составляет 34 865 152 символа. Это соответствует максимальному размеру вложения в 25 МБ до кодировки Base64.

attachmentName: string

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

options: Office.AsyncContextOptions & { isInline: boolean }

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

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

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

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

void

Если вы используете API URL-адреса данных (например, ), вам нужно удалить префикс URL-адреса данных, readAsDataURLа затем отправить оставшуюся строку в этот API. Например, если полная строка представлена как data:image/svg+xml;base64,<rest of Base64 string>, удалите data:image/svg+xml;base64,.
Чтобы добавить встроенное изображение в кодировке Base64 в текст создаваемого сообщения или встречи, используйте методы API Body , такие как prependAsync, setSignatureAsync, или setAsync. Если вы используете для Office.context.mailbox.item.body.setAsync вставки изображение, сначала вызовите Office.context.mailbox.item.body.getAsync получение текущего текста элемента. В противном случае изображение не будет отображаться в тексте после вставки. Например, см. пример "Добавление встроенного изображения в кодировке Base64 в текст сообщения или встречи (Compose)" в Script Lab.

Ошибки:

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

Примеры

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

const base64String = "iVBORw0KGgoAAAANSUhEUgAAACAAAAAgCAYAAABzenr0AAAACXBIWXMAAAsSAAALEgHS3X78AAACRUlEQVRYw82XzXHbMBCFP2F8tzsQc8Ixyh0zoiuIXIGdCsxUYKqC0B04FdiuwMoM7mGOOIXqQGoAymXhgSX+itJM9kIRFLAP+3YXD5Pdbscx5oxaAIW8Ztr6l2PWmQwF4IyaieP53qdfAqQ8CwBn1JU4vpWhrbxXQA5MZfynANmcDIAzKgcy4FKGXsVJFf3nLgKyBQptfT4KQMRz2N0fcbxqmRMDWXflx0VPnrdArq0vekQ1Dv0UeHZGNebHhwjU8AzwKM43RyZnbAf58Q6ghudeWd0Aus0+5EcMIIRi3beua0D3Nm39BEAx3i7HTK4DEBJn5YxKOnaRA5+ErpMBWMpzDvx1RuXCcxOISlufAjfC7zgAsqsvUvMAD0ApPaEtGi9AIlUzKgJo60tt/SyKRkzLrAXERluf7W1gOICWaMyB386oooOWsIHvXbSoHuUSFovtHqicUVnH3EJoeT0aQEf5/XBGlc6otIOWBXAtPeZkAIJ9Bt6cUU9tZautX2nrk3MACHYr1ZKProKRtDw4o8pzAPjWo+NtpXTTvoteDDg8noDAcwbcRedAkGdFXyk2GEDcegVAFp2gyVDHjRQ4o6q2smoqtR5Hd+qMqtoALCWUUymr1m43QMZfOaMK4C0SrMsDANJ2E5FNcbdbjHC+ENl+H0myJFbLtaq4Rt8dyPBYRQV1E40nMv9rl7xrOw3DGb+Whcqu3i/OM6CUOWvgRlufNmnLYy4m77uJI7AXtdNcTDrU71LEyv7v01/N/ovL6bmu5/8A1tNWZldH0W4AAAAASUVORK5CYII=";
Office.context.mailbox.item.addFileAttachmentFromBase64Async(
  base64String,
  "logo.png",
  { isInline: false },
  (result) => {
    if (result.status === Office.AsyncResultStatus.Failed) {
      console.log(`Failed to add attachment from Base64-encoded string: ${result.error.message}.`);
      return;
    }
    console.log(`Added attachment from a Base64-encoded string with ID: ${result.value}`);
  }
);

...

// Set the signature for the current item with inline image.
const modIcon1Base64 = "iVBORw0KGgoAAAANSUhEUgAAABwAAAAcCAYAAAByDd+UAAAAGXRFWHRTb2Z0d2FyZQBBZG9iZSBJbWFnZVJlYWR5ccllPAAAA2ZpVFh0WE1MOmNvbS5hZG9iZS54bXAAAAAAADw/eHBhY2tldCBiZWdpbj0i77u/IiBpZD0iVzVNME1wQ2VoaUh6cmVTek5UY3prYzlkIj8+IDx4OnhtcG1ldGEgeG1sbnM6eD0iYWRvYmU6bnM6bWV0YS8iIHg6eG1wdGs9IkFkb2JlIFhNUCBDb3JlIDUuMC1jMDYxIDY0LjE0MDk0OSwgMjAxMC8xMi8wNy0xMDo1NzowMSAgICAgICAgIj4gPHJkZjpSREYgeG1sbnM6cmRmPSJodHRwOi8vd3d3LnczLm9yZy8xOTk5LzAyLzIyLXJkZi1zeW50YXgtbnMjIj4gPHJkZjpEZXNjcmlwdGlvbiByZGY6YWJvdXQ9IiIgeG1sbnM6eG1wTU09Imh0dHA6Ly9ucy5hZG9iZS5jb20veGFwLzEuMC9tbS8iIHhtbG5zOnN0UmVmPSJodHRwOi8vbnMuYWRvYmUuY29tL3hhcC8xLjAvc1R5cGUvUmVzb3VyY2VSZWYjIiB4bWxuczp4bXA9Imh0dHA6Ly9ucy5hZG9iZS5jb20veGFwLzEuMC8iIHhtcE1NOk9yaWdpbmFsRG9jdW1lbnRJRD0ieG1wLmRpZDpDRDMxMDg1MjBCNDZFMTExODE2MkM1RUI2M0M4MDYxRCIgeG1wTU06RG9jdW1lbnRJRD0ieG1wLmRpZDpFMTUxQjgyRjQ2MEQxMUUxODlFMkQwNTYzQ0YwMTUxMiIgeG1wTU06SW5zdGFuY2VJRD0ieG1wLmlpZDpFMTUxQjgyRTQ2MEQxMUUxODlFMkQwNTYzQ0YwMTUxMiIgeG1wOkNyZWF0b3JUb29sPSJBZG9iZSBQaG90b3Nob3AgQ1M1LjEgV2luZG93cyI+IDx4bXBNTTpEZXJpdmVkRnJvbSBzdFJlZjppbnN0YW5jZUlEPSJ4bXAuaWlkOkQxMzEwODUyMEI0NkUxMTE4MTYyQzVFQjYzQzgwNjFEIiBzdFJlZjpkb2N1bWVudElEPSJ4bXAuZGlkOkNEMzEwODUyMEI0NkUxMTE4MTYyQzVFQjYzQzgwNjFEIi8+IDwvcmRmOkRlc2NyaXB0aW9uPiA8L3JkZjpSREY+IDwveDp4bXBtZXRhPiA8P3hwYWNrZXQgZW5kPSJyIj8+uC/WfAAAAehJREFUeNpilCzfwEAEkAbiECA2A2J1IOaHin8E4ptAfBaIVwLxU0IGMRKw0B6IW4DYhoE4cASIK6E0VsCEQ1wUiNcB8QESLGOAqj0MxBuhZhBloS4QnwHiQAbygR/UDF1CFupCXSjHQDmQg5qli8tCUBBsQUoQ1AD8UDNFsVk4n0o+w+bT+egWglKjNymmeGhLkqLcG2oHAwtUoIuQDj5OVgZPLUmwRe5aEmAxqYqNpFgKssOcCeplM0KqdST5GfpDDRm0JfkYrj3/SE7QguyQY4ImYYLgCtAS10kHGMw6dzNsv/qC7OwCClJXYlR++v6b4er3j5QmIFcmaNlIL6AOslCIjhYKMTHQGTBBqxh6gXcgC6/R0cKbIAv30dHCfaAKGJTxHxJSqS3Fz9DkowNmywpyMcgA8fF7b8D8VWcfM6w8+4gYC+VB+RCk8hSh0gaUD4/dewvlvUWRe/z+GzGWgex4BGtiOAHxXhoHpzMoSGHZAhSPW2lo2VZYWkHOh4nEtLrIAE+hZmNUwK+B2BOIv1PRsu9QM1/jatNcBtVZ0IREKXgENesyoVYbzNIdFFi2A5tl+NqlL6BB4QBNzsSCU1A9nlAzMAALAQMOQl0qB23qWwKxIlIrDBQ394H4OBCvISYqAAIMACVibHDqsO7zAAAAAElFTkSuQmCC";
Office.context.mailbox.item.addFileAttachmentFromBase64Async(
  modIcon1Base64,
  "myImage.png",
  { isInline: true },
  function(result) {
    if (result.status == Office.AsyncResultStatus.Succeeded) {
      const signature = (document.getElementById("signature") as HTMLInputElement).value + "<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, чтобы удалить вложение, добавленное во время текущего сеанса.

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

Параметры

base64File: string

Содержимое изображения или файла в кодировке Base64, которое должно быть добавлено к сообщению электронной почты или событию. Максимальная длина кодированной строки составляет 34 865 152 символа. Это соответствует максимальному размеру вложения в 25 МБ до кодировки Base64.

attachmentName: string

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

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

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

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

void

Если вы используете API URL-адреса данных (например, ), вам нужно удалить префикс URL-адреса данных, readAsDataURLа затем отправить оставшуюся строку в этот API. Например, если полная строка представлена как data:image/svg+xml;base64,<rest of Base64 string>, удалите data:image/svg+xml;base64,.
Чтобы добавить встроенное изображение в кодировке Base64 в текст создаваемого сообщения или встречи, используйте методы API Body , такие как prependAsync, setSignatureAsync, или setAsync. Если вы используете для Office.context.mailbox.item.body.setAsync вставки изображение, сначала вызовите Office.context.mailbox.item.body.getAsync получение текущего текста элемента. В противном случае изображение не будет отображаться в тексте после вставки. Например, см. пример "Добавление встроенного изображения в кодировке Base64 в текст сообщения или встречи (Compose)" в Script Lab.

Ошибки:

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

addHandlerAsync(eventType, handler, options, callback)

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

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

Параметры

eventType: Office.EventType | string

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

handler: any

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

options: Office.AsyncContextOptions

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

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

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

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

void

Примеры

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

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

addHandlerAsync(eventType, handler, callback)

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

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

Параметры

eventType: Office.EventType | string

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

handler: any

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

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

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

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

void

addItemAttachmentAsync(itemId, attachmentName, options, callback)

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

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

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

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

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

Параметры

itemId: any

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

attachmentName: string

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

options: Office.AsyncContextOptions

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

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

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

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

void

Примеры

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

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

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

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

addItemAttachmentAsync(itemId, attachmentName, callback)

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

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

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

Если надстройка Office работает в Outlook в Интернете и в новом Outlook для Windows, этот 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

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

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

void

close()

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

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

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

close(): void;

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

void

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

Примеры

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

В Outlook для Windows (классическая версия) и на Mac этот API устанавливает подпись в разделах "Новое сообщение" и "Ответы/пересылки" для отправляющей учетной записи значение "(нет)", что фактически отключает подпись. В Outlook в Интернете и новом Outlook для Windows 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

Примеры

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

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

disableClientSignatureAsync(callback)

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

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

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

Параметры

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

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

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

void

getAttachmentContentAsync(attachmentId, options, callback)

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

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

Параметры

attachmentId: string

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

options: Office.AsyncContextOptions

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

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

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

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

void

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

Ошибки:

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

Примеры

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

// Gets the attachments of the current message or appointment in compose mode. The getAttachmentsAsync call can only be used in compose mode.
Office.context.mailbox.item.getAttachmentsAsync((result) => {
  if (result.status === Office.AsyncResultStatus.Failed) {
    console.log(result.error.message);
    return;
  }

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

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

getAttachmentContentAsync(attachmentId, callback)

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

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

Параметры

attachmentId: string

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

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

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

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

void

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

Ошибки:

AttachmentTypeNotSupported : тип вложения не поддерживается. К неподдерживаемым типам относятся встроенные изображения в формате RTF или вложения элементов, отличные от элементов электронной почты или календаря (таких как контакт или задача).
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 будет содержать код ошибки с указанием причины сбоя. Если вызов выполнен успешно, в свойстве asyncResult.value возвращается массив AttachmentDetailsCompose объектов.

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

void

В Outlook в Интернете и в новой версии Outlook для Windows пользователи могут выбрать параметр «Отправка и общий доступ», чтобы отправить вложение в OneDrive и включить ссылку на файл в элемент письма. Однако, поскольку включена только ссылка, getAttachmentsAsync это вложение не возвращается.
Для вложений типа Office.MailboxEnums.AttachmentType.Itemразмер и сериализованное содержимое, возвращаемые getAttachmentsAsync обработчиком, могут различаться между вызовами, выполненными из обработчика OnMessageSend событий или OnAppointmentSend . Чтобы надежно обнаруживать изменения вложения, обработайте OnMessageAttachmentsChanged вместо этого событие OR OnAppointmentAttachmentsChanged .

Примеры

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

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

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

getAttachmentsAsync(callback)

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

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

Параметры

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

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

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

void

В Outlook в Интернете и в новой версии Outlook для Windows пользователи могут выбрать параметр «Отправка и общий доступ», чтобы отправить вложение в OneDrive и включить ссылку на файл в элемент письма. Однако, поскольку включена только ссылка, getAttachmentsAsync это вложение не возвращается.
Для вложений типа Office.MailboxEnums.AttachmentType.Itemразмер и сериализованное содержимое, возвращаемые getAttachmentsAsync обработчиком, могут различаться между вызовами, выполненными из обработчика OnMessageSend событий или OnAppointmentSend . Чтобы надежно обнаруживать изменения вложения, обработайте OnMessageAttachmentsChanged вместо этого событие OR OnAppointmentAttachmentsChanged .

getInitializationContextAsync(options, callback)

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

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 .

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

void

Примеры

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

getInitializationContextAsync(callback)

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

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

Параметры

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

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

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

void

getItemIdAsync(options, callback)

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

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

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

Параметры

options: Office.AsyncContextOptions

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

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

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

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

void

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

Ошибки:

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

getItemIdAsync(callback)

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

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

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

Параметры

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

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

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

void

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

Ошибки:

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

Примеры

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

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

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

getSelectedDataAsync(coercionType, options, callback)

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

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

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

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

Параметры

coercionType: Office.CoercionType | string

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

options: Office.AsyncContextOptions

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

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

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

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

void

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

Примеры

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

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

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

getSelectedDataAsync(coercionType, callback)

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

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

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

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

Параметры

coercionType: Office.CoercionType | string

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

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

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

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

void

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

Примеры

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

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

getSharedPropertiesAsync(options, callback)

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

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

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

Параметры

options: Office.AsyncContextOptions

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

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

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

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

void

getSharedPropertiesAsync(callback)

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

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

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

Параметры

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

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

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

void

Примеры

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

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

isClientSignatureEnabledAsync(options, callback)

Получает включенную сигнатуру клиента.

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

Примеры

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

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

isClientSignatureEnabledAsync(callback)

Получает включенную сигнатуру клиента.

В Outlook в Интернете и новой версии Outlook для Windows возвращает true сведения о том, включена ли подпись для типовnewMail создания ,reply или .forward Если в Outlook для классической версии Windows (классическая версия) или для Mac задано значение "(нет)" либо отключено в Outlook в Интернете или новой версии Outlook для Windows, возвращается false.

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

Параметры

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

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

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

void

loadCustomPropertiesAsync(callback, userContext)

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

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

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

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

Параметры

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

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

userContext: any

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

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

void

Примеры

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

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

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

removeAttachmentAsync(attachmentId, options, callback)

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

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

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

Параметры

attachmentId: string

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

options: Office.AsyncContextOptions

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

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

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

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

void

Важно! ЭтотremoveAttachmentAsync метод не удаляет встроенные вложения из элемента письма. Чтобы удалить встроенное вложение, сначала получите его основную часть, а затем удалите ссылки на вложение из его содержимого. С помощью интерфейсов API Office.Body можно получить и настроить текст элемента.

Ошибки:

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

Примеры

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

Office.context.mailbox.item.removeAttachmentAsync(
  (document.getElementById("attachmentId") as HTMLInputElement).value,
  (result) => {
    if (result.status === Office.AsyncResultStatus.Failed) {
      console.error(result.error.message);
      return;
    }
    console.log(`Attachment removed successfully.`);
  }
);

removeAttachmentAsync(attachmentId, callback)

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

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

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

Параметры

attachmentId: string

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

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

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

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

void

Важно! ЭтотremoveAttachmentAsync метод не удаляет встроенные вложения из элемента письма. Чтобы удалить встроенное вложение, сначала получите его основную часть, а затем удалите ссылки на вложение из его содержимого. С помощью интерфейсов API Office.Body можно получить и настроить текст элемента.

Ошибки:

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

removeHandlerAsync(eventType, options, callback)

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

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

Параметры

eventType: Office.EventType | string

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

options: Office.AsyncContextOptions

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

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

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

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

void

removeHandlerAsync(eventType, callback)

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

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

Параметры

eventType: Office.EventType | string

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

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

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

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

void

Примеры

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

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

saveAsync(options, callback)

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

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

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

Параметры

options: Office.AsyncContextOptions

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

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

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

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

void

В Outlook в Интернете, новом Outlook для Windows или классическом Outlook в Windows в сетевом режиме (без кэширования) элемент сохраняется на сервере. В Outlook в режиме кэширования этот элемент сохраняется в локальном кэше.
При работе с содержимым в формате HTML важно учитывать, что клиент Outlook может изменять содержимое. Это означает, что последующие вызовы таких методов, как Body.getAsync, Body.setAsync, и даже saveAsync могут не приводить к тому же содержимому.
Возвращаемый идентификатор совпадает с идентификатором элемента веб-служб Exchange (EWS). Возвращаемый идентификатор элемента не идентичен идентификатору записи Outlook или идентификатору, используемому REST API Outlook. Перед вызовами REST API с использованием этого значения его следует преобразовать с помощью Office.context.mailbox.convertToRestId.
Если ваша надстройка вызывает saveAsync получение кода элемента для использования с EWS или REST API, имейте в виду, что когда Outlook находится в режиме кэширования, может потребоваться некоторое время для фактической синхронизации элемента с сервером. Пока элемент не будет синхронизирован, использование кода элемента будет возвращать ошибку.
В Outlook для Mac сохранение собрания поддерживается только в версии 16.35 (20030802) и более поздних. В противном случае saveAsync метод завершится сбоем при вызове из собрания в режиме создания. Временное решение см. в статье "Не удается сохранить собрание как черновик в Outlook для Mac с помощью API Office JS".

Ошибки:

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)

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

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

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

Параметры

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

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

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

void

В Outlook в Интернете, новом Outlook для Windows или классическом Outlook в Windows в сетевом режиме (без кэширования) элемент сохраняется на сервере. В Outlook в режиме кэширования этот элемент сохраняется в локальном кэше.
При работе с содержимым в формате HTML важно учитывать, что клиент Outlook может изменять содержимое. Это означает, что последующие вызовы таких методов, как Body.getAsync, Body.setAsync, и даже saveAsync могут не приводить к тому же содержимому.
Возвращаемый идентификатор совпадает с идентификатором элемента веб-служб Exchange (EWS). Возвращаемый идентификатор элемента не идентичен идентификатору записи Outlook или идентификатору, используемому REST API Outlook. Перед вызовами REST API с использованием этого значения его следует преобразовать с помощью Office.context.mailbox.convertToRestId.
Если ваша надстройка вызывает saveAsync получение кода элемента для использования с EWS или REST API, имейте в виду, что когда Outlook находится в режиме кэширования, может потребоваться некоторое время для фактической синхронизации элемента с сервером. Пока элемент не будет синхронизирован, использование кода элемента будет возвращать ошибку.
В Outlook для Mac сохранение собрания поддерживается только в версии 16.35 (20030802) и более поздних. В противном случае saveAsync метод завершится сбоем при вызове из собрания в режиме создания. Временное решение см. в статье "Не удается сохранить собрание как черновик в Outlook для Mac с помощью API Office JS".

Ошибки:

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

sendAsync(options, callback)

Отправляет составляемую встречу.

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

Параметры

options: Office.AsyncContextOptions

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

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

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

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

void

Этот sendAsync метод поддерживается только в реализациях области задач и команд функций. Она не поддерживается в обработчиках на основе событий или в сценариях множественного выбора элементов.
В реализации команды функции возвращаемое значение asyncResult.status может не отражать успешную отправку составляемой встречи. Это связано с тем, что метод sendAsync является асинхронным API, и события, находящиеся вне управления надстройки (например, события, обрабатываемые отдельно установленной надстройкой Smart Alerts), могут блокировать отправку элемента. Поскольку вы не можете полагаться на состояние, возвращенное в asyncResult.status выполнении определенных операций, вы должны вызывать только метод event.completed в функции обратного вызова. Этот event.completed вызов сигнализирует о том, что обработка надстройки завершена. Выполнение другого кода в функции обратного вызова, кроме этого вызова, не гарантируется. Перед вызовом sendAsyncрекомендуется обработать другие операции .
В реализации области задач любой код, включенный для выполнения asyncResult.statusOffice.AsyncResultStatus.Success , не гарантируется обработкой. Это связано с тем, что элемент мог быть уже отправлен и надстройка завершила обработку. Перед вызовом sendAsyncрекомендуется обработать другие операции .
Выполнение любого кода, включенного после вызова sendAsync , не гарантируется, поскольку обработка надстройки завершается после вызова sendAsync .

sendAsync(callback)

Отправляет составляемую встречу.

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

Параметры

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

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

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

void

Этот sendAsync метод поддерживается только в реализациях области задач и команд функций. Она не поддерживается в обработчиках на основе событий или в сценариях множественного выбора элементов.
В реализации команды функции возвращаемое значение asyncResult.status может не отражать успешную отправку составляемой встречи. Это связано с тем, что метод sendAsync является асинхронным API, и события, находящиеся вне управления надстройки (например, события, обрабатываемые отдельно установленной надстройкой Smart Alerts), могут блокировать отправку элемента. Поскольку вы не можете полагаться на состояние, возвращенное в asyncResult.status выполнении определенных операций, вы должны вызывать только метод event.completed в функции обратного вызова. Этот event.completed вызов сигнализирует о том, что обработка надстройки завершена. Выполнение другого кода в функции обратного вызова, кроме этого вызова, не гарантируется. Перед вызовом sendAsyncрекомендуется обработать другие операции .
В реализации области задач любой код, включенный для выполнения asyncResult.statusOffice.AsyncResultStatus.Success , не гарантируется обработкой. Это связано с тем, что элемент мог быть уже отправлен и надстройка завершила обработку. Перед вызовом sendAsyncрекомендуется обработать другие операции .
Выполнение любого кода, включенного после вызова sendAsync , не гарантируется, поскольку обработка надстройки завершается после вызова sendAsync .

Примеры

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

// This snippet sends the current message or appointment being composed.
Office.context.mailbox.item.sendAsync((asyncResult) => {
  if (asyncResult.status === Office.AsyncResultStatus.Failed) {
    console.log("Action failed with error: " + asyncResult.error.message);
    return;
  }
});

setSelectedDataAsync(data, options, callback)

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

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

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

Параметры

data: string

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

options: Office.AsyncContextOptions & Office.CoercionTypeOptions

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

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

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

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

void

Примеры

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

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

setSelectedDataAsync(data, callback)

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

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

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

Комментарии

Используется

Примеры

Свойства

Методы

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

body

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

Комментарии

Примеры

categories

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

Комментарии

Примеры

end

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

Комментарии

Примеры

enhancedLocation

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

Комментарии

Примеры

isAllDayEvent

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

Комментарии

Примеры

itemType

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

Комментарии

Примеры

location

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

Комментарии

Примеры

notificationMessages

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

Комментарии

Примеры

optionalAttendees

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

Комментарии

Примеры

organizer

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

Комментарии

Примеры

recurrence

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

Комментарии

Примеры

requiredAttendees

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

Комментарии

Примеры

sensitivity

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

Комментарии

Примеры

sensitivityLabel

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

Комментарии

Примеры

seriesId

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

Комментарии

Примеры

sessionData

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

Комментарии

Примеры

start

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

Комментарии

Примеры

subject

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

Комментарии

Примеры

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