Office.AttachmentDetailsCompose interface

アイテムの添付ファイルを表します。 新規作成モードのみです。

AttachmentDetailsCompose オブジェクトの配列は、getAttachmentsAsync メソッドによって返されます。

注釈

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 on the web と新しい Outlook on Windows では、識別子は Exchange Web サービス (EWS) ID です。 インライン添付ファイルの場合、初期識別子は、添付ファイルがサーバーにアップロードされる間の addinId というプレフィックスが付いた一時的な添付ファイル ID です。 アップロードが完了すると、添付ファイルは EWS ID を受け取ります。 詳細については、「備考」セクションの注を参照してください。

  • Windows (クラシック) 版および Mac 版の Outlook では、インライン添付ファイルと非インライン添付ファイルの識別子が添付ファイルのインデックスです。

isInline

添付ファイルが添付ファイル リストではなくアイテムの本文に画像として表示されるかどうかを示す値を取得します。

isServiceAccessible

Outlook on the web と新しい Outlook on Windows で、メッセージ内のインライン添付ファイルがサーバーにアップロードされ、Exchange Web サービス (EWS) ID が割り当てられているかどうかを示します。

name

添付ファイルの名前を取得します。

size

添付ファイルのサイズをバイト単位で取得します。

url

添付ファイルの種類が MailboxEnums.AttachmentType.Cloud の場合、添付ファイルの URL を取得します。

プロパティの詳細

attachmentType

添付ファイルの種類を示す値を取得します。

attachmentType: MailboxEnums.AttachmentType | string;

プロパティ値

注釈

重要:

  • Windows 上の Outlook on the web および新しい Outlook では、ローカルに保存され、ドラッグ アンド ドロップまたは [アイテムの添付] オプションを使用して添付されたメッセージまたは予定の種類は Office.MailboxEnums.AttachmentType.File です。 ファイル名拡張子は name プロパティで返されます。 ただし、[ 添付ファイルとして転送] オプションを使用して添付されたメッセージまたは予定の種類は Office.MailboxEnums.AttachmentType.Item です。 この場合、拡張子は name プロパティで返されません。

  • 従来の Outlook on Windows では、ドラッグ アンド ドロップ、 ファイルの添付、または 添付ファイルとして転送 を使用して添付されたメッセージまたは予定の種類は Office.MailboxEnums.AttachmentType.Item です。 ファイル名拡張子は name プロパティで返されません。

  • Outlook on Mac では、ドラッグ アンド ドロップ、 アイテムの添付、または 添付ファイルとして 転送を使用して添付されたメッセージまたは予定の種類は Office.MailboxEnums.AttachmentType.File です。 ファイル名拡張子は name プロパティで返されます。

contentId

インライン 添付ファイルのコンテンツ識別子を取得します。

contentId: string;

プロパティ値

string

注釈

API セット: メールボックス 1.16

重要: 2025 年 11 月 15 日にリリースされた Outlook on the web および Windows 上の新しい Outlook の Outlook on the web の Outlook メールの HTML 本文でインライン画像が表示される方法が変更されました。 以前は、画像の添付ファイル ID は、該当する <img> 要素の src 属性に表示されていました。 代わりに、src 属性のコンテンツ ID (cid) によって画像が表されるようになりました。 HTML エディターから添付ファイル ID を解析する場合、または src 属性の URL から画像の Base64 でエンコードされた値を取得する場合は、アドインの解析ロジックを更新する必要があります。 詳細については、「Outlook on the web および新しい Outlook for Windows でのインライン画像表現の変更」を参照してください。

id

添付ファイルの識別子を取得します。 この値は、Outlook クライアントによって異なります。

  • Outlook on the web と新しい Outlook on Windows では、識別子は Exchange Web サービス (EWS) ID です。 インライン添付ファイルの場合、初期識別子は、添付ファイルがサーバーにアップロードされる間の addinId というプレフィックスが付いた一時的な添付ファイル ID です。 アップロードが完了すると、添付ファイルは EWS ID を受け取ります。 詳細については、「備考」セクションの注を参照してください。

  • Windows (クラシック) 版および Mac 版の Outlook では、インライン添付ファイルと非インライン添付ファイルの識別子が添付ファイルのインデックスです。

