Office.MessageCompose interface

Obtient un objet qui fournit des méthodes pour obtenir ou mettre à jour les destinataires de la ligne Cci (copie carbone invisible) d’un message.

Selon le client/la plateforme (Windows, Mac, etc.), des limites peuvent s’appliquer sur le nombre de destinataires que vous pouvez obtenir ou mettre à jour. Pour plus d’informations, consultez l’objet Destinataires .

bcc: Recipients;

Valeur de propriété

Remarques

Jeu d’API : Boîte aux lettres 1.1

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

Mode Outlook applicable : Message Compose

Exemples

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/30-recipients-and-attendees/get-set-bcc-message-compose.yaml

Office.context.mailbox.item.bcc.getAsync(function(asyncResult) {
  if (asyncResult.status === Office.AsyncResultStatus.Succeeded) {
    const msgBcc = asyncResult.value;
    console.log("Message being blind-copied to:");
    for (let i = 0; i < msgBcc.length; i++) {
      console.log(msgBcc[i].displayName + " (" + msgBcc[i].emailAddress + ")");
    }
  } else {
    console.error(asyncResult.error);
  }
});

...

const email = (document.getElementById("emailBcc") as HTMLInputElement).value;
const emailArray = [email];
Office.context.mailbox.item.bcc.setAsync(emailArray, function(asyncResult) {
  if (asyncResult.status === Office.AsyncResultStatus.Succeeded) {
    console.log("Succeeded in setting Bcc field.");
  } else {
    console.error(asyncResult.error);
  }
});

Obtient un objet qui fournit des méthodes permettant de manipuler le corps d’un élément.

body: Body;

Valeur de propriété

Remarques

Jeu d’API : Boîte aux lettres 1.1

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

Mode Outlook applicable : Message Compose

Exemples

// 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 the result parameter passed to the callback function.
{
    "value": "TEXT of whole body (including threads below)",
    "status": "succeeded",
    "asyncContext": "This is passed to the callback"
}

Obtient un objet qui fournit des méthodes pour gérer les catégories de l’élément.

categories: Categories;

Valeur de propriété

Remarques

Jeu d’API : Boîte aux lettres 1.8

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

Mode Outlook applicable : Message Compose

Important : Dans Outlook sur le web et la nouvelle version d’Outlook sur Windows, vous ne pouvez pas utiliser l’API pour gérer les catégories d’un message en mode Compose.

Exemples

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/45-categories/work-with-categories.yaml

Office.context.mailbox.item.categories.getAsync(function(asyncResult) {
  if (asyncResult.status === Office.AsyncResultStatus.Succeeded) {
    const categories = asyncResult.value;
    if (categories && categories.length > 0) {
      console.log("Categories assigned to this item:");
      console.log(JSON.stringify(categories));
    } else {
      console.log("There are no categories assigned to this item.");
    }
  } else {
    console.error(asyncResult.error);
  }
});

...

// Note: In order for you to successfully add a category,
// it must be in the mailbox categories master list.

Office.context.mailbox.masterCategories.getAsync(function(asyncResult) {
  if (asyncResult.status === Office.AsyncResultStatus.Succeeded) {
    const masterCategories = asyncResult.value;
    if (masterCategories && masterCategories.length > 0) {
      // Grab the first category from the master list.
      const categoryToAdd = [masterCategories[0].displayName];
      Office.context.mailbox.item.categories.addAsync(categoryToAdd, function(asyncResult) {
        if (asyncResult.status === Office.AsyncResultStatus.Succeeded) {
          console.log(`Successfully assigned category '${categoryToAdd}' to item.`);
        } else {
          console.log("categories.addAsync call failed with error: " + asyncResult.error.message);
        }
      });
    } else {
      console.log("There are no categories in the master list on this mailbox. You can add categories using Office.context.mailbox.masterCategories.addAsync.");
    }
  } else {
    console.error(asyncResult.error);
  }
});

...

Office.context.mailbox.item.categories.getAsync(function(asyncResult) {
  if (asyncResult.status === Office.AsyncResultStatus.Succeeded) {
    const categories = asyncResult.value;
    if (categories && categories.length > 0) {
      // Grab the first category assigned to this item.
      const categoryToRemove = [categories[0].displayName];
      Office.context.mailbox.item.categories.removeAsync(categoryToRemove, function(asyncResult) {
        if (asyncResult.status === Office.AsyncResultStatus.Succeeded) {
          console.log(`Successfully unassigned category '${categoryToRemove}' from this item.`);
        } else {
          console.log("categories.removeAsync call failed with error: " + asyncResult.error.message);
        }
      });
    } else {
      console.log("There are no categories assigned to this item.");
    }
  } else {
    console.error(asyncResult.error);
  }
});

Permet d’accéder aux destinataires en copie carbone (Cc) d’un message. Le type d’objet et le niveau d’accès dépendent du mode de l’élément en cours.

La propriété cc renvoie un objet Recipients qui fournit des méthodes permettant d’obtenir ou de mettre à jour les destinataires figurant sur la ligne Cc du message. Toutefois, selon le client/la plateforme (Windows, Mac, etc.), des limites peuvent s’appliquer sur le nombre de destinataires que vous pouvez obtenir ou mettre à jour. Pour plus d’informations, consultez l’objet Destinataires .

cc: Recipients;

Valeur de propriété

Remarques

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

Mode Outlook applicable : Message Compose

Exemples

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/30-recipients-and-attendees/get-set-cc-message-compose.yaml

Office.context.mailbox.item.cc.getAsync(function(asyncResult) {
  if (asyncResult.status === Office.AsyncResultStatus.Succeeded) {
    const msgCc = asyncResult.value;
    console.log("Message being copied to:");
    for (let i = 0; i < msgCc.length; i++) {
      console.log(msgCc[i].displayName + " (" + msgCc[i].emailAddress + ")");
    }
  } else {
    console.error(asyncResult.error);
  }
});

...

const email = (document.getElementById("emailCc") as HTMLInputElement).value;
const emailArray = [email];
Office.context.mailbox.item.cc.setAsync(emailArray, function(asyncResult) {
  if (asyncResult.status === Office.AsyncResultStatus.Succeeded) {
    console.log("Succeeded in setting Cc field.");
  } else {
    console.error(asyncResult.error);
  }
});

Obtient l’identificateur de la conversation qui contient un message particulier.

Vous pouvez obtenir un nombre entier de cette propriété si votre application de messagerie est activée dans les formulaires de lecture ou les réponses des formulaires de composition. Si, par la suite, l’utilisateur modifie l’objet du message de réponse, lors de l’envoi de la réponse, l’ID de conversation de ce message va changer et la valeur que vous avez obtenue plus tôt ne sera plus applicable.

Cette propriété obtient une valeur null lorsqu’un élément est ajouté à un formulaire de composition. Si l’utilisateur définit la ligne Objet et enregistre l’élément, la propriété conversationId renvoie une valeur.

conversationId: string;

Valeur de propriété

Remarques

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

Mode Outlook applicable : Message Compose

Exemples

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

console.log(`Conversation ID: ${Office.context.mailbox.item.conversationId}`);

Obtient ou définit la date et l’heure de remise différée d’un message.

La delayDeliveryTime propriété renvoie un objet qui fournit des DelayDeliveryTime méthodes pour gérer la date et l’heure de remise du message.

delayDeliveryTime: DelayDeliveryTime;

Valeur de propriété

Remarques

Jeu d’API : Boîte aux lettres 1.13

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

Mode Outlook applicable : Message Compose

Exemples

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

function setDeliveryDate(minutes) {
  // This snippet sets the delivery date and time of a message.
  const currentTime = new Date().getTime();
  const milliseconds = totalDelay * 60000;
  const timeDelay = new Date(currentTime + milliseconds);
  Office.context.mailbox.item.delayDeliveryTime.setAsync(timeDelay, (asyncResult) => {
    if (asyncResult.status === Office.AsyncResultStatus.Failed) {
      console.log(asyncResult.error.message);
      return;
    }

    if (minutes === 1440) {
      console.log(`Delayed delivery by an additional one day.`);
    } else {
      console.log(`Delayed delivery by an additional ${minutes} minutes.`);
    }
  });
}

Obtient l’adresse de messagerie de l’expéditeur d’un message.

La from propriété renvoie un From objet qui fournit une méthode pour obtenir la valeur from.

from: From;

Valeur de propriété

Remarques

Jeu d’API : Mailbox 1.7

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

Mode Outlook applicable : Message Compose

Important : Cette propriété est prise en charge dans Outlook sur Android et sur iOS. Pour voir un exemple de scénario, voir Implémenter l’activation basée sur les événements dans les compléments mobiles Outlook.

Exemples

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/30-recipients-and-attendees/get-from-message-compose.yaml

Office.context.mailbox.item.from.getAsync(function(asyncResult) {
  if (asyncResult.status === Office.AsyncResultStatus.Succeeded) {
    const msgFrom = asyncResult.value;
    console.log("Message from: " + msgFrom.displayName + " (" + msgFrom.emailAddress + ")");
  } else {
    console.error(asyncResult.error);
  }
});

