JavaScript-API-Anforderungssätze für Outlook

Outlook-Add-Ins deklarieren mithilfe des Requirements-Elements in ihrem Manifest, welche API-Versionen sie erfordern. Outlook-Add-Ins umfassen immer ein Set-Element mit einem -Attribut, das auf festgelegt ist, und einem -Attribut, das auf den mindestens erforderlichen API-Anforderungssatz festgelegt ist, der das Add-In-Szenario unterstützt.

Der folgende Manifestcodeausschnitt gibt z. B. als Mindestanforderungssatz 1.1 an.

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

Alle Outlook-APIs gehören zu dem Mailbox -Anforderungssatz. Der Mailbox-Anforderungssatz weist Versionen auf, und jeder neue Satz von APIs, der veröffentlicht wird, gehört zu einer höheren Version des Satzes. Nicht alle Outlook-Clients unterstützen den neuesten Satz von APIs, aber wenn ein Outlook-Client Unterstützung für einen Anforderungssatz deklariert, unterstützt er normalerweise alle APIs in diesem Satz (sehen Sie in der Dokumentation nach, ob es zu einer bestimmten API oder einem bestimmten Feature Ausnahmen gibt).

Das Festlegen einer Mindestanforderungssatzversion im Manifest steuert, in welchem Outlook-Client das Add-In angezeigt wird. Wenn ein Client den Mindestanforderungssatz nicht unterstützt, wird das Add-In nicht geladen. Wenn z. B. Anforderungssatzversion 1.3 angegeben wird, bedeutet dies, dass das Add-In nicht in einem Outlook-Client angezeigt wird, der nicht mindestens 1.3 unterstützt.

Hinweis

