Office.LoadedMessageCompose interface

Paquet:
outlook

Représente un message en mode de composition actuellement chargé. Un LoadedMessageCompose objet est renvoyé lorsqu’il Office.context.mailbox.loadItemByIdAsync est appelé sur un message en mode composition.

Remarques

Jeu d’API : Boîte aux lettres 1.15

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

Mode Outlook applicable : Message Compose

Important:

  • Lors de l’implémentation de la fonctionnalité de sélection multiple d’éléments, déterminez si vous pouvez déjà accéder aux propriétés obligatoires de l’élément sélectionné par le biais de l’appelOffice.context.mailbox.getSelectedItemsAsync. Si vous le pouvez, vous n’avez pas besoin d’appeler loadItemByIdAsync.

  • Un seul élément de courrier peut être chargé à la fois. Lorsque vous implémentez loadItemByIdAsync, vous devez appeler unloadAsync après avoir traité l’élément. Cela doit être fait avant d’appeler loadItemByIdAsync un autre article.

Utilisateur

Exemples

// Gets the sender's email address of each selected message.
async function getSenderEmailAddress(item) {
    const itemId = item.itemId;
    await new Promise((resolve) => {
        Office.context.mailbox.loadItemByIdAsync(itemId, (result) => {
            if (result.status === Office.AsyncResultStatus.Failed) {
                console.log(result.error.message);
                return;
            }

            const loadedItem = result.value;
            const sender = loadedItem.from.emailAddress;
            console.log(sender);

            // Unload the current message before processing another selected message.
            loadedItem.unloadAsync((asyncResult) => {
                if (asyncResult.status === Office.AsyncResultStatus.Failed) {
                    console.log(asyncResult.error.message);
                    return;
                }

                resolve();
            });
        });
    });
}

Propriétés

bcc

Indique les destinataires de la ligne Cci (copie carbone invisible) d’un message.
body

Obtient le corps et le format de l’élément.
categories

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

Permet d’obtenir les destinataires de la ligne Cc (copie carbone) d’un message.
conversationId

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

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

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

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

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

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

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

Obtient les messages de notification de l’élément.
sensitivityLabel

Obtient l’étiquette de confidentialité d’un message.
seriesId

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

Dans Outlook sur le web et sur Windows (nouveau et classique), le seriesId renvoie l’ID EWS (services Web Exchange) de l’article parent (série) auquel cet article appartient.
subject

Récupère la description qui s’affiche dans le champ d’objet d’un élément.

La subject propriété obtient l’objet entier de l’élément, tel qu’il est envoyé par le serveur de messagerie.
to

Indique les destinataires sur la ligne À d’un message. 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.

Méthodes

getAttachmentContentAsync(attachmentId, options, callback)

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, callback)

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

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

Récupère les pièces jointes de l’élément sous forme de tableau.
getComposeTypeAsync(options, callback)

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)

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.
getConversationIndexAsync(options, callback)

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

Obtient la position codée en Base64 du message actuel dans un thread de conversation.
getInitializationContextAsync(options, callback)

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

Récupère les données d’initialisation transmises lorsque le complément est activé par un message actionnable.
getItemClassAsync(options, callback)

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

Obtient la classe d’éléments services Web Exchange du message sélectionné.
getItemIdAsync(options, callback)

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)

Obtient de manière asynchrone l’ID d’un élément enregistré.

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

Remarque : Si votre complément appelle getItemIdAsync un élément en mode de composition (par exemple, pour obtenir une itemId à 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é, il n’est pas reconnu et son itemId utilisation renvoie une erreur.
getSharedPropertiesAsync(options, callback)

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)

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.
isClientSignatureEnabledAsync(options, callback)

Obtient si la signature client est activée.

Dans Outlook sur Windows (classique), 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 sont désactivés dans Outlook sur le web ou la nouvelle version d’Outlook sur Windows, l’appel d’API retourne false.
isClientSignatureEnabledAsync(callback)

Obtient si la signature client est activée.