Obtient l’ID de message Internet du message d’origine auquel répond le message actuel.

inReplyTo: string;

Valeur de propriété

Remarques

Jeu d’API : Boîte aux lettres 1.14

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

Mode Outlook applicable : Message Compose

Important:

• Dans Outlook sur Windows, la inReplyTo valeur est conservée sur toutes les réponses, indépendamment des modifications apportées par l’utilisateur, telles que la modification de l’objet dans une réponse.

• La inReplyTo propriété affiche null les nouveaux messages et invitations à une réunion transférés par un utilisateur qui est également l’organisateur de la réunion.

Exemples

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

// This snippet gets the ID of the message being replied to by the current message (PR_IN_REPLY_TO_ID).
// The API call is supported on messages being composed and isn't supported on read items.
const inReplyTo = Office.context.mailbox.item.inReplyTo;
if (inReplyTo) {
  console.log("ID of the message being replied to: " + inReplyTo);
} else {
  console.log("No InReplyTo property available for this message");
}

Obtient ou définit les en-têtes Internet personnalisés d’un message.

La internetHeaders propriété renvoie un objet qui fournit des InternetHeaders méthodes pour gérer les en-têtes Internet sur le message.

Pour plus d’informations, voir Obtenir et définir des en-têtes Internet sur un message dans un complément Outlook.

internetHeaders: InternetHeaders;

Valeur de propriété

Remarques

Jeu d’API : Boîte aux lettres 1.8

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

Mode Outlook applicable : Message Compose

Important : l’API d’en-têtes Internet est prise en charge dans Outlook sur Android et sur iOS à partir de la version 4.2405.0. Pour en savoir plus sur les fonctionnalités prises en charge dans Outlook sur les appareils mobiles, voir API JavaScript Outlook prises en charge dans Outlook sur les appareils mobiles.

Exemples

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/70-mime-headers/manage-custom-internet-headers-message-compose.yaml

Office.context.mailbox.item.internetHeaders.getAsync(
  ["preferred-fruit", "preferred-vegetable", "best-vegetable", "nonexistent-header"],
  function (asyncResult) {
    if (asyncResult.status === Office.AsyncResultStatus.Succeeded) {
      console.log("Selected headers: " + JSON.stringify(asyncResult.value));
    } else {
      console.log("Error getting selected headers: " + JSON.stringify(asyncResult.error));
    }
  }
);

Obtient le type d’élément représenté par une instance.

La itemType propriété renvoie l’une des valeurs d’énumération, indiquant si l’instance de ItemType l’objet d’élément est un message ou un rendez-vous.

itemType: MailboxEnums.ItemType | string;

Valeur de propriété

Remarques

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

Mode Outlook applicable : Message Compose

Exemples

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

Obtient les messages de notification pour un élément.

notificationMessages: NotificationMessages;

Valeur de propriété

Remarques

Jeu d’API : Boîte aux lettres 1.3

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

Mode Outlook applicable : Message Compose

Important : Pour en savoir plus sur les différents types de messages de notification que vous pouvez implémenter, voir Créer des notifications pour votre complément Outlook.

Exemples

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

Récupère l’objet pour obtenir ou définir l’étiquette de confidentialité d’un message.

sensitivityLabel: SensitivityLabel;

Valeur de propriété

Remarques

Jeu d’API : Boîte aux lettres 1.13

Niveau d’autorisation minimal : lecture/écriture d’élément

Mode Outlook applicable : Message Compose

Important : Pour utiliser la fonctionnalité d’étiquette de confidentialité dans votre complément, vous devez disposer d’un abonnement Microsoft 365 E5.

Pour en savoir plus sur la gestion des étiquettes de confidentialité dans votre complément, voir Gérer l’étiquette de confidentialité de votre message ou rendez-vous en mode de composition.

Exemples

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

Obtient l’ID de la série à laquelle une instance appartient.

Dans Outlook sur le web, sur Windows (nouveau et classique) et sur Mac, la seriesId renvoie l’ID EWS (services Web Exchange) de l’article parent (série) auquel cet article appartient. Toutefois, sur iOS et Android, seriesId renvoie l’ID REST de l’élément parent.

seriesId: string;

Valeur de propriété

Remarques

Jeu d’API : Mailbox 1.7

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

Mode Outlook applicable : Message Compose

Important : l’identificateur renvoyé par la seriesId propriété est le même que l’identificateur d’élément des services Web Exchange. Cette seriesId propriété n’est pas identique aux ID Outlook utilisés par l’API REST d’Outlook. Avant d’effectuer des appels d’API REST en utilisant cette valeur, elle doit être convertie en .Office.context.mailbox.convertToRestId Pour plus d’informations, consultez Utiliser les API REST Outlook à partir d’un complément Outlook.

La seriesId propriété renvoie null les éléments qui n’ont pas de parent tels que les rendez-vous uniques, les éléments de série ou les demandes de réunion, et renvoie undefined tous les autres éléments qui ne sont pas des demandes de réunion.

Exemples

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

Gère les SessionData d’un élément en mode Compose.

Important : Dans les clients Outlook qui prennent en charge la boîte aux lettres 1.15 ou une version antérieure, l’objet SessionData complet pour chaque élément de courrier est limité à 50 000 caractères par complément. Dans les clients qui prennent en charge la boîte aux lettres 1.16 ou une version ultérieure, la limite de caractères par complément est de 2 621 440 caractères.

sessionData: SessionData;

Valeur de propriété

Remarques

Jeu d’API : Boîte aux lettres 1.11

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

Mode Outlook applicable : Message Compose

Exemples

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

Obtient ou définit la description qui apparaît dans le champ d’objet d’un élément.

La propriété subject obtient ou définit l’intégralité de l’objet de l’élément, tel qu’il est envoyé par le serveur de messagerie.

La propriété subject renvoie un objet Subject qui fournit des méthodes pour obtenir et définir l’objet.

subject: Subject;

Valeur de propriété

Remarques

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

Mode Outlook applicable : Message Compose

Exemples

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

Permet d’accéder aux destinataires figurant sur la ligne À d’un message. Le type d’objet et le niveau d’accès dépendent du mode de l’élément en cours.

La propriété to renvoie un objet Recipients qui fournit des méthodes permettant d’obtenir ou de mettre à jour les destinataires figurant sur la ligne À du message. Toutefois, selon le client/la plateforme (Windows, Mac, etc.), des limites peuvent s’appliquer sur le nombre de destinataires que vous pouvez obtenir ou mettre à jour. Pour plus d’informations, consultez l’objet Destinataires .

to: Recipients;

Valeur de propriété

Remarques

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

Mode Outlook applicable : Message Compose

Exemples

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/30-recipients-and-attendees/get-set-to-message-compose.yaml

Office.context.mailbox.item.to.getAsync(function(asyncResult) {
  if (asyncResult.status === Office.AsyncResultStatus.Succeeded) {
    const msgTo = asyncResult.value;
    console.log("Message being sent to:");
    for (let i = 0; i < msgTo.length; i++) {
      console.log(msgTo[i].displayName + " (" + msgTo[i].emailAddress + ")");
    }
  } else {
    console.error(asyncResult.error);
  }
});

...

const email = (document.getElementById("emailTo") as HTMLInputElement).value;
const emailArray = [email];
Office.context.mailbox.item.to.setAsync(emailArray, function(asyncResult) {
  if (asyncResult.status === Office.AsyncResultStatus.Succeeded) {
    console.log("Succeeded in setting To field.");
  } else {
    console.error(asyncResult.error);
  }
});

Ajoute un fichier à un message ou un rendez-vous en pièce jointe.

La méthode addFileAttachmentAsync charge le fichier depuis l’URI spécifié et le joint à l’élément dans le formulaire de composition.

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

Paramètres

Retours

Remarques

Jeu d’API : Mailbox 1.1 pour Outlook sur Windows (classique) et sur Mac, Mailbox 1.8 pour Outlook sur le web et la nouvelle version d’Outlook sur Windows

Niveau d’autorisation minimal : lecture/écriture d’élément

Mode Outlook applicable : Message Compose

Important:

• Cette méthode n’est pas prise en charge dans Outlook sur iOS ou Android. Pour plus d’informations sur les API prises en charge dans Outlook Mobile, consultez API JavaScript Outlook prises en charge dans Outlook sur les appareils mobiles.

• À 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.

• Les images bitmap (BMP) ne sont pas prises en charge si elles sont ajoutées en tant que pièces jointes incluses.

• Dans les builds récentes d’Outlook classique sur Windows, un bogue a été introduit et ajoute de manière incorrecte un Authorization: Bearer en-tête à cette action (que ce soit à l’aide de cette API ou de l’interface utilisateur Outlook). Pour contourner ce problème, utilisez l’API introduite avec le addFileAttachmentFromBase64 jeu de conditions requises 1.8.

• L’URI du fichier à joindre doit prendre en charge la mise en cache en production. Le serveur qui héberge l’image ne doit pas renvoyer d’en-tête spécifiant no-cache, no-storeou des Cache-Control options similaires dans la réponse HTTP. Toutefois, lorsque vous développez le complément et apportez des modifications aux fichiers, la mise en cache peut vous empêcher de voir vos modifications. Nous vous recommandons d’utiliser Cache-Control des en-têtes pendant le développement.

