Office.LoadedMessageCompose interface

Paquet:

outlook

Représente un message en mode de composition actuellement chargé. Un LoadedMessageCompose objet est retourné quand Office.context.mailbox.loadItemByIdAsync est appelé sur un message en mode de composition.

Remarques

[ Ensemble d’API : Boîte aux lettres 1.15 ]

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

Mode Outlook applicable : message Compose

Important:

• Lors de l’implémentation de la fonctionnalité de sélection multiple d’élément, déterminez si vous pouvez déjà accéder aux propriétés requises de l’élément sélectionné via 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 le traitement de l’élément. Cette opération doit être effectuée avant d’appeler loadItemByIdAsync sur un autre élément.

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	Obtient les destinataires sur la ligne Cci (copie carbone aveugle) 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	Obtient les destinataires sur 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ées d’un message.
from	Obtient l’adresse de messagerie de l’expéditeur d’un message.
inReplyTo	Obtient l’ID du message d’origine à laquelle le message actuel répond.
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é retourne l’une des valeurs d’énumérationItemType, indiquant si l’objet élément instance 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 appartient un instance. Dans Outlook sur le web et sur Windows (nouveau et classique), retourne seriesId l’ID des services Web Exchange (EWS) de l’élément parent (série) auquel cet élément appartient.
subject	Obtient la description qui apparaît dans le champ objet d’un élément. La subject propriété obtient l’objet entier de l’élément, tel qu’envoyé par le serveur de messagerie.
to	Obtient 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 actif.

Méthodes

getAttachmentContentAsync(attachmentId, options, callback)	Obtient une pièce jointe à partir d’un message ou d’un rendez-vous et la renvoie en tant qu’objet AttachmentContent .
getAttachmentContentAsync(attachmentId, callback)	Obtient une pièce jointe à partir d’un message ou d’un rendez-vous et la renvoie en tant qu’objet AttachmentContent .
getAttachmentsAsync(options, callback)	Obtient les pièces jointes de l’élément sous forme de tableau.
getAttachmentsAsync(callback)	Obtient les pièces jointes de l’élément sous forme de tableau.
getComposeTypeAsync(options, callback)	Spécifie le type de composition de message et son type de forçage. Le message peut être nouveau, ou une réponse ou un transfert. Le type de contrainte peut être HTML ou texte brut.
getComposeTypeAsync(callback)	Spécifie le type de composition de message et son type de forçage. Le message peut être nouveau, ou une réponse ou un transfert. Le type de contrainte peut être HTML ou texte brut.
getConversationIndexAsync(options, callback)	Obtient la position encodée en Base64 du message actuel dans un thread de conversation.
getConversationIndexAsync(callback)	Obtient la position encodée en Base64 du message actuel dans un thread de conversation.
getInitializationContextAsync(options, callback)	Obtient les données d’initialisation transmises lorsque le complément est activé par un message actionnable.
getInitializationContextAsync(callback)	Obtient les données d’initialisation transmises lorsque le complément est activé par un message actionnable.
getItemClassAsync(options, callback)	Obtient la classe d’élément Services Web Exchange du message sélectionné.
getItemClassAsync(callback)	Obtient la classe d’élément Services Web Exchange du message sélectionné.
getItemIdAsync(options, callback)	Obtient de façon asynchrone l’identificateur d’élément EWS (Exchange Web Services) d’un élément enregistré. Lorsqu’elle est appelée, cette méthode retourne l’ID d’élément via la fonction de rappel.
getItemIdAsync(callback)	Obtient de façon asynchrone l’ID d’un élément enregistré. Lorsqu’elle est appelée, cette méthode retourne l’ID d’élément via la fonction de rappel. Remarque : Si votre complément appelle getItemIdAsync sur un élément en mode composition (par exemple, pour obtenir un itemId à utiliser avec EWS ou l’API REST), sachez que lorsqu’Outlook est en mode mis en cache, la synchronisation de l’élément sur le serveur peut prendre un certain temps. Tant que l’élément n’est pas synchronisé, le itemId n’est pas reconnu et son utilisation retourne 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 les dossiers partagés et les scénarios de boîte 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 les dossiers partagés et les scénarios de boîte aux lettres partagées dans un complément Outlook.
isClientSignatureEnabledAsync(options, callback)	Obtient si la signature du client est activée. Dans Outlook sur Windows (classique), l’appel d’API retourne true si la signature par défaut pour les nouveaux messages, réponses ou transfert est définie sur un modèle pour le compte Outlook d’envoi. Dans Outlook sur le web et outlook sur Windows, l’appel d’API retourne true si la signature est activée pour les types newMailcompose , replyou 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 outlook sur Windows, l’appel d’API retourne false.
isClientSignatureEnabledAsync(callback)	Obtient si la signature du client est activée. Dans Outlook sur Windows (classique), l’appel d’API retourne true si la signature par défaut pour les nouveaux messages, réponses ou transfert est définie sur un modèle pour le compte Outlook d’envoi. Dans Outlook sur le web et outlook sur Windows, l’appel d’API retourne true si la signature est activée pour les types newMailcompose , replyou 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 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 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 façon asynchrone le message actuel en tant que brouillon.
saveAsync(callback)	Enregistre de façon 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