Informationen zum Ausführen von APIs in diesen nummerierten Anforderungssätzen finden Sie in der Produktionsbibliothek auf dem CDN (https://appsforoffice.microsoft.com/lib/1/hosted/office.js).

Informationen zur Verwendung der Vorschau-APIs finden Sie im Abschnitt Verwenden von Vorschau-APIs weiter unten in diesem Artikel.

Verwenden von APIs aus neueren Anforderungssätzen

Das Festlegen eines Anforderungssatzes beschränkt nicht die verfügbaren APIs, die das Add-In verwenden kann. Wenn das Add-In beispielsweise den Anforderungssatz „Mailbox 1.1“ angibt, aber in einem Outlook-Client ausgeführt wird, der „Mailbox 1.3“ unterstützt, kann das Add-In APIs aus dem Anforderungssatz „Mailbox 1.3“ verwenden.

Um neuere APIs zu verwenden, können Entwickler folgendermaßen überprüfen, ob eine bestimmte Anwendung den Anforderungssatz unterstützt:

if (Office.context.requirements.isSetSupported('Mailbox', '1.3')) {
  // Perform actions.
}
else {
  // Provide alternate flow/logic.
}

Alternativ können Entwickler mithilfe der Standard-JavaScript-Methode das Vorhandensein einer neueren API überprüfen.

if (item.somePropertyOrFunction !== undefined) {
  // Use item.somePropertyOrFunction.
  item.somePropertyOrFunction;
}

Für APIs, die sich in der im Manifest angegebenen Version des Anforderungssatzes befinden, sind solche Überprüfungen nicht erforderlich.

Auswählen einen Mindestanforderungssatzes

Entwickler sollten den ältesten Anforderungssatz verwenden, der die kritischen APIs für ihr Szenario enthält, ohne die das Add-In nicht funktioniert.

Von Exchange-Servern und Outlook-Clients unterstützte Anforderungssätze

In diesem Abschnitt wird auf den Umfang der von Exchange-Servern und Outlook-Clients unterstützten Anforderungssätze eingegangen. Ausführliche Informationen zu den Server-und Clientanforderungen für die Ausführung von Outlook-Add-Ins finden Sie unter Voraussetzungen für Outlook-Add-Ins .

Wichtig

Wenn Ihr Exchange-Zielserver und Ihr Outlook-Zielclient unterschiedliche Anforderungssätze unterstützen, sind Sie auf den niedrigeren Anforderungssatzumfang beschränkt. Wenn z. B. ein Add-In in Outlook 2016 unter Mac (größter Anforderungssatz: 1.6) gegen Exchange 2013 (größter Anforderungssatz: 1.1) ausgeführt wird, ist das Add-In auf den Anforderungssatz 1.1 beschränkt.

Exchange-Serverunterstützung

Die folgenden Server unterstützen Outlook-Add-Ins.

Produkt Hauptversion von Exchange Unterstützte API-Anforderungssätze
Exchange Online Neuestes Build 1.1, 1.2, 1.3, 1.4, 1.5, 1.6, 1.7, 1.8, 1.9, 1.10
IdentityAPI 1.3*
Exchange lokal 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

Hinweis

* Um in Ihrem Add-In-Code die den Identity API-Satz 1.3 vorzugeben, überprüfen Sie, ob dies unterstützt wird, indem Sie isSetSupported('IdentityAPI', '1.3') aufrufen. Das Deklarieren im Manifest des Add-Ins wird nicht unterstützt. Sie können auch feststellen, ob die API unterstützt wird, indem Sie prüfen, dass sie nicht undefined ist. Weitere Informationen finden Sie unter Verwenden von APIs aus neueren Anforderungssätzen.

Outlook-Clientunterstützung

Add-Ins werden in Outlook auf den folgenden Plattformen unterstützt.

Plattform Hauptversion von Office/Outlook Unterstützte API-Anforderungssätze
Windows Microsoft 365-Abonnement 1.1, 1.2, 1.3, 1.4, 1.5, 1.6, 1.7, 1.81, 1.91, 1.101
IdentityAPI 1.32
2019 Einmalkauf (Einzelhandel) 1.1, 1.2, 1.3, 1.4, 1.5, 1.6, 1.7, 1.81
2019 Einmalkauf (Volumenlizenz) 1.1, 1.2, 1.3, 1.4, 1.5, 1.6, 1.7
2016 als Einmalkauf 1.1, 1.2, 1.3, 1.43
2013 als Einmalkauf 1.1, 1.2, 1.33, 1.43
Mac aktuelle Benutzeroberfläche
(in Verbindung mit einem Microsoft 365-Abonnement)
1.1, 1.2, 1.3, 1.4, 1.5, 1.6, 1.7, 1.8
IdentityAPI 1.32
neue Benutzeroberfläche (Vorschau)4
(in Verbindung mit einem Microsoft 365-Abonnement)
1.1, 1.2, 1.3, 1.4, 1.5, 1.6, 1.7, 1.8
IdentityAPI 1.32
2019 als Einmalkauf 1.1, 1.2, 1.3, 1.4, 1.5, 1.6
2016 als Einmalkauf 1.1, 1.2, 1.3, 1.4, 1.5, 1.6
iOS Microsoft 365-Abonnement 1.1, 1.2, 1.3, 1.4, 1.55
Android Microsoft 365-Abonnement 1.1, 1.2, 1.3, 1.4, 1.55
Webbrowser moderne Outlook-Benutzeroberfläche, wenn verbunden mit
Exchange Online: Microsoft 365-Abonnement, Outlook.com
1.1, 1.2, 1.3, 1.4, 1.5, 1.6, 1.7, 1.8, 1.9, 1.10
IdentityAPI 1.32
klassische Outlook-Benutzeroberfläche, wenn verbunden mit
Exchange lokal
1.1, 1.2, 1.3, 1.4, 1.5, 1.6

Hinweis

1 Unterstützung für 1.8 in Outlook unter Windows mit einem Microsoft 365-Abonnement oder einem Einzelhandel-Einmalkauf verfügbar ab Version 1910 (Build 12130.20272). Unterstützung für 1.9 in Outlook unter Windows mit einem Microsoft 365-Abonnement ist ab Version 2008 (Build 13127.20296) verfügbar. Unterstützung für 1.10 in Outlook unter Windows mit einem Microsoft 365-Abonnement ist ab Version 2104 (Build 13929.20296) verfügbar. Weitere Details gemäß Ihrer Version finden Sie auf der Seite "Updateverlauf" für Office 2019 or Microsoft 365 und Ihre Office-Clientversion und den Updatekanal finden.

2 Um in Ihrem Add-In-Code die den Identity API-Satz 1.3 vorzugeben, überprüfen Sie, ob dies unterstützt wird, indem Sie isSetSupported('IdentityAPI', '1.3') aufrufen. Das Deklarieren im Manifest des Add-Ins wird nicht unterstützt. Sie können auch feststellen, ob die API unterstützt wird, indem Sie prüfen, dass sie nicht undefined ist. Weitere Informationen finden Sie unter Verwenden von APIs aus neueren Anforderungssätzen.

3 Unterstützung für 1.3 in Outlook 2013 wurde als Teil des Outlook 2013-Updates vom 8. Dezember 2015 (KB3114349) hinzugefügt. Unterstützung für 1.4 in Outlook 2013 wurde als Teil des Outlook 2013-Updates vom 13. September 2016 (KB3118280) hinzugefügt. Unterstützung für 1.4 in Outlook 2016 (einmaliger Kauf) wurde als Teil des Office 2016-Updates vom 3. Juli 2018 (KB4022223) hinzugefügt.

4 Unterstützung für die neue Mac-Benutzeroberfläche (Vorschau) ist ab Outlook Version 16.38.506 verfügbar. Weitere Informationen finden Sie im Abschnitt Add-In-Unterstützung in Outlook auf der neuen Mac-Benutzeroberfläche.

5 Aktuell gibt es zusätzliche Überlegungen bei Entwurf und Implementierung von Add-Ins für mobile Clients. Der einzige unterstützte Modus lautet beispielsweise "Nachricht lesen". Weitere Details finden Sie unter Codeüberlegungen beim Hinzufügen von Unterstützung für Add-In-Befehle für Outlook Mobile.

Tipp

Zwischen klassischem und modernem Outlook können Sie in einem Webbrowser anhand der Symbolleiste des Postfachs unterscheiden.

modern

Bildschirmausschnitt der modernen Outlook-Symbolleiste

klassisch

Bildschirmausschnitt der klassischen Outlook-Symbolleiste

Verwenden von Vorschau-APIs

Neue JavaScript-APIs für Outlook werden zuerst als Vorschau eingeführt und werden später Teil eines bestimmten nummerierten Anforderungssatzes, nachdem sie ausreichend getestet wurden und Feedback von Benutzern gesammelt wurde. Wenn Sie Feedback zu einer Vorschau-API geben möchten, verwenden Sie bitte den Feedbackmechanismus am Ende der Webseite, die die Dokumentation der API enthält.

Hinweis

Vorschau-APIs unterliegen Änderungen und können nicht für den Einsatz in Produktionsumgebungen vorgesehen werden.

Weitere Informationen zu den Vorschau-APIs finden Sie unter Preview-Anforderungssatz für die Outlook-API.