Remarque
L’accès à cette page nécessite une autorisation. Vous pouvez essayer de vous connecter ou de modifier des répertoires.
L’accès à cette page nécessite une autorisation. Vous pouvez essayer de modifier des répertoires.
Le sous-ensemble de l’API de complément Outlook de l’API JavaScript d’Office comprend des objets, des méthodes, des propriétés et des événements que vous pouvez utiliser dans un complément Outlook.
Remarque
Dans cette documentation, l’ensemble de conditions requises présenté est différent de l’ensemble de conditions requises de la version précédente.
Nouveautés de la version 1.15
Le jeu de conditions requises de boîte aux lettres 1.15 inclut toutes les fonctionnalités du jeu de conditions requises 1.14. Les fonctionnalités suivantes ont été ajoutées.
- Ajout de la prise en charge des boutons radio pour formater les options de signalement dans la boîte de dialogue intégrée de signalement du spam .
- Ajout de la prise en charge de l’inclusion d’une case à cocher « Ne plus afficher ce message » dans une boîte de dialogue de signalement de courrier indésirable qui ne nécessite pas l’intervention d’un utilisateur.
- Ajout de la prise en charge de l’ouverture d’un volet Office à partir d’une boîte de dialogue de signalement de courrier indésirable.
- Ajout de la prise en charge de Markdown pour mettre en forme les messages d’erreur dans une boîte de dialogue Alertes intelligentes .
- Ajout de la prise en charge de l’exécution d’une fonction à partir de la boîte de dialogue Alertes intelligentes.
- Ajout d’une méthode pour envoyer par programme un élément de courrier.
- Ajout d’une méthode permettant de charger un seul message à partir de plusieurs messages sélectionnés afin d’obtenir ses propriétés ou d’effectuer des opérations sur celui-ci.
- Ajout d’un événement qui se produit lorsque le volet Office d’un complément est ouvert à partir d’un message actionnable, d’une notification InsightMessage , d’une boîte de dialogue Alertes intelligentes ou d’une boîte de dialogue intégrée de signalement de courrier indésirable.
- Ajout de la prise en charge des pièces jointes codées en Base64 dans les formulaires de réponse.
Liste des API
Le tableau suivant répertorie les API introduites dans le jeu de conditions requises de boîte aux lettres 1.15. Pour consulter la documentation de référence sur toutes les API prises en charge par le jeu d’exigences de boîte aux lettres 1.15 ou version antérieure, consultez API Outlook.
| Classe | Champs | Description |
|---|---|---|
| AppointmentCompose | sendAsync(callback ?: (asyncResult : Office.AsyncResult<void>) => void) | Envoie le rendez-vous en cours de composition. |
| sendAsync(options : Office.AsyncContextOptions, callback ?: (asyncResult : Office.AsyncResult<void>) => void) | Envoie le rendez-vous en cours de composition. | |
| InitializationContextChangedEventArgs | initializationContextData | Représente les données à transmettre au volet Office d’un complément à partir d’un message actionnable, d’un message de notification, d’une boîte de dialogue Alertes intelligentes ou intégré |
| type | Représente le type de l’événement. | |
| LoadedMessageCompose | 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. | |
| Catégories | 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. | |
| 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. | |
| getAttachmentContentAsync(attachmentId : string, callback ?: (asyncResult : Office.AsyncResult<AttachmentContent>) => void) | 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) | Récupère une pièce jointe d’un message ou d’un rendez-vous et la renvoie en tant qu’objet AttachmentContent . |
|
| getAttachmentsAsync(callback ?: (asyncResult : Office.AsyncResult<AttachmentDetailsCompose[]>) => void) | 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) | Récupère les pièces jointes de l’élément sous forme de tableau. | |
| getComposeTypeAsync(callback : (asyncResult : Office.AsyncResult) => void) | Spécifie le type de composition du message et son type de coercition. | |
| getComposeTypeAsync(options : Office.AsyncContextOptions, callback : (asyncResult : Office.AsyncResult) => void) | Spécifie le type de composition du message et son type de coercition. | |
| getConversationIndexAsync(callback : (asyncResult : Office.AsyncResult<string>) => void) | 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) | Obtient la position codée en Base64 du message actuel dans un thread de conversation. | |
| getInitializationContextAsync(callback : (asyncResult : Office.AsyncResult<string>) => void) | 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) | Récupère les données d’initialisation transmises lorsque le complément est activé par un message actionnable. | |
| getItemClassAsync(callback : (asyncResult : Office.AsyncResult<string>) => void) | Obtient la classe d’éléments services Web Exchange du message sélectionné. | |
| getItemClassAsync(options : Office.AsyncContextOptions, callback : (asyncResult : Office.AsyncResult<string>) => void) | Obtient la classe d’éléments services Web Exchange du message sélectionné. | |
| getItemIdAsync(callback : (asyncResult : Office.AsyncResult<string>) => void) | Obtient de manière asynchrone l’ID d’un élément enregistré. | |
| getItemIdAsync(options : Office.AsyncContextOptions, callback : (asyncResult : Office.AsyncResult<string>) => void) | Obtient de manière asynchrone l’identificateur d’élément EWS (services Web Exchange) | |
| getSharedPropertiesAsync(callback : (asyncResult : Office.AsyncResult<SharedProperties>) => void) | 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. | |
| getSharedPropertiesAsync(options : Office.AsyncContextOptions, callback : (asyncResult : Office.AsyncResult<SharedProperties>) => void) | 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. | |
| 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. | |
| isClientSignatureEnabledAsync(callback : (asyncResult : Office.AsyncResult<boolean>) => void) | Obtient si la signature client est activée. | |
| isClientSignatureEnabledAsync(options : Office.AsyncContextOptions, callback : (asyncResult : Office.AsyncResult<boolean>) => void) | Obtient si la signature client est activée. | |
| itemType | Obtient le type d’élément représenté par une instance. | |
| loadCustomPropertiesAsync(callback : (asyncResult : Office.AsyncResult<CustomProperties>) => void, userContext ?: any) | Charge de manière asynchrone les propriétés personnalisées de ce complément vers l’élément sélectionné. | |
| notificationMessages | Obtient les messages de notification de l’élément. | |
| saveAsync(callback : (asyncResult : Office.AsyncResult<string>) => void) | Enregistre de manière asynchrone le message actuel en tant que brouillon. | |
| saveAsync(options : Office.AsyncContextOptions, callback : (asyncResult : Office.AsyncResult<string>) => void) | Enregistre de manière asynchrone le message actuel en tant que brouillon. | |
| sensitivityLabel | Obtient l’étiquette de confidentialité d’un message. | |
| seriesId | Obtient l’ID de la série à laquelle une instance appartient. | |
| subject | Récupère la description qui s’affiche dans le champ d’objet d’un élément. | |
| to | Indique les destinataires sur la ligne À d’un message. | |
| unloadAsync(callback ?: (asyncResult : Office.AsyncResult<void>) => void) | 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) | 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. | |
| LoadedMessageRead | attachments | Récupère les pièces jointes de l’élément sous forme de tableau. |
| body | Obtient le corps de l’élément et son format. | |
| Catégories | 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. | |
| dateTimeCreated | Obtient la date et l’heure de création d’un élément. | |
| dateTimeModified | Obtient la date et l’heure de la dernière modification d’un élément. | |
| displayReplyAllFormAsync(formData : string | ReplyFormData, callback ?: (asyncResult : Office.AsyncResult<void>) => void) | Affiche un formulaire de réponse qui inclut soit l’expéditeur et tous les destinataires du message sélectionné, soit l’organisateur et tous les participants à la | |
| displayReplyAllFormAsync(formData : string | ReplyFormData, options : Office.AsyncContextOptions, callback ?: (asyncResult : Office.AsyncResult<void>) => void) | Affiche un formulaire de réponse qui inclut soit l’expéditeur et tous les destinataires du message sélectionné, soit l’organisateur et tous les participants à la | |
| displayReplyFormAsync(formData : string | ReplyFormData, callback ?: (asyncResult : Office.AsyncResult<void>) => void) | Affiche un formulaire de réponse qui comprend uniquement l’expéditeur du message sélectionné ou l’organisateur du rendez-vous sélectionné. | |
| displayReplyFormAsync(formData : string | ReplyFormData, options : Office.AsyncContextOptions, callback ?: (asyncResult : Office.AsyncResult<void>) => void) | Affiche un formulaire de réponse qui comprend uniquement l’expéditeur du message sélectionné ou l’organisateur du rendez-vous sélectionné. | |
| end | Obtient la date et l’heure auxquelles le rendez-vous doit se terminer. | |
| from | Obtient l’adresse de messagerie de l’expéditeur d’un message. | |
| getAllInternetHeadersAsync(callback ?: (asyncResult : Office.AsyncResult<string>) => void) | Obtient tous les en-têtes Internet pour le message sous forme de chaîne. | |
| getAllInternetHeadersAsync(options : Office.AsyncContextOptions, callback ?: (asyncResult : Office.AsyncResult<string>) => void) | Obtient tous les en-têtes Internet pour le message sous forme de chaîne. | |
| getAsFileAsync(callback : (asyncResult : Office.AsyncResult<string>) => void) | Récupère le message actuel au format EML encodé en Base64. | |
| getAsFileAsync(options : Office.AsyncContextOptions, callback : (asyncResult : Office.AsyncResult<string>) => void) | Récupère le message actuel au format EML encodé en Base64. | |
| getAttachmentContentAsync(attachmentId : string, callback ?: (asyncResult : Office.AsyncResult<AttachmentContent>) => void) | 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) | Récupère une pièce jointe d’un message ou d’un rendez-vous et la renvoie en tant qu’objet AttachmentContent . |
|
| getInitializationContextAsync(callback : (asyncResult : Office.AsyncResult<string>) => void) | 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) | Récupère les données d’initialisation transmises lorsque le complément est activé par un message actionnable. | |
| getRegExMatches() | Renvoie les valeurs de chaîne dans l’élément sélectionné qui correspondent aux expressions régulières définies dans un fichier manifeste XML. | |
| getRegExMatchesByName(name : string) | Renvoie les valeurs de chaîne dans l’élément sélectionné qui correspondent à l’expression régulière nommée définie dans un fichier manifeste XML. | |
| getSelectedRegExMatches() | Renvoie des valeurs de chaîne dans une correspondance mise en surbrillance qui correspondent aux expressions régulières définies dans un fichier manifeste XML. | |
| getSharedPropertiesAsync(callback : (asyncResult : Office.AsyncResult<SharedProperties>) => void) | 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. | |
| getSharedPropertiesAsync(options : Office.AsyncContextOptions, callback : (asyncResult : Office.AsyncResult<SharedProperties>) => void) | 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. | |
| internetMessageId | Obtient l’identificateur de message Internet d’un message. | |
| itemClass | Obtient la classe d’éléments services Web Exchange du message sélectionné. | |
| itemId | Obtient l’identificateur d’élément des services web Exchange | |
| itemType | Obtient le type d’élément représenté par une instance. | |
| loadCustomPropertiesAsync(callback : (asyncResult : Office.AsyncResult<CustomProperties>) => void, userContext ?: any) | Charge de manière asynchrone les propriétés personnalisées de ce complément vers l’élément sélectionné. | |
| location | Obtient l’emplacement d’une demande de réunion. | |
| normalizedSubject | Obtient l’objet d’un élément, avec tous les préfixes supprimés (y compris RE : et FWD :). | |
| notificationMessages | Obtient les messages de notification de l’élément. | |
| Périodicité | Obtient le modèle de récurrence d’un rendez-vous. | |
| sender | Obtient l’adresse de messagerie de l’expéditeur d’un message électronique. | |
| seriesId | Obtient l’ID de la série à laquelle une instance appartient. | |
| start | Obtient la date et l’heure de début du rendez-vous. | |
| subject | Récupère la description qui s’affiche dans le champ d’objet d’un élément. | |
| to | Indique les destinataires sur la ligne À d’un message. | |
| unloadAsync(callback ?: (asyncResult : Office.AsyncResult<void>) => void) | 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) | 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. | |
| Boîte aux lettres | loadItemByIdAsync(itemId : string, callback : (asyncResult : Office.AsyncResult<LoadedMessageCompose | LoadedMessageRead>) => void) | Charge un seul élément de courrier par son ID EWS (services Web Exchange). |
| loadItemByIdAsync(itemId : string, options : Office.AsyncContextOptions, callback : (asyncResult : Office.AsyncResult<LoadedMessageCompose | LoadedMessageRead>) => void) | Charge un seul élément de courrier par son ID EWS (services Web Exchange). | |
| MessageCompose | sendAsync(callback ?: (asyncResult : Office.AsyncResult<void>) => void) | Envoie le message en cours de composition. |
| sendAsync(options : Office.AsyncContextOptions, callback ?: (asyncResult : Office.AsyncResult<void>) => void) | Envoie le message en cours de composition. | |
| AttachmentType | Base64 | La pièce jointe est un fichier codé en Base64. |
| ReplyFormAttachment | base64file | Représente la chaîne codée en Base64 du fichier à joindre. |
| SmartAlertsEventCompletedOptions | errorMessageMarkdown | Lorsque vous utilisez la méthode completed pour signaler la fin d’un gestionnaire d’événements |
| SpamReportingEventCompletedOptions | ID de commande | Lorsque vous utilisez la méthode « completed » pour signaler la fin du traitement d’un message signalé, |
| contextData | Lorsque vous utilisez la méthode « completed » pour signaler la fin du traitement d’un message signalé, |
Événements
Le tableau suivant répertorie les événements introduits dans le jeu de conditions requises 1.15. Pour obtenir la liste de tous les événements pris en charge qui peuvent être gérés à l’aide des méthodes etremoveHandlerAsync, consultez Office.EventTypeaddHandlerAsync.
| Événement | Description | Objet |
|---|---|---|
| InitializationContextChanged | Le volet Office d’un complément a été ouvert à partir d’un message actionnable, InsightMessage d’une notification, d’une boîte de dialogue Alertes intelligentes ou d’une boîte de dialogue intégrée de signalement de courrier indésirable. |
Option |
Remarque
Pour les événements pris en charge dans un complément d’activation en fonction des événements, consultez Activer des compléments avec des événements.
Mises à jour du manifeste
Le tableau suivant répertorie les mises à jour de manifeste introduites dans l’ensemble de conditions requises de boîte aux lettres 1.15. Pour en savoir plus sur les types de manifestes de compléments Office, voir Manifeste de compléments Office.
| Fonctionnalité | Manifeste unifié pour Microsoft 365 | Manifeste du complément uniquement | Description |
|---|---|---|---|
| Création de rapport de courrier indésirable | "extensions.ribbons.spamPreProcessingDialog.spamReportingOptions.type" |
Options de reporting | Ajout de la prise en charge des boutons radio dans la boîte de dialogue de prétraitement d’un complément intégré de signalement du courrier indésirable. |
| Création de rapport de courrier indésirable | "extensions.ribbons.spamPreProcessingDialog.spamNeverShowAgainOption" |
PreProcessingDialog | Ajout de la prise en charge de la case à cocher « Ne plus afficher ce message » dans la boîte de dialogue de prétraitement d’un complément intégré de signalement du courrier indésirable. |