• Vous pouvez utiliser le même URI avec la removeAttachmentAsync méthode pour supprimer la pièce jointe dans la même session.

Erreurs :

• AttachmentSizeExceeded : la pièce jointe est plus grande qu’autorisée.

• FileTypeNotSupported : la pièce jointe a une extension qui n’est pas autorisée.

• NumberOfAttachmentsExceeded : Le message ou le rendez-vous contient trop de pièces jointes.

Exemples

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

Ajoute un fichier à un message ou un rendez-vous en pièce jointe.

La méthode addFileAttachmentAsync charge le fichier depuis l’URI spécifié et le joint à l’élément dans le formulaire de composition.

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

Paramètres

Retours

Remarques

Jeu d’API : Mailbox 1.1 pour Outlook sur Windows (classique) et sur Mac, Mailbox 1.8 pour Outlook sur le web et la nouvelle version d’Outlook sur Windows

Niveau d’autorisation minimal : lecture/écriture d’élément

Mode Outlook applicable : Message Compose

Important:

• Cette méthode n’est pas prise en charge dans Outlook sur iOS ou Android. Pour plus d’informations sur les API prises en charge dans Outlook Mobile, consultez API JavaScript Outlook prises en charge dans Outlook sur les appareils mobiles.

• À 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.

• Les images bitmap (BMP) ne sont pas prises en charge si elles sont ajoutées en tant que pièces jointes incluses.

• Dans les builds récentes d’Outlook classique sur Windows, un bogue a été introduit et ajoute de manière incorrecte un Authorization: Bearer en-tête à cette action (que ce soit à l’aide de cette API ou de l’interface utilisateur Outlook). Pour contourner ce problème, utilisez l’API introduite avec le addFileAttachmentFromBase64 jeu de conditions requises 1.8.

• L’URI du fichier à joindre doit prendre en charge la mise en cache en production. Le serveur qui héberge l’image ne doit pas renvoyer d’en-tête spécifiant no-cache, no-storeou des Cache-Control options similaires dans la réponse HTTP. Toutefois, lorsque vous développez le complément et apportez des modifications aux fichiers, la mise en cache peut vous empêcher de voir vos modifications. Nous vous recommandons d’utiliser Cache-Control des en-têtes pendant le développement.

• Vous pouvez utiliser le même URI avec la removeAttachmentAsync méthode pour supprimer la pièce jointe dans la même session.

Erreurs :

• AttachmentSizeExceeded : la pièce jointe est plus grande qu’autorisée.

• FileTypeNotSupported : la pièce jointe a une extension qui n’est pas autorisée.

• NumberOfAttachmentsExceeded : Le message ou le rendez-vous contient trop de pièces jointes.

Ajoute un fichier à un message ou un rendez-vous en pièce jointe.

La addFileAttachmentFromBase64Async méthode charge le fichier à partir de l’encodage Base64 et le joint à l’élément dans le formulaire de composition. Cette méthode renvoie l’identificateur de pièce jointe dans l’objet asyncResult.value .

L’identificateur peut être utilisé avec la méthode removeAttachmentAsync pour supprimer la pièce jointe dans la même session.

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

Paramètres

Retours

Remarques

Jeu d’API : Boîte aux lettres 1.8

Niveau d’autorisation minimal : lecture/écriture d’élément

Mode Outlook applicable : Message Compose

Important:

• L’ajout d’un fichier Base64 incorporé à un message en mode composition est pris en charge dans Outlook sur Android et sur iOS. Pour plus d’informations sur les API prises en charge dans Outlook Mobile, consultez API JavaScript Outlook prises en charge dans Outlook sur les appareils mobiles.

• À compter du 30 mars 2026, après la fin de l’appel ou avec addFileAttachmentAsyncaddFileAttachmentFromBase64AsyncisInline la fin de l’appeltrue, 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.

• Si vous utilisez une API d’URL de données (par exemple), readAsDataURLvous devez supprimer le préfixe d’URL de données, puis envoyer le reste de la chaîne à cette API. Par exemple, si la chaîne complète est représentée par data:image/svg+xml;base64,<rest of Base64 string>, remove data:image/svg+xml;base64,.

• Pour ajouter une image encodée en Base64 au corps d’un message ou d’un rendez-vous en cours de composition, utilisez les méthodes de l’API Corps , telles que prependAsync, setSignatureAsyncou setAsync. Si vous utilisez Office.context.mailbox.item.body.setAsync pour insérer l’image, appelez Office.context.mailbox.item.body.getAsync d’abord pour obtenir le corps actuel de l’élément. Sinon, l’image ne s’affiche pas dans le corps une fois insérée. Pour obtenir un exemple, voir l’exemple Ajouter une image encodée en Base64 au message ou au corps du rendez-vous (Compose) dans Script Lab.

Erreurs :

• AttachmentSizeExceeded : la pièce jointe est plus grande qu’autorisée.

• FileTypeNotSupported : la pièce jointe a une extension qui n’est pas autorisée.

• NumberOfAttachmentsExceeded : Le message ou le rendez-vous contient trop de pièces jointes.

Exemples

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

Ajoute un fichier à un message ou un rendez-vous en pièce jointe.

La addFileAttachmentFromBase64Async méthode charge le fichier à partir de l’encodage Base64 et le joint à l’élément dans le formulaire de composition. Cette méthode renvoie l’identificateur de pièce jointe dans l’objet asyncResult.value .

L’identificateur peut être utilisé avec la méthode removeAttachmentAsync pour supprimer la pièce jointe dans la même session.

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

Paramètres

Retours

Remarques

Jeu d’API : Boîte aux lettres 1.8

Niveau d’autorisation minimal : lecture/écriture d’élément

Mode Outlook applicable : Message Compose

Important:

• L’ajout d’un fichier Base64 incorporé à un message en mode composition est pris en charge dans Outlook sur Android et sur iOS. Pour plus d’informations sur les API prises en charge dans Outlook Mobile, consultez API JavaScript Outlook prises en charge dans Outlook sur les appareils mobiles.

• À compter du 30 mars 2026, après la fin de l’appel ou avec addFileAttachmentAsyncaddFileAttachmentFromBase64AsyncisInline la fin de l’appeltrue, 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.

• Si vous utilisez une API d’URL de données (par exemple), readAsDataURLvous devez supprimer le préfixe d’URL de données, puis envoyer le reste de la chaîne à cette API. Par exemple, si la chaîne complète est représentée par data:image/svg+xml;base64,<rest of Base64 string>, remove data:image/svg+xml;base64,.

• Pour ajouter une image encodée en Base64 au corps d’un message ou d’un rendez-vous en cours de composition, utilisez les méthodes de l’API Corps , telles que prependAsync, setSignatureAsyncou setAsync. Si vous utilisez Office.context.mailbox.item.body.setAsync pour insérer l’image, appelez Office.context.mailbox.item.body.getAsync d’abord pour obtenir le corps actuel de l’élément. Sinon, l’image ne s’affiche pas dans le corps une fois insérée. Pour obtenir un exemple, voir l’exemple Ajouter une image encodée en Base64 au message ou au corps du rendez-vous (Compose) dans Script Lab.

Erreurs :

• AttachmentSizeExceeded : la pièce jointe est plus grande qu’autorisée.

• FileTypeNotSupported : la pièce jointe a une extension qui n’est pas autorisée.

• NumberOfAttachmentsExceeded : Le message ou le rendez-vous contient trop de pièces jointes.

ajoute un gestionnaire d’événements pour un événement pris en charge. Les événements sont uniquement disponibles dans les compléments du volet Office.

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

Paramètres

Retours

Remarques

Jeu d’API : Mailbox 1.7

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

Mode Outlook applicable : Message Compose

Important : Pour obtenir la liste des événements pris en charge sur un élément de courrier, voir Modèle objet d’élément Outlook.

Exemples

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

ajoute un gestionnaire d’événements pour un événement pris en charge. Les événements sont uniquement disponibles dans les compléments du volet Office.

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

Paramètres

Retours

Remarques

Jeu d’API : Mailbox 1.7

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

Mode Outlook applicable : Message Compose

Important : Pour obtenir la liste des événements pris en charge sur un élément de courrier, voir Modèle objet d’élément Outlook.

Ajoute un élément Exchange, comme un message, en pièce jointe au message ou au rendez-vous.

La méthode addItemAttachmentAsync joint l’élément avec l’identificateur Exchange spécifié à l’élément du formulaire de composition. Si vous spécifiez une fonction de rappel, la méthode est appelée avec un paramètre, , qui contient soit l’identificateur de pièce jointe, asyncResultsoit un code indiquant une erreur survenue lors de l’attachement de l’élément. Vous pouvez utiliser le paramètre options pour transmettre des informations d’état à la fonction de rappel, si nécessaire.

L’identificateur peut être utilisé avec la méthode removeAttachmentAsync pour supprimer la pièce jointe dans la même session.