Obtient les destinataires sur la ligne Cci (copie carbone aveugle) d’un message.

bcc: Recipients;

Valeur de propriété

Office.Recipients

Remarques

[ Ensemble d’API : Boîte aux lettres 1.1 ]

Niveau d’autorisation minimal : élément de lecture

Mode Outlook applicable : message Compose

Important:

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

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

body

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

body: Body;

Valeur de propriété

Office.Body

Remarques

[ Ensemble d’API : Boîte aux lettres 1.1 ]

Niveau d’autorisation minimal : élément de lecture

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

[ Ensemble d’API : Boîte aux lettres 1.8 ]

Niveau d’autorisation minimal : élément de lecture

Mode Outlook applicable : message Compose

cc

Obtient les destinataires sur la ligne Cc (copie carbone) d’un message.

cc: Recipients;

Valeur de propriété

Office.Recipients

Remarques

Niveau d’autorisation minimal : élément de lecture

Mode Outlook applicable : message Compose

Important:

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

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

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 : élément de lecture

Mode Outlook applicable : message Compose

delayDeliveryTime

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

delayDeliveryTime: DelayDeliveryTime;

Valeur de propriété

Office.DelayDeliveryTime

Remarques

[ Ensemble d’API : Boîte aux lettres 1.13 ]

Niveau d’autorisation minimal : élément de lecture

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

[ Ensemble d’API : Boîte aux lettres 1.7 ]

Niveau d’autorisation minimal : élément de lecture

Mode Outlook applicable : message Compose

inReplyTo

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

inReplyTo: string;

Valeur de propriété

string

Remarques

[ Ensemble d’API : Boîte aux lettres 1.14 ]

Niveau d’autorisation minimal : élément de lecture

Mode Outlook applicable : message Compose

Important:

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

• La inReplyTo propriété retourne null les nouveaux messages et les invitations à la 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

[ Ensemble d’API : Boîte aux lettres 1.8 ]

Niveau d’autorisation minimal : élément de lecture

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é retourne l’une des valeurs d’énumérationItemType, indiquant si l’objet élément instance est un message ou un rendez-vous.

itemType: MailboxEnums.ItemType | string;

Valeur de propriété

Office.MailboxEnums.ItemType | string

Remarques

Niveau d’autorisation minimal : élément de lecture

Mode Outlook applicable : message Compose

notificationMessages

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

notificationMessages: NotificationMessages;

Valeur de propriété

Office.NotificationMessages

Remarques

[ Ensemble d’API : Boîte aux lettres 1.3 ]

Niveau d’autorisation minimal : élément de lecture

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.

