Difference between revisions of "MailStore Outlook App Deployment"

[unchecked revision][unchecked revision]
(Created page with "In order to use the MailStore Outlook App for the new Outlook, a manifest tailored to your installation must be generated. The manifest describes how your MailStore installat...")
 
Line 34: Line 34:
 
* Open the email archive client and connect to an instance as an administrator.
 
* Open the email archive client and connect to an instance as an administrator.
 
* Go to ''Administration'' > ''Miscellaneous'' > ''Deployment''.
 
* Go to ''Administration'' > ''Miscellaneous'' > ''Deployment''.
 +
* In case the download is disabled, the [https://help.mailstore.com/en/spe/Branding SPE Branding] needs to be adjusted first. The client has to be restarted for changes to take effect.
 
* If you have logged in as a global SPE administrator via the MailStore SPE Web Console, enter the external URL under which the instance can be reached in the field provided, e.g. ''<nowiki>https://archive.example.com/instanceid</nowiki>''.
 
* If you have logged in as a global SPE administrator via the MailStore SPE Web Console, enter the external URL under which the instance can be reached in the field provided, e.g. ''<nowiki>https://archive.example.com/instanceid</nowiki>''.
 
** If you have logged in as an instance administrator, MailStore assumes that you have used the external hostname for the connection and automatically uses this hostname to generate the manifest.
 
** If you have logged in as an instance administrator, MailStore assumes that you have used the external hostname for the connection and automatically uses this hostname to generate the manifest.

Revision as of 14:33, 7 October 2024

In order to use the MailStore Outlook App for the new Outlook, a manifest tailored to your installation must be generated.

The manifest describes how your MailStore installation can be accessed from within Outlook.

This manifest can be uploaded to the app store of your Microsoft 365 tenant. This makes the MailStore Outlook App available in the Outlook app store and can either be centrally assigned to users by administrators via policy, or users can add the app from the app store to their Outlook installation.

Requirements

  • The new Outlook must be connected to a Microsoft 365 tenant.
  • Administrative access to the Microsoft 365 tenant.
  • MailStore requires a trusted certificate. This can come from Let's Encrypt or another certification authority.

Generating the manifest

In addition to the MailStore hostname, the manifest also contains a unique ID that identifies the app in the Outlook App Store. The ID is permanently saved by MailStore and remains constant for each installation so that it is adopted when generating further manifests and the app can still be identified using the same ID. This makes it possible to update the existing app if the hostname under which MailStore can be reached changes.

Manifests must therefore always be generated on the server to which the associated Outlook app is to connect.

One of the hostnames stored in the certificate must be used in the manifest so that Outlook allows a connection to the MailStore Server.

MailStore Server

  • Open the MailStore Server Service Configuration.
  • Go to the Network Settings.
  • Select a hostname from the menu or enter the hostname under which MailStore Server can be reached manually.
  • Enter an optional name in case you create multiple Outlook apps for multiple servers and you want these apps to be distinguishable in the Outlook App Store.
  • Click Generate Manifest and select the target file to create the manifest.

MailStore SPE

To enable the manifest to be downloaded, the branding of the SPE may need to be extended by some values. Otherwise the download will not be available.

  • Open the email archive client and connect to an instance as an administrator.
  • Go to Administration > Miscellaneous > Deployment.
  • In case the download is disabled, the SPE Branding needs to be adjusted first. The client has to be restarted for changes to take effect.
  • If you have logged in as a global SPE administrator via the MailStore SPE Web Console, enter the external URL under which the instance can be reached in the field provided, e.g. https://archive.example.com/instanceid.
    • If you have logged in as an instance administrator, MailStore assumes that you have used the external hostname for the connection and automatically uses this hostname to generate the manifest.
  • Click Download and select the target file to download the manifest.

Installation

  • Log in to the Microsoft Teams Admin Center.
  • Go to Teams Apps > Manage Apps.
  • Click Actions > Upload new app.
  • Click on Upload and select the previously generated manifest.
  • After the successful upload, the app can be found by searching for MailStore or the name you have chosen from the SPE branding.
  • Select the app and click on Users and Groups.
  • Publish the app.
  • End users can now find the app in the app store within Outlook and add it to their Outlook.
  • You can also assign the app to users via policy, to do this, click on Setup policies.
  • Add a new policy or edit an existing policy.
  • Configure the policy according to your needs.

Update

The manifest must be updated if the host name under which MailStore is accessible has changed.

Create a new manifest as described in the Installation section.

  • Sign in to the Microsoft Teams Admin Center.
  • Go to Teams Apps > Manage Apps.
  • Select the existing app from the list of apps.
  • In the overview tile, click Upload File and select the previously generated manifest.