Si votre complément Office s’exécute dans Outlook sur le web ou dans la nouvelle version d’Outlook sur Windows, la addItemAttachmentAsync méthode peut joindre des éléments à des éléments autres que celui que vous modifiez. Toutefois, cela n’est pas pris en charge et n’est pas recommandé.

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

Paramètres

Retours

Remarques

Jeu d’API : Boîte aux lettres 1.1

Niveau d’autorisation minimal : lecture/écriture d’élément

Mode Outlook applicable : Message Compose

Erreurs :

• NumberOfAttachmentsExceeded : Le message ou le rendez-vous contient trop de pièces jointes.

Exemples

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

Ajoute un élément Exchange, comme un message, en pièce jointe au message ou au rendez-vous.

La méthode addItemAttachmentAsync joint l’élément avec l’identificateur Exchange spécifié à l’élément du formulaire de composition. Si vous spécifiez une fonction de rappel, la méthode est appelée avec un paramètre, , qui contient soit l’identificateur de pièce jointe, asyncResultsoit un code indiquant une erreur survenue lors de l’attachement de l’élément. Vous pouvez utiliser le paramètre options pour transmettre des informations d’état à la fonction de rappel, si nécessaire.

L’identificateur peut être utilisé avec la méthode removeAttachmentAsync pour supprimer la pièce jointe dans la même session.

Si votre complément Office s’exécute dans Outlook sur le web ou dans la nouvelle version d’Outlook sur Windows, la addItemAttachmentAsync méthode peut joindre des éléments à des éléments autres que celui que vous modifiez. Toutefois, cela n’est pas pris en charge et n’est pas recommandé.

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

Paramètres

Retours

Remarques

Jeu d’API : Boîte aux lettres 1.1

Niveau d’autorisation minimal : lecture/écriture d’élément

Mode Outlook applicable : Message Compose

Erreurs :

• NumberOfAttachmentsExceeded : Le message ou le rendez-vous contient trop de pièces jointes.

Ferme l’élément en cours qui est composé.

Le comportement de la méthode close dépend de l’état actuel de l’élément en cours de composition. Si les modifications apportées à l’élément n’ont pas été enregistrées, le client invite l’utilisateur à enregistrer, ignorer ou fermer l’action.

Dans Outlook sur Windows (classique) et sur Mac, la méthode n’a close aucun effet sur une réponse dans le volet de lecture.

close(): void;

Retours

Remarques

Jeu d’API : Boîte aux lettres 1.3

Niveau d’autorisation minimal : restreint

Mode Outlook applicable : Message Compose

Important : Dans Outlook sur le web et la nouvelle version d’Outlook sur Windows, si l’élément est un rendez-vous et qu’il a déjà été enregistré à l’aide saveAsyncde , l’utilisateur est invité à enregistrer, ignorer ou annuler même si aucune modification n’a eu lieu depuis le dernier enregistrement de l’élément.

Conseil : utilisez la méthode closeAsync au lieu de la close méthode si vous souhaitez que votre complément :

• Supprimez automatiquement un message en cours de rédaction sans inviter l’utilisateur via la boîte de dialogue Enregistrer.

• Déterminez quand un utilisateur annule la boîte de dialogue Enregistrer l’élément d’un message en cours de composition.

• Fermer une réponse dans le volet de lecture ou un brouillon existant.

Exemples

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

Ferme le message actuel en cours de composition avec l’option permettant d’ignorer les modifications non enregistrées. Le message en cours de composition peut être un nouveau message, une réponse ou un brouillon existant.

closeAsync(options: Office.AsyncContextOptions & { discardItem: boolean }, callback?: (asyncResult: Office.AsyncResult<void>) => void): void;

Paramètres

Retours

Remarques

Jeu d’API : Boîte aux lettres 1.14

Niveau d’autorisation minimal : lecture/écriture d’élément

Mode Outlook applicable : Message Compose

Important:

• La closeAsync méthode est uniquement prise en charge dans les implémentations de volets Office et de commandes de fonction. Il n’est pas pris en charge dans les gestionnaires basés sur des événements ou lesscénarios de sélection multiple d’éléments.

• Lorsque la closeAsync méthode ferme et ignore le message actuel, le complément qui l’a appelé cesse de s’exécuter.

Erreurs :

• The operation was cancelled by the user : l’utilisateur sélectionne Annuler dans la boîte de dialogue d’enregistrement et la discardItem propriété n’est pas définie ou est définie sur false.

• The operation is not supported : la closeAsync méthode tente de fermer une réponse dans le volet de lecture ou un brouillon existant et la discardItem propriété n’est pas définie ou est définie sur false.

Ferme le nouveau message en cours de composition.

Le comportement d’un nouveau message en cours de rédaction varie selon que le message contient ou non des modifications non enregistrées. Si aucune modification n’a été effectuée, le message est fermé sans boîte de dialogue d’enregistrement. En revanche, si le message contient des modifications non enregistrées, une boîte de dialogue d’enregistrement s’affiche et invite l’utilisateur à enregistrer un brouillon, à supprimer les modifications ou à annuler l’opération.

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

Paramètres

Retours

Remarques

Jeu d’API : Boîte aux lettres 1.14

Niveau d’autorisation minimal : lecture/écriture d’élément

Mode Outlook applicable : Message Compose

Important:

• La closeAsync méthode est uniquement prise en charge dans les implémentations de volets Office et de commandes de fonction. Il n’est pas pris en charge dans les gestionnaires basés sur des événements ou lesscénarios de sélection multiple d’éléments.

• Lorsque la closeAsync méthode ferme et ignore le message actuel, le complément qui l’a appelé cesse de s’exécuter.

Erreurs :

• The operation was cancelled by the user : l’utilisateur sélectionne Annuler dans la boîte de dialogue d’enregistrement.

• The operation is not supported : la closeAsync méthode tente de fermer une réponse dans le volet de lecture ou un brouillon existant.

Exemples

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/25-item-save-and-close/close-async.yaml

// This snippet closes the current message being composed and discards any unsaved changes when the optional property, discardItem, is set to true.
// The API call works on a new message being composed, a reply, or an existing draft.
// When discardItem is set to false or isn't defined on a new message with unsaved changes, the user is prompted to save a draft, discard the changes, or cancel the close operation.
Office.context.mailbox.item.closeAsync(
  { discardItem: true },
  (asyncResult) => {
    if (asyncResult.status === Office.AsyncResultStatus.Failed) {
      console.log("Action failed with error: " + asyncResult.error.message);
      return;
    }
  });

Désactive la signature du client Outlook.

Le comportement de cette méthode dépend du client que le complément exécute.

• Dans Outlook sur le web et la nouvelle version d’Outlook sur Windows, l’option de signature pour les nouveaux messages, réponses et transferts est désactivée. Une signature sélectionnée est également désactivée par la méthode.

• Dans Outlook sur Windows (classique) et sur Mac, la signature dans les sections Nouveaux messages et Réponses/Transferts du compte d’envoi est définie sur (aucun).

• Dans Outlook sur Android et sur iOS, la signature enregistrée sur l’appareil mobile est effacée.

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

Paramètres

Retours

Remarques

Jeu d’API : Boîte aux lettres 1.10

Niveau d’autorisation minimal : lecture/écriture d’élément

Mode Outlook applicable : Message Compose

Important : cette méthode est prise en charge dans la fonctionnalité Message Compose sur Outlook sur Android et sur iOS à partir de la version 4.2352.0. Pour plus d’informations sur les API prises en charge dans Outlook Mobile, consultez API JavaScript Outlook prises en charge dans Outlook sur les appareils mobiles.

Exemples

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

Désactive la signature du client Outlook.

Le comportement de cette méthode dépend du client que le complément exécute.

• Dans Outlook sur le web et la nouvelle version d’Outlook sur Windows, l’option de signature pour les nouveaux messages, réponses et transferts est désactivée. Une signature sélectionnée est également désactivée par la méthode.

• Dans Outlook sur Windows (classique) et sur Mac, la signature dans les sections Nouveaux messages et Réponses/Transferts du compte d’envoi est définie sur (aucun).

• Dans Outlook sur Android et sur iOS, la signature enregistrée sur l’appareil mobile est effacée.

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

Paramètres

Retours

Remarques

Jeu d’API : Boîte aux lettres 1.10

Niveau d’autorisation minimal : lecture/écriture d’élément

Mode Outlook applicable : Message Compose

Important : cette méthode est prise en charge dans la fonctionnalité Message Compose sur Outlook sur Android et sur iOS à partir de la version 4.2352.0. Pour plus d’informations sur les API prises en charge dans Outlook Mobile, consultez API JavaScript Outlook prises en charge dans Outlook sur les appareils mobiles.

Récupère une pièce jointe d’un message ou d’un rendez-vous et la renvoie en tant qu’objet AttachmentContent .

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

Paramètres

Retours

Remarques

Jeu d’API : Boîte aux lettres 1.8

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

Mode Outlook applicable : Message Compose

Important:

• La getAttachmentContentAsync méthode obtient la pièce jointe avec l’identifiant spécifié de l’élément. Il est préférable d’obtenir l’identificateur de la pièce jointe à partir d’un getAttachmentsAsync appel, puis, dans la même session, d’utiliser cet identificateur pour récupérer la pièce jointe.