• Seule la getAllAsync méthode de l’objet NotificationMessages est prise en charge.

sensitivityLabel

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

sensitivityLabel: SensitivityLabel;

Valeur de propriété

Office.SensitivityLabel

Remarques

[ Ensemble d’API : Boîte aux lettres 1.13 ]

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

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.

• 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, consultez Gérer l’étiquette de confidentialité de votre message ou rendez-vous en mode composition.

seriesId

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

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

seriesId: string;

Valeur de propriété

string

Remarques

[ Ensemble d’API : Boîte aux lettres 1.7 ]

Niveau d’autorisation minimal : élément de lecture

Mode Outlook applicable : message Compose

Important : l’identificateur retourné par la seriesId propriété est identique à 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 Outlook. Avant d’effectuer des appels d’API REST à l’aide de cette valeur, vous devez la convertir à l’aide Office.context.mailbox.convertToRestIdde . Pour plus d’informations, voir Utiliser les API REST Outlook à partir d’un complément Outlook.

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

subject

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

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

subject: Subject;

Valeur de propriété

Office.Subject

Remarques

Niveau d’autorisation minimal : élément de lecture

Mode Outlook applicable : message Compose

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

to

Obtient 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 actif.

to: Recipients;

Valeur de propriété

Office.Recipients

Remarques

Niveau d’autorisation minimal : élément de lecture

Mode Outlook applicable : message Compose

Important:

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

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

Détails de la méthode

getAttachmentContentAsync(attachmentId, options, callback)

Obtient une pièce jointe à partir 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

Identificateur de la pièce jointe que vous souhaitez obtenir.

options

Office.AsyncContextOptions

Littéral d’objet qui contient une ou plusieurs des propriétés suivantes : les asyncContextdé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. Une fois la méthode 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

[ Ensemble d’API : Boîte aux lettres 1.8 ]

Niveau d’autorisation minimal : élément de lecture

Mode Outlook applicable : message Compose

Important:

• La getAttachmentContentAsync méthode obtient la pièce jointe avec l’identificateur spécifié à partir de l’élément. Il est recommandé 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.

• Dans Outlook sur le web et le nouvel 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 n’est valide que dans la même session. Une session est terminée lorsque l’utilisateur ferme l’application, ou si l’utilisateur commence à composer un formulaire inline, puis affiche ensuite le formulaire pour continuer dans une fenêtre distincte.

Erreurs :

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

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

getAttachmentContentAsync(attachmentId, callback)

Obtient une pièce jointe à partir 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

Identificateur de la pièce jointe que vous souhaitez obtenir.

callback

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

Facultatif. Une fois la méthode 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

[ Ensemble d’API : Boîte aux lettres 1.8 ]

Niveau d’autorisation minimal : élément de lecture

Mode Outlook applicable : message Compose

Important:

• La getAttachmentContentAsync méthode obtient la pièce jointe avec l’identificateur spécifié à partir de l’élément. Il est recommandé 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.

• Dans Outlook sur le web et le nouvel 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 n’est valide que dans la même session. Une session est terminée lorsque l’utilisateur ferme l’application, ou si l’utilisateur commence à composer un formulaire inline, puis affiche ensuite le formulaire pour continuer dans une fenêtre distincte.

Erreurs :

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

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

getAttachmentsAsync(options, callback)

Obtient 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

Littéral d’objet qui contient une ou plusieurs des propriétés suivantes : les asyncContextdé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. Une fois la méthode 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.

Retours

void

Remarques

[ Ensemble d’API : Boîte aux lettres 1.8 ]

Niveau d’autorisation minimal : élément de lecture

Mode Outlook applicable : message Compose

Important : dans Outlook sur le web et le nouvel 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, étant donné qu’un seul lien est inclus, getAttachmentsAsync ne retourne pas cette pièce jointe.

getAttachmentsAsync(callback)

Obtient 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. Une fois la méthode 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.

Retours

void

Remarques

