Office.AttachmentDetailsCompose interface

Пакет:
outlook

Представляет вложение в элементе. Только в режиме создания.

Этот getAttachmentsAsync метод возвращает массив AttachmentDetailsCompose объектов.

Комментарии

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

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

Применимый режим Outlook: Compose

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

Примеры

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

Свойства

attachmentType

Получает значение, указывающее тип вложения.
contentId

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

Получает идентификатор вложения. Значение зависит от клиента Outlook.

  • В Outlook в Интернете и новом Outlook для Windows идентификатором является идентификатор веб-служб Exchange (EWS). Для встроенных вложений начальным идентификатором является временный идентификатор вложения с префиксом addinId, пока вложение загружается на сервер. После завершения отправки вложение получает идентификатор EWS. Дополнительные сведения см. в примечаниях в разделе "Замечания".

  • В Outlook для Windows (классическая версия) и на Mac идентификатором встроенных и невстроенных вложений является индекс вложения.
isInline

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

В Outlook в Интернете и новой версии Outlook для Windows указывает, было ли встроенное в сообщение вложение отправлено на сервер и ему назначен идентификатор веб-служб Exchange (EWS).
name

Получает имя вложения.
size

Получает размер вложения в байтах.
url

Получает URL-адрес вложения, если его типом является MailboxEnums.AttachmentType.Cloud.

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

attachmentType

Получает значение, указывающее тип вложения.

attachmentType: MailboxEnums.AttachmentType | string;

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

Office.MailboxEnums.AttachmentType | string

Комментарии

Важно!

  • В Outlook в Интернете и новом Outlook для Windows сообщение или встреча, сохраненные локально, а затем вложенные с помощью перетаскивания или параметра «Вложить элемент», имеют тип Office.MailboxEnums.AttachmentType.File. Расширение имени файла возвращается в свойстве name . Однако сообщение или встреча, вложенные с помощью параметра "Переслать как вложение ", имеют тип Office.MailboxEnums.AttachmentType.Item. В этом случае расширение не возвращается в свойстве name .

  • В классической версии Outlook для Windows сообщение или встреча, вложенные с помощью перетаскивания, вложения файла или пересылки как вложения , имеют тип Office.MailboxEnums.AttachmentType.Item. Расширение имени файла не возвращается в свойстве name .

  • В Outlook для Mac сообщение или встреча, вложенные с помощью перетаскивания, прикрепления элемента или пересылки как вложения , имеют тип Office.MailboxEnums.AttachmentType.File. Расширение имени файла возвращается в свойстве name .

contentId

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

contentId: string;

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

string

Комментарии

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

Важно! Изменения в том, как встроенные изображения представлены в HTML-тексте электронных писем Outlook в Outlook в Интернете и новом Outlook для Windows, выпущенном 15 ноября 2025 г. Ранее идентификатор вложения изображения отображался в src атрибуте соответствующего <img> элемента. Теперь изображение представлено идентификатором содержимого (cid) в атрибуте src . Если вы анализируете идентификатор вложения из HTML-редактора или получаете значение изображения в кодировке Base64 из URL-адреса в атрибуте src , необходимо обновить логику синтаксического анализа надстройки. Дополнительные сведения см. в статьях "Изменения встроенного представления изображений в Outlook в Интернете" и "Новый Outlook для Windows".

id

Получает идентификатор вложения. Значение зависит от клиента Outlook.

  • В Outlook в Интернете и новом Outlook для Windows идентификатором является идентификатор веб-служб Exchange (EWS). Для встроенных вложений начальным идентификатором является временный идентификатор вложения с префиксом addinId, пока вложение загружается на сервер. После завершения отправки вложение получает идентификатор EWS. Дополнительные сведения см. в примечаниях в разделе "Замечания".

  • В Outlook для Windows (классическая версия) и на Mac идентификатором встроенных и невстроенных вложений является индекс вложения.

id: string;

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

string

Комментарии

Важно. Начиная с 30 марта 2026 г. после завершения вызова addFileAttachmentAsyncaddFileAttachmentFromBase64AsyncisInlinetrue встроенным изображениям в сообщениях в Outlook в Интернете и новом Outlook для Windows локально назначается временный идентификатор вложения при их отправке на сервер. Временному идентификатору вложения предназначается префикс addinId. После отправки изображений на сервер им назначается идентификатор веб-служб Exchange (EWS). Идентификатор временного вложения поддерживается только в течение текущего сеанса создания сообщения. Дополнительные сведения об обработке встроенных изображений см. в статье Изменения идентификаторов вложений для встроенных изображений в надстройках Outlook.

isInline

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

isInline: boolean;

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

boolean

isServiceAccessible

В Outlook в Интернете и новой версии Outlook для Windows указывает, было ли встроенное в сообщение вложение отправлено на сервер и ему назначен идентификатор веб-служб Exchange (EWS).

isServiceAccessible: boolean;

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

boolean

Комментарии

Важно!

  • Начиная с 30 марта 2026 г. после завершения вызова addFileAttachmentAsyncaddFileAttachmentFromBase64AsyncisInlinetrue встроенным изображениям в Outlook в Интернете и новом Outlook для Windows локально назначается временный идентификатор вложения при их отправке на сервер. Временному идентификатору вложения предназначается префикс addinId. После загрузки изображений на сервер им назначается идентификатор веб-служб Exchange (EWS) в свойстве id , и их isServiceAccessible свойство имеет значение true. Идентификатор временного вложения поддерживается только в течение текущего сеанса создания сообщения. Дополнительные сведения об обработке встроенных изображений см. в статье Изменения идентификаторов вложений для встроенных изображений в надстройках Outlook.

  • В Outlook для классической версии Windows (классическая версия) и для Mac свойство isServiceAccessible всегда возвращает значение false , так как идентификатор вложения является индексом вложения.

name

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

name: string;

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

string

Комментарии

Важно!

  • Вложение типа Office.MailboxEnums.AttachmentType.Item не возвращает расширение имени файла в свойстве name .

  • В Outlook в Интернете и новом Outlook для Windows сообщение или встреча, сохраненные локально, а затем вложенные с помощью перетаскивания или параметра «Вложить элемент», имеют тип Office.MailboxEnums.AttachmentType.File. Расширение имени файла возвращается в свойстве name . Однако сообщение или встреча, вложенные с помощью параметра "Переслать как вложение ", имеют тип Office.MailboxEnums.AttachmentType.Item. В этом случае расширение не возвращается в свойстве name .

  • В классической версии Outlook для Windows сообщение или встреча, вложенные с помощью перетаскивания, вложения файла или пересылки как вложения , имеют тип Office.MailboxEnums.AttachmentType.Item. Расширение имени файла не возвращается в свойстве name .

  • В Outlook для Mac сообщение или встреча, вложенные с помощью перетаскивания, прикрепления элемента или пересылки как вложения , имеют тип Office.MailboxEnums.AttachmentType.File. Расширение имени файла возвращается в свойстве name .

size

Получает размер вложения в байтах.

size: number;

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

number

url

Получает URL-адрес вложения, если его типом является MailboxEnums.AttachmentType.Cloud.

url?: string;

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

string