Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[Outlook] (manifest) removing preview language from some Outlook docs #4440

Merged
merged 10 commits into from
May 3, 2024
3 changes: 2 additions & 1 deletion docs/includes/outlook-permission-levels-table.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,9 +8,10 @@
Permissions are declared in the manifest. The markup varies depending on the type of manifest.

- **XML manifest**: Use the **\<Permissions\>** element.
- **Unified manifest for Microsoft 365 (preview)**: Use the "name" property of an object in the "authorization.permissions.resourceSpecific" array.
- **Unified manifest for Microsoft 365**: Use the "name" property of an object in the "authorization.permissions.resourceSpecific" array.

> [!NOTE]
>
> - There's a supplementary permission needed for add-ins that use the append-on-send feature. With the XML manifest, specify the permission in the [ExtendedPermissions](/javascript/api/manifest/extendedpermissions) element. For details, see [Implement append-on-send in your Outlook add-in](../outlook/append-on-send.md). With the unified manifest, specify this permission with the name **Mailbox.AppendOnSend.User** in an additional object in the "authorization.permissions.resourceSpecific" array.
> - There's a supplementary permission needed for add-ins that use shared folders. With the XML manifest, specify the permission by setting the [SupportsSharedFolders](/javascript/api/manifest/supportssharedfolders) element to `true`. For details, see [Enable shared folders and shared mailbox scenarios in an Outlook add-in](../outlook/delegate-access.md). With the unified manifest, specify this permission with the name **Mailbox.SharedFolder** in an additional object in the "authorization.permissions.resourceSpecific" array.