Dans Outlook sur Windows (classique), 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 sont désactivés dans Outlook sur le web ou la nouvelle version d’Outlook sur Windows, l’appel d’API retourne false.
loadCustomPropertiesAsync(callback, userContext)

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 des propriétés personnalisées à partir de l’élément de courrier.
saveAsync(options, callback)

Enregistre de manière asynchrone le message actuel en tant que brouillon.
saveAsync(callback)

Enregistre de manière asynchrone le message actuel en tant que brouillon.
unloadAsync(options, callback)

Lorsque plusieurs éléments de courrier sont sélectionnés, ferme l’élément actuellement chargé afin qu’un autre élément de courrier sélectionné puisse être chargé pour traitement.
unloadAsync(callback)

Lorsque plusieurs éléments de courrier sont sélectionnés, ferme l’élément actuellement chargé afin qu’un autre élément de courrier sélectionné puisse être chargé pour traitement.

Détails de la propriété

bcc

Indique les destinataires de la ligne Cci (copie carbone invisible) d’un message.

bcc: Recipients;

Valeur de propriété

Office.Recipients

Remarques

Jeu d’API : Boîte aux lettres 1.1

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

Mode Outlook applicable : Message Compose

Important:

  • Seule la getAsync méthode de l’objet Destinataires est prise en charge.

  • Selon le client et la plateforme Outlook, des limites peuvent s’appliquer quant au nombre de destinataires que vous pouvez recevoir. Pour plus d’informations, voir l’objet Destinataires .

body

Obtient le corps et le format de l’élément.

body: Body;

Valeur de propriété

Office.Body

Remarques

Jeu d’API : Boîte aux lettres 1.1

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

Mode Outlook applicable : Message Compose

Important : seules les getAsync méthodes et getTypeAsync de l’objet Body sont prises en charge.

categories

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

categories: Categories;

Valeur de propriété

Office.Categories

Remarques

Jeu d’API : Boîte aux lettres 1.8

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

Mode Outlook applicable : Message Compose

cc

Permet d’obtenir les destinataires de la ligne Cc (copie carbone) d’un message.

cc: Recipients;

Valeur de propriété

Office.Recipients

Remarques

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

Mode Outlook applicable : Message Compose

Important:

  • Seule la getAsync méthode de l’objet Destinataires est prise en charge.

  • Selon le client et la plateforme Outlook, des limites peuvent s’appliquer quant au nombre de destinataires que vous pouvez recevoir. Pour plus d’informations, voir l’objet Destinataires .

conversationId

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.

conversationId: string;

Valeur de propriété

string

Remarques

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

Mode Outlook applicable : Message Compose

delayDeliveryTime

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

delayDeliveryTime: DelayDeliveryTime;

Valeur de propriété

Office.DelayDeliveryTime

Remarques

Jeu d’API : Boîte aux lettres 1.13

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

Mode Outlook applicable : Message Compose

Important : seule la getAsync méthode de l’objet DelayDeliveryTime est prise en charge.

from

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

from: From;

Valeur de propriété

Office.From

Remarques

Jeu d’API : Mailbox 1.7

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

Mode Outlook applicable : Message Compose

inReplyTo

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

inReplyTo: string;

Valeur de propriété

string

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.

internetHeaders

Obtient les en-têtes Internet personnalisés d’un 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é

Office.InternetHeaders

Remarques

Jeu d’API : Boîte aux lettres 1.8

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

Mode Outlook applicable : Message Compose

Important : seule la getAsync méthode de l’objet InternetHeaders est prise en charge.

itemType

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é

Office.MailboxEnums.ItemType | string

Remarques

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

Mode Outlook applicable : Message Compose

notificationMessages

Obtient les messages de notification de l’élément.

notificationMessages: NotificationMessages;

Valeur de propriété

Office.NotificationMessages

Remarques

Jeu d’API : Boîte aux lettres 1.3

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

Mode Outlook applicable : Message Compose

Important:

sensitivityLabel

Obtient l’étiquette de confidentialité d’un message.

sensitivityLabel: SensitivityLabel;

Valeur de propriété

