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.8
Le jeu de conditions requises 1.8 inclut toutes les fonctionnalités du jeu de conditions requises 1.7. Les fonctionnalités suivantes ont été ajoutées.
- Ajout de méthodes permettant d’obtenir le contenu d’une pièce jointe ou d’obtenir toutes les pièces jointes d’un élément en mode composition. Pour plus d’informations, voir Gérer les pièces jointes d’un élément dans un formulaire de rédaction dans Outlook.
- Ajout d’une méthode pour ajouter un fichier en tant que pièce jointe à l’aide d’une chaîne codée en Base64.
- Ajout de propriétés et de méthodes pour gérer les catégories sur les éléments et dans la liste de catégories master de la boîte aux lettres.
- Ajout de la prise en charge des scénarios d’accès délégué , notamment d’une méthode permettant d’obtenir des propriétés partagées et d’un élément manifest pour activer les compléments dans les dossiers partagés.
- Ajout d’un objet pour gérer l’ensemble d’emplacements d’un rendez-vous. Pour plus d’informations, voir Obtenir ou définir l’emplacement lorsque vous composez un rendez-vous dans Outlook.
- Ajout d’un objet pour obtenir et définir des en-têtes Internet personnalisés sur un élément de message en mode composition.
- Ajout d’une méthode permettant d’obtenir tous les en-têtes Internet sur un élément de message en mode Lecture.
- Ajout d’une méthode pour obtenir les données d’initialisation transmises lorsque le complément est activé par un message actionnable.
- Ajout d’une méthode pour obtenir l’ID d’un élément de rendez-vous ou de message enregistré.
- Ajout d’un paramètre facultatif
optionsà l’appel pour annuler l’exécutionevent.completedd’un événement. - Ajout d’événements qui se produisent lorsqu’une pièce jointe est ajoutée ou supprimée et lorsque l’emplacement du rendez-vous est modifié.
Liste des API
Le tableau suivant répertorie les API introduites dans le jeu de conditions requises de boîte aux lettres 1.8. 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.8 ou version antérieure, consultez API Outlook.
| Classe | Champs | Description |
|---|---|---|
| AppointmentCompose | addFileAttachmentFromBase64Async(base64File : string, attachmentName : string, callback ?: (asyncResult : Office.AsyncResult<string>) => void) | Ajoute un fichier à un message ou un rendez-vous en pièce jointe. |
| addFileAttachmentFromBase64Async(base64File : string, attachmentName : string, options : Office.AsyncContextOptions & { isInline : boolean }, callback ?: (asyncResult : Office.AsyncResult<string>) => void) | Ajoute un fichier à un message ou un rendez-vous en pièce jointe. | |
| Catégories | Obtient un objet qui fournit des méthodes pour gérer les catégories de l’élément. | |
| enhancedLocation | Obtient ou définit les emplacements du rendez-vous. | |
| 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. | |
| 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. | |
| getItemIdAsync(callback : (asyncResult : Office.AsyncResult<string>) => void) | Obtient de manière asynchrone l’identificateur d’élément EWS (services Web Exchange) | |
| 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. | |
| AppointmentRead | Catégories | Obtient un objet qui fournit des méthodes pour gérer les catégories de l’élément. |
| enhancedLocation | Obtient les emplacements d’un rendez-vous. | |
| 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. | |
| 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. | |
| AttachmentContent | content | Contenu d’une pièce jointe sous forme de chaîne. |
| format | Format de chaîne à utiliser pour le contenu d’une pièce jointe. | |
| AttachmentDetailsCompose | attachmentType | Obtient une valeur qui indique le type de la pièce jointe. |
| id | Obtient l’identificateur d’une pièce jointe. | |
| isInline | Obtient une valeur qui indique si la pièce jointe apparaît sous la forme d’une image dans le corps de l’élément plutôt que dans la liste des pièces jointes. | |
| isServiceAccessible | Dans Outlook sur le web et la nouvelle version d’Outlook sur Windows, indique si une pièce jointe incorporée dans un message a été téléchargée sur le serveur et si un ID EWS (services Web Exchange) a été attribué. | |
| name | Obtient le nom de la pièce jointe. | |
| size | Obtient la taille de la pièce jointe en octets. | |
| url | Récupère l’URL de la pièce jointe si son type est MailboxEnums.AttachmentType.Cloud. |
|
| AttachmentsChangedEventArgs | attachmentDetails | Obtient l’objet représentant la pièce jointe ajoutée ou supprimée dans |
| attachmentStatus | Indique si la pièce jointe a été ajoutée ou supprimée d’un élément de courrier. | |
| type | Obtient le type d’événement qui a été déclenché. | |
| Categories | addAsync(categories : string[], callback ?: (asyncResult : Office.AsyncResult<void>) => void) | Ajoute des catégories à un article. |
| addAsync(categories : string[], options : Office.AsyncContextOptions, callback ?: (asyncResult : Office.AsyncResult<void>) => void) | Ajoute des catégories à un article. | |
| getAsync(callback : (asyncResult : Office.AsyncResult<CategoryDetails[]>) => void) | Obtient les catégories d’un élément. | |
| getAsync(options : Office.AsyncContextOptions, callback : (asyncResult : Office.AsyncResult<CategoryDetails[]>) => void) | Obtient les catégories d’un élément. | |
| removeAsync(categories : string[], callback ?: (asyncResult : Office.AsyncResult<void>) => void) | Supprime des catégories d’un élément. | |
| removeAsync(categories : string[], options : Office.AsyncContextOptions, callback ?: (asyncResult : Office.AsyncResult<void>) => void) | Supprime des catégories d’un élément. | |
| Détailscatégorie | color | Couleur de la catégorie. |
| displayName | Nom de la catégorie. | |
| EnhancedLocation | addAsync(locationIdentifiers : LocationIdentifier[], callback ?: (asyncResult : Office.AsyncResult<void>) => void) | S’ajoute à l’ensemble des emplacements associés au rendez-vous. |
| addAsync(locationIdentifiers : LocationIdentifier[], options : Office.AsyncContextOptions, callback ?: (asyncResult : Office.AsyncResult<void>) => void) | S’ajoute à l’ensemble des emplacements associés au rendez-vous. | |
| getAsync(callback ?: (asyncResult : Office.AsyncResult<LocationDetails[]>) => void) | Obtient l’ensemble des emplacements associés au rendez-vous. | |
| getAsync(options : Office.AsyncContextOptions, callback ?: (asyncResult : Office.AsyncResult<LocationDetails[]>) => void) | Obtient l’ensemble des emplacements associés au rendez-vous. | |
| removeAsync(locationIdentifiers : LocationIdentifier[], callback ?: (asyncResult : Office.AsyncResult<void>) => void) | Supprime l’ensemble des emplacements associés au rendez-vous. | |
| removeAsync(locationIdentifiers : LocationIdentifier[], options : Office.AsyncContextOptions, callback ?: (asyncResult : Office.AsyncResult<void>) => void) | Supprime l’ensemble des emplacements associés au rendez-vous. | |
| EnhancedLocationsChangedEventArgs | enhancedLocations | Obtient l’ensemble des emplacements améliorés. |
| type | Obtient le type de l’événement. | |
| InternetHeaders | getAsync(names : string[], callback : (asyncResult : Office.AsyncResult<Record string<, string>>) => void) | Étant donné un tableau de noms d’en-têtes Internet, cette méthode renvoie un enregistrement contenant ces en-têtes Internet et leurs valeurs. |
| getAsync(names : string[], options : Office.AsyncContextOptions, callback : (asyncResult : Office.AsyncResult<Record string<, string>>) => void) | Étant donné un tableau de noms d’en-têtes Internet, cette méthode renvoie un enregistrement contenant ces en-têtes Internet et leurs valeurs. | |
| removeAsync(names : string[], callback ?: (asyncResult : Office.AsyncResult<void>) => void) | Étant donné un tableau de noms d’en-têtes Internet, cette méthode supprime les en-têtes spécifiés de la collection d’en-têtes Internet. | |
| removeAsync(names : string[], options : Office.AsyncContextOptions, callback ?: (asyncResult : Office.AsyncResult<void>) => void) | Étant donné un tableau de noms d’en-têtes Internet, cette méthode supprime les en-têtes spécifiés de la collection d’en-têtes Internet. | |
| setAsync(headers : Record<string, string>, callback ?: (asyncResult : Office.AsyncResult<void>) => void) | Définit les en-têtes Internet spécifiés sur les valeurs spécifiées. | |
| setAsync(headers : Record<string, string>, options : Office.AsyncContextOptions, callback ?: (asyncResult : Office.AsyncResult<void>) => void) | Définit les en-têtes Internet spécifiés sur les valeurs spécifiées. | |
| LocationDetails | displayName | Nom complet de l’emplacement. |
| emailAddress | Adresse e-mail associée à l’emplacement. | |
| locationIdentifier | Le LocationIdentifier de l’emplacement. |
|
| LocationIdentifier | id | ID unique de l’emplacement. |
| type | Type de l’emplacement. | |
| Boîte aux lettres | masterCategories | Obtient un objet qui fournit des méthodes pour gérer la liste master des catégories associée à une boîte aux lettres. |
| Catégoriesmaître | addAsync(categories : CategoryDetails[], callback ?: (asyncResult : Office.AsyncResult<void>) => void) | Ajoute des catégories à la liste master d’une boîte aux lettres. |
| addAsync(categories : CategoryDetails[], options : Office.AsyncContextOptions, callback ?: (asyncResult : Office.AsyncResult<void>) => void) | Ajoute des catégories à la liste master d’une boîte aux lettres. | |
| getAsync(callback : (asyncResult : Office.AsyncResult<CategoryDetails[]>) => void) | Obtient la liste master des catégories sur une boîte aux lettres. | |
| getAsync(options : Office.AsyncContextOptions, callback : (asyncResult : Office.AsyncResult<CategoryDetails[]>) => void) | Obtient la liste master des catégories sur une boîte aux lettres. | |
| removeAsync(categories : string[], callback ?: (asyncResult : Office.AsyncResult<void>) => void) | Supprime des catégories de la liste master d’une boîte aux lettres. | |
| removeAsync(categories : string[], options : Office.AsyncContextOptions, callback ?: (asyncResult : Office.AsyncResult<void>) => void) | Supprime des catégories de la liste master d’une boîte aux lettres. | |
| MessageCompose | addFileAttachmentFromBase64Async(base64File : string, attachmentName : string, callback ?: (asyncResult : Office.AsyncResult<string>) => void) | Ajoute un fichier à un message ou un rendez-vous en pièce jointe. |
| addFileAttachmentFromBase64Async(base64File : string, attachmentName : string, options : Office.AsyncContextOptions & { isInline : boolean }, callback ?: (asyncResult : Office.AsyncResult<string>) => void) | Ajoute un fichier à un message ou un rendez-vous en pièce jointe. | |
| Catégories | Obtient un objet qui fournit des méthodes pour gérer les catégories de l’élément. | |
| 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. | |
| 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. | |
| getItemIdAsync(callback : (asyncResult : Office.AsyncResult<string>) => void) | Obtient de manière asynchrone l’identificateur d’élément EWS (services Web Exchange) | |
| 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. | |
| internetHeaders | Obtient ou définit les en-têtes Internet personnalisés d’un message. | |
| MessageRead | Catégories | Obtient un objet qui fournit des méthodes pour gérer les catégories de l’élément. |
| 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. | |
| 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. | |
| 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. | |
| AttachmentContentFormat | Base64 | Le contenu de la pièce jointe est renvoyé sous la forme d’une chaîne codée en Base64. |
| Eml | Le contenu de la pièce jointe est renvoyé sous la forme d’une chaîne représentant un fichier .eml formaté. | |
| ICalendar | Le contenu de la pièce jointe est renvoyé sous la forme d’une chaîne représentant un fichier au format .icalendar. | |
| Url | Le contenu de la pièce jointe est renvoyé sous la forme d’une chaîne représentant une URL. | |
| AttachmentStatus | Ajout | Une pièce jointe a été ajoutée à l’élément. |
| Supprimé | Une pièce jointe a été supprimée de l’élément. | |
| CategoryColor | Aucun | Couleur par défaut ou aucune couleur mappée. |
| Preset0 | Rouge | |
| Preset1 | Orange | |
| Preset10 | Gris acier | |
| Preset11 | Acier foncé | |
| Preset12 | Gris | |
| Preset13 | Gris foncé | |
| Preset14 | Noir | |
| Preset15 | Rouge foncé | |
| Preset16 | Orange foncé | |
| Preset17 | Marron foncé | |
| Preset18 | Jaune foncé | |
| Preset19 | Vert foncé | |
| Preset2 | Marron | |
| Preset20 | Bleu-vert foncé | |
| Preset21 | Olive foncé | |
| Preset22 | Bleu foncé | |
| Preset23 | Violet foncé | |
| Preset24 | Couleur canneberge foncé | |
| Preset3 | Jaune | |
| Preset4 | Vert | |
| Preset5 | Bleu-vert | |
| Preset6 | Olive | |
| Preset7 | Bleu | |
| Preset8 | Violet | |
| Preset9 | Couleur canneberge | |
| DelegatePermissions | DeleteAll | Le délégué est autorisé à supprimer tous les éléments. |
| DeleteOwn | Le délégué est autorisé à supprimer uniquement les éléments qu’il a créés. | |
| ModifierTout | Le délégué est autorisé à modifier tous les éléments. | |
| EditOwn | Le délégué est autorisé à modifier uniquement les éléments qu’il a créés. | |
| Lire | Le délégué est autorisé à lire les éléments. | |
| Écrire | Le délégué est autorisé à créer et à écrire des éléments. | |
| LocationType | Personnalisé | Un emplacement personnalisé. |
| Room | Une salle de conférence ou une ressource similaire avec une adresse SMTP. | |
| SharedProperties | delegated Permissions | Autorisations dont le délégué dispose sur un dossier partagé ou l’utilisateur sur une boîte aux lettres partagée. |
| owner | Adresse e-mail du propriétaire d’un élément partagé. | |
| Boîte aux lettres cible | Emplacement de la boîte aux lettres du propriétaire pour l’accès du délégué. | |
| targetRestUrl | URL de base de l’API REST (actuellement https://outlook.office.com/api). |
Événements
Le tableau suivant répertorie les événements introduits dans le jeu d’exigences 1.8. 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 |
|---|---|---|
| AttachmentsChanged (Pièces jointesChanged | Une pièce jointe a été ajoutée ou supprimée d’un élément. | Option |
| EnhancedLocationsChanged | Le lieu du rendez-vous a été modifié. | Option |
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.8. 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 |
|---|---|---|---|
| Prise en charge des dossiers partagés |
"authorization.permissions.resourceSpecific.name" définir sur "Mailbox.SharedFolder" |
SupportsSharedFolders | Définit si le complément est disponible dans les scénarios de dossiers partagés. |
Voir aussi
Collaborer avec nous sur GitHub
La source de ce contenu se trouve sur GitHub, où vous pouvez également créer et examiner les problèmes et les demandes de tirage. Pour plus d’informations, consultez notre guide du contributeur.