[ Ensemble d’API : Boîte aux lettres 1.8 ]

Niveau d’autorisation minimal : élément de lecture

Mode Outlook applicable : message Compose

Important : dans Outlook sur le web et le nouvel 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, étant donné qu’un seul lien est inclus, getAttachmentsAsync ne retourne pas cette pièce jointe.

getComposeTypeAsync(options, callback)

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

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

Paramètres

options

Office.AsyncContextOptions

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

callback

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

Une fois la méthode 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 forçage de l’élément.

Retours

void

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

Remarques

[ Ensemble d’API : Boîte aux lettres 1.10 ]

Niveau d’autorisation minimal : élément de lecture

Mode Outlook applicable : message Compose

getComposeTypeAsync(callback)

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

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

Paramètres

callback

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

Une fois la méthode 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 forçage de l’élément.

Retours

void

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

Remarques

[ Ensemble d’API : Boîte aux lettres 1.10 ]

Niveau d’autorisation minimal : élément de lecture

Mode Outlook applicable : message Compose

getConversationIndexAsync(options, callback)

Obtient la position encodé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

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

callback

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

Une fois la méthode 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 encodée en Base64 du message actuel dans une conversation est retournée dans la asyncResult.value propriété .

Retours

void

Remarques

[ Ensemble d’API : Boîte aux lettres 1.14 ]

Niveau d’autorisation minimal : élément de lecture

Mode Outlook applicable : message Compose

Conseil : Vous pouvez utiliser l’index de conversation pour localiser un message dans un thread de conversation. Ensuite, utilisez son contenu pour fournir un contexte pour le message actuel en cours de composition.

getConversationIndexAsync(callback)

Obtient la position encodé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

Une fois la méthode 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 encodée en Base64 du message actuel dans une conversation est retournée dans la asyncResult.value propriété .

Retours

void

Remarques

[ Ensemble d’API : Boîte aux lettres 1.14 ]

Niveau d’autorisation minimal : élément de lecture

Mode Outlook applicable : message Compose

Conseil : Vous pouvez utiliser l’index de conversation pour localiser un message dans un thread de conversation. Ensuite, utilisez son contenu pour fournir un contexte pour le message actuel en cours de composition.

getInitializationContextAsync(options, callback)

Obtient 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

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

callback

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

Une fois la méthode 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 s’il n’y a pas de contexte d’initialisation) dans la asyncResult.value propriété .

Retours

void

Remarques

[ Ensemble d’API : Boîte aux lettres 1.8 ]

Niveau d’autorisation minimal : élément de lecture

Mode Outlook applicable : message Compose

getInitializationContextAsync(callback)

Obtient 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

Une fois la méthode 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 s’il n’y a pas de contexte d’initialisation) dans la asyncResult.value propriété .

Retours

void

Remarques

[ Ensemble d’API : Boîte aux lettres 1.8 ]

Niveau d’autorisation minimal : élément de lecture

Mode Outlook applicable : message Compose

getItemClassAsync(options, callback)

Obtient la classe d’élément Services Web Exchange du message sélectionné.

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

Paramètres

options

Office.AsyncContextOptions

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

callback

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

Une fois la méthode 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 retournée dans la asyncResult.value propriété .

Retours

void

Remarques

[ Ensemble d’API : Boîte aux lettres 1.14 ]

Niveau d’autorisation minimal : élément de lecture

Mode Outlook applicable : message Compose

Important:

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

Classe de l’élément	Description
IPM. Note	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 à l’acceptation des 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ément Services Web Exchange du message sélectionné.

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

Paramètres

callback

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

Une fois la méthode 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 retournée dans la asyncResult.value propriété .

Retours

void

Remarques

[ Ensemble d’API : Boîte aux lettres 1.14 ]

Niveau d’autorisation minimal : élément de lecture

Mode Outlook applicable : message Compose

Important:

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

