JavaScript-API-Anforderungssätze für Outlook

Outlook-Add-Ins deklarieren, welche API-Versionen sie in ihrem Manifest benötigen. Das Markup variiert je nachdem, ob Sie das Manifestformat nur für Add-Ins oder das einheitliche Manifest für Microsoft 365 verwenden.

Die API-Version wird durch die Eigenschaft "extensions.requirements.capabilities" angegeben. Legen Sie die Eigenschaft "capabilities.name" auf "Mailbox" und die Eigenschaft "capabilities.minVersion" auf den API-Mindestanforderungssatz fest, der die Szenarien des Add-Ins unterstützt.

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

"extensions": [
{
  "requirements": {
    "capabilities": [
      {
        "name": "Mailbox", "minVersion": "1.1"
      }
    ]
  },
  ...
}

Alle Outlook-APIs gehören zum MailboxAnforderungssatz. 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 die neuesten APIs. Wenn jedoch ein Outlook-Client die Unterstützung für einen Anforderungssatz deklariert, werden in der Regel alle APIs in diesem Anforderungssatz unterstützt (überprüfen Sie die Dokumentation zu einer bestimmten API oder Funktion auf Ausnahmen).

Die im Manifest angegebenen Mindestanforderungen bestimmen, welche Outlook-Clients das Add-In laden können. Wenn der Outlook-Client nicht mindestens die angegebene Version unterstützt, wird das Add-In nicht geladen. Wenn Sie beispielsweise die Version für den Anforderungssatz auf 1.3 festlegen, wird das Add-In nur auf Outlook-Clients angezeigt, die Version 1.3 oder höher unterstützen.

Hinweis

Obwohl Outlook auf Android und iOS bis zum Anforderungssatz 1.5 unterstützt wird, kann Ihr mobiles Add-In jetzt einige APIs aus späteren Anforderungssätzen implementieren. Weitere Informationen dazu, welche APIs in Outlook Mobile unterstützt werden, finden Sie unter In Outlook auf Mobilgeräten unterstützte Outlook-JavaScript-APIs.

Verwenden von APIs aus späteren Anforderungssätzen

Das Festlegen eines Anforderungssatzes schränkt die verfügbaren APIs, die das Add-In verwenden kann, nicht ein. Wenn das Add-In beispielsweise den Anforderungssatz "Postfach 1.1" angibt, aber in einem Outlook-Client ausgeführt wird, der "Postfach 1.3" unterstützt, kann das Add-In APIs aus dem Anforderungssatz "Postfach 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.somePropertyOrMethod !== undefined) {
  // Use item.somePropertyOrMethod.
  item.somePropertyOrMethod;
}

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

Mindestanforderungen auswählen

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 möglicherweise auf den niedrigeren Anforderungssatzumfang beschränkt. Wenn beispielsweise ein Add-In in Outlook 2019 unter Windows (höchster Anforderungssatz: 1.6) im Vergleich zu Exchange 2016 (höchster Anforderungssatz: 1.5) ausgeführt wird, ist Ihr Add-In möglicherweise auf den Anforderungssatz 1.5 beschränkt.

Exchange-Serverunterstützung

In der folgenden Tabelle sind die Exchange-Server und die von ihnen unterstützten Postfachanforderungssätze aufgeführt. Damit Ihr Add-In in Outlook angezeigt wird, das in einer bestimmten Exchange-Umgebung gehostet wird, muss die Version, die Sie als Mindestanforderung im Manifest Ihres Add-Ins angeben, von dieser Umgebung unterstützt werden.

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, 1.11, 1.12, 1.13, 1.14, 1.15, 1.16
IdentityAPI 1.31
Exchange lokal Subscription Edition (SE) 1.1, 1.2, 1.3, 1.4, 1.5
2019 1.1, 1.2, 1.3, 1.4, 1.5
2016 1.1, 1.2, 1.3, 1.4, 1.5

1 Um das Identitäts-API-Set 1.3 in Ihrem Outlook-Add-In-Code vorzuschreiben, überprüfen Sie, ob es unterstützt wird, indem isSetSupported('IdentityAPI', '1.3')Sie . Das Deklarieren im Manifest des Outlook-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.

