Skip to content

Commit 50c99a2

Browse files
[Outlook] (sideloading) Reorganize article (#5164)
* Reorganize sideloading article * Fix bookmark and update wording * Update ms.date
1 parent 29128c4 commit 50c99a2

File tree

2 files changed

+45
-29
lines changed

2 files changed

+45
-29
lines changed
Lines changed: 44 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -1,68 +1,60 @@
11
---
22
title: Sideload Outlook add-ins for testing
33
description: Use sideloading to install an Outlook add-in for testing without having to first put it in an add-in catalog.
4-
ms.date: 05/06/2025
4+
ms.date: 05/13/2025
55
ms.topic: how-to
66
ms.localizationpriority: medium
77
---
88

99
# Sideload Outlook add-ins for testing
1010

11-
Sideload your Outlook add-in for testing without having to first put it in an add-in catalog.
11+
Sideload your Outlook add-in for testing in Outlook on the web, on Windows ([new](https://support.microsoft.com/office/656bb8d9-5a60-49b2-a98b-ba7822bc7627) or classic), on Mac, or on mobile devices without having to first put it in an add-in catalog.
12+
13+
The sideloading process differs depending on the type of manifest your add-in uses. Select the tab for the applicable manifest. For more information on Office Add-in manifests, see [Office Add-ins manifest](../develop/add-in-manifests.md).
1214

1315
> [!IMPORTANT]
1416
> If your Outlook add-in supports mobile, sideload the manifest using the instructions in this article for your Outlook client on the web, on Windows, or on Mac, then follow the guidance in [Testing your add-ins on mobile](outlook-mobile-addins.md#testing-your-add-ins-on-mobile).
1517
16-
## Sideload an add-in that uses the unified app manifest for Microsoft 365
18+
# [Unified manifest for Microsoft 365](#tab/jsonmanifest)
1719

1820
The process to sideload an add-in that uses the unified app manifest for Microsoft 365 varies depending on the tool you used to create your add-in project. For more information, see [Sideload Office Add-ins that use the unified manifest for Microsoft 365](../testing/sideload-add-in-with-unified-manifest.md).
1921

20-
## Sideload an add-in that uses an add-in only manifest
22+
# [Add-in only manifest](#tab/xmlmanifest)
2123

2224
An Outlook add-in that uses an add-in only manifest can be sideloaded automatically through the command line or manually through the **Add-Ins for Outlook** dialog.
2325

2426
### Sideload automatically
2527

26-
If you created your Outlook add-in using the [Yeoman generator for Office Add-ins](../develop/yeoman-generator-overview.md), sideloading is best done through the command line. This takes advantage of our tooling and allows you to sideload across all of your supported devices in one command.
27-
28-
> [!NOTE]
29-
> If you're developing on macOS, you must manually sideload your add-in after running `npm start`. For guidance, see the [Sideload manually](#sideload-manually) section of this article.
28+
If you created your Outlook add-in using the [Yeoman generator for Office Add-ins](../develop/yeoman-generator-overview.md), sideloading is best done through the command line. This takes advantage of our tooling and allows you to sideload across all of your supported devices with one command.
3029

3130
1. Open a command prompt and navigate to the root directory of your Yeoman generated add-in project. Run the command `npm start`.
3231

33-
> [!TIP]
34-
> When you first use Yeoman generator to develop an Office Add-in, your default browser opens a window where you'll be prompted to sign in to your Microsoft 365 account. If a sign-in window doesn't appear and you encounter a sideloading or login timeout error, run `teamsapp auth login m365` before running `npm start` again.
32+
> [!NOTE]
33+
>
34+
> - If you're developing on macOS, you must manually sideload your add-in after running `npm start`. For guidance, see the [Sideload manually](#sideload-manually) section of this article.
35+
>
36+
> - When you first use Yeoman generator to develop an Office Add-in, your default browser opens a window where you'll be prompted to sign in to your Microsoft 365 account. If a sign-in window doesn't appear and you encounter a sideloading or login timeout error, run `teamsapp auth login m365` before running `npm start` again.
3537
36-
1. Your Outlook add-in will automatically sideload to Outlook on your desktop computer. You'll see a dialog appear, stating there is an attempt to sideload the add-in, listing the name and the location of the manifest file. Select **OK**, which will register the manifest.
38+
1. A dialog appears stating an attempt to sideload the add-in. It lists the name and location of the manifest file. Select **OK** to register the manifest.
3739

3840
> [!IMPORTANT]
3941
> If the manifest contains an error or the path to the manifest is invalid, you'll receive an error message.
4042
41-
1. If your manifest contains no errors and the path is valid, your add-in will now be sideloaded and available on both your desktop and in Outlook on the web. It will also be installed across all your supported devices.
43+
1. If your manifest contains no errors and the path is valid, your add-in will now be sideloaded and available on the Outlook desktop client and on the web. It will also be installed across all your supported devices.
4244

4345
### Sideload manually
4446

45-
Though we strongly recommend sideloading automatically through the command line as covered in the previous section, you can also manually sideload an Outlook add-in. Add-ins that use the add-in only manifest are manually sideloaded through the **Add-Ins for Outlook** dialog. The following steps apply to Outlook on the web, on Windows ([new](https://support.microsoft.com/office/656bb8d9-5a60-49b2-a98b-ba7822bc7627) and classic), and on Mac.
47+
Though we strongly recommend sideloading automatically through the command line as covered in the previous section, you can also manually sideload an Outlook add-in. Add-ins that use the add-in only manifest are manually sideloaded through the **Add-Ins for Outlook** dialog.
48+
49+
The following steps apply to Outlook on the web, on Windows (new and classic), and on Mac.
4650

4751
1. In your preferred browser, go to <https://aka.ms/olksideload>. Outlook on the web opens, then the **Add-Ins for Outlook** dialog appears after a few seconds.
4852

4953
> [!TIP]
5054
>
51-
> - If your mailbox toolbar looks like the following image, you're using the classic version of Outlook on the web.
52-
>
53-
> ![Header of the classic Outlook on the web toolbar with "Office 365 | Outlook" as its title.](../images/outlook-on-the-web-classic-toolbar.png)
54-
>
55-
> To access the **Add-Ins for Outlook** dialog, open [Outlook on the web](https://outlook.office365.com). Then, select the gear icon from the top-right section of the toolbar and choose **Manage add-ins**.
56-
>
57-
> ![The Manage add-ins option is selected in classic Outlook on the web.](../images/outlook-sideload-web-manage-integrations.png)
58-
>
59-
> Note that your organization may include its own logo in the mailbox toolbar, so you might see something slightly different from what is shown in the preceding images.
60-
>
6155
> - In classic Outlook on Windows, you can also access the **Add-Ins for Outlook** dialog by selecting **File** > **Info** > **Manage Add-ins**. This opens Outlook on the web in your preferred browser, then loads the dialog.
6256
>
63-
> - In Outlook on Mac, starting in Version 16.85 (24051214), the **Get Add-ins** button no longer opens the **Add-Ins for Outlook** dialog. Instead, it opens [AppSource](https://appsource.microsoft.com/marketplace/apps?product=office%3Boutlook&page=1&src=office) in your default browser. Earlier versions can still access the **Add-Ins for Outlook** dialog through the **Get Add-ins** button. If you don't see **Get Add-ins** in your version of Outlook, select the ellipsis button (`...`) from the ribbon, then select **Get Add-ins**.
64-
>
65-
> ![The Get Add-ins option is selected from the ellipsis button in Outlook on Mac.](../images/outlook-sideload-new-mac.png)
57+
> - To access the **Add-Ins for Outlook** dialog in the classic version of Outlook on the web or in Outlook on Mac prior to Version 16.85 (24051214), see [Access the add-ins dialog in classic Outlook on the web or earlier versions of Outlook on Mac](#access-the-add-ins-dialog-in-classic-outlook-on-the-web-or-earlier-versions-of-outlook-on-mac).
6658
6759
1. In the **Add-Ins for Outlook** dialog box, select **My add-ins**.
6860

@@ -79,9 +71,27 @@ Though we strongly recommend sideloading automatically through the command line
7971
> [!NOTE]
8072
> In classic Outlook on Windows, it may take up to 24 hours for your manually sideloaded add-in to appear in the client. This is due to caching.
8173
82-
## Locate a sideloaded add-in
74+
1. The add-in is sideloaded to Outlook. Although the add-in was sideloaded through the **Add-Ins for Outlook** dialog in Outlook on the web, the add-in should also appear in supported Outlook desktop clients.
8375

84-
To learn how to access a sideloaded add-in in your Outlook client, see [Use add-ins in Outlook](https://support.microsoft.com/office/1ee261f9-49bf-4ba6-b3e2-2ba7bcab64c8).
76+
## Access the add-ins dialog in classic Outlook on the web or earlier versions of Outlook on Mac
77+
78+
### Classic Outlook on the web
79+
80+
In Outlook on the web, if your mailbox toolbar looks like the following image, you're using the classic version of Outlook on the web.
81+
82+
![Header of the classic Outlook on the web toolbar with "Office 365 | Outlook" as its title.](../images/outlook-on-the-web-classic-toolbar.png)
83+
84+
To access the **Add-Ins for Outlook** dialog, open [Outlook on the web](https://outlook.office365.com). Then, select the gear icon from the top-right section of the toolbar and choose **Manage add-ins**.
85+
86+
![The Manage add-ins option is selected in classic Outlook on the web.](../images/outlook-sideload-web-manage-integrations.png)
87+
88+
Note that your organization may include its own logo in the mailbox toolbar, so you might see something slightly different from what is shown in the preceding images.
89+
90+
### Earlier versions of Outlook on Mac
91+
92+
In Outlook on Mac, starting in Version 16.85 (24051214), the **Get Add-ins** button no longer opens the **Add-Ins for Outlook** dialog. Instead, it opens [AppSource](https://appsource.microsoft.com/marketplace/apps?product=office%3Boutlook&page=1&src=office) in your default browser. Earlier versions can still access the **Add-Ins for Outlook** dialog through the **Get Add-ins** button. If you don't see **Get Add-ins** in your version of Outlook, select the ellipsis button (`...`) from the ribbon, then select **Get Add-ins**.
93+
94+
![The Get Add-ins option is selected from the ellipsis button in Outlook on Mac.](../images/outlook-sideload-new-mac.png)
8595

8696
## Remove a sideloaded add-in
8797

@@ -91,6 +101,12 @@ Otherwise, on all versions of Outlook, the key to removing a sideloaded add-in i
91101

92102
To manually remove a sideloaded add-in from Outlook, in the **Add-Ins for Outlook** dialog, navigate to the **Custom Addins** section. Choose the ellipsis (`...`) for the add-in, then choose **Remove**.
93103

104+
---
105+
106+
## Locate a sideloaded add-in
107+
108+
To learn how to access a sideloaded add-in in your Outlook client, see [Use add-ins in Outlook](https://support.microsoft.com/office/1ee261f9-49bf-4ba6-b3e2-2ba7bcab64c8).
109+
94110
## See also
95111

96112
- [Add-ins for Outlook on mobile devices](outlook-mobile-addins.md)

docs/publish/stage-outlook-add-in-azure.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -61,7 +61,7 @@ Visual Studio creates a basic Outlook add-in that you'll be able to publish as-i
6161

6262
## Step 4: Sideload the manifest to Outlook
6363

64-
Follow the guidance at [Sideload an Outlook add-in that uses an add-in only manifest](../outlook/sideload-outlook-add-ins-for-testing.md#sideload-an-add-in-that-uses-an-add-in-only-manifest) to sideload the add-in.
64+
Follow the guidance at [Sideload an Outlook add-in that uses an add-in only manifest](../outlook/sideload-outlook-add-ins-for-testing.md?tabs=xmlmanifest) to sideload the add-in.
6565

6666
## See also
6767

0 commit comments

Comments
 (0)