Office.SensitivityLabel

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 avoir un abonnement Microsoft 365 E5.

  • Seule la getAsync méthode de l’objet SensitivityLabel est prise en charge.

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.

seriesId

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

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

seriesId: string;

Valeur de propriété

string

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. La 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 pour 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 pour tous les autres éléments qui ne sont pas des demandes de réunion.

subject

Récupère la description qui s’affiche dans le champ d’objet d’un élément.

La subject propriété obtient l’objet entier de l’élément, tel qu’il est envoyé par le serveur de messagerie.

subject: Subject;

Valeur de propriété

Office.Subject

Remarques

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

Mode Outlook applicable : Message Compose

Important : seule la getAsync méthode de l’objet Subject est prise en charge.

to

Indique les destinataires sur la ligne À d’un message. 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.

to: Recipients;

Valeur de propriété

Office.Recipients

Remarques

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

Mode Outlook applicable : Message Compose

Important:

  • Seule la getAsync méthode de l’objet Destinataires est prise en charge.

  • Selon le client et la plateforme Outlook, des limites peuvent s’appliquer quant au nombre de destinataires que vous pouvez recevoir. Pour plus d’informations, voir l’objet Destinataires .

Détails de la méthode

getAttachmentContentAsync(attachmentId, options, callback)

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

attachmentId

string

Identifiant de la pièce jointe que vous souhaitez obtenir. Dans Outlook sur le web et le nouvel Outlook sur Windows, l’ID de pièce jointe temporaire généré localement pour les images incorporées qui n’ont pas encore été téléchargées sur le serveur est pris en charge pendant la durée de la session de composition en cours.

options
Office.AsyncContextOptions

Un littéral d’objet qui contient une ou plusieurs des propriétés suivantes :- asyncContext: Les développeurs peuvent fournir n’importe quel objet auquel ils souhaitent accéder dans la fonction de rappel.

callback

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

Facultatif. Lorsque la méthode est terminée, la fonction passée dans le callback paramètre est appelée avec un seul paramètre, asyncResult, qui est un Office.AsyncResult objet. Si l’appel échoue, la asyncResult.error propriété contient un code d’erreur avec la raison de l’échec.

Retours

void

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.

getAttachmentContentAsync(attachmentId, callback)

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

attachmentId

string

Identifiant de la pièce jointe que vous souhaitez obtenir. Dans Outlook sur le web et le nouvel Outlook sur Windows, l’ID de pièce jointe temporaire généré localement pour les images incorporées qui n’ont pas encore été téléchargées sur le serveur est pris en charge pendant la durée de la session de composition en cours.

callback

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

Facultatif. Lorsque la méthode est terminée, la fonction passée dans le callback paramètre est appelée avec un seul paramètre, asyncResult, qui est un Office.AsyncResult objet. Si l’appel échoue, la asyncResult.error propriété contient un code d’erreur avec la raison de l’échec.

Retours

void

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.

getAttachmentsAsync(options, callback)

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

options
Office.AsyncContextOptions

Un littéral d’objet qui contient une ou plusieurs des propriétés suivantes :- asyncContext: Les développeurs peuvent fournir n’importe quel objet auquel ils souhaitent accéder dans la fonction de rappel.

callback

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

Facultatif. Lorsque la méthode est terminée, la fonction passée dans le callback paramètre est appelée avec un seul paramètre de type Office.AsyncResult. Si l’appel échoue, la asyncResult.error propriété contient un code d’erreur avec la raison de l’échec. Si l’appel réussit, un tableau d’objets AttachmentDetailsCompose est renvoyé dans la asyncResult.value propriété.

Retours

void

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.

getAttachmentsAsync(callback)

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

callback

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

Facultatif. Lorsque la méthode est terminée, la fonction passée dans le callback paramètre est appelée avec un seul paramètre de type Office.AsyncResult. Si l’appel échoue, la asyncResult.error propriété contient un code d’erreur avec la raison de l’échec. Si l’appel réussit, un tableau d’objets AttachmentDetailsCompose est renvoyé dans la asyncResult.value propriété.

Retours

void

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.

getComposeTypeAsync(options, callback)

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

options
Office.AsyncContextOptions