Classe de l’élément	Description
IPM. Note	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 à l’acceptation des demandes de réunion
IPM. Schedule.Meeting.Resp.Tent	Réponses provisoirement positives à des demandes de rendez-vous

getItemIdAsync(options, callback)

Obtient de façon asynchrone l’identificateur d’élément EWS (Exchange Web Services) d’un élément enregistré.

Lorsqu’elle est appelé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

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

callback

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

Une fois la méthode 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’élément est retourné dans la asyncResult.value propriété .

Retours

void

Remarques

[ Ensemble d’API : Boîte aux lettres 1.8 ]

Niveau d’autorisation minimal : élément de lecture

Mode Outlook applicable : message Compose

Important:

• L’ID d’élément retourné 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 à l’aide de cette valeur, vous devez la convertir à l’aide Office.context.mailbox.convertToRestIdde .

• Si votre complément appelle getItemIdAsync sur un élément en mode composition (par exemple, pour obtenir un itemId à utiliser avec EWS ou l’API REST), sachez que lorsqu’Outlook est en mode mis en cache, la synchronisation de l’élément sur le serveur peut prendre un certain temps. Tant que l’élément n’est pas synchronisé, le itemId n’est pas reconnu et son utilisation retourne 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 façon asynchrone l’ID d’un élément enregistré.

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

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

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

Paramètres

callback

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

Une fois la méthode 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

[ Ensemble d’API : Boîte aux lettres 1.8 ]

Niveau d’autorisation minimal : élément de lecture

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 les dossiers partagés et les scénarios de boîte 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

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

callback

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

Une fois la méthode 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

