Office.AttachmentDetailsCompose interface

Paquet:
outlook

Représente une pièce jointe sur un élément. Mode composition uniquement.

Un tableau d’objets AttachmentDetailsCompose est renvoyé par la getAttachmentsAsync méthode.

Remarques

Jeu d’API : Boîte aux lettres 1.8

Niveau d’autorisation minimal : lire l’élément

Mode Outlook applicable : Compose

Utilisateur

Exemples

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

Propriétés

attachmentType

Obtient une valeur qui indique le type de la pièce jointe.
contentId

Obtient l’identificateur de contenu d’une pièce jointe incluse.
id

Obtient l’identificateur d’une pièce jointe. La valeur varie en fonction du client Outlook.

  • Dans Outlook sur le web et la nouvelle version d’Outlook sur Windows, l’identificateur est l’ID EWS (services Web Exchange). Pour les pièces jointes incluses, l’identifiant initial est un identifiant de pièce jointe temporaire, préfixé par addinId, pendant que la pièce jointe est téléchargée sur le serveur. Une fois le chargement terminé, la pièce jointe reçoit un ID EWS. Pour plus d’informations, consultez les notes dans la section Remarques.

  • Dans Outlook sur Windows (classique) et sur Mac, l’identifiant des pièces jointes incorporées et non incorporées est l’index de la pièce jointe.
isInline

Obtient une valeur qui indique si la pièce jointe apparaît sous la forme d’une image dans le corps de l’élément plutôt que dans la liste des pièces jointes.
isServiceAccessible

Dans Outlook sur le web et la nouvelle version d’Outlook sur Windows, indique si une pièce jointe incorporée dans un message a été téléchargée sur le serveur et si un ID EWS (services Web Exchange) a été attribué.
name

Obtient le nom de la pièce jointe.
size

Obtient la taille de la pièce jointe en octets.
url

Récupère l’URL de la pièce jointe si son type est MailboxEnums.AttachmentType.Cloud.

Détails de la propriété

attachmentType

Obtient une valeur qui indique le type de la pièce jointe.

attachmentType: MailboxEnums.AttachmentType | string;

Valeur de propriété

Office.MailboxEnums.AttachmentType | string

Remarques

Important:

  • Dans Outlook sur le web et la nouvelle version d’Outlook sur Windows, un message ou un rendez-vous enregistré localement puis joint à l’aide de la fonction glisser-déplacer ou de l’option Joindre un élément est de type Office.MailboxEnums.AttachmentType.File. L’extension de nom de fichier est renvoyée dans la name propriété. Toutefois, un message ou un rendez-vous joint à l’aide de l’option Transférer en tant que pièce jointe est de type Office.MailboxEnums.AttachmentType.Item. Dans ce cas, aucune extension n’est renvoyée dans la name propriété.

  • Dans Outlook classique sur Windows, un message ou un rendez-vous joint à l’aide de la fonction Glisser-déplacer, Joindre un fichier ou Transférer en tant que pièce jointe est de type Office.MailboxEnums.AttachmentType.Item. Une extension de nom de fichier n’est pas renvoyée dans la name propriété.

  • Dans Outlook sur Mac, un message ou un rendez-vous joint à l’aide de la fonction glisser-déplacer, joindre un élément ou transférer en tant que pièce jointe est de type Office.MailboxEnums.AttachmentType.File. L’extension de nom de fichier est renvoyée dans la name propriété.

contentId

Obtient l’identificateur de contenu d’une pièce jointe incluse.

contentId: string;

Valeur de propriété

string

Remarques

Jeu d’API : Boîte aux lettres 1.16

Important : modifications apportées à la façon dont les images incorporées sont représentées dans le corps HTML des e-mails Outlook dans Outlook sur le web et la nouvelle version d’Outlook sur Windows publiée le 15 novembre 2025. Auparavant, l’ID de pièce jointe de l’image apparaissait dans l’attribut src de l’élément applicable <img> . L’image est à présent représentée par un ID de contenu (cid) dans l’attribut src . Si vous analysez l’ID de pièce jointe à partir de l’éditeur HTML ou si vous obtenez la valeur codée en Base64 de l’image à partir de l’URL dans l’attribut src , vous devez mettre à jour la logique d’analyse de votre complément. Pour plus d’informations, consultez Modifications apportées à la représentation d’images en ligne dans Outlook sur le web et la nouvelle version d’Outlook pour Windows.

id

