Skip to content

Commit d22c262

Browse files
author
github-actions
committed
Merge branch 'main' into live
2 parents ba6ed22 + c70c0fe commit d22c262

11 files changed

+157
-53
lines changed

docs/develop/create-addin-commands-unified-manifest.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -599,4 +599,4 @@ You've now completed adding a menu to your add-in. [Sideload and test it](../tes
599599
## See also
600600

601601
- [Add-in commands](../design/add-in-commands.md)
602-
- [Unified manifest for Microsoft 365](json-manifest-overview.md).
602+
- [Unified manifest for Microsoft 365](unified-manifest-overview.md)

docs/develop/unified-manifest-overview.md

Lines changed: 22 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
title: Office Add-ins with the unified app manifest for Microsoft 365
33
description: Get an overview of the unified app manifest for Microsoft 365 for Office Add-ins and its uses.
44
ms.topic: overview
5-
ms.date: 02/12/2025
5+
ms.date: 06/19/2025
66
ms.localizationpriority: high
77
---
88

@@ -75,6 +75,27 @@ There is a `"validDomains"` array in the manifest file that is used to tell Offi
7575

7676
To override this behavior in desktop platforms, add each domain you want to open in the add-in window to the list of domains specified in the `"validDomains"` array. If the add-in tries to go to a URL in a domain that is in the list, then it opens in the task pane in both Office on the web and desktop. If it tries to go to a URL that isn't in the list, then in Office on desktop, that URL opens in a new browser window (outside the add-in task pane).
7777

