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 Teams (préversion) ou le format manifeste XML.

La version de l’API est spécifiée par l’élément Requirements . Les compléments Outlook contiennent toujours un élément Set avec un attribut Name défini sur Mailbox et un attribut MinVersion défini sur l’ensemble minimal de conditions requises de l’API 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.

<Requirements>
  <Sets>
    <Set Name="Mailbox" MinVersion="1.1" />
  </Sets>
</Requirements>

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 (consultez la documentation sur une API ou une fonctionnalité spécifique pour toutes les exceptions).

La définition d’une version minimale d’ensemble de conditions requises dans le manifeste permet de contrôler les clients Outlook dans lesquels le complément va apparaître. 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

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 disponibles en préversion, consultez la section Utilisation des API disponibles en préversion plus loin dans cet article.

Utilisation des API d’un ensemble de conditions requises ultérieure

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

Importante

Il existe actuellement un bogue qui isSetSupported('Mailbox', '1.3') renvoie par erreur true dans Outlook sur le Web par rapport à Exchange 2013. Pour en savoir plus sur les combinaisons prises en charge des ensembles de conditions requises, des serveurs Exchange et des clients Outlook, consultez Ensembles de conditions requises pris en charge par les serveurs Exchange et les clients Outlook.

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.

Choix d’un ensemble minimal de conditions requises

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 est en cours d’exécution dans Outlook 2016 sur Mac (ensemble de conditions requises le plus élevé : 1.6) par rapport à Exchange 2013 (ensemble de conditions requises le plus élevé : 1.1), votre macro peut être limitée à l’ensemble de conditions requises 1.1.

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
IdentityAPI 1.3*
Exchange local 2019 1.1, 1.2, 1.3, 1.4, 1.5
2016 1.1, 1.2, 1.3, 1.4, 1.5
2013 1.1

Remarque

* Pour exiger l’ensemble d’API d’identité 1.3 dans votre code de complément Outlook, vérifiez si elle est prise 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.

Prise en charge du client Outlook

Les compléments sont pris en charge dans Outlook sur les plateformes suivantes.

Plateforme Version principale d’Office/Outlook Ensembles de conditions requises des API prises en charge
Windows - Abonnement Microsoft 365
- Outlook 2016 perpétuels et versions ultérieures
1.1, 1.2, 1.3, 1.4, 1.5, 1.6, 1.7, 1.81, 1.91, 1.10 1, 1.111, 1.121
IdentityAPI 1.32
Outlook 2021 perpétuel sous licence en volume 1.1, 1.2, 1.3, 1.4, 1.5, 1.6, 1.7, 1.81, 1.91
IdentityAPI 1.32
Outlook 2019 perpétuel avec licence en volume 1.1, 1.2, 1.3, 1.4, 1.5, 1.6
Outlook 2016 perpétuel sous licence en volume 1.1, 1.2, 1.3, 1.43
perpétuel Outlook 2013 1.1, 1.2, 1.33, 1.43
Mac interface utilisateur classique 1.1, 1.2, 1.3, 1.4, 1.5, 1.6, 1.7, 1.8
IdentityAPI 1.32
nouvelle interface utilisateur4 1.1, 1.2, 1.3, 1.4, 1.5, 1.6, 1.7, 1.8, 1.9, 1.10, 1.11, 1.12
IdentityAPI 1.32
iOS5 6 Abonnement 1.1, 1.2, 1.3, 1.4, 1.5
Android5 6 Abonnement 1.1, 1.2, 1.3, 1.4, 1.5
Navigateur web5 7 interface utilisateur moderne d’Outlook lors de sa connexion à
Exchange Online : abonnement, Outlook.com
1.1, 1.2, 1.3, 1.4, 1.5, 1.6, 1.7, 1.8, 1.9, 1.10, 1.11, 1.12
IdentityAPI 1.32
interface utilisateur classique d’Outlook lors de sa connexion à
Exchange local
1.1, 1.2, 1.3, 1.4, 1.5, 1.6

Remarque

1 Prise en charge des versions pour les ensembles de conditions requises les plus récents dans Outlook sur Windows avec un abonnement Microsoft 365 ou une licence perpétuelle commerciale, comme suit :

  • La prise en charge de la version 1.8 est disponible à partir de la version 1910 (build 12130.20272).
  • La prise en charge de la version 1.9 est disponible à partir de la version 2008 (build 13127.20296).
  • La prise en charge de la version 1.10 est disponible à partir de la version 2104 (build 13929.20296).
  • La prise en charge de la version 1.11 est disponible à partir de la version 2110 (build 14527.20226).
  • La prise en charge de la version 1.12 est disponible à partir de la version 2206 (build 15330.20196).

Pour plus d’informations sur votre version, consultez la page d’historique des mises à jour pour Office 2021 ou Microsoft 365 et comment trouver votre version du client Office et votre canal de mise à jour.

2 Pour exiger l’ensemble d’API d’identité 1.3 dans votre code de complément Outlook, vérifiez s’il est pris en charge par l’appel 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.

3 La prise en charge de la version 1.3 dans Outlook 2013 a été ajoutée dans le cadre de la mise à jour du 8 décembre 2015 pour Outlook 2013 (KB3114349). La prise en charge de la version 1.4 dans Outlook 2013 a été ajoutée dans le cadre de la mise à jour du 13 septembre 2016 pour Outlook 2013 (KB3118280). La prise en charge de la version 1.4 dans les Outlook 2016 perpétuels sous licence en volume a été ajoutée dans le cadre de la mise à jour du 3 juillet 2018 pour Office 2016 (KB4022223).

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

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

6 Il existe actuellement des considérations supplémentaires lors de la conception et de l’implémentation de compléments pour les clients mobiles. Par exemple, le seul mode pris en charge est lecture de message. Pour plus d’informations, voir considérations relatives au code lors de l’ajout de la prise en charge des commandes de complément pour lesOutlook Mobile.

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

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

Barre d’outils Outlook moderne.

classique

Barre d’outils Outlook classique.

Utilisation des API de 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.