Un littéral d’objet qui contient une ou plusieurs des propriétés suivantes :- asyncContext: Les développeurs peuvent fournir n’importe quel objet auquel ils souhaitent accéder dans la fonction de rappel.

callback

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

Lorsque la méthode est terminée, la fonction passée dans le callback paramètre est appelée avec un seul paramètre de type Office.AsyncResult. En cas de réussite, la asyncResult.value propriété contient un objet avec le type de composition et le type de coercition de l’élément.

Retours

void

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

getComposeTypeAsync(callback)

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

callback

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

Lorsque la méthode est terminée, la fonction passée dans le callback paramètre est appelée avec un seul paramètre de type Office.AsyncResult. En cas de réussite, la asyncResult.value propriété contient un objet avec le type de composition et le type de coercition de l’élément.

Retours

void

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

getConversationIndexAsync(options, callback)

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

options
Office.AsyncContextOptions

Un littéral d’objet qui contient une ou plusieurs des propriétés suivantes :- asyncContext: Les développeurs peuvent fournir n’importe quel objet auquel ils souhaitent accéder dans la fonction de rappel.

callback

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

Lorsque la méthode est terminée, la fonction passée dans le callback paramètre est appelée avec un seul paramètre, asyncResult, qui est un Office.AsyncResult objet. La position codée en Base64 du message actuel dans une conversation est renvoyée dans la asyncResult.value propriété.

Retours

void

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.

getConversationIndexAsync(callback)

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

callback

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

Lorsque la méthode est terminée, la fonction passée dans le callback paramètre est appelée avec un seul paramètre, asyncResult, qui est un Office.AsyncResult objet. La position codée en Base64 du message actuel dans une conversation est renvoyée dans la asyncResult.value propriété.

Retours

void

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.

getInitializationContextAsync(options, callback)

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

options
Office.AsyncContextOptions

Un littéral d’objet qui contient une ou plusieurs des propriétés suivantes :- asyncContext: Les développeurs peuvent fournir n’importe quel objet auquel ils souhaitent accéder dans la fonction de rappel.

callback

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

Lorsque la méthode est terminée, la fonction passée dans le callback paramètre est appelée avec un seul paramètre de type Office.AsyncResult. En cas de réussite, les données de contexte d’initialisation sont fournies sous la forme d’une chaîne (ou d’une chaîne vide en l’absence de contexte d’initialisation) dans la asyncResult.value propriété.

Retours

void

Remarques

Jeu d’API : Boîte aux lettres 1.8

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

Mode Outlook applicable : Message Compose

getInitializationContextAsync(callback)

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

callback

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

Lorsque la méthode est terminée, la fonction passée dans le callback paramètre est appelée avec un seul paramètre de type Office.AsyncResult. En cas de réussite, les données de contexte d’initialisation sont fournies sous la forme d’une chaîne (ou d’une chaîne vide en l’absence de contexte d’initialisation) dans la asyncResult.value propriété.

Retours

void

Remarques

Jeu d’API : Boîte aux lettres 1.8

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

Mode Outlook applicable : Message Compose

getItemClassAsync(options, callback)

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

options
Office.AsyncContextOptions

Un littéral d’objet qui contient une ou plusieurs des propriétés suivantes :- asyncContext: Les développeurs peuvent fournir n’importe quel objet auquel ils souhaitent accéder dans la fonction de rappel.

callback

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

Lorsque la méthode est terminée, la fonction passée dans le callback paramètre est appelée avec un seul paramètre, asyncResult, qui est un Office.AsyncResult objet. La classe de message est renvoyée dans la asyncResult.value propriété.

Retours

void

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.

Classe de l’élément Description
IPM. Remarque Nouveaux messages et réponses aux messages
IPM.Schedule.Meeting.Request Demandes de réunion
IPM.Schedule.Meeting.Canceled Annulations de rendez-vous
IPM. Schedule.Meeting.Resp.Neg Réponses négatives à des demandes de rendez-vous
IPM. Schedule.Meeting.Resp.Pos Réponses pour accepter les demandes de réunion
IPM. Schedule.Meeting.Resp.Tent Réponses provisoirement positives à des demandes de rendez-vous