78+
## Client and platform support
79+
80+
Add-ins that use the unified manifest can be installed if the Office platform *directly* supports it.
81+
82+
To run an add-in on platforms that don't directly support the unified manifest, you must publish the add-in to [AppSource](https://appsource.microsoft.com/). When the app package that contains the unified manifest is deployed in AppSource, an add-in only manifest is generated from the unified manifest and stored. This add-in only manifest is then used to install the add-in on platforms that don't directly support the unified manifest.
83+
84+
The following tables lists which Office platforms directly support add-ins that use the unified manifest.
85+
86+
| Client/platform | Support for add-ins with the unified manifest|
87+
| ----- | ----- |
88+
| Office on the web | Directly supported |
89+
| Office on Windows (Version 2304 (Build 16320.00000) or later) connected to a Microsoft 365 subscription | Directly supported |
90+
| [new Outlook on Windows](https://support.microsoft.com/office/656bb8d9-5a60-49b2-a98b-ba7822bc7627) | Directly supported |
91+
| Office on Windows (prior to Version 2304 (Build 16320.00000)) connected to a Microsoft 365 subscription | Not directly supported |
92+
| Office on Windows (perpetual versions) | Not directly supported |
93+
| Office on Mac | Not directly supported |
94+
| Office on mobile | Not directly supported |
95+
96+
> [!NOTE]
97+
> If you're deploying an add-in in the [Microsoft 365 Admin Center](../publish/publish.md) and require it to run on platforms that don't directly support the unified manifest, the add-in must be a published AppSource add-in. Custom add-ins or line-of-business (LOB) add-ins that use the unified manifest can't currently be deployed in the Microsoft 365 Admin Center.
98+
7899
## Sample unified manifest
79100

80101
The following is an example of a unified app manifest for an add-in. It doesn't contain every possible manifest property.

docs/excel/make-custom-functions-compatible-with-xll-udf.md

Lines changed: 29 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,33 @@ To enable compatibility with an existing XLL add-in, identify the equivalent XLL
2020

2121
To set the equivalent XLL add-in for your custom functions, specify the `FileName` of the XLL file. When the user opens a workbook with functions from the XLL file, Excel converts the functions to compatible functions. The workbook then uses the XLL file when opened in Excel on Windows, but it continues to use custom functions from your Excel JavaScript API add-in when opened on the web or on Mac.
2222

23-
The following example shows how to specify both a COM add-in and an XLL add-in as equivalents in an Excel JavaScript API add-in manifest file. Often you specify both. For completeness, this example shows both equivalents in context. They're identified by their `ProgId` and `FileName` respectively. The `EquivalentAddins` element must be positioned immediately before the closing `VersionOverrides` tag. For more information on COM add-in compatibility, see [Make your Office Add-in compatible with an existing COM add-in](../develop/make-office-add-in-compatible-with-existing-com-add-in.md).
23+
The manifest configuration depends on what type of manifest the add-in uses.
24+
25+
# [Unified manifest for Microsoft 365](#tab/jsonmanifest)
26+
27+
The following example shows how to specify both a COM add-in and an XLL add-in as equivalents in a unified manifest. Often you specify both. For completeness, this example shows both equivalents in context. They're identified by their [`"alternates.prefer.comAddin.progId"`](/microsoft-365/extensibility/schema/extension-alternate-versions-array-prefer-com-addin#progid) and [`"alternates.prefer.xllCustomFunctions.filename"`](/microsoft-365/extensibility/schema/extension-alternate-versions-array-prefer-xll-custom-functions#filename) respectively. For more information on COM add-in compatibility, see [Make your Office Add-in compatible with an existing COM add-in](../develop/make-office-add-in-compatible-with-existing-com-add-in.md).
28+
29+
```json
30+
"extensions" [
31+
...
32+
"alternates" [
33+
{
34+
"prefer": {
35+
"comAddin": {
36+
"progId": "ContosoCOMAddin"
37+
},
38+
"xllCustomFunctions": {
39+
"fileName": "contosofunctions.xll"
40+
}
41+
}
42+
}
43+
]
44+
]
45+
```
46+
47+
# [Add-in only manifest](#tab/xmlmanifest)
48+
49+
The following example shows how to specify both a COM add-in and an XLL add-in as equivalents in an Excel JavaScript API add-in only manifest file. Often you specify both. For completeness, this example shows both equivalents in context. They're identified by their `ProgId` and `FileName` respectively. The `EquivalentAddins` element must be positioned immediately before the closing `VersionOverrides` tag. For more information on COM add-in compatibility, see [Make your Office Add-in compatible with an existing COM add-in](../develop/make-office-add-in-compatible-with-existing-com-add-in.md).
2450

2551
```xml
2652
<VersionOverrides>
@@ -39,6 +65,8 @@ The following example shows how to specify both a COM add-in and an XLL add-in a
3965
</VersionOverrides>
4066
```
4167

68+
---
69+
4270
> [!NOTE]
4371
> If an Excel JavaScript API add-in declares its custom functions to be compatible with an XLL add-in, changing the manifest at a later time could break a user's workbook because it will change the file format.
4472
Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,2 @@
11
> [!NOTE]
2-
> Office Add-ins that use the unified manifest for Microsoft 365 are *directly* supported in Office on the web, in [new Outlook on Windows](https://support.microsoft.com/office/656bb8d9-5a60-49b2-a98b-ba7822bc7627), and in Office on Windows connected to a Microsoft 365 subscription, Version 2304 (Build 16320.00000) or later.
3-
>
4-
> When the app package that contains the unified manifest is deployed in [AppSource](https://appsource.microsoft.com/) or the [Microsoft 365 Admin Center](../publish/publish.md) then an add-in only manifest is generated from the unified manifest and stored. This add-in only manifest enables the add-in to be installed on platforms that don't directly support the unified manifest, including Office on Mac, Office on mobile, subscription versions of Office on Windows earlier than 2304 (Build 16320.00000), and perpetual versions of Office on Windows.
2+
> For information on clients and platforms that *directly* support Office Add-ins that use the unified manifest for Microsoft 365, see [Office Add-ins with the unified app manifest for Microsoft 365](../develop/unified-manifest-overview.md#client-and-platform-support).

docs/outlook/compare-outlook-add-in-support-in-outlook-for-mac.md

Lines changed: 9 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
title: Compare Outlook add-in support in Outlook on Mac
33
description: Learn how add-in support in Outlook on Mac compares with other Outlook clients.
4-
ms.date: 02/29/2024
4+
ms.date: 06/19/2025
55
ms.localizationpriority: medium
66
---
77

@@ -11,8 +11,6 @@ You can create and run an Outlook add-in the same way in Outlook on Mac as in th
1111

1212
For more information, see [Deploy and install Outlook add-ins for testing](testing-and-tips.md).
1313

14-
For information about new UI support, see [Add-in support in Outlook on new Mac UI](#add-in-support-in-outlook-on-new-mac-ui).
15-
1614
| Area | Outlook on the web, Windows (new and classic), and mobile devices | Outlook on Mac |
1715
|:-----|:-----|:-----|
1816
| Supported versions of office.js| All APIs in Office.js. | All APIs in Office.js.<br><br>**NOTE**: In Outlook on Mac, only Version 16.35 (20030802) or later supports saving a meeting. Otherwise, the `saveAsync` method fails when called from a meeting in compose mode. See [Cannot save a meeting as a draft in Outlook for Mac by using Office JS API](https://support.microsoft.com/help/4505745) for a workaround. |
@@ -39,3 +37,11 @@ You can determine which UI version you're on, as follows:
3937
**New UI**
4038

4139
![New UI on Mac.](../images/outlook-on-mac-new.png)
40+
41+
## Support for add-ins with the unified manifest for Microsoft 365
42+
43+
Add-ins that use the [unified manifest for Microsoft 365](../develop/unified-manifest-overview.md) aren't directly supported in Outlook on Mac. To run this type of add-in, it must first be published to [AppSource](https://appsource.microsoft.com/). An add-in only manifest is then generated from the unified manifest, which enables the add-in to be installed in Outlook on Mac.
44+
45+
If you're deploying an add-in that uses the unified manifest in the [Microsoft 365 Admin Center](../publish/publish.md) and require it to run in Outlook on Mac, the add-in must be a published AppSource add-in. Custom add-ins or line-of-business (LOB) add-ins that use the unified manifest can't currently be deployed in the Microsoft 365 Admin Center.
46+
47+
For more information, see the "Client and platform support" section of [Office Add-ins with the unified app manifest for Microsoft 365](../develop/unified-manifest-overview.md#client-and-platform-support).

docs/outlook/outlook-mobile-addins.md

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
title: Add-ins for Outlook on mobile devices
33
description: Outlook mobile add-ins are supported on all Microsoft 365 business accounts and Outlook.com accounts.
4-
ms.date: 10/17/2024
4+
ms.date: 06/19/2025
55
ms.localizationpriority: medium
66
---
77

@@ -73,6 +73,14 @@ Here are examples of scenarios that make sense in Outlook mobile.
7373

7474
![Animated GIF showing user interaction with an add-in in Outlook on Android.](../images/outlook-mobile-addin-interaction-android.gif)
7575

76+
## Support for add-ins with the unified manifest for Microsoft 365
77+
78+
Add-ins that use the [unified manifest for Microsoft 365](../develop/unified-manifest-overview.md) aren't directly supported in Outlook on mobile devices. To run this type of add-in, it must first be published to [AppSource](https://appsource.microsoft.com/). An add-in only manifest is then generated from the unified manifest, which enables the add-in to be installed in Outlook mobile.
79+
80+
If you're deploying an add-in that uses the unified manifest in the [Microsoft 365 Admin Center](../publish/publish.md) and require it to run in Outlook mobile, the add-in must be a published AppSource add-in. Custom add-ins or line-of-business (LOB) add-ins that use the unified manifest can't currently be deployed in the Microsoft 365 Admin Center.
81+
82+
For more information, see the "Client and platform support" section of [Office Add-ins with the unified app manifest for Microsoft 365](../develop/unified-manifest-overview.md#client-and-platform-support).
83+
7684
## Testing your add-ins on mobile
7785

7886
To test an add-in on Outlook mobile, first [sideload an add-in](sideload-outlook-add-ins-for-testing.md) using a Microsoft 365 or Outlook.com account in Outlook on the web, on Windows ([new](https://support.microsoft.com/office/656bb8d9-5a60-49b2-a98b-ba7822bc7627) or classic), or on Mac. Make sure your manifest is properly formatted to contain `MobileFormFactor` or it won't load in Outlook mobile.

docs/outlook/smart-alerts-onmessagesend-walkthrough.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
title: Automatically check for an attachment before a message is sent
33
description: Learn how to implement an event-based add-in that implements Smart Alerts to automatically check a message for an attachment before it's sent.
4-
ms.date: 06/17/2025
4+
ms.date: 06/18/2025
55
ms.topic: how-to
66
ms.localizationpriority: medium
77
---
@@ -324,7 +324,7 @@ In this scenario, you'll add handling for sending a message. Your add-in will ch
324324
> - To ensure your add-in runs as expected when an `OnMessageSend` or `OnAppointmentSend` event occurs, call `Office.actions.associate` in the JavaScript file where your handlers are implemented. This maps the event handler name specified in the manifest to its JavaScript counterpart. If this call isn't included in your JavaScript file and the send mode property of your manifest is set to **soft block** or isn't specified, your users will be blocked from sending messages or meetings. The location of the handler name in the manifest differs depending on the type of manifest your add-in uses.
325325
> - **Unified manifest for Microsoft 365**: The value specified in the [`"actionId"`](/microsoft-365/extensibility/schema/extension-auto-run-events-array-events#actionid) property of the applicable [`"autoRunEvents.events"`](/microsoft-365/extensibility/schema/extension-auto-run-events-array-events) object.
326326
> - **Add-in only manifest**: The function name specified in the applicable [LaunchEvent](/javascript/api/manifest/extensionpoint#launchevent) element.
327-
> - When the JavaScript function specified in the manifest to handle an event runs, code in `Office.onReady()` and `Office.initialize` isn't run. We recommend adding any startup logic needed by event handlers, such as checking the user's Outlook version, to the event handlers instead.
327+
> - In classic Outlook on Windows, when the JavaScript function specified in the manifest to handle an event runs, code in `Office.onReady()` and `Office.initialize` isn't run. We recommend adding any startup logic needed by event handlers, such as checking the user's Outlook version, to the event handlers instead.
328328
> - The [errorMessageMarkdown](/javascript/api/outlook/office.smartalertseventcompletedoptions#outlook-office-smartalertseventcompletedoptions-errormessagemarkdown-member) property was introduced in [requirement set 1.15](/javascript/api/requirement-sets/outlook/requirement-set-1.15/outlook-requirement-set-1.15). Learn more about its [supported clients and platforms](/javascript/api/requirement-sets/outlook/outlook-api-requirement-sets#outlook-client-support).
329329

330330
## Customize the text and functionality of a button in the dialog (optional)

docs/outlook/spam-reporting.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
title: Implement an integrated spam-reporting add-in
33
description: Learn how to implement an integrated spam-reporting add-in in Outlook.
4-
ms.date: 06/17/2025
4+
ms.date: 06/18/2025
55
ms.topic: how-to
66
ms.localizationpriority: medium
77
---
@@ -55,7 +55,7 @@ To implement the integrated spam-reporting feature in your add-in, you must conf
5555

5656
:::image type="content" source="../images/outlook-spam-ribbon-button.png" alt-text="A sample ribbon button of a spam-reporting add-in.":::
5757

58-
- The preprocessing dialog. When a user selects the add-in button, a dialog appears with **Report** and **Don't Report** options. In this dialog, you can share information about the reporting process or implement input options to get information about a reported message. Input options include checkboxes, radio buttons, and a text box. When a user selects **Report** from the dialog, the [SpamReporting](/javascript/api/office/office.eventtype) event is activated and is then handled by the JavaScript event handler. The following is an example of a preprocessing dialog in Outlook on Windows. Note that the appearance of the dialog may vary depending on the platform the user's Outlook client is running on.
58+
- The preprocessing dialog. When a user selects the add-in button, a dialog appears with **Report** and **Don't Report** options. In this dialog, you can share information about the reporting process or implement input options to get information about a reported message. Input options include checkboxes, radio buttons, and a text box. When a user selects **Report** from the dialog, the [SpamReporting](/javascript/api/office/office.eventtype) event is activated and is then handled by the JavaScript event handler. The following is an example of a preprocessing dialog in classic Outlook on Windows. Note that the appearance of the dialog may vary depending on the platform the user's Outlook client is running on.
5959

6060
:::image type="content" source="../images/outlook-spam-processing-dialog.png" alt-text="A sample preprocessing dialog of a spam-reporting add-in.":::
6161

@@ -418,12 +418,12 @@ For a list of properties you can include in a JSON object to pass as a parameter
418418

419419
1. Save your changes.
420420

421-
The following is a sample post-processing dialog shown to the user once the add-in completes processing a reported message in Outlook on Windows. Note that the appearance of the dialog may vary depending on the platform the user's Outlook client is running on.
421+
The following is a sample post-processing dialog shown to the user once the add-in completes processing a reported message in classic Outlook on Windows. Note that the appearance of the dialog may vary depending on the platform the user's Outlook client is running on.
422422

423423
:::image type="content" source="../images/outlook-spam-post-processing-dialog.png" alt-text="A sample of a post-processing dialog shown once a reported spam message has been processed by the add-in.":::
424424

425425
> [!TIP]
426-
> As you develop a spam-reporting add-in that will run in Outlook on Windows, keep the following in mind.
426+
> As you develop a spam-reporting add-in that will run in classic Outlook on Windows, keep the following in mind.
427427
>
428428
> - Imports aren't currently supported in the JavaScript file that contains the code to handle the spam-reporting event.
429429
> - When the JavaScript function specified in the manifest to handle the `SpamReporting` event runs, code in `Office.onReady()` and `Office.initialize` isn't run. We recommend adding any startup logic needed by the event handler, such as checking the user's Outlook version, to the event handler instead.

0 commit comments

Comments
 (0)