id: string;

プロパティ値

string

注釈

重要: 2026 年 3 月 30 日以降、isInlinetrue に設定した addFileAttachmentAsync または addFileAttachmentFromBase64Async への呼び出しが完了すると、Outlook on the web のメッセージおよび新しい Outlook on Windows のメッセージのインライン画像は、サーバーにアップロードされる間、ローカルに一時的な添付ファイル ID が割り当てられます。 添付ファイルの一時IDのプレフィックスは addinId。 画像がサーバーにアップロードされると、Exchange Web サービス (EWS) ID が割り当てられます。 一時添付ファイル ID は、現在の作成セッションの期間中のみサポートされます。 インライン画像の処理方法の変更の詳細については、「 Outlook アドインでのインライン画像の添付ファイル ID の変更」を参照してください。

isInline

添付ファイルが添付ファイル リストではなくアイテムの本文に画像として表示されるかどうかを示す値を取得します。

isInline: boolean;

プロパティ値

boolean

isServiceAccessible

Outlook on the web と新しい Outlook on Windows で、メッセージ内のインライン添付ファイルがサーバーにアップロードされ、Exchange Web サービス (EWS) ID が割り当てられているかどうかを示します。

isServiceAccessible: boolean;

プロパティ値

boolean

注釈

重要:

  • 2026 年 3 月 30 日以降、isInlinetrue に設定した addFileAttachmentAsync または addFileAttachmentFromBase64Async への呼び出しが完了すると、Outlook on the web のインライン イメージと新しい Outlook on Windows には、サーバーにアップロードされる間、ローカルに一時的な添付ファイル ID が割り当てられます。 添付ファイルの一時IDのプレフィックスは addinId。 画像がサーバーにアップロードされると、 id プロパティで Exchange Web サービス (EWS) ID が割り当てられ、 isServiceAccessible プロパティが true に設定されます。 一時添付ファイル ID は、現在の作成セッションの期間中のみサポートされます。 インライン画像の処理方法の変更の詳細については、「 Outlook アドインでのインライン画像の添付ファイル ID の変更」を参照してください。

  • Windows (クラシック) 版および Mac 版の Outlook では、添付ファイル ID が添付ファイルのインデックスとなるため、 isServiceAccessible プロパティは常に false を返します。

name

添付ファイルの名前を取得します。

name: string;

プロパティ値

string

注釈

重要:

  • Office.MailboxEnums.AttachmentType.Item 型の添付ファイルは、name プロパティでファイル名拡張子を返しません。

  • Windows 上の Outlook on the web および新しい Outlook では、ローカルに保存され、ドラッグ アンド ドロップまたは [アイテムの添付] オプションを使用して添付されたメッセージまたは予定の種類は Office.MailboxEnums.AttachmentType.File です。 ファイル名拡張子は name プロパティで返されます。 ただし、[ 添付ファイルとして転送] オプションを使用して添付されたメッセージまたは予定の種類は Office.MailboxEnums.AttachmentType.Item です。 この場合、拡張子は name プロパティで返されません。

  • 従来の Outlook on Windows では、ドラッグ アンド ドロップ、 ファイルの添付、または 添付ファイルとして転送 を使用して添付されたメッセージまたは予定の種類は Office.MailboxEnums.AttachmentType.Item です。 ファイル名拡張子は name プロパティで返されません。

  • Outlook on Mac では、ドラッグ アンド ドロップ、 アイテムの添付、または 添付ファイルとして 転送を使用して添付されたメッセージまたは予定の種類は Office.MailboxEnums.AttachmentType.File です。 ファイル名拡張子は name プロパティで返されます。

size

添付ファイルのサイズをバイト単位で取得します。

size: number;

プロパティ値

number

url

添付ファイルの種類が MailboxEnums.AttachmentType.Cloud の場合、添付ファイルの URL を取得します。

url?: string;

プロパティ値

string