2 changes: 1 addition & 1 deletion docs/includes/rules-not-supported-json-note.md
Original file line number Diff line number Diff line change
@@ -1,2 +1,2 @@
> [!NOTE]
> Outlook add-in features that depend on activation rules aren't supported when the add-in uses a [Unified manifest for Microsoft 365 (preview)](../develop/json-manifest-overview.md).
> Outlook add-in features that depend on activation rules aren't supported when the add-in uses a [Unified manifest for Microsoft 365](../develop/json-manifest-overview.md).
4 changes: 2 additions & 2 deletions docs/outlook/apis.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: Outlook add-in APIs
description: Learn how to reference the Outlook add-in APIs and declare permissions in your Outlook add-in.
ms.date: 10/03/2022
ms.date: 04/12/2024
ms.topic: overview
ms.localizationpriority: medium
---
Expand Down Expand Up @@ -47,7 +47,7 @@ if (item.somePropertyOrFunction) {
Specify the minimum requirement set that supports the critical set of APIs for your scenario, without which features of your add-in won't work. You specify the requirement set in the manifest. The markup varies depending on the manifest that you are using.

- **XML manifest**: Use the **\<Requirements\>** element. Note that the **\<Methods\>** child element of **\<Requirements\>** isn't supported in Outlook add-ins, so you can't declare support for specific methods.
- **Unified manifest for Microsoft 365 (preview)**: Use the "extensions.capabilities" property.
- **Unified manifest for Microsoft 365**: Use the "extensions.capabilities" property.

For more information, see [Office add-in manifests](../develop/add-in-manifests.md), and [Understanding Outlook API requirement sets](/javascript/api/requirement-sets/outlook/outlook-api-requirement-sets).

Expand Down
4 changes: 2 additions & 2 deletions docs/outlook/append-on-send.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: Prepend or append content to a message or appointment body on send
description: Learn how to prepend or append content to a message or appointment body when the mail item is sent.
ms.date: 03/26/2024
ms.date: 04/12/2024
ms.topic: how-to
ms.localizationpriority: medium
---
Expand All @@ -27,7 +27,7 @@ Complete the [Outlook quick start](../quickstarts/outlook-quickstart.md?tabs=yeo

To configure the manifest, select the tab for the type of manifest you'll use.

# [Unified manifest for Microsoft 365 (developer preview)](#tab/jsonmanifest)
# [Unified manifest for Microsoft 365](#tab/jsonmanifest)

The following shows how to configure your unified manifest to enable the prepend-on-send and append-on-send features.

Expand Down
7 changes: 2 additions & 5 deletions docs/outlook/authentication.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: Authentication options in Outlook add-ins
description: Outlook add-ins provide a number of different methods to authenticate, depending on your specific scenario.
ms.date: 03/21/2024
ms.date: 04/12/2024
ms.topic: overview
ms.localizationpriority: high
---
Expand All @@ -25,10 +25,7 @@ Consider using SSO access tokens if your add-in:
- Microsoft services that are exposed as part of Microsoft Graph
- A non-Microsoft service that you control

The SSO authentication method uses the [OAuth2 On-Behalf-Of flow provided by Azure Active Directory](/azure/active-directory/develop/active-directory-v2-protocols-oauth-on-behalf-of). It requires that the add-in register in the [Application Registration Portal](https://apps.dev.microsoft.com/) and specify any required Microsoft Graph scopes in its manifest.

> [!NOTE]
> If the add-in is using the [Unified manifest for Microsoft 365 (preview)](../develop/json-manifest-overview.md), there is some manifest configuration, but Microsoft Graph scopes aren't specified. SSO-enabled add-ins that use the unified manifest can be sideloaded, but can't be deployed in any other way at this time.
The SSO authentication method uses the [OAuth2 On-Behalf-Of flow provided by Azure Active Directory](/azure/active-directory/develop/active-directory-v2-protocols-oauth-on-behalf-of). It requires that the add-in register in the [Application Registration Portal](https://apps.dev.microsoft.com/) and specify any required Microsoft Graph scopes in the add-in manifest, if the XML manifest is being used. If the add-in is using the [unified manifest for Microsoft 365](../develop/json-manifest-overview.md), there is some manifest configuration, but Microsoft Graph scopes aren't specified. Instead, the needed scopes are specified at runtime in a call to fetch a token to Microsoft Graph.

Using this method, your add-in can obtain an access token scoped to your server back-end API. The add-in uses this as a bearer token in the `Authorization` header to authenticate a call back to your API. At that point your server can:

Expand Down
4 changes: 2 additions & 2 deletions docs/outlook/autolaunch.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: Configure your Outlook add-in for event-based activation
description: Learn how to configure your Outlook add-in for event-based activation.
ms.date: 03/12/2024
ms.date: 04/12/2024
ms.topic: concept-article
ms.localizationpriority: medium
---
Expand Down Expand Up @@ -81,7 +81,7 @@ When developing an event-based add-in to run in the Outlook on Windows client, b
- Add-ins don't run code included in `Office.onReady()` and `Office.initialize`. We recommend adding any startup logic, such as checking the user's Outlook version, to your event handlers instead.
- Only the JavaScript file referenced in the manifest is supported for event-based activation. You must bundle your event-handling JavaScript code into this single file. The location of the referenced JavaScript file in the manifest varies depending on the type of manifest your add-in uses.
- **XML manifest**: **\<Override\>** child element of the **\<Runtime\>** node
- **Unified manifest for Microsoft 365 (preview)**: "script" property of the "code" object
- **Unified manifest for Microsoft 365**: "script" property of the "code" object

Note that a large JavaScript bundle may cause issues with the performance of your add-in. We recommend preprocessing heavy operations, so that they're not included in your event-handling code.

Expand Down
4 changes: 2 additions & 2 deletions docs/outlook/categories.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: Get and set categories
description: How to manage categories on mailbox and item.
ms.date: 02/29/2024
ms.date: 04/12/2024
ms.topic: how-to
ms.localizationpriority: medium
---
Expand All @@ -21,7 +21,7 @@ Only categories in the master list on your mailbox are available for you to appl
> For the add-in to manage the categories master list, it must request the **read/write mailbox** permission in the manifest. The markup varies depending on the type of manifest.
>
> - **XML manifest**: Set the **\<Permissions\>** element to **ReadWriteMailbox**.
> - **Unified manifest for Microsoft 365 (preview)**: Set the "name" property of an object in the "authorization.permissions.resourceSpecific" array to "Mailbox.ReadWrite.User".
> - **Unified manifest for Microsoft 365**: Set the "name" property of an object in the "authorization.permissions.resourceSpecific" array to "Mailbox.ReadWrite.User".

### Add master categories

Expand Down
4 changes: 2 additions & 2 deletions docs/outlook/compose-scenario.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: Create Outlook add-ins for compose forms
description: Learn about scenarios and capabilities of Outlook add-ins for compose forms.
ms.date: 04/28/2023
ms.date: 04/12/2024
ms.topic: overview
ms.localizationpriority: high
---
Expand Down Expand Up @@ -33,7 +33,7 @@ Compose add-ins are implemented as [add-in commands](../design/add-in-commands.m
> [!NOTE]
> Add-ins developed for servers or clients that don't support add-in commands use [activation rules](activation-rules.md) in a [Rule](/javascript/api/manifest/rule) element contained in the [OfficeApp](/javascript/api/manifest/officeapp) element. Unless the add-in is being specifically developed for older clients and servers, new add-ins should use add-in commands.
>
> Add-ins that use activation rules aren't supported in an add-in that uses a [Unified manifest for Microsoft 365 (preview)](../develop/unified-manifest-overview.md).
> Add-ins that use activation rules aren't supported in an add-in that uses a [Unified manifest for Microsoft 365](../develop/unified-manifest-overview.md).

## API features available to compose add-ins

Expand Down
6 changes: 3 additions & 3 deletions docs/outlook/debug-autolaunch.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: Debug your event-based or spam-reporting Outlook add-in
description: Learn how to debug your Outlook add-in that implements event-based activation or integrated spam reporting.
ms.date: 03/29/2024
ms.date: 04/12/2024
ms.topic: how-to
ms.localizationpriority: medium
---
Expand All @@ -20,8 +20,8 @@ If you used the [Yeoman generator for Office Add-ins](../develop/yeoman-generato

1. Get your add-in's ID from the manifest.

- **XML manifest**: Use the value of the **\<Id\>** element, child of the root **\<OfficeApp\>** element.
- **Unified manifest for Microsoft 365 (preview)**: Use the value of the "id" property of the root anonymous `{ ... }` object.
- **XML manifest**: Use the value of the **\<Id\>** element child of the root **\<OfficeApp\>** element.
- **Unified manifest for Microsoft 365**: Use the value of the "id" property of the root anonymous `{ ... }` object.

1. Create a registry `DWORD` value named `UseDirectDebugger` in `HKEY_CURRENT_USER\SOFTWARE\Microsoft\Office\16.0\Wef\Developer\[Add-in ID]`. Replace `[Add-in ID]` with your add-in's ID from the manifest.

Expand Down
4 changes: 2 additions & 2 deletions docs/outlook/delay-delivery.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: Manage the delivery date and time of a message
description: Learn how to get and set the delivery date and time of a message in compose mode.
ms.date: 01/29/2024
ms.date: 04/12/2024
ms.topic: how-to
ms.localizationpriority: medium
---
Expand All @@ -15,7 +15,7 @@ The Outlook client gives you the option to delay the delivery of a message, but

## Configure the manifest

To schedule the delivery of a message, your add-in must be able to activate in message compose mode. This is defined through the [MessageComposeCommandSurface](/javascript/api/manifest/extensionpoint#messagecomposecommandsurface) extension point in an XML manifest or the **mailCompose** "contexts" property in a [Unified manifest for Microsoft 365 (preview)](../develop/unified-manifest-overview.md).
To schedule the delivery of a message, your add-in must be able to activate in message compose mode. This is defined through the [MessageComposeCommandSurface](/javascript/api/manifest/extensionpoint#messagecomposecommandsurface) extension point in an XML manifest or the **mailCompose** "contexts" property in a [Unified manifest for Microsoft 365](../develop/unified-manifest-overview.md).

For further guidance on how to configure an Outlook add-in manifest, see [Office add-in manifests](../develop/add-in-manifests.md).

Expand Down
8 changes: 4 additions & 4 deletions docs/outlook/delegate-access.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: Enable shared folders and shared mailbox scenarios in an Outlook add-in
description: Discusses how to configure add-in support for shared folders (a.k.a. delegate access) and shared mailboxes.
ms.date: 12/21/2023
ms.date: 04/12/2024
ms.topic: how-to
ms.localizationpriority: medium
---
Expand Down Expand Up @@ -147,11 +147,11 @@ To enable shared folders and shared mailbox scenarios in your add-in, you must e
First, to support REST calls from a delegate, the add-in must request the **read/write mailbox** permission. The markup varies depending on the type of manifest.

- **XML manifest**: Set the **\<Permissions\>** element to **ReadWriteMailbox**.
- **Unified manifest for Microsoft 365 (preview)**: Set the "name" property of an object in the "authorization.permissions.resourceSpecific" array to "Mailbox.ReadWrite.User".
- **Unified manifest for Microsoft 365**: Set the "name" property of an object in the "authorization.permissions.resourceSpecific" array to "Mailbox.ReadWrite.User".

Second, enable support for shared folders. The markup varies depending on the type of manifest.

# [Unified manifest for Microsoft 365 (developer preview)](#tab/jsonmanifest)
# [Unified manifest for Microsoft 365](#tab/jsonmanifest)

Add an additional object to the "authorization.permissions.resourceSpecific" array and set its "name" property to "Mailbox.SharedFolder".

Expand Down Expand Up @@ -303,7 +303,7 @@ The message is now in a shared context and add-ins that support these shared sce
Your add-in can use REST. To enable REST access to the owner's mailbox or to the shared mailbox as applicable, the add-in must request the **read/write mailbox** permission in the manifest. The markup varies depending on the type of manifest.

- **XML manifest**: Set the **\<Permissions\>** element to **ReadWriteMailbox**.
- **Unified manifest for Microsoft 365 (preview)**: Set the "name" property of an object in the "authorization.permissions.resourceSpecific" array to "Mailbox.ReadWrite.User".
- **Unified manifest for Microsoft 365**: Set the "name" property of an object in the "authorization.permissions.resourceSpecific" array to "Mailbox.ReadWrite.User".

EWS isn't supported.

Expand Down
4 changes: 2 additions & 2 deletions docs/outlook/extension-module-outlook-add-ins.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: Module extension Outlook add-ins
description: Create applications that run inside Outlook to make it easy for your users to access business information and productivity tools without ever leaving Outlook.
ms.date: 01/11/2024
ms.date: 04/12/2024
ms.localizationpriority: medium
---

Expand All @@ -16,7 +16,7 @@ Module extension add-ins appear in the Outlook navigation bar, right alongside m

To create and run module extension add-ins, you must:

- Develop the add-in using an XML manifest. The [Unified manifest for Microsoft 365 (preview)](../develop/json-manifest-overview.md) isn't supported.
- Develop the add-in using an XML manifest. The [Unified manifest for Microsoft 365](../develop/json-manifest-overview.md) doesn't support module extensions.
- Run the add-in in Outlook 2016 or later on Windows.

## Open a module extension
Expand Down
4 changes: 2 additions & 2 deletions docs/outlook/extract-entity-strings-from-an-item.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: Extract entity strings from an Outlook item
description: Learn how to extract entity strings from an Outlook item in an Outlook add-in.
ms.date: 01/16/2024
ms.date: 04/12/2024
ms.topic: how-to
ms.localizationpriority: medium
---
Expand Down Expand Up @@ -37,7 +37,7 @@ The add-in provides buttons for the user to choose a type of entity. When the us
## XML manifest

> [!NOTE]
> The Outlook add-in feature described in this article uses activation rules, which aren't supported in add-ins that use a [Unified manifest for Microsoft 365 (preview)](../develop/unified-manifest-overview.md).
> The Outlook add-in feature described in this article uses activation rules, which aren't supported in add-ins that use the [unified manifest for Microsoft 365](../develop/unified-manifest-overview.md).

The entities add-in has two activation rules joined by a logical OR operation.

Expand Down
4 changes: 2 additions & 2 deletions docs/outlook/get-or-set-the-location-of-an-appointment.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: Get or set the location of an appointment in an add-in
description: Learn how to get or set the location of an appointment in an Outlook add-in.
ms.date: 11/08/2022
ms.date: 04/12/2024
ms.topic: how-to
ms.localizationpriority: medium
---
Expand All @@ -24,7 +24,7 @@ The following table lists the location APIs and the modes (i.e., Compose or Read
| [item.enhancedLocation.addAsync](/javascript/api/outlook/office.enhancedlocation#outlook-office-enhancedlocation-addasync-member(1)) | Organizer/Compose |
| [item.enhancedLocation.removeAsync](/javascript/api/outlook/office.enhancedlocation#outlook-office-enhancedlocation-removeasync-member(1)) | Organizer/Compose |

To use the methods that are available only to compose add-ins, configure the add-in XML manifest to activate the add-in in Organizer/Compose mode. See [Create Outlook add-ins for compose forms](compose-scenario.md) for more details. Activation rules aren't supported in add-ins that use a [Unified manifest for Microsoft 365 (preview)](../develop/json-manifest-overview.md).
To use the methods that are available only to compose add-ins, configure the add-in XML manifest to activate the add-in in Organizer/Compose mode. See [Create Outlook add-ins for compose forms](compose-scenario.md) for more details. Activation rules aren't supported in add-ins that use a [Unified manifest for Microsoft 365](../develop/json-manifest-overview.md).

## Use the `enhancedLocation` API

Expand Down
4 changes: 2 additions & 2 deletions docs/outlook/inside-the-identity-token.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: Inside the Exchange identity token in an Outlook add-in
description: Learn about the contents of an Exchange user identity token generated from an Outlook add-in.
ms.date: 03/21/2024
ms.date: 04/12/2024
ms.localizationpriority: medium
---

Expand Down Expand Up @@ -64,7 +64,7 @@ The following table lists the parts of the identity token payload.

| Claim | Description |
|:-----|:-----|
| `aud` | The URL of the add-in that requested the token. A token is only valid if it is sent from the add-in that is running in the client's webview control. The URL of the add-in is specified in the manifest. The markup depends on the type of manifest.</br></br>**XML manifest:** If the add-in uses the Office Add-ins manifests schema v1.1, this URL is the URL specified in the first **\<SourceLocation\>** element, under the form type `ItemRead` or `ItemEdit`, whichever occurs first as part of the [FormSettings](/javascript/api/manifest/formsettings) element in the add-in manifest.</br></br>**Unified manifest for Microsoft 365 (preview):** The URL is specified in the "extensions.audienceClaimUrl" property. |
| `aud` | The URL of the add-in that requested the token. A token is only valid if it is sent from the add-in that is running in the client's webview control. The URL of the add-in is specified in the manifest. The markup depends on the type of manifest.</br></br>**XML manifest:** If the add-in uses the Office Add-ins manifests schema v1.1, this URL is the URL specified in the first **\<SourceLocation\>** element, under the form type `ItemRead` or `ItemEdit`, whichever occurs first as part of the [FormSettings](/javascript/api/manifest/formsettings) element in the add-in manifest.</br></br>**Unified manifest for Microsoft 365:** The URL is specified in the "extensions.audienceClaimUrl" property. |
| `iss` | A unique identifier for the Exchange server that issued the token. All tokens issued by this Exchange server will have the same identifier. |
| `nbf` | The date and time that the token is valid starting from. The value is the number of seconds since January 1, 1970. |
| `exp` | The date and time that the token is valid until. The value is the number of seconds since January 1, 1970. |
Expand Down
4 changes: 2 additions & 2 deletions docs/outlook/on-new-compose-events-walkthrough.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: Automatically set the subject of a new message or appointment
description: Learn how to implement an event-based add-in that automatically sets the subject of a new message or appointment.
ms.date: 02/29/2024
ms.date: 04/12/2024
ms.topic: how-to
ms.localizationpriority: medium
---
Expand All @@ -23,7 +23,7 @@ Complete the [Outlook quick start](../quickstarts/outlook-quickstart.md?tabs=yeo

To configure the manifest, select the tab for the type of manifest you're using.

# [Unified manifest for Microsoft 365 (developer preview)](#tab/jsonmanifest)
# [Unified manifest for Microsoft 365](#tab/jsonmanifest)

1. Open the **manifest.json** file.

Expand Down