• À compter du 30 mars 2026, après la fin de l’appel ou avec addFileAttachmentAsyncaddFileAttachmentFromBase64AsyncisInline la fin de l’appeltrue, 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.

• Dans Outlook sur le web et la nouvelle version d’Outlook sur Windows, getAttachmentContentAsync ne prend pas en charge les pièces jointes ajoutées à l’aide de l’option Charger et partager.

• Dans Outlook sur le web, sur les appareils mobiles et dans le nouvel Outlook sur Windows, l’identificateur de pièce jointe est valide uniquement dans la même session. Une session se termine lorsque l’utilisateur ferme l’application ou si l’utilisateur commence à composer un formulaire en ligne, puis sort du formulaire pour continuer dans une fenêtre séparée.

Erreurs :

• AttachmentTypeNotSupported : le type de pièce jointe n’est pas pris en charge. Les types non pris en charge incluent les images incorporées au format RTF ou les types de pièces jointes d’éléments autres que les éléments de courrier électronique ou de calendrier (tels qu’un élément de contact ou de tâche).

• InvalidAttachmentId : l’identificateur de pièce jointe n’existe pas.

Exemples

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

Récupère une pièce jointe d’un message ou d’un rendez-vous et la renvoie en tant qu’objet AttachmentContent .

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

Paramètres

Retours

Remarques

Jeu d’API : Boîte aux lettres 1.8

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

Mode Outlook applicable : Message Compose

Important:

• La getAttachmentContentAsync méthode obtient la pièce jointe avec l’identifiant spécifié de l’élément. Il est préférable d’obtenir l’identificateur de la pièce jointe à partir d’un getAttachmentsAsync appel, puis, dans la même session, d’utiliser cet identificateur pour récupérer la pièce jointe.

• À compter du 30 mars 2026, après la fin de l’appel ou avec addFileAttachmentAsyncaddFileAttachmentFromBase64AsyncisInline la fin de l’appeltrue, 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.

• Dans Outlook sur le web et la nouvelle version d’Outlook sur Windows, getAttachmentContentAsync ne prend pas en charge les pièces jointes ajoutées à l’aide de l’option Charger et partager.

• Dans Outlook sur le web, sur les appareils mobiles et dans le nouvel Outlook sur Windows, l’identificateur de pièce jointe est valide uniquement dans la même session. Une session se termine lorsque l’utilisateur ferme l’application ou si l’utilisateur commence à composer un formulaire en ligne, puis sort du formulaire pour continuer dans une fenêtre séparée.

Erreurs :

• AttachmentTypeNotSupported : le type de pièce jointe n’est pas pris en charge. Les types non pris en charge incluent les images incorporées au format RTF ou les types de pièces jointes d’éléments autres que les éléments de courrier électronique ou de calendrier (tels qu’un élément de contact ou de tâche).

• InvalidAttachmentId : l’identificateur de pièce jointe n’existe pas.

Récupère les pièces jointes de l’élément sous forme de tableau.

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

Paramètres

Retours

Remarques

Jeu d’API : Boîte aux lettres 1.8

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

Mode Outlook applicable : Message Compose

Important:

• À compter du 30 mars 2026, après la fin de l’appel ou avec addFileAttachmentAsyncaddFileAttachmentFromBase64AsyncisInline la fin de l’appeltrue, 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.

• Dans Outlook sur le web et la nouvelle version d’Outlook sur Windows, les utilisateurs peuvent sélectionner l’option Charger et partager pour charger une pièce jointe dans OneDrive et inclure un lien vers le fichier dans l’élément de courrier. Toutefois, comme seul un lien est inclus, getAttachmentsAsync ne renvoie pas cette pièce jointe.

• Pour les pièces jointes de type Office.MailboxEnums.AttachmentType.Item, la taille et le contenu sérialisé retourné par getAttachmentsAsync peuvent différer entre les appels effectués à partir d’un gestionnaire d’événements OnMessageSend ou OnAppointmentSend . Pour détecter de manière fiable les modifications apportées aux pièces jointes, gérez plutôt l’événement OnMessageAttachmentsChanged ou OnAppointmentAttachmentsChanged .

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

Récupère les pièces jointes de l’élément sous forme de tableau.

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

Paramètres

Retours

Remarques

Jeu d’API : Boîte aux lettres 1.8

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

Mode Outlook applicable : Message Compose

Important:

• À compter du 30 mars 2026, après la fin de l’appel ou avec addFileAttachmentAsyncaddFileAttachmentFromBase64AsyncisInline la fin de l’appeltrue, 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.

• Dans Outlook sur le web et la nouvelle version d’Outlook sur Windows, les utilisateurs peuvent sélectionner l’option Charger et partager pour charger une pièce jointe dans OneDrive et inclure un lien vers le fichier dans l’élément de courrier. Toutefois, comme seul un lien est inclus, getAttachmentsAsync ne renvoie pas cette pièce jointe.

• Pour les pièces jointes de type Office.MailboxEnums.AttachmentType.Item, la taille et le contenu sérialisé retourné par getAttachmentsAsync peuvent différer entre les appels effectués à partir d’un gestionnaire d’événements OnMessageSend ou OnAppointmentSend . Pour détecter de manière fiable les modifications apportées aux pièces jointes, gérez plutôt l’événement OnMessageAttachmentsChanged ou OnAppointmentAttachmentsChanged .

Spécifie le type de composition du message et son type de coercition. Le message peut être un nouveau, une réponse ou un transfert. Le type de coercition peut être HTML ou texte brut.

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

Paramètres

Retours

Objet avec ComposeType et CoercionType énumération pour l’élément de message.

Remarques

Jeu d’API : Boîte aux lettres 1.10

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

Mode Outlook applicable : Message Compose

Important : Cette méthode est prise en charge dans Outlook sur Android et sur iOS à partir de la version 4.2352.0. Pour plus d’informations sur les API prises en charge dans Outlook Mobile, consultez API JavaScript Outlook prises en charge dans Outlook sur les appareils mobiles.

Spécifie le type de composition du message et son type de coercition. Le message peut être un nouveau, une réponse ou un transfert. Le type de coercition peut être HTML ou texte brut.

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

Paramètres

Retours

Objet avec ComposeType et CoercionType énumération pour l’élément de message.

Remarques

Jeu d’API : Boîte aux lettres 1.10

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

Mode Outlook applicable : Message Compose

Important : Cette méthode est prise en charge dans Outlook sur Android et sur iOS à partir de la version 4.2352.0. Pour plus d’informations sur les API prises en charge dans Outlook Mobile, consultez API JavaScript Outlook prises en charge dans Outlook sur les appareils mobiles.

Exemples

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

// Get the compose type of the current message.
Office.context.mailbox.item.getComposeTypeAsync(function(asyncResult) {
  if (asyncResult.status === Office.AsyncResultStatus.Succeeded) {
    console.log(
      "getComposeTypeAsync succeeded with composeType: " +
        asyncResult.value.composeType +
        " and coercionType: " +
        asyncResult.value.coercionType
    );
  } else {
    console.error(asyncResult.error);
  }
});

Obtient la position codée en Base64 du message actuel dans un thread de conversation.

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

Paramètres

Retours

Remarques

Jeu d’API : Boîte aux lettres 1.14

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

Mode Outlook applicable : Message Compose

Conseil : vous pouvez utiliser l’index de conversation pour localiser un message dans un thread de conversation. Utilisez ensuite son contenu pour fournir un contexte au message actuel en cours de composition.

Obtient la position codée en Base64 du message actuel dans un thread de conversation.

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

Paramètres

Retours

Remarques

Jeu d’API : Boîte aux lettres 1.14

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

Mode Outlook applicable : Message Compose

Conseil : vous pouvez utiliser l’index de conversation pour localiser un message dans un thread de conversation. Utilisez ensuite son contenu pour fournir un contexte au message actuel en cours de composition.

Exemples

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

// This snippet returns the Base64-encoded position of the current message in a conversation thread (PR_CONVERSATION_INDEX).
// The API call is supported on a message being composed and isn't supported on read items or appointments.
Office.context.mailbox.item.getConversationIndexAsync((result) => {
   if (result.status === Office.AsyncResultStatus.Failed) {
      console.log(result.error.message);
      return;
   }
   
   const conversationIndex = result.value;
   if (conversationIndex) {
      console.log("Position in the conversation thread: " + conversationIndex);
   } else {
      console.log("The current message doesn't belong to a conversation thread.");
   }
});

Récupère les données d’initialisation transmises lorsque le complément est activé par un message actionnable.

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

Paramètres

Retours

Remarques

Jeu d’API : Boîte aux lettres 1.8

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

Mode Outlook applicable : Message Compose

Exemples

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

Récupère les données d’initialisation transmises lorsque le complément est activé par un message actionnable.

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

Paramètres

Retours

Remarques

Jeu d’API : Boîte aux lettres 1.8

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

Mode Outlook applicable : Message Compose

Obtient la classe d’éléments services Web Exchange du message sélectionné.

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