getItemClassAsync(callback)

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

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

Paramètres

callback

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

Lorsque la méthode est terminée, la fonction passée dans le callback paramètre est appelée avec un seul paramètre, asyncResult, qui est un Office.AsyncResult objet. La classe de message est renvoyée dans la asyncResult.value propriété.

Retours

void

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.

Classe de l’élément Description
IPM. Remarque Nouveaux messages et réponses aux messages
IPM.Schedule.Meeting.Request Demandes de réunion
IPM.Schedule.Meeting.Canceled Annulations de rendez-vous
IPM. Schedule.Meeting.Resp.Neg Réponses négatives à des demandes de rendez-vous
IPM. Schedule.Meeting.Resp.Pos Réponses pour accepter les demandes de réunion
IPM. Schedule.Meeting.Resp.Tent Réponses provisoirement positives à des demandes de rendez-vous

getItemIdAsync(options, callback)

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

options
Office.AsyncContextOptions

Un littéral d’objet qui contient une ou plusieurs des propriétés suivantes :- asyncContext: Les développeurs peuvent fournir n’importe quel objet auquel ils souhaitent accéder dans la fonction de rappel.

callback

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

Lorsque la méthode est terminée, la fonction passée dans le callback paramètre est appelée avec un seul paramètre de type Office.AsyncResult. L’ID d’élément EWS de l’article est renvoyé dans la asyncResult.value propriété.

Retours

