Microsoft Docs

Deploying Outlook Add-ins

This section guides you through the process of deploying your Outlook add-ins to make them available to users. We'll cover different deployment scenarios and the steps involved.

Deployment Options

There are several ways to deploy your Outlook add-in:

• Centralized Deployment (Admininistrator controlled): Allows administrators to deploy add-ins to users in their organization.
• Self-Service Deployment (User controlled): Users can install add-ins directly from a manifest file or by browsing an add-in store.
• Side Loading: For testing and development purposes, you can temporarily load an add-in using its manifest file.

Centralized Deployment

Centralized deployment is the recommended approach for organizations. It provides administrators with control over which add-ins are available to users.

Steps for Centralized Deployment:

1. Prepare your manifest file: Ensure your add-in's manifest (.xml file) is correctly configured with all necessary information, including icons, permissions, and supported clients.
2. Upload the manifest: Navigate to the Microsoft 365 admin center and go to Settings > Integrated apps.
3. Select Deployment Type: Choose to deploy to users or specific groups within your organization.
4. Configure Add-in Settings: Specify the deployment scope, choose whether to deploy automatically or on demand, and select the users or groups who will receive the add-in.
5. Review and Deploy: Review your configuration and initiate the deployment. It may take some time for the add-in to appear for users.

Self-Service Deployment

Users can deploy add-ins themselves if they have permission to do so.

From a File:

1. In Outlook, go to the Home tab.
2. Click Get Add-ins.
3. Click My add-ins.
4. Under Add a custom add-in, select Add from file.
5. Browse to and select your add-in's manifest file.

From the Office Store:

1. In Outlook, go to the Home tab.
2. Click Get Add-ins.
3. Browse or search for your add-in.
4. Click Add on the add-in's page.

Side Loading for Testing

Side loading is useful for testing your add-in before wider deployment. This method is temporary and specific to your Outlook client.

Steps to Side Load:

1. In Outlook, go to the Home tab.
2. Click Get Add-ins.
3. Click My add-ins.
4. Under Add a custom add-in, select Add from file.
5. Browse to and select your add-in's manifest file.

The add-in will appear in your Outlook client. Note that side-loaded add-ins are removed when Outlook is restarted.

Manifest File Considerations

Your manifest file is the heart of your add-in's deployment. Key elements to verify include:

• <Id>: A unique GUID for your add-in.
• <Version>: The current version number. Increment this for updates.
• <ProviderName>: Your organization's name.
• <DisplayName>: The name of your add-in as shown to users.
• <Description>: A brief description of the add-in.
• <IconUrl>: URLs to your add-in's icons.
• <SupportUrl>: A URL for support information.
• <DefaultLocale>: The default language for your add-in.
• <Permissions>: The permissions your add-in requires.
• <Hosts>: The Office applications where your add-in will run (e.g., Mail, Calendar).
• <ExtensionPoint>: Defines where and how your add-in appears in the UI.
• <Resources>: Specifies the URLs for your add-in's HTML, JavaScript, and CSS files.

Refer to the official schema documentation for a complete reference.

Updating an Add-in

To update an existing add-in:

1. Increment the <Version> element in your manifest file.
2. Upload the updated manifest file using the same deployment method you used initially (e.g., Centralized Deployment in the admin center).

It may take some time for the changes to propagate to all users.