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 reine Add-In-Manifestformat 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 MINDEST-API-Anforderungssatz 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 AnforderungssatzMailbox. 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 im Allgemeinen alle APIs in diesem Anforderungssatz (lesen Sie die Dokumentation zu einer bestimmten API oder einem Feature auf Ausnahmen).
Festlegen einer Mindestanforderungssatzversion in den Manifeststeuerelementen, in denen das Add-In vom Outlook-Client angezeigt wird. Wenn ein Client den Mindestanforderungssatz nicht unterstützt, wird das Add-In nicht geladen. Wenn beispielsweise die Anforderungssatzversion 1.3 angegeben ist, bedeutet dies, dass das Add-In in keinem Outlook-Client angezeigt wird, der mindestens 1.3 nicht unterstützt.
Hinweis
Obwohl Outlook unter Android und unter iOS bis zum Anforderungssatz 1.5 unterstützt, 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 mobilen Geräten unterstützte 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 "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.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.
Auswählen eines 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 möglicherweise auf den niedrigeren Anforderungssatzumfang beschränkt. Wenn beispielsweise ein Add-In in Outlook 2019 unter Windows (höchster Anforderungssatz: 1.6) für 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
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, 1.11, 1.12, 1.13, 1.14 IdentityAPI 1.31 |
| Lokales Exchange2 | 2019 | 1.1, 1.2, 1.3, 1.4, 1.5 |
| 2016 | 1.1, 1.2, 1.3, 1.4, 1.5 |
Hinweis
1 Wenn Sie den Identitäts-API-Satz 1.3 in Ihrem Outlook-Add-In-Code anfordern möchten, überprüfen Sie, ob dies unterstützt wird, indem Sie aufrufen isSetSupported('IdentityAPI', '1.3'). 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.
2 Auch wenn ein Add-In Features aus 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 Anforderungssatz den von Exchange lokal unterstützten Anforderungen entspricht. Ein implementiertes Feature funktioniert jedoch nur, wenn der Outlook-Client, in dem das Add-In installiert ist, die für ein Feature erforderlichen Mindestanforderungen unterstützt. Informationen zum Ermitteln der Anforderungssätze, die von unterschiedlichen Outlook-Clients unterstützt werden, finden Sie unter Outlook-Clientunterstützung. Es wird empfohlen, dies mit der Dokumentation zum spezifischen Feature für alle Ausnahmen zu ergänzen.
Outlook-Clientunterstützung
Add-Ins werden in Outlook auf den folgenden Plattformen unterstützt.
Hinweis
1 Add-Ins werden in Outlook unter Android, unter iOS und modernem mobilen Web mit lokalen Exchange-Konten nicht unterstützt. Bestimmte iOS-Geräte unterstützen weiterhin Add-Ins, wenn sie lokale Exchange-Konten mit klassischen Outlook im Web verwenden. Informationen zu unterstützten Geräten finden Sie unter Voraussetzungen zum Ausführen von Office-Add-Ins.
2 Add-Ins funktionieren nicht in modernen Outlook im Web auf iPhone- und Android-Smartphones. Informationen zu unterstützten Geräten finden Sie unter Voraussetzungen zum Ausführen von Office-Add-Ins.
3 Um den Identitäts-API-Satz 1.3 in Ihrem Outlook-Add-In-Code zu erfordern, überprüfen Sie, ob dies unterstützt wird, indem Sie aufrufen isSetSupported('IdentityAPI', '1.3'). 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 unterstützten Mindestversionen 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 1.4 in volumelizenzierten unbefristeten Outlook 2016 wurde im Rahmen des Updates für Office 2016 (KB4022223) vom 3. Juli 2018 hinzugefügt.
6 Unterstützung für die neue Mac-Benutzeroberfläche ist in 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.
7 Obwohl das klassische Outlook für Mac den Postfachanforderungssatz 1.9 nicht unterstützt, unterstützt es den DialogApi 1.2-Anforderungssatz. Informationen zur unterstützten Mindestversion und zum Build finden Sie unter Dialog-API-Anforderungssätze.
8 Derzeit gibt es zusätzliche Überlegungen beim Entwerfen und Implementieren von Add-Ins für mobile Clients. Weitere Informationen finden Sie unter Codeüberlegungen beim Hinzufügen von Unterstützung für Add-In-Befehle in Outlook auf mobilen Geräten. Obwohl Outlook unter Android und unter iOS bis zum Anforderungssatz 1.5 unterstützt, 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 mobilen Geräten unterstützte JavaScript-APIs.
Tipp
Zwischen klassischem und modernem Outlook können Sie in einem Webbrowser anhand der Symbolleiste des Postfachs unterscheiden.
modern
klassisch
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) |
Weitere Informationen zu Ihrer Clientversion finden Sie auf der Seite mit dem Updateverlauf für Microsoft 365 oder Office 2024 und wie Sie Ihre Office-Clientversion und ihren Updatekanal finden.
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.
Office Add-ins