Skip to main content
Version: Any 26

Outlook add-in

Any provides an Outlook add-in that lets users save to Any, without leaving Outlook, an email or its attachments. It adds two commands to the message ribbon:

  • Envoyer le mail vers Any (Send the email to Any): imports the whole message, as an .eml file;
  • Envoyer les pièces jointes vers Any (Send the attachments to Any): imports the message's attachments.

The command opens a side pane showing Any's import dialog: the user fills in the document metadata there, as for an import from the web interface.

The add-in ships with Any: its files are served by the Any server itself, under https://<server>/<context>/addin/. There is nothing to host elsewhere.

Prerequisites​

Outlook. Outlook on the web, new Outlook for Windows, classic Outlook for Windows (Microsoft 365) and Outlook for Mac. The ribbon buttons require support for the Mailbox 1.14 API requirement set; older perpetual versions of Outlook (2016, 2019) are not supported.

Any server.

  • Any must be reachable over HTTPS, with a certificate trusted by the workstations, from each user's workstation: the add-in pane loads Any's pages directly.

  • Session cookies must be issued with the SameSite=None and Secure attributes, which the delivered shiro.ini files do. If your shiro.ini is customized, check the following lines:

    sessionManager.sessionIdCookie.sameSite = NONE
    sessionManager.sessionIdCookie.secure = true
    rememberMeManager.cookie.sameSite = NONE
    rememberMeManager.cookie.secure = true

User rights. The user must be able to import content into the target room:

  • the Content import feature enabled on the application;
  • the content:import:content permission;
  • write access to the target room (and, if applicable, folder).

Without these rights, the pane displays "You don't have sufficient permissions to import content".

Prepare the manifest​

An Office add-in is described by an XML manifest file, which tells Outlook where to find the add-in's pages and where to import messages. The template manifest ships with Any:

https://<server>/<context>/addin/manifest.xml

Download it, then adapt it to your installation in a text editor.

Server address​

Replace all the addresses ending with /addin/… (icons, pane page and commands page) with the address of your Any server:

<IconUrl DefaultValue="https://any.example.com/any/addin/assets/icon-64.png"/>
<HighResolutionIconUrl DefaultValue="https://any.example.com/any/addin/assets/icon-128.png"/>
...
<SourceLocation DefaultValue="https://any.example.com/any/addin/taskpane.html"/>
...
<bt:Image id="Icon.16x16" DefaultValue="https://any.example.com/any/addin/assets/icon-16.png"/>
<bt:Image id="Icon.32x32" DefaultValue="https://any.example.com/any/addin/assets/icon-32.png"/>
<bt:Image id="Icon.80x80" DefaultValue="https://any.example.com/any/addin/assets/icon-80.png"/>
<bt:Url id="Commands.Url" DefaultValue="https://any.example.com/any/addin/commands.html"/>

Import destination​

The import destination is set by the parameters of the ImportMail.Url (send the email) and ImportAttachments.Url (send the attachments) addresses:

<bt:Url id="ImportMail.Url" DefaultValue="https://any.example.com/any/addin/taskpane.html?anyServerUrl=https://any.example.com/any&amp;applicationId=legal&amp;mode=mail&amp;roomId=mail"/>
<bt:Url id="ImportAttachments.Url" DefaultValue="https://any.example.com/any/addin/taskpane.html?anyServerUrl=https://any.example.com/any&amp;applicationId=legal&amp;mode=attachments&amp;roomId=mail"/>
ParameterValue
anyServerUrlAny's address, context included (for example https://any.example.com/any). It must be on the same domain as the add-in's pages.
applicationIdTechnical name of the application to import into
roomIdTechnical name of the target room, as it appears in the room's URL in Any
folderPathOptional: folder of the room to import into
modemail to import the message, attachments to import the attachments. Do not change.

In the XML file, parameters are separated by &amp;, not by &.

The document type, form and metadata offered are those of the import configuration of the target application and room.

Add-in identification​

  • DisplayName and Description: name and description shown to users.
  • Id: unique identifier of the add-in. If you deploy other manifests in the same Microsoft 365 tenant — for example one per application, or one for testing and one for production — give each one a new identifier (GUID).
  • Version: increment it on each change of an already deployed manifest, so that Outlook picks up the new version.
  • Command labels are changed in the <bt:ShortStrings> section.

To offer several destinations (for example one room per department), prepare one manifest per destination, each with its own Id and DisplayName, and assign each one to the relevant users.

Validate the manifest​

Before deploying it, you can check the manifest with Microsoft's tool:

npx office-addin-manifest validate manifest.xml

Deploy the add-in​

Centralized deployment installs the add-in for the chosen users or groups, without any action on their part. It requires a Global Administrator or Exchange Administrator account of the Microsoft 365 tenant.

  1. Open the Microsoft 365 admin center: https://admin.microsoft.com.
  2. Go to Settings → Integrated apps.
  3. Click Upload custom apps.
  4. Choose the Office Add-in type, then Upload manifest file (.xml) from device and select the prepared manifest.
  5. Choose the relevant users: the whole organization, specific users or groups.
  6. Accept the requested permissions, then click Finish deployment.

The add-in appears in Outlook after a delay that can reach 24 hours. For an update, upload the new manifest (with a higher Version number) to the same integrated app.

Outlook with Exchange Server (on-premises)​

In the Exchange admin center, go to Organization → Add-ins, click + then Add from file, and select the manifest. Then make the add-in available, or mandatory, for users.

Installation by a user​

For a test, or if centralized deployment is not used, a user can install the add-in themselves, if the organization's policy allows it:

  1. Open Outlook on the web (https://outlook.office.com) or new Outlook.
  2. Open a message, then click Apps (or Get Add-ins) in the ribbon.
  3. Go to My add-ins.
  4. Under Custom add-ins, click Add a custom add-in → Add from file and select the manifest.

An add-in installed this way also appears in Outlook for Windows and for Mac signed in to the same account.

Usage​

  1. In Outlook, open or select a message.
  2. In the ribbon, Any group, click the email button or the attachments button. Depending on the Outlook client, the buttons may be under the Apps or … menu.
  3. On first use, sign in to Any in the pane.
  4. Fill in the import form, then validate.
  5. The pane closes and a notification confirms the import on the message.

Troubleshooting​

SymptomProbable causeAction
The Any group does not appearCentralized deployment still propagating, or Outlook version too oldWait up to 24 hours; check the Outlook version
The pane stays blank or shows a loading errorAny not reachable from the workstation, untrusted certificate, or wrong manifest addressesOpen https://<server>/<context>/addin/taskpane.html in a browser on the workstation
The pane shows a security error page or stays empty after sign-inanyServerUrl on a different domain from the add-in's pagesUse the same domain for anyServerUrl and the /addin/ addresses
The user must sign in again on each opening, or the session does not holdSession cookies without SameSite=None; Secure, or third-party cookies blocked by the browserCheck shiro.ini; allow cookies for Any's domain
"You don't have sufficient permissions to import content"Import feature disabled, content:import:content permission missing, or no write access to the roomCheck the user's rights on the target application and room
Import into the wrong roomapplicationId / roomId parameters of the manifestFix the manifest, increment Version and redeploy it