void

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 un élément en mode de composition (par exemple, pour obtenir une itemId à 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é, il n’est pas reconnu et son itemId utilisation renvoie une erreur.

Erreurs :

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

getItemIdAsync(callback)

Obtient de manière asynchrone l’ID d’un élément enregistré.

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

Remarque : Si votre complément appelle getItemIdAsync un élément en mode de composition (par exemple, pour obtenir une itemId à 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é, il n’est pas reconnu et son itemId utilisation renvoie une erreur.

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

Paramètres

callback

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

Lorsque la méthode est terminée, la fonction passée dans le callback paramètre est appelée avec un seul paramètre de type Office.AsyncResult.

Retours

void

Remarques

Jeu d’API : Boîte aux lettres 1.8

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

Mode Outlook applicable : Message Compose

Erreurs :

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

getSharedPropertiesAsync(options, callback)

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

options
Office.AsyncContextOptions

Un littéral d’objet qui contient une ou plusieurs des propriétés suivantes :- asyncContext: Les développeurs peuvent fournir n’importe quel objet auquel ils souhaitent accéder dans la fonction de rappel.

callback

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

Lorsque la méthode est terminée, la fonction passée dans le callback paramètre est appelée avec un seul paramètre, asyncResult, qui est un Office.AsyncResult objet. La asyncResult.value propriété fournit les propriétés de l’élément partagé.

Retours

void

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

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.

getSharedPropertiesAsync(callback)

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

callback

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

Lorsque la méthode est terminée, la fonction passée dans le callback paramètre est appelée avec un seul paramètre, asyncResult, qui est un Office.AsyncResult objet. La asyncResult.value propriété fournit les propriétés de l’élément partagé.

Retours

void

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

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.

isClientSignatureEnabledAsync(options, callback)

Obtient si la signature client est activée.

Dans Outlook sur Windows (classique), 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 sont désactivés dans Outlook sur le web ou 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

options
Office.AsyncContextOptions

Un littéral d’objet qui contient une ou plusieurs des propriétés suivantes :- asyncContext: Les développeurs peuvent fournir n’importe quel objet auquel ils souhaitent accéder dans la fonction de rappel.

callback

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

Lorsque la méthode est terminée, la fonction passée dans le callback paramètre est appelée avec un seul paramètre de type Office.AsyncResult.

Retours

void

Remarques

Jeu d’API : Boîte aux lettres 1.10

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

Mode Outlook applicable : Message Compose

isClientSignatureEnabledAsync(callback)

Obtient si la signature client est activée.

Dans Outlook sur Windows (classique), 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 sont désactivés dans Outlook sur le web ou la nouvelle version d’Outlook sur Windows, l’appel d’API retourne false.

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

Paramètres

callback

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

Lorsque la méthode est terminée, la fonction passée dans le callback paramètre est appelée avec un seul paramètre de type Office.AsyncResult.

Retours

void

Remarques

Jeu d’API : Boîte aux lettres 1.10

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

Mode Outlook applicable : Message Compose

loadCustomPropertiesAsync(callback, userContext)

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 des propriétés personnalisées à partir de l’élément de courrier.

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

Paramètres

callback

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

Lorsque la méthode est terminée, la fonction passée dans le callback paramètre est appelée avec un seul paramètre de type Office.AsyncResult.

userContext

any

Facultatif. Les développeurs peuvent fournir un objet auquel ils souhaitent accéder dans la fonction de rappel. Cet objet est accessible via la propriété asyncResult.asyncContext dans la fonction de rappel.

Retours

void

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

saveAsync(options, callback)

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

options
Office.AsyncContextOptions

Un littéral d’objet qui contient une ou plusieurs des propriétés suivantes :- asyncContext: Les développeurs peuvent fournir n’importe quel objet auquel ils souhaitent accéder dans la fonction de rappel.

callback

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

Lorsque la méthode est terminée, la fonction passée dans le callback paramètre est appelée avec un seul paramètre, asyncResult, qui est un Office.AsyncResult objet. L’ID de message EWS est renvoyé dans la asyncResult.value propriété.

Retours

void

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 un élément en mode de composition afin d’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.

saveAsync(callback)

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

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

Paramètres

callback

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

Lorsque la méthode est terminée, la fonction passée dans le callback paramètre est appelée avec un seul paramètre, asyncResult, qui est un Office.AsyncResult objet. L’ID de message EWS est renvoyé dans la asyncResult.value propriété.

Retours

void

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 un élément en mode de composition afin d’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.

unloadAsync(options, callback)

Lorsque plusieurs éléments de courrier sont sélectionnés, ferme l’élément actuellement chargé afin qu’un autre élément de courrier sélectionné puisse être chargé pour traitement.

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

Paramètres

options
Office.AsyncContextOptions

Littéral d’objet qui contient la asyncContext propriété. Attribuez à la asyncContext propriété tout objet auquel vous souhaitez accéder dans la fonction de rappel.

callback

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

Facultatif. Lorsque la méthode est terminée, la fonction passée dans le paramètre de rappel est appelée avec un seul paramètre, asyncResult, qui est un Office.AsyncResult objet.

Retours

void

Remarques

Jeu d’API : Boîte aux lettres 1.15

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

Mode Outlook applicable : Message Compose

Important:

  • Pour en savoir plus sur le traitement de plusieurs messages sélectionnés, voir Activer votre complément Outlook sur plusieurs messages.

  • Lorsqu’un élément de courrier sélectionné est chargé à l’aide de loadItemByIdAsync, vous devez l’appeler unloadAsync après traitement. Cela doit être fait avant d’appeler loadItemByIdAsync un autre élément sélectionné.

unloadAsync(callback)

Lorsque plusieurs éléments de courrier sont sélectionnés, ferme l’élément actuellement chargé afin qu’un autre élément de courrier sélectionné puisse être chargé pour traitement.

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

Paramètres

callback

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

Facultatif. Lorsque la méthode est terminée, la fonction passée dans le paramètre de rappel est appelée avec un seul paramètre, asyncResult, qui est un Office.AsyncResult objet.

Retours

void

Remarques

Jeu d’API : Boîte aux lettres 1.15

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

Mode Outlook applicable : Message Compose

Important:

  • Pour en savoir plus sur le traitement de plusieurs messages sélectionnés, voir Activer votre complément Outlook sur plusieurs messages.

  • Lorsqu’un élément de courrier sélectionné est chargé à l’aide de loadItemByIdAsync, vous devez l’appeler unloadAsync après traitement. Cela doit être fait avant d’appeler loadItemByIdAsync un autre élément sélectionné.