Obtient l’identificateur d’une pièce jointe. La valeur varie en fonction du client Outlook.

  • Dans Outlook sur le web et la nouvelle version d’Outlook sur Windows, l’identificateur est l’ID EWS (services Web Exchange). Pour les pièces jointes incluses, l’identifiant initial est un identifiant de pièce jointe temporaire, préfixé par addinId, pendant que la pièce jointe est téléchargée sur le serveur. Une fois le chargement terminé, la pièce jointe reçoit un ID EWS. Pour plus d’informations, consultez les notes dans la section Remarques.

  • Dans Outlook sur Windows (classique) et sur Mac, l’identifiant des pièces jointes incorporées et non incorporées est l’index de la pièce jointe.

id: string;

Valeur de propriété

string

Remarques

Important : à compter du 30 mars 2026, après la fin de l’appel ou de addFileAttachmentAsyncaddFileAttachmentFromBase64AsyncisInline la configuration planifiéetrue, les images incorporées dans les messages dans Outlook sur le web et le nouvel Outlook sur Windows se voient attribuer localement un ID de pièce jointe temporaire pendant leur chargement sur le serveur. Un ID de pièce jointe temporaire est préfixé par addinId. Une fois les images téléchargées sur le serveur, un ID EWS (services Web Exchange) leur est attribué. L’ID de pièce jointe temporaire n’est pris en charge que pendant la durée de la session de composition en cours. Pour plus d’informations sur les modifications apportées à la façon dont les images incorporées sont gérées, voir Modifications apportées aux ID de pièce jointe pour les images incorporées dans les compléments Outlook.

isInline

Obtient une valeur qui indique si la pièce jointe apparaît sous la forme d’une image dans le corps de l’élément plutôt que dans la liste des pièces jointes.

isInline: boolean;

Valeur de propriété

boolean

isServiceAccessible

Dans Outlook sur le web et la nouvelle version d’Outlook sur Windows, indique si une pièce jointe incorporée dans un message a été téléchargée sur le serveur et si un ID EWS (services Web Exchange) a été attribué.

isServiceAccessible: boolean;

Valeur de propriété

boolean

Remarques

Important:

  • À compter du 30 mars 2026, une fois l’appel vers addFileAttachmentAsync ou addFileAttachmentFromBase64AsyncisInline avec défini sur true terminé, les images incorporées dans Outlook sur le web et le nouvel Outlook sur Windows reçoivent localement un ID de pièce jointe temporaire pendant leur chargement sur le serveur. Un ID de pièce jointe temporaire est préfixé par addinId. Une fois les images téléchargées sur le serveur, un ID EWS (services Web Exchange) leur est attribué dans la id propriété et leur isServiceAccessible propriété est définie sur true. L’ID de pièce jointe temporaire n’est pris en charge que pendant la durée de la session de composition en cours. Pour plus d’informations sur les modifications apportées à la façon dont les images incorporées sont gérées, voir Modifications apportées aux ID de pièce jointe pour les images incorporées dans les compléments Outlook.

  • Dans Outlook sur Windows (classique) et sur Mac, la propriété est toujours renvoyée false puisque l’ID isServiceAccessible de pièce jointe est l’index de la pièce jointe.

name

Obtient le nom de la pièce jointe.

name: string;

Valeur de propriété

string

Remarques

Important:

  • Un document de type Office.MailboxEnums.AttachmentType.Item ne renvoie pas d’extension de nom de fichier dans la name propriété.

  • Dans Outlook sur le web et la nouvelle version d’Outlook sur Windows, un message ou un rendez-vous enregistré localement puis joint à l’aide de la fonction glisser-déplacer ou de l’option Joindre un élément est de type Office.MailboxEnums.AttachmentType.File. L’extension de nom de fichier est renvoyée dans la name propriété. Toutefois, un message ou un rendez-vous joint à l’aide de l’option Transférer en tant que pièce jointe est de type Office.MailboxEnums.AttachmentType.Item. Dans ce cas, aucune extension n’est renvoyée dans la name propriété.

  • Dans Outlook classique sur Windows, un message ou un rendez-vous joint à l’aide de la fonction Glisser-déplacer, Joindre un fichier ou Transférer en tant que pièce jointe est de type Office.MailboxEnums.AttachmentType.Item. Une extension de nom de fichier n’est pas renvoyée dans la name propriété.

  • Dans Outlook sur Mac, un message ou un rendez-vous joint à l’aide de la fonction glisser-déplacer, joindre un élément ou transférer en tant que pièce jointe est de type Office.MailboxEnums.AttachmentType.File. L’extension de nom de fichier est renvoyée dans la name propriété.

size

Obtient la taille de la pièce jointe en octets.

size: number;

Valeur de propriété

number

url

Récupère l’URL de la pièce jointe si son type est MailboxEnums.AttachmentType.Cloud.

url?: string;

Valeur de propriété

string