Paramètres

Retours

Remarques

Jeu d’API : Boîte aux lettres 1.14

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

Mode Outlook applicable : Message Compose

Important:

Le tableau suivant répertorie les classes de messages par défaut.

Obtient la classe d’éléments services Web Exchange du message sélectionné.

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

Paramètres

Retours

Remarques

Jeu d’API : Boîte aux lettres 1.14

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

Mode Outlook applicable : Message Compose

Important:

Le tableau suivant répertorie les classes de messages par défaut.

Exemples

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

// This snippet returns the Exchange Web Services item class property (PR_MESSAGE_CLASS) of the current message.
// The API call is only supported on a message being composed.
Office.context.mailbox.item.getItemClassAsync((asyncResult) => {
  if (asyncResult.status === Office.AsyncResultStatus.Failed) {
    console.log("Action failed with error: " + asyncResult.error.message);
    return;
  }

  console.log("Item class of the current message: " + asyncResult.value);
});

Obtient de manière asynchrone l’identifiant d’élément EWS (services Web Exchange) d’un élément enregistré.

Lorsqu’elle est invoquée, cette méthode retourne l’ID d’élément via la fonction de rappel.

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

Paramètres

Retours

Remarques

Jeu d’API : Boîte aux lettres 1.8

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

Mode Outlook applicable : Message Compose

Important:

• L’ID d’élément renvoyé n’est pas identique à l’ID d’entrée Outlook ou à l’ID utilisé par l’API REST Outlook. Avant d’effectuer des appels d’API REST en utilisant cette valeur, elle doit être convertie en .Office.context.mailbox.convertToRestId

• Si votre complément appelle getItemIdAsync (par exemple, pour obtenir un ID d’élément à utiliser avec EWS ou l’API REST), n’oubliez pas que lorsqu’Outlook est en mode mis en cache, la synchronisation de l’élément avec le serveur peut prendre un certain temps. Tant que l’élément n’est pas synchronisé, l’ID de l’élément n’est pas reconnu et son utilisation renvoie une erreur.

Erreurs :

• ItemNotSaved : l’ID ne peut pas être récupéré tant que l’élément n’est pas enregistré.

Obtient de manière asynchrone l’identifiant d’élément EWS (services Web Exchange) d’un élément enregistré.

Lorsqu’elle est invoquée, cette méthode retourne l’ID d’élément via la fonction de rappel.

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

Paramètres

Retours

Remarques

Jeu d’API : Boîte aux lettres 1.8

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

Mode Outlook applicable : Message Compose

Important:

• L’ID d’élément renvoyé n’est pas identique à l’ID d’entrée Outlook ou à l’ID utilisé par l’API REST Outlook. Avant d’effectuer des appels d’API REST en utilisant cette valeur, elle doit être convertie en .Office.context.mailbox.convertToRestId

• Si votre complément appelle getItemIdAsync (par exemple, pour obtenir un ID d’élément à utiliser avec EWS ou l’API REST), n’oubliez pas que lorsqu’Outlook est en mode mis en cache, la synchronisation de l’élément avec le serveur peut prendre un certain temps. Tant que l’élément n’est pas synchronisé, l’ID de l’élément n’est pas reconnu et son utilisation renvoie une erreur.

Erreurs :

• ItemNotSaved : l’ID ne peut pas être récupéré tant que l’élément n’est pas enregistré.

Exemples

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

Renvoie de manière asynchrone les données sélectionnées à partir de l’objet ou du corps d’un message.

S’il n’y a pas de sélection mais que le curseur se trouve dans le corps ou le sujet, la méthode renvoie une chaîne vide pour les données sélectionnées. Si un champ autre que le corps ou l’objet est sélectionné, la méthode renvoie l’erreur InvalidSelection.

Pour accéder aux données sélectionnées à partir de la fonction de rappel, appelez asyncResult.value.data. Pour accéder à la propriété source d’où provient la sélection, appelez asyncResult.value.sourceProperty, qui sera soit body ou subject.

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

Paramètres

Retours

Les données sélectionnées sous la forme d’une chaîne dont le format est déterminé par coercionType.

Remarques

Jeu d’API : Boîte aux lettres 1.2

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

Mode Outlook applicable : Message Compose

Exemples

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

Renvoie de manière asynchrone les données sélectionnées à partir de l’objet ou du corps d’un message.

S’il n’y a pas de sélection mais que le curseur se trouve dans le corps ou le sujet, la méthode renvoie une chaîne vide pour les données sélectionnées. Si un champ autre que le corps ou l’objet est sélectionné, la méthode renvoie l’erreur InvalidSelection.

Pour accéder aux données sélectionnées à partir de la fonction de rappel, appelez asyncResult.value.data. Pour accéder à la propriété source d’où provient la sélection, appelez asyncResult.value.sourceProperty, qui sera soit body ou subject.

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

Paramètres

Retours

Les données sélectionnées sous la forme d’une chaîne dont le format est déterminé par coercionType.

Remarques

Jeu d’API : Boîte aux lettres 1.2

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

Mode Outlook applicable : Message Compose

Exemples

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

Obtient les propriétés d’un rendez-vous ou d’un message dans un dossier partagé ou une boîte aux lettres partagée.

Pour plus d’informations sur l’utilisation de cette API, voir Activer des scénarios de dossiers partagés et de boîtes aux lettres partagées dans un complément Outlook.

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

Paramètres

Retours

Remarques

Jeu d’API : Boîte aux lettres 1.8 pour la prise en charge des dossiers partagés, Boîte aux lettres 1.13 pour la prise en charge des boîtes aux lettres partagées

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

Mode Outlook applicable : Message Compose

Remarque : cette méthode n’est pas prise en charge dans Outlook sur iOS ou sur Android.

Important : en mode de Composition de message, cette API n’est pas prise en charge dans Outlook sur le web ou sur Windows (nouveau et classique), sauf si les conditions suivantes sont remplies.

a. Accès délégué/Dossiers partagés

1. Le propriétaire de la boîte aux lettres commence à envoyer un message. Il peut s’agir d’un nouveau message, d’une réponse ou d’un transfert.

2. Ils enregistrent le message, puis le déplacent de leur propre dossier Brouillons vers un dossier partagé avec le délégué.

3. Le délégué ouvre le brouillon à partir du dossier partagé, puis poursuit sa composition.

b. Boîte aux lettres partagée ouverte dans le même panneau que la boîte aux lettres principale de l’utilisateur (web, Windows classique) ou boîte aux lettres partagée qui n’a pas été promue en compte complet (nouveau Windows)

1. L’utilisateur de boîte aux lettres partagée commence un message. Il peut s’agir d’un nouveau message, d’une réponse ou d’un transfert.

2. Ils enregistrent le message, puis le déplacent de leur propre dossier Brouillons vers un dossier dans la boîte aux lettres partagée.

3. Un autre utilisateur de boîte aux lettres partagée ouvre le brouillon à partir de la boîte aux lettres partagée, puis continue à composer.

Une fois ces conditions remplies, le message devient disponible dans un contexte partagé et les compléments qui prennent en charge ces scénarios partagés peuvent obtenir les propriétés partagées de l’élément. Une fois le message envoyé, il se trouve généralement dans le dossier Éléments envoyés de la boîte aux lettres personnelle de l’expéditeur.

La getSharedPropertiesAsync méthode est prise en charge sur les plateformes suivantes sans conditions supplémentaires.

• Outlook sur le web lorsque la boîte aux lettres partagée est ouverte dans un onglet ou une fenêtre distincte à l’aide de l’option Ouvrir une autre boîte aux lettres.

• Nouvel Outlook sur Windows lorsque la boîte aux lettres partagée est promue compte complet.

Obtient les propriétés d’un rendez-vous ou d’un message dans un dossier partagé ou une boîte aux lettres partagée.

Pour plus d’informations sur l’utilisation de cette API, voir Activer des scénarios de dossiers partagés et de boîtes aux lettres partagées dans un complément Outlook.

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

Paramètres

Retours

Remarques

Jeu d’API : Boîte aux lettres 1.8 pour la prise en charge des dossiers partagés, Boîte aux lettres 1.13 pour la prise en charge des boîtes aux lettres partagées

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

Mode Outlook applicable : Message Compose

Remarque : cette méthode n’est pas prise en charge dans Outlook sur iOS ou sur Android.

Important : en mode de Composition de message, cette API n’est pas prise en charge dans Outlook sur le web ou sur Windows (nouveau et classique), sauf si les conditions suivantes sont remplies.

a. Accès délégué/Dossiers partagés

1. Le propriétaire de la boîte aux lettres commence à envoyer un message. Il peut s’agir d’un nouveau message, d’une réponse ou d’un transfert.

2. Ils enregistrent le message, puis le déplacent de leur propre dossier Brouillons vers un dossier partagé avec le délégué.

3. Le délégué ouvre le brouillon à partir du dossier partagé, puis poursuit sa composition.

b. Boîte aux lettres partagée ouverte dans le même panneau que la boîte aux lettres principale de l’utilisateur (web, Windows classique) ou boîte aux lettres partagée qui n’a pas été promue en compte complet (nouveau Windows)

