Ensembles de conditions requises de l’API JavaScript pour Outlook
Les compléments Outlook déclarent les versions d’API dont ils ont besoin dans leur manifeste. Le balisage varie selon que vous utilisez le format de manifeste du complément uniquement ou le manifeste unifié pour Microsoft 365.
La version de l’API est spécifiée par la propriété « extensions.requirements.capabilities ». Définissez la propriété « capabilities.name » sur « Mailbox » et la propriété « capabilities.minVersion » sur l’ensemble de conditions requises de l’API minimale qui prend en charge les scénarios du complément.
Par exemple, l’extrait de manifeste suivant indique l’ensemble minimal de conditions requises 1.1.
"extensions": [
{
"requirements": {
"capabilities": [
{
"name": "Mailbox", "minVersion": "1.1"
}
]
},
...
}
Toutes les API Outlook appartiennent à l’ensemble de Mailboxconditions requises. L’ensemble de conditions requises Mailbox possède plusieurs versions et chaque nouvel ensemble d’API publié appartient à une version supérieure de l’ensemble. Tous les clients Outlook ne prennent pas en charge l’ensemble d’API le plus récent, mais si un client Outlook déclare prendre en charge un ensemble de conditions requises, il prend généralement en charge toutes les API de cet ensemble de conditions requises (case activée la documentation sur une API ou une fonctionnalité spécifique pour toutes les exceptions).
Définition d’une version minimale de l’ensemble de conditions requises dans les contrôles de manifeste dans lesquels le client Outlook le complément s’affiche. Si un client ne prend pas en charge l’ensemble de conditions requises minimales, il ne charge pas le complément. Par exemple, si la version de l’ensemble de conditions requises spécifiée est 1.3, le complément n’apparaîtra pas dans les clients Outlook qui ne prennent pas en charge au minimum la version 1.3.
Remarque
Bien qu’Outlook sur Android et sur iOS prennent en charge jusqu’à l’ensemble de conditions requises 1.5, votre complément mobile peut désormais implémenter certaines API à partir d’ensembles de conditions requises ultérieurs. Pour plus d’informations sur les API prises en charge dans Outlook Mobile, consultez API JavaScript Outlook prises en charge dans Outlook sur les appareils mobiles.
Utiliser des API à partir d’ensembles de conditions requises ultérieurs
La définition d’un ensemble de conditions requises ne limite pas les API disponibles que le complément peut utiliser. Par exemple, si le complément spécifie l’ensemble de conditions requises « Mailbox 1.1 », mais qu’il s’exécute dans un client Outlook qui prend en charge « Mailbox 1.3 », le complément peut utiliser les API de l’ensemble de conditions requises « Mailbox 1.3 ».
Pour utiliser une nouvelle API, les développeurs peuvent vérifier si une application particulière prend en charge l’ensemble des conditions requises en procédant comme suit :
if (Office.context.requirements.isSetSupported('Mailbox', '1.3')) {
// Perform actions.
}
else {
// Provide alternate flow/logic.
}
Autrement, les développeurs peuvent vérifier la disponibilité d’une nouvelle API en utilisant la technique JavaScript standard.
if (item.somePropertyOrMethod !== undefined) {
// Use item.somePropertyOrMethod.
item.somePropertyOrMethod;
}
Ces vérifications ne sont pas nécessaires pour les API présentes dans l’ensemble de conditions requises dont la version est la même que celle spécifiée dans le manifeste.
Choisir un ensemble de conditions requises minimales
Les développeurs doivent utiliser l’ensemble de conditions requises le plus ancien qui contient l’ensemble d’API critique pour leur scénario, sans lequel le complément ne fonctionne pas.
Ensembles de conditions requises pris en charge par les serveurs Exchange et les clients Outlook
Dans cette section, nous prenons note de la plage d’ensembles de conditions requises pris en charge par les serveurs Exchange et les clients Outlook. Pour plus d’informations sur la configuration requise pour le serveur et le client pour l’exécution de compléments Outlook, voir Conditions requises pour les compléments Outlook.
Importante
Si votre serveur cible Exchange client Outlook prendre en charge différents ensembles de conditions requises, vous pouvez être limité à la plage d’ensembles de conditions requises inférieure. Par exemple, si un complément s’exécute dans Outlook 2019 sur Windows (ensemble de conditions requises la plus élevée : 1.6) par rapport à Exchange 2016 (ensemble de conditions requises le plus élevé : 1.5), votre complément peut être limité à l’ensemble de conditions requises 1.5.
Prise en charge par le serveur Exchange
Les serveurs suivants prennent en charge des compléments Outlook.
| Produit | Version principale d’Exchange | Ensembles de conditions requises des API prises en charge |
|---|---|---|
| Exchange Online | Dernière version |
1.1, 1.2, 1.3, 1.4, 1.5, 1.6, 1.7, 1.8, 1.9, 1.10, 1.11, 1.12, 1.13, 1.14 IdentityAPI 1.31 |
| Exchange sur site2 | 2019 | 1.1, 1.2, 1.3, 1.4, 1.5 |
| 2016 | 1.1, 1.2, 1.3, 1.4, 1.5 |
Remarque
1 Pour exiger l’ensemble d’API d’identité 1.3 dans le code de votre complément Outlook, case activée s’il est pris en charge en appelant isSetSupported('IdentityAPI', '1.3'). Sa déclaration dans le manifeste du Outlook n’est pas prise en charge. Vous pouvez également déterminer si l’API est prise en charge en vérifiant qu’elle n’est pas undefined. Pour plus d’informations, consultez Utilisation des API d’un ensemble de conditions requises ultérieure.
2 Même si un complément implémente des fonctionnalités à partir d’ensembles de conditions requises non pris en charge dans un environnement Exchange local, il peut toujours être ajouté à un client Outlook tant que l’ensemble de conditions requises spécifié dans son manifeste s’aligne sur celles prises en charge par Exchange en local. Toutefois, une fonctionnalité implémentée ne fonctionne que si le client Outlook dans lequel le complément est installé prend en charge la configuration requise minimale requise par une fonctionnalité. Pour déterminer les ensembles de conditions requises pris en charge par différents clients Outlook, consultez Prise en charge des clients Outlook. Nous vous recommandons de le compléter avec la documentation sur la fonctionnalité spécifique pour toutes les exceptions.
Prise en charge du client Outlook
Les compléments sont pris en charge dans Outlook sur les plateformes suivantes.
Remarque
1 Les compléments ne sont pas pris en charge dans Outlook sur Android, iOS et le web mobile moderne avec des comptes Exchange locaux. Certains appareils iOS prennent toujours en charge les compléments lors de l’utilisation de comptes Exchange locaux avec des Outlook sur le web classiques. Pour plus d’informations sur les appareils pris en charge, consultez Configuration requise pour l’exécution des compléments Office.
2 Les compléments ne fonctionnent pas dans les Outlook sur le web modernes sur les smartphones iPhone et Android. Pour plus d’informations sur les appareils pris en charge, consultez Configuration requise pour l’exécution des compléments Office.
3 Pour exiger l’ensemble d’API d’identité 1.3 dans le code de votre complément Outlook, case activée s’il est pris en charge en appelant isSetSupported('IdentityAPI', '1.3'). Sa déclaration dans le manifeste du Outlook n’est pas prise en charge. Vous pouvez également déterminer si l’API est prise en charge en vérifiant qu’elle n’est pas undefined. Pour plus d’informations, consultez Utilisation des API d’un ensemble de conditions requises ultérieure.
4 Pour en savoir plus sur les versions minimales prises en charge pour les ensembles de conditions requises récents dans Outlook classique sur Windows avec un abonnement Microsoft 365 ou une licence perpétuelle commerciale, voir Prise en charge des versions pour les ensembles de conditions requises dans Outlook classique sur Windows.
5 La prise en charge de la version 1.4 dans les Outlook 2016 perpétuelles sous licence en volume a été ajoutée dans le cadre de la mise à jour du 3 juillet 2018 pour Office 2016 (KB4022223).
6 La prise en charge de la nouvelle interface utilisateur Mac est disponible à partir d’Outlook version 16.38.506. Pour plus d’informations, consultez la section Prise en charge du macro complémentaire dans Outlook sur le nouvel interface d’utilisateur Mac.
7 Bien qu’Outlook classique sur Mac ne prend pas en charge l’ensemble de conditions requises de boîte aux lettres 1.9, il prend en charge l’ensemble de conditions requises DialogApi 1.2. Pour plus d’informations sur la version et la build minimales prises en charge, consultez Ensembles de conditions requises de l’API dialog.
8 Il existe actuellement des considérations supplémentaires lors de la conception et de l’implémentation de compléments pour les clients mobiles. Pour plus d’informations, consultez considérations relatives au code lors de l’ajout de la prise en charge des commandes de complément dans Outlook sur les appareils mobiles. Bien qu’Outlook sur Android et sur iOS prennent en charge jusqu’à l’ensemble de conditions requises 1.5, votre complément mobile peut désormais implémenter certaines API à partir d’ensembles de conditions requises ultérieurs. Pour plus d’informations sur les API prises en charge dans Outlook Mobile, consultez API JavaScript Outlook prises en charge dans Outlook sur les appareils mobiles.
Conseil
Vous pouvez faire la distinction entre les deux versions d’Outlook, classique et moderne, dans un navigateur Web en regardant la barre d’outils de votre boîte aux lettres.
moderne
classique
Prise en charge des versions pour les ensembles de conditions requises dans Outlook classique sur Windows
Le tableau suivant répertorie la prise en charge des versions pour les ensembles de conditions requises de boîte aux lettres plus récents dans Outlook sur Windows classique avec un abonnement Microsoft 365 ou une licence perpétuelle commerciale.
| Ensemble de conditions requises | Version |
|---|---|
| 1.8 | Version 1910 (build 12130.20272) |
| 1.9 | Version 2008 (build 13127.20296) |
| 1.10 | Version 2104 (Build 13929.20296) |
| 1.11 | Version 2110 (build 14527.20226) |
| 1.12 | Version 2206 (build 15330.20196) |
| 1.13 | Version 2304 (Build 16327.20248) |
| 11.4 | Version 2404 (build 17530.15000) |
Pour plus d’informations sur la version de votre client, consultez la page historique des mises à jour pour Microsoft 365 ou Office 2024 et comment trouver votre version du client Office et le canal de mise à jour.
Référencer la bibliothèque de production de l’API JavaScript Office
Pour utiliser des API dans l’un des ensembles de conditions requises numérotées, vous devez référencer la bibliothèque de productionsur le réseau de distribution de contenu (CDN) Office.js. Pour plus d’informations sur l’utilisation des API en préversion, consultez Tester les API en préversion.
API de test en préversion
Les nouvelles API Outlook JavaScript sont d’abord introduites dans la « préversion », puis deviennent partie intégrante d’un ensemble de conditions requises spécifiques numérotées une fois qu’un nombre suffisant de tests a été effectué et que les utilisateurs ont renvoyé des commentaires. Pour formuler des commentaires sur une version d’évaluation API, utilisez le mécanisme de commentaires à la fin de la page web où l’API est documenté.
Remarque
Les API en préversion sont susceptibles d’être modifiées et ne sont pas destinées à être utilisées dans un environnement de production.
Pour plus d’informations sur les API de préversion, reportez-vous à l’article relatif à l’ensemble de conditions requises de l’API Outlook de préversion.