Auch wenn ein Add-In Features aus späteren Anforderungssätzen implementiert, die in einer lokalen Exchange-Umgebung nicht unterstützt werden, kann es dennoch einem Outlook-Client hinzugefügt werden, solange der im Manifest angegebene Mindestanforderungssatz mit den in der lokalen Exchange-Umgebung unterstützten übereinstimmt. Ein implementiertes Feature funktioniert jedoch nur, wenn der Outlook-Client, in dem das Add-In installiert ist, den Mindestanforderungssatz unterstützt, der für ein Feature erforderlich ist. Beispielsweise wird ein Signatur-Add-In, dessen Manifest 1.5 angibt, in der lokalen Exchange 2019-Umgebung installiert und geladen. Der Aufruf von Body.setSignatureAsync, der im Anforderungssatz 1.10 eingeführt wurde, wird jedoch nur ausgeführt, wenn der Outlook-Client, auf dem das Add-In installiert ist, 1.10 unterstützt.

Informationen zum Ermitteln der Anforderungssätze, die von verschiedenen Outlook-Clients unterstützt werden, finden Sie unter Outlook-Clientunterstützung. Wir empfehlen, diese mit der Dokumentation zum spezifischen Feature für eventuelle Ausnahmen zu ergänzen.

Outlook-Clientunterstützung

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

Plattform Hauptversion von Office/Outlook Unterstützte API-Anforderungssätze
Webbrowser1 2 moderne Outlook-Benutzeroberfläche, wenn verbunden mit
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, 1.13, 1.14, 1.15, 1.16
DevicePermissionService 1.1
DialogAPI 1.1
DialogAPI 1.2
DialogOrigin 1.1
IdentityAPI 1.33
NestedAppAuth 1.1
klassische Outlook-Benutzeroberfläche, wenn verbunden mit
Exchange lokal
1.1, 1.2, 1.3, 1.4, 1.5, 1.6
Windows neue Outlook-Benutzeroberfläche mit einem Microsoft 365-Abonnement 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, 1.15, 1.16
DevicePermissionService 1.1
DialogAPI 1.1
DialogAPI 1.2
DialogOrigin 1.1
IdentityAPI 1.33
NestedAppAuth 1.1
Klassische Outlook-Benutzeroberfläche mit einem Microsoft 365-Abonnement4 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, 1.15, 1.16
DialogAPI 1.1
DialogAPI 1.2
DialogOrigin 1.1
IdentityAPI 1.33
NestedAppAuth 1.1
OpenBrowserWindowApi 1.1
Unbefristetes Outlook 2021 und höher für den Einzelhandel (klassische Outlook-Benutzeroberfläche)4 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, 1.15, 1.16
DialogAPI 1.1
DialogAPI 1.2
DialogOrigin 1.1
IdentityAPI 1.33
NestedAppAuth 1.1
OpenBrowserWindowApi 1.1
Volumenlizenzierte unbefristete/LTSC Outlook 2024 (klassische Outlook-Benutzeroberfläche) 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
DialogAPI 1.1
DialogAPI 1.2
DialogOrigin 1.1
IdentityAPI 1.33
NestedAppAuth 1.1
OpenBrowserWindowApi 1.1
Volumenlizenz unbefristet/LTSC Outlook 2021 (klassische Outlook-Benutzeroberfläche) 1.1, 1.2, 1.3, 1.4, 1.5, 1.6, 1.7, 1.8, 1.9
DialogAPI 1.1
DialogAPI 1.2
DialogOrigin 1.1
IdentityAPI 1.33
OpenBrowserWindowApi 1.1
Mac neue UI5 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
DialogAPI 1.1
DialogAPI 1.2
DialogOrigin 1.1
IdentityAPI 1.33
NestedAppAuth 1.1
OpenBrowserWindowApi 1.1
Klassische Benutzeroberfläche 1.1, 1.2, 1.3, 1.4, 1.5, 1.6, 1.7, 1.8
DialogAPI 1.1
DialogAPI 1.26
DialogOrigin 1.1
IdentityAPI 1.33
NestedAppAuth 1.1
OpenBrowserWindowApi 1.1
Android1 7 Abonnement 1.1, 1.2, 1.3, 1.4, 1.5
NestedAppAuth 1.1
iOS1 7 Abonnement 1.1, 1.2, 1.3, 1.4, 1.5
NestedAppAuth 1.1