1. L’utilisateur de boîte aux lettres partagée commence un message. Il peut s’agir d’un nouveau message, d’une réponse ou d’un transfert.

2. Ils enregistrent le message, puis le déplacent de leur propre dossier Brouillons vers un dossier dans la boîte aux lettres partagée.

3. Un autre utilisateur de boîte aux lettres partagée ouvre le brouillon à partir de la boîte aux lettres partagée, puis continue à composer.

Une fois ces conditions remplies, le message devient disponible dans un contexte partagé et les compléments qui prennent en charge ces scénarios partagés peuvent obtenir les propriétés partagées de l’élément. Une fois le message envoyé, il se trouve généralement dans le dossier Éléments envoyés de la boîte aux lettres personnelle de l’expéditeur.

La getSharedPropertiesAsync méthode est prise en charge sur les plateformes suivantes sans conditions supplémentaires.

• Outlook sur le web lorsque la boîte aux lettres partagée est ouverte dans un onglet ou une fenêtre distincte à l’aide de l’option Ouvrir une autre boîte aux lettres.

• Nouvel Outlook sur Windows lorsque la boîte aux lettres partagée est promue compte complet.

Exemples

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

Obtient si la signature client est activée.

Dans Outlook sur Windows (classique) et sur Mac, l’appel d’API est renvoyé true si la signature par défaut pour les nouveaux messages, réponses ou transferts est définie sur un modèle pour le compte Outlook d’envoi. Dans Outlook sur le web et la nouvelle version d’Outlook sur Windows, l’appel d’API est renvoyé true si la signature est activée pour les typesnewMail de composition , reply, ou forward. Si les paramètres sont définis sur « (aucun) » dans Outlook sur Windows (classique) ou sur Mac, ou désactivés dans Outlook sur le web ou dans la nouvelle version d’Outlook sur Windows, l’appel d’API retourne false.

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

Paramètres

Retours

Remarques

Jeu d’API : Boîte aux lettres 1.10

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

Mode Outlook applicable : Message Compose

Exemples

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

Obtient si la signature client est activée.

Dans Outlook sur Windows (classique) et sur Mac, l’appel d’API est renvoyé true si la signature par défaut pour les nouveaux messages, réponses ou transferts est définie sur un modèle pour le compte Outlook d’envoi. Dans Outlook sur le web et la nouvelle version d’Outlook sur Windows, l’appel d’API est renvoyé true si la signature est activée pour les typesnewMail de composition , reply, ou forward. Si les paramètres sont définis sur « (aucun) » dans Outlook sur Windows (classique) ou sur Mac, ou désactivés dans Outlook sur le web ou dans la nouvelle version d’Outlook sur Windows, l’appel d’API retourne false.

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

Paramètres

Retours

Remarques

Jeu d’API : Boîte aux lettres 1.10

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

Mode Outlook applicable : Message Compose

Charge de manière asynchrone les propriétés personnalisées de ce complément vers l’élément sélectionné.

Les propriétés personnalisées sont stockées sous forme de paires clé-valeur sur une base par application et par élément. Cette méthode renvoie un objet CustomProperties dans le rappel, qui fournit des méthodes pour accéder aux propriétés personnalisées spécifiques à l’élément actuel et au complément actuel. Les propriétés personnalisées ne sont pas chiffrées sur l’élément, il ne doit donc pas être utilisé comme stockage sécurisé.

Les propriétés personnalisées sont fournies sous la forme d’un objet CustomProperties dans la propriété asyncResult.value. Cet objet peut être utilisé pour obtenir, définir, enregistrer et supprimer des propriétés personnalisées de l’élément de courrier.

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

Paramètres

Retours

Remarques

Jeu d’API : Boîte aux lettres 1.1

Pour en savoir plus sur les propriétés personnalisées, voir Obtenir et définir les métadonnées d’un complément Outlook.

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

Mode Outlook applicable : Message Compose

Exemples

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

Supprime une pièce jointe d’un message ou d’un rendez-vous.

La méthode removeAttachmentAsync supprime la pièce jointe avec l’identificateur spécifié de l’élément. Nous vous recommandons vivement de supprimer une pièce jointe à l’aide de son identificateur uniquement si la même application de messagerie a ajouté cette pièce jointe au cours de la même session. Dans Outlook sur le web, sur les appareils mobiles et dans la nouvelle version d’Outlook sur Windows, l’identificateur de pièce jointe est valide uniquement au sein de la même session. Une session se termine lorsque l’utilisateur ferme l’application ou si l’utilisateur commence à composer un formulaire en ligne, puis sort du formulaire pour continuer dans une fenêtre séparée.

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

Paramètres

Retours

Remarques

Jeu d’API : Boîte aux lettres 1.1

Niveau d’autorisation minimal : lecture/écriture d’élément

Mode Outlook applicable : Message Compose

Important : cette removeAttachmentAsync méthode ne supprime pas les pièces jointes d’un courrier. Pour supprimer une pièce jointe incorporée, commencez par obtenir le corps de l’élément, puis supprimez toutes les références de la pièce jointe de son contenu. Utilisez les API Office.Body pour obtenir et définir le corps d’un élément.

Erreurs :

• InvalidAttachmentId : l’identificateur de pièce jointe n’existe pas.

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

Supprime une pièce jointe d’un message ou d’un rendez-vous.

La méthode removeAttachmentAsync supprime la pièce jointe avec l’identificateur spécifié de l’élément. Nous vous recommandons vivement de supprimer une pièce jointe à l’aide de son identificateur uniquement si la même application de messagerie a ajouté cette pièce jointe au cours de la même session. Dans Outlook sur le web, sur les appareils mobiles et dans la nouvelle version d’Outlook sur Windows, l’identificateur de pièce jointe est valide uniquement au sein de la même session. Une session se termine lorsque l’utilisateur ferme l’application ou si l’utilisateur commence à composer un formulaire en ligne, puis sort du formulaire pour continuer dans une fenêtre séparée.

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

Paramètres

Retours

Remarques

Jeu d’API : Boîte aux lettres 1.1

Niveau d’autorisation minimal : lecture/écriture d’élément

Mode Outlook applicable : Message Compose

Important : cette removeAttachmentAsync méthode ne supprime pas les pièces jointes d’un courrier. Pour supprimer une pièce jointe incorporée, commencez par obtenir le corps de l’élément, puis supprimez toutes les références de la pièce jointe de son contenu. Utilisez les API Office.Body pour obtenir et définir le corps d’un élément.

Erreurs :

• InvalidAttachmentId : l’identificateur de pièce jointe n’existe pas.

Supprime les gestionnaires d’événements pour un type d’événement pris en charge. Les événements sont uniquement disponibles dans les compléments du volet Office.

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

Paramètres

Retours

Remarques

Jeu d’API : Mailbox 1.7

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

Mode Outlook applicable : Message Compose

Important : Pour obtenir la liste des événements pris en charge sur un élément de courrier, voir Modèle objet d’élément Outlook.

Supprime les gestionnaires d’événements pour un type d’événement pris en charge. Les événements sont uniquement disponibles dans les compléments du volet Office.

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

Paramètres

Retours

Remarques

Jeu d’API : Mailbox 1.7

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

Mode Outlook applicable : Message Compose

Important : Pour obtenir la liste des événements pris en charge sur un élément de courrier, voir Modèle objet d’élément Outlook.

Exemples

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

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

Enregistre de manière asynchrone le message actuel en tant que brouillon.

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

Paramètres

Retours

Remarques

Jeu d’API : Boîte aux lettres 1.3

Niveau d’autorisation minimal : lecture/écriture d’élément

Mode Outlook applicable : Message Compose

Important:

• Dans Outlook sur le web, la nouvelle version d’Outlook sur Windows ou Outlook classique sur Windows en mode en ligne (mode non mis en cache), l’élément est enregistré sur le serveur. Dans Outlook en mode mis en cache, l’élément est enregistré dans le cache local.

• Lorsque vous travaillez avec du contenu au format HTML, il est important de noter que le client Outlook peut modifier le contenu. Cela signifie que les appels ultérieurs à des méthodes telles Body.getAsyncque , Body.setAsyncet même saveAsync peuvent ne pas aboutir au même contenu.

• L’identificateur renvoyé est identique à celui d’élément EWS (services Web Exchange). L’ID d’élément renvoyé n’est pas identique à l’ID d’entrée Outlook ou à l’ID utilisé par l’API REST Outlook. Avant d’effectuer des appels d’API REST en utilisant cette valeur, elle doit être convertie en .Office.context.mailbox.convertToRestId

• Si votre complément appelle saveAsync pour obtenir un ID d’élément à utiliser avec EWS ou l’API REST, n’oubliez pas que lorsqu’Outlook est en mode mis en cache, la synchronisation effective de l’élément avec le serveur peut prendre un certain temps. Tant que l’élément n’est pas synchronisé, l’utilisation de l’ID d’élément renvoie une erreur.