[ Ensemble 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 : élément de lecture

Mode Outlook applicable : message Compose

Important : En mode Message Compose, 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. Déléguer l’accès/Dossiers partagés

1. Le propriétaire de la boîte aux lettres démarre 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 continue la 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 la boîte aux lettres partagée qui n’a pas été promue en compte complet (nouveau Windows)

1. L’utilisateur de la boîte aux lettres partagée démarre 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 de 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.

• Nouveau Outlook sur Windows lorsque la boîte aux lettres partagée est promue en 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 les dossiers partagés et les scénarios de boîte 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

Une fois la méthode 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

[ Ensemble 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 : élément de lecture

Mode Outlook applicable : message Compose

Important : En mode Message Compose, 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. Déléguer l’accès/Dossiers partagés

1. Le propriétaire de la boîte aux lettres démarre 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 continue la 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 la boîte aux lettres partagée qui n’a pas été promue en compte complet (nouveau Windows)

1. L’utilisateur de la boîte aux lettres partagée démarre 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 de 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.

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

isClientSignatureEnabledAsync(options, callback)

Obtient si la signature du client est activée.

Dans Outlook sur Windows (classique), l’appel d’API retourne true si la signature par défaut pour les nouveaux messages, réponses ou transfert est définie sur un modèle pour le compte Outlook d’envoi. Dans Outlook sur le web et outlook sur Windows, l’appel d’API retourne true si la signature est activée pour les types newMailcompose , replyou 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 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

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

callback

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

Une fois la méthode 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

[ Ensemble d’API : Boîte aux lettres 1.10 ]

Niveau d’autorisation minimal : élément de lecture

Mode Outlook applicable : message Compose

isClientSignatureEnabledAsync(callback)

Obtient si la signature du client est activée.

Dans Outlook sur Windows (classique), l’appel d’API retourne true si la signature par défaut pour les nouveaux messages, réponses ou transfert est définie sur un modèle pour le compte Outlook d’envoi. Dans Outlook sur le web et outlook sur Windows, l’appel d’API retourne true si la signature est activée pour les types newMailcompose , replyou 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 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

Une fois la méthode 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

[ Ensemble d’API : Boîte aux lettres 1.10 ]

Niveau d’autorisation minimal : élément de lecture

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

Une fois la méthode 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

[ Ensemble d’API : Boîte aux lettres 1.1 ]

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

Niveau d’autorisation minimal : élément de lecture

Mode Outlook applicable : message Compose

saveAsync(options, callback)

Enregistre de façon asynchrone le message actuel en tant que brouillon.

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

Paramètres

options

Office.AsyncContextOptions

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

callback

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

Une fois la méthode 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 retourné dans la asyncResult.value propriété .

Retours

void

Remarques

[ Ensemble d’API : Boîte aux lettres 1.3 ]

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

Mode Outlook applicable : message Compose

Important:

• Dans Outlook sur le web, nouvel 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 utilisez 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 comme Body.getAsync, Body.setAsyncet saveAsync même peuvent ne pas aboutir au même contenu.

• L’identificateur retourné est identique à l’identificateur d’élément EWS (Exchange Web Services). L’ID d’élément retourné 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 à l’aide de cette valeur, vous devez la convertir à l’aide Office.context.mailbox.convertToRestIdde .

• Si votre complément appelle saveAsync un élément en mode composition afin d’obtenir un ID d’élément à utiliser avec EWS ou l’API REST, sachez que lorsqu’Outlook est en mode mis en cache, la synchronisation de l’élément sur 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 outlook sur Windows, le compte de boîte aux lettres dans lequel un brouillon est enregistré varie lorsque saveAsync est appelé sur un message qui sera envoyé à partir d’un compte de boîte aux lettres partagé. Si l’expéditeur crée un message à partir de sa boîte aux lettres personnelle et sélectionne le compte de boîte aux lettres partagé dans le champ De , saveAsync enregistre le brouillon 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é dans un onglet de navigateur distinct (via l’option Ouvrir une autre boîte aux lettres , par exemple) et y crée un nouveau message, saveAsync 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 façon asynchrone le message actuel en tant que brouillon.

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

Paramètres

callback

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

Une fois la méthode 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 retourné dans la asyncResult.value propriété .

Retours

void

Remarques

[ Ensemble d’API : Boîte aux lettres 1.3 ]

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

Mode Outlook applicable : message Compose

Important:

• Dans Outlook sur le web, nouvel 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 utilisez 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 comme Body.getAsync, Body.setAsyncet saveAsync même peuvent ne pas aboutir au même contenu.

• L’identificateur retourné est identique à l’identificateur d’élément EWS (Exchange Web Services). L’ID d’élément retourné 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 à l’aide de cette valeur, vous devez la convertir à l’aide Office.context.mailbox.convertToRestIdde .

• Si votre complément appelle saveAsync un élément en mode composition afin d’obtenir un ID d’élément à utiliser avec EWS ou l’API REST, sachez que lorsqu’Outlook est en mode mis en cache, la synchronisation de l’élément sur 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 outlook sur Windows, le compte de boîte aux lettres dans lequel un brouillon est enregistré varie lorsque saveAsync est appelé sur un message qui sera envoyé à partir d’un compte de boîte aux lettres partagé. Si l’expéditeur crée un message à partir de sa boîte aux lettres personnelle et sélectionne le compte de boîte aux lettres partagé dans le champ De , saveAsync enregistre le brouillon 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é dans un onglet de navigateur distinct (via l’option Ouvrir une autre boîte aux lettres , par exemple) et y crée un nouveau message, saveAsync 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é . Affectez à la propriété tout objet auquel vous souhaitez accéder dans la asyncContext fonction de rappel.

callback

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

Facultatif. Une fois la méthode 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

[ Ensemble d’API : Boîte aux lettres 1.15 ]

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

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 loadItemByIdAsyncde , vous devez appeler unloadAsync après son traitement. Cette opération doit être effectuée avant d’appeler loadItemByIdAsync sur 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. Une fois la méthode 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

[ Ensemble d’API : Boîte aux lettres 1.15 ]

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

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 loadItemByIdAsyncde , vous devez appeler unloadAsync après son traitement. Cette opération doit être effectuée avant d’appeler loadItemByIdAsync sur un autre élément sélectionné.