1 Add-Ins werden in Outlook auf Android, unter iOS und im modernen mobilen Web mit lokalen Exchange-Konten nicht unterstützt. Bestimmte iOS-Geräte unterstützen weiterhin Add-Ins, wenn lokale Exchange-Konten mit klassischem Outlook im Web verwendet werden. Informationen zu unterstützten Geräten finden Sie unter Voraussetzungen zum Ausführen von Office-Add-Ins.

2 Add-Ins funktionieren im modernen Outlook im Web auf iPhone- und Android-Smartphones nicht. Informationen zu unterstützten Geräten finden Sie unter Voraussetzungen zum Ausführen von Office-Add-Ins.

3 Um das Identitäts-API-Set 1.3 in Ihrem Outlook-Add-In-Code vorzuschreiben, überprüfen Sie, ob es unterstützt wird, indem isSetSupported('IdentityAPI', '1.3')Sie . Das Deklarieren im Manifest des Outlook-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.

4 Informationen zu den mindestens unterstützten Versionen für aktuelle Anforderungssätze im klassischen Outlook unter Windows mit einem Microsoft 365-Abonnement oder einer unbefristeten Einzelhandelslizenz finden Sie unter Versionsunterstützung für Anforderungssätze im klassischen Outlook unter Windows.

5 Unterstützung für die neue Mac-Benutzeroberfläche 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.

6 Obwohl das klassische Outlook auf Mac den Postfach-Anforderungssatz 1.9 nicht unterstützt, unterstützt es den DialogApi 1.2-Anforderungssatz. Informationen zu den unterstützten Mindestversionen und -builds finden Sie unter Dialog-API-Anforderungssätze.

7 Derzeit gibt es zusätzliche Überlegungen beim Entwerfen und Implementieren von Add-Ins für mobile Clients. Weitere Details finden Sie unter Codeüberlegungen beim Hinzufügen von Unterstützung für Add-In-Befehle in Outlook auf mobilen Geräten. Obwohl Outlook auf Android und iOS bis zum Anforderungssatz 1.5 unterstützt wird, kann Ihr mobiles Add-In jetzt einige APIs aus späteren Anforderungssätzen implementieren. Weitere Informationen dazu, welche APIs in Outlook Mobile unterstützt werden, finden Sie unter In Outlook auf Mobilgeräten unterstützte Outlook-JavaScript-APIs.

Tipp

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

modern

Die moderne Outlook-Symbolleiste.

klassisch

Die klassische Outlook-Symbolleiste.

Versionsunterstützung für Anforderungssätze im klassischen Outlook unter Windows

In der folgenden Tabelle ist die Versionsunterstützung für neuere Postfachanforderungssätze im klassischen Outlook unter Windows mit einem Microsoft 365-Abonnement oder einer unbefristeten Einzelhandelslizenz aufgeführt.

Anforderungssatz 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)
1.14 Version 2404 (Build 17530.15000)
1.15 Version 2412 (Build 18324.20172)
1.16 Version 2602 (Build 19725.20126)

Weitere Informationen zu Ihrer Clientversion finden Sie auf der Seite zum Updateverlauf für Microsoft 365 oder Office 2024 , und wie Sie Ihre Office-Clientversion und Ihren Updatekanal finden.

Hinweis

In Outlook empfängt jeder Updatekanal Updates mit einer anderen Geschwindigkeit. Informationen dazu, wie Sie sicherstellen können, dass Ihr Kanal eine bestimmte Version oder einen bestimmten Build unterstützt, finden Sie unter Updateverlauf für Microsoft 365 Apps. Einen Vergleich der verschiedenen Updatekanäle finden Sie unter Übersicht über die Updatekanäle für Microsoft 365 Apps.

Verweisen auf die Office JavaScript-API-Produktionsbibliothek

Informationen zum Ausführen von APIs in einem der nummerierten Anforderungssätze finden Sie in der Produktionsbibliothek im Content Delivery Network (CDN) von Office.js. Informationen zur Verwendung von Vorschau-APIs finden Sie unter Testen von Vorschau-APIs.

Testen 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 können sich ändern und sind nicht für die Verwendung in einer Produktionsumgebung vorgesehen.

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