• Dans Outlook sur le web et la nouvelle version d’Outlook sur Windows, le compte de boîte aux lettres dans lequel un brouillon est enregistré varie selon l’appel saveAsync d’un message envoyé à partir d’un compte de boîte aux lettres partagée. Si l’expéditeur crée un nouveau message à partir de sa boîte aux lettres personnelle et sélectionne le compte de boîte aux lettres partagée dans le champ De , saveAsync le brouillon est enregistré dans le dossier Brouillons de la boîte aux lettres personnelle de l’utilisateur. Si l’expéditeur ouvre le compte de boîte aux lettres partagée dans un onglet distinct du navigateur (par exemple, via l’option Ouvrir une autre boîte aux lettres ) et y crée un nouveau message, saveAsync il enregistre le brouillon dans le dossier Brouillons de la boîte aux lettres partagée.

Erreurs :

• InvalidAttachmentId : l’identificateur de pièce jointe n’existe pas.

Enregistre de manière asynchrone le message actuel en tant que brouillon.

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

Paramètres

Retours

Remarques

Jeu d’API : Boîte aux lettres 1.3

Niveau d’autorisation minimal : lecture/écriture d’élément

Mode Outlook applicable : Message Compose

Important:

• Dans Outlook sur le web, la nouvelle version d’Outlook sur Windows ou Outlook classique sur Windows en mode en ligne (mode non mis en cache), l’élément est enregistré sur le serveur. Dans Outlook en mode mis en cache, l’élément est enregistré dans le cache local.

• Lorsque vous travaillez avec du contenu au format HTML, il est important de noter que le client Outlook peut modifier le contenu. Cela signifie que les appels ultérieurs à des méthodes telles Body.getAsyncque , Body.setAsyncet même saveAsync peuvent ne pas aboutir au même contenu.

• L’identificateur renvoyé est identique à celui d’élément EWS (services Web Exchange). L’ID d’élément renvoyé n’est pas identique à l’ID d’entrée Outlook ou à l’ID utilisé par l’API REST Outlook. Avant d’effectuer des appels d’API REST en utilisant cette valeur, elle doit être convertie en .Office.context.mailbox.convertToRestId

• Si votre complément appelle saveAsync pour obtenir un ID d’élément à utiliser avec EWS ou l’API REST, n’oubliez pas que lorsqu’Outlook est en mode mis en cache, la synchronisation effective de l’élément avec le serveur peut prendre un certain temps. Tant que l’élément n’est pas synchronisé, l’utilisation de l’ID d’élément renvoie une erreur.

• Dans Outlook sur le web et la nouvelle version d’Outlook sur Windows, le compte de boîte aux lettres dans lequel un brouillon est enregistré varie selon l’appel saveAsync d’un message envoyé à partir d’un compte de boîte aux lettres partagée. Si l’expéditeur crée un nouveau message à partir de sa boîte aux lettres personnelle et sélectionne le compte de boîte aux lettres partagée dans le champ De , saveAsync le brouillon est enregistré dans le dossier Brouillons de la boîte aux lettres personnelle de l’utilisateur. Si l’expéditeur ouvre le compte de boîte aux lettres partagée dans un onglet distinct du navigateur (par exemple, via l’option Ouvrir une autre boîte aux lettres ) et y crée un nouveau message, saveAsync il enregistre le brouillon dans le dossier Brouillons de la boîte aux lettres partagée.

Erreurs :

• InvalidAttachmentId : l’identificateur de pièce jointe n’existe pas.

Exemples

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

Envoie le message en cours de composition.

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

Paramètres

Retours

Remarques

Jeu d’API : Boîte aux lettres 1.15

Niveau d’autorisation minimal : lire/écrire une boîte aux lettres

Mode Outlook applicable : Message Compose

Important:

• La sendAsync méthode est uniquement prise en charge dans les implémentations de volets Office et de commandes de fonction. Il n’est pas pris en charge dans les gestionnaires basés sur des événements ou lesscénarios de sélection multiple d’éléments.

• Dans une implémentation de commande de fonction, la valeur renvoyée peut asyncResult.status ne pas refléter si le rendez-vous en cours de composition est correctement envoyé. Cela s’explique par le fait que la sendAsync méthode est une API asynchrone et que des événements échappant au contrôle du complément (par exemple, des événements gérés par un complément Smart Alerts installé séparément) peuvent bloquer l’envoi de l’élément. Étant donné que vous ne pouvez pas vous fier au status retourné asyncResult.status pour exécuter certaines opérations, vous devez uniquement appeler la méthode event.completed dans la fonction de rappel. L’appel event.completed signale que le complément a terminé le traitement. En dehors de cet appel, il n’est pas garanti que d’autres codes de la fonction de rappel s’exécutent. Nous vous recommandons de traiter les autres opérations avant d’appeler sendAsync.

• Dans une implémentation de volet Office, il n’est pas garanti que tout code inclus pour s’exécuter quand asyncResult.status il est traité n’est Office.AsyncResultStatus.Success pas garanti. Il en est ainsi parce que l’élément a peut-être déjà été envoyé et que le complément a terminé le traitement. Nous vous recommandons de traiter les autres opérations avant d’appeler sendAsync.

• Il n’est pas garanti que tout code inclus après l’appel sendAsync s’exécute puisque le complément termine le traitement après l’appel sendAsync .

• La sendAsync méthode est disponible en préversion dans Outlook sur Mac à partir de la version 16.105 (Build 25121117). Pour tester cette fonctionnalité, rejoignez le programme Microsoft 365 Insider et sélectionnez l’option Canal bêta pour accéder aux builds bêta d’Office.

Envoie le message en cours de composition.

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

Paramètres

Retours

Remarques

Jeu d’API : Boîte aux lettres 1.15

Niveau d’autorisation minimal : lire/écrire une boîte aux lettres

Mode Outlook applicable : Message Compose

Important:

• La sendAsync méthode est uniquement prise en charge dans les implémentations de volets Office et de commandes de fonction. Il n’est pas pris en charge dans les gestionnaires basés sur des événements ou lesscénarios de sélection multiple d’éléments.

• Dans une implémentation de commande de fonction, la valeur renvoyée peut asyncResult.status ne pas refléter si le rendez-vous en cours de composition est correctement envoyé. Cela s’explique par le fait que la sendAsync méthode est une API asynchrone et que des événements échappant au contrôle du complément (par exemple, des événements gérés par un complément Smart Alerts installé séparément) peuvent bloquer l’envoi de l’élément. Étant donné que vous ne pouvez pas vous fier au status retourné asyncResult.status pour exécuter certaines opérations, vous devez uniquement appeler la méthode event.completed dans la fonction de rappel. L’appel event.completed signale que le complément a terminé le traitement. En dehors de cet appel, il n’est pas garanti que d’autres codes de la fonction de rappel s’exécutent. Nous vous recommandons de traiter les autres opérations avant d’appeler sendAsync.

• Dans une implémentation de volet Office, il n’est pas garanti que tout code inclus pour s’exécuter quand asyncResult.status il est traité n’est Office.AsyncResultStatus.Success pas garanti. Il en est ainsi parce que l’élément a peut-être déjà été envoyé et que le complément a terminé le traitement. Nous vous recommandons de traiter les autres opérations avant d’appeler sendAsync.

• Il n’est pas garanti que tout code inclus après l’appel sendAsync s’exécute puisque le complément termine le traitement après l’appel sendAsync .

• La sendAsync méthode est disponible en préversion dans Outlook sur Mac à partir de la version 16.105 (Build 25121117). Pour tester cette fonctionnalité, rejoignez le programme Microsoft 365 Insider et sélectionnez l’option Canal bêta pour accéder aux builds bêta d’Office.

Exemples

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

Insère les données dans le corps ou l’objet d’un message de manière asynchrone.

La setSelectedDataAsync méthode insère la chaîne spécifiée à l’emplacement du curseur dans l’objet ou le corps de l’élément, ou, si du texte est sélectionné dans l’éditeur, elle remplace le texte sélectionné. Si le curseur ne se trouve pas dans le champ corps ou objet, une erreur est renvoyée. Après l’insertion, le curseur est placé à la fin du contenu inséré.

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

Paramètres

Retours

Remarques

Jeu d’API : Boîte aux lettres 1.2

Niveau d’autorisation minimal : lecture/écriture d’élément

Mode Outlook applicable : Message Compose

Erreurs :

• InvalidAttachmentId : l’identificateur de pièce jointe n’existe pas.

Exemples

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

Insère les données dans le corps ou l’objet d’un message de manière asynchrone.

La setSelectedDataAsync méthode insère la chaîne spécifiée à l’emplacement du curseur dans l’objet ou le corps de l’élément, ou, si du texte est sélectionné dans l’éditeur, elle remplace le texte sélectionné. Si le curseur ne se trouve pas dans le champ corps ou objet, une erreur est renvoyée. Après l’insertion, le curseur est placé à la fin du contenu inséré.

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

Paramètres

Retours

Remarques

Jeu d’API : Boîte aux lettres 1.2

Niveau d’autorisation minimal : lecture/écriture d’élément

Mode Outlook applicable : Message Compose

Erreurs :

• InvalidAttachmentId : l’identificateur de pièce jointe n’existe pas.