You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
[Outlook] (requirement sets) Clarify support (#2285)
* Apply feedback
* Minor fixes
* Apply suggestion
* Apply suggestions from review
Co-authored-by: Elizabeth Samuel <[email protected]>
---------
Co-authored-by: Elizabeth Samuel <[email protected]>
Copy file name to clipboardExpand all lines: docs/requirement-sets/outlook/outlook-api-requirement-sets.md
+11-8Lines changed: 11 additions & 8 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,7 +1,7 @@
1
1
---
2
2
title: Outlook JavaScript API requirement sets
3
3
description: Learn more about the Outlook JavaScript API requirement sets.
4
-
ms.date: 03/11/2025
4
+
ms.date: 05/29/2025
5
5
ms.topic: overview
6
6
ms.localizationpriority: high
7
7
---
@@ -48,7 +48,7 @@ For example, the following manifest snippet indicates a minimum requirement set
48
48
49
49
All Outlook APIs belong to the `Mailbox`[requirement set](/office/dev/add-ins/develop/specify-office-hosts-and-api-requirements). The `Mailbox` requirement set has versions, and each new set of APIs that we release belongs to a higher version of the set. Not all Outlook clients support the newest set of APIs, but if an Outlook client declares support for a requirement set, generally it supports all of the APIs in that requirement set (check the documentation on a specific API or feature for any exceptions).
50
50
51
-
Setting a minimum requirement set version in the manifest controls in which Outlook client the add-in will appear. If a client doesn't support the minimum requirement set, it doesn't load the add-in. For example, if requirement set version 1.3 is specified, this means the add-in will not show up in any Outlook client that doesn't support at least 1.3.
51
+
The minimum requirement set specified in the manifest determines which Outlook clients can load the add-in. If the Outlook client doesn't support at least the specified version, the add-in won't load. For example, if you specify the requirement set version to 1.3, the add-in only appears in Outlook clients that support version 1.3 or higher.
52
52
53
53
> [!NOTE]
54
54
> Although Outlook on Android and on iOS support up to requirement set 1.5, your mobile add-in can now implement some APIs from later requirement sets. For more information on which APIs are supported in Outlook mobile, see [Outlook JavaScript APIs supported in Outlook on mobile devices](/office/dev/add-ins/outlook/outlook-mobile-apis).
@@ -92,18 +92,19 @@ In this section, we note the range of requirement sets supported by Exchange ser
92
92
93
93
### Exchange server support
94
94
95
-
The following servers supportOutlook add-ins.
95
+
The following table lists Exchange servers and the Mailbox requirement sets they support. For your add-in to show up in Outlook hosted in a particular Exchange environment, the version you specify as the minimum requirement set in your add-in's manifest must be supported by that environment.
96
96
97
97
| Product | Major Exchange version | Supported API requirement sets |
> <sup>1</sup> [!INCLUDE [How to use the Identity 1.3 requirement set in Outlook add-ins](../../includes/outlook-identity-13-note.md)]
105
-
>
106
-
> <sup>2</sup> Even if an add-in implements features from requirement sets not supported in an Exchange on-premises environment, it can still be added to an Outlook client as long as the requirement set specified in its manifest aligns with those supported by Exchange on-premises. However, an implemented feature will only work if the Outlook client in which the add-in is installed supports the minimum requirement set needed by a feature. To determine the requirement sets supported by varying Outlook clients, see [Outlook client support](#outlook-client-support). We recommend supplementing this with the documentation on the specific feature for any exceptions.
104
+
105
+
Even if an add-in implements features from later requirement sets not supported in an Exchange on-premises environment, it can still be added to an Outlook client as long as the minimum requirement set specified in its manifest aligns with those supported by Exchange on-premises. However, an implemented feature only works if the Outlook client in which the add-in is installed supports the minimum requirement set needed by a feature. For example, a signature add-in that specifies 1.5 in its manifest will be installed and loaded in the Exchange 2019 on-premises environment. However, its call to [Body.setSignatureAsync](/javascript/api/outlook/office.body#outlook-office-body-setsignatureasync-member(1)), which was introduced in requirement set 1.10, will only run if the Outlook client where the add-in is installed supports 1.10.
106
+
107
+
To determine the requirement sets supported by varying Outlook clients, see [Outlook client support](#outlook-client-support). We recommend supplementing this with the documentation on the specific feature for any exceptions.
107
108
108
109
### Outlook client support
109
110
@@ -125,7 +126,6 @@ Add-ins are supported in Outlook on the following platforms.
> <sup>1</sup> Add-ins aren't supported in Outlook on Android, on iOS, and modern mobile web with on-premises Exchange accounts. Certain iOS devices still support add-ins when using on-premises Exchange accounts with classic Outlook on the web. For information about supported devices, see [Requirements for running Office Add-ins](/office/dev/add-ins/concepts/requirements-for-running-office-add-ins#client-requirements-non-windows-smartphone-and-tablet).
130
130
>
131
131
> <sup>2</sup> Add-ins don't work in modern Outlook on the web on iPhone and Android smartphones. For information about supported devices, see [Requirements for running Office Add-ins](/office/dev/add-ins/concepts/requirements-for-running-office-add-ins#client-requirements-non-windows-smartphone-and-tablet).
@@ -170,6 +170,9 @@ The following table lists version support for more recent Mailbox requirement se
170
170
171
171
For more details about your client version, see the update history page for [Microsoft 365](/officeupdates/update-history-office365-proplus-by-date) or [Office 2024](/officeupdates/update-history-office-2024) and how to [find your Office client version and update channel](https://support.microsoft.com/office/932788b8-a3ce-44bf-bb09-e334518b8b19).
172
172
173
+
> [!NOTE]
174
+
> In Outlook, each update channel receives updates at a different rate. To verify that your channel supports a particular version or build, see [Update history for Microsoft 365 Apps](/officeupdates/update-history-microsoft365-apps-by-date). For a comparison of the different update channels, see [Overview of update channels for Microsoft 365 Apps](/microsoft-365-apps/updates/overview-update-channels).
175
+
173
176
## Reference the Office JavaScript API production library
174
177
175
178
To use APIs in any of the numbered requirement sets, you should reference the **production** library on the [Office.js content delivery network (CDN)](https://appsforoffice.microsoft.com/lib/1/hosted/office.js). For information on how to use preview APIs, see [Test preview APIs](#test-preview-apis).
0 commit comments