Difference between revisions of "Outlook Addin"

From regify WIKI
Jump to navigation Jump to search
 
(79 intermediate revisions by the same user not shown)
Line 1: Line 1:
== Outlook for Web (OWA) and Outlook new ==
+
== Outlook New/o365 web Add-In ==
We really tried to develop an add-in for ''Outlook new'' and OWA. Unfortunately, the official ''office-js'' API from Microsoft does not allow us to create a working regimail add-in. The main reason is the lack of API functionality provided. This is what we are missing (12/2024):
+
===Installation===
 +
Open your add-in marketplace <span style="display: inline-block; margin: 0; padding: 0;">[[File:Outlook-app-symbol.png|20px|frameless|alt=Outlook Marketplace Symbol]]</span> and search for "regimail". Then follow the instructions on the screen.
  
* Composing regimails
+
=== Usage ===
** No API to reliable get attachments and inline images ([https://github.com/OfficeDev/office-js/issues?q=is%3Aissue+inline+attachments source]).
+
'''Writing:''' During writing, the top ribbon bar is switching to "Message" view. There, you can click the "Apps" button <span style="display: inline-block; margin: 0; padding: 0;">[[File:Outlook-app-symbol.png|20px|frameless|alt=Outlook Marketplace Symbol]]</span> to reach the regify Add-In for encryption. Follow the instructions on screen.
** No API to get attachments from forwarded messages ([https://github.com/OfficeDev/office-js/issues?q=is%3Aissue+forwarded+ source]).
 
** No API to trigger sending after encryption ([https://github.com/OfficeDev/office-js/discussions/5191 source]).
 
* Reading regimails
 
** No API to set/replace body or delete/replace attachments ([https://learn.microsoft.com/en-us/javascript/api/outlook/office.messageread?view=outlook-js-preview source]). The alternative would be to create a new message with decrypted content in parallel. But see next point.
 
** No API to create a new message in inbox folder with custom content.
 
** Only an API to open the compose form, but this does not allow us to save to the correct location except of drafts folder. It would become sent or a draft. Both we don't want.
 
** Display only in a small side pane. If we want to open a bigger window for displaying the message, the user is forced to always allow this window every time.
 
  
In addition, the API version provided by the users environment must support the needed API functionality. For on-prem installations of Exchange 2016 and 2019, the maximum API requirement set available is 1.5. But for the most functions required, an API requirement set of 1.11 or even higher is needed. Such API requirement set levels are only available if your Outlook is connected to Exchange Online from Office 365 (hosted by Microsoft) ([https://learn.microsoft.com/en-us/javascript/api/requirement-sets/outlook/outlook-api-requirement-sets?view=common-js-preview&tabs=jsonmanifest#requirement-sets-supported-by-exchange-servers-and-outlook-clients source]). Microsoft also did not yet announce, what API requirements set it will support for upcomming Exchange 2025.
+
'''Reading:''' If an email is visible in preview, there appears a small "Apps" button <span style="display: inline-block; margin: 0; padding: 0;">[[File:Outlook-app-symbol.png|20px|frameless|alt=Outlook Marketplace Symbol]]</span> on top of the message window. There you can reach the regify Add-In for viewing the message.
  
<span style="color: #d03030; font-weight: bold;">Therefore, we recommend you to not update to ''Outlook new'' if you want to keep your current regimail add-in working!<br>
+
=== Functions ===
[https://learn.microsoft.com/en-us/microsoft-365-apps/outlook/get-started/control-install Here is how you can stop Outlook from automatic update to Outlook new.]</span>
+
The regimail Add-In for Outlook new and o365 supports the following functions:
 +
* '''Open and decrypt regimails''' and show content and extract attachments.
 +
* '''Encrypt regimails''' from your existing email draft.
 +
* Configure regify settings (regify account settings).
 +
* Additional functions may be added in the future.
  
=== What comes next? ===
+
=== Compatibility notes ===
Until now, we focused on the official ''office-js'' API provided by Microsoft. But there is the option to communicate with the connected Exchange server directly, offering some more functionality than the ''office-js'' API. We are investigating the possibility to gain what we want from this path.
+
We tested the following combinations with the regimail Add-In (December 2025):
  
Our focus is now to provide you with an add-in that offers at least some basic functionality soon. But it needs time, so please be patient.
+
<span style="color: green;">✓</span> Works with '''O365 web''' (eg outlook.live.com) on Windows, MacOS and Linux. <sup>(c)</sup><br>
 +
<span style="color: green;">✓</span> Works with '''Outlook Classic 2024''' with '''Hosted Exchange 2019''' account on Windows. <sup>(a) (b)</sup><br>
 +
<span style="color: green;">✓</span> Works with '''Outlook Classic 2024''' and '''O365 account''' on Windows. <sup>(a)</sup><br>
 +
<span style="color: green;">✓</span> Works with '''Outlook New''' with '''O365 account''' on Windows.<br>
 +
<span style="color: orange;">●︎</span> Not working with any '''Outlook Classic''' and '''On-Prem''' Exchange 2019 or 2016 backend. <sup>(a)</sup><br>
 +
<span style="color: orange;">●︎</span> Not working with any '''Outlook Classic 2019 or 2016''' and O365 account. <sup>(a)</sup><br>
 +
<span style="color: red;">✗</span> Not working with '''Exchange 2019 OWA''' (web access).<br>
 +
<span style="color: red;">✗</span> Not working with '''Exchange 2016 OWA''' (web access).<br>
  
We will keep you updated on this page.
+
<span style="font-size: 80%;">(a) Consider using our regular Add-In for Outlook ''Classic'' contained in regify client setup (COM Add-In)!</span>
  
== Outlook Legacy ==
+
<span style="font-size: 80%;">(b) Due to Microsoft documentation, it works because of [https://learn.microsoft.com/en-us/javascript/api/requirement-sets/outlook/outlook-api-requirement-sets?view=common-js-preview&tabs=jsonmanifest#outlook-client-support Outlook 2024 LTSC] (volume licensing). It will not work with any previous Outlook ''Classic'' version.</span>
  
===Supported versions===
+
<span style="font-size: 80%;">(c) We've seen issues for saving decrypted regimail message attachments with '''Firefox''' browsers. If you need this, use '''any other up to date web browser''' like Edge, Chrome, Opera, Vivaldi etc.<br>Background: Firefox is interpreting ''content-security-policy'' values different than others. Due to this, Firefox blocks BLOB downloads because of Microsofts ''content-security-policy settings''.</span>
The current AddIn for Microsoft Outlook is available for the following versions:
 
* Outlook 2019 (32 Bit & 64 Bit)
 
* Outlook 2021 / Office 365 (32 Bit & 64 Bit)
 
* Outlook 2024 / Office 365 (32 Bit & 64 Bit)
 
  
Please respect that we're no longer supporting Outlook before 2019. Running this e-mail client is also no longer secure. Please consider upgrading to a newer version or how about trying Mozilla Thunderbird?
+
=== FAQ for Outlook New/o365 ===
 +
'''Q:''' Why don't you decrypt automatically if an encrypted regimail is received (rgf file)?<br>
 +
'''A:''' Office JavaScript Add-Ins cannot run code in the background or automatically when an email is selected or received. Add-In code only executes after the user explicitly opens the add-in. This is a security and performance feature of the Office platform, as documented by Microsoft. Therefore, the regimail Add-In is not able to handle regimails automatically.
  
=== Functions ===
+
'''Q:''' Why is there no regimail Add-in buttons in the Outlook GUI?<br>
 +
'''A:''' There are such buttons in local installed Outlook Classic 2024, but for Outlook New and o365 (in the web), the Microsoft Office Add-In API does not offer any integration into the ribbon menus. Therefore, you are forced to start the Add-In using the "Apps" or "More Apps" button <span style="display: inline-block; margin: 0; padding: 0;">[[File:Outlook-app-symbol.png|18px|frameless|alt=Outlook Marketplace Symbol]]</span> to run the regimail Add-In.
  
The AddIn for Microsoft Outlook offers the following functions:
+
'''Q:''' I wan't to reset the Add-In settings. How can I enter the settings dialog?<br>
* create new regify e-mails
+
'''A:''' Just create a new empty email. Now run the regimail Add-In using the "Apps" or "More Apps" button <span style="display: inline-block; margin: 0; padding: 0;">[[File:Outlook-app-symbol.png|18px|frameless|alt=Outlook Marketplace Symbol]]</span> in the "Message" tab. The "encrypt now" button appears. Instead of pressing, open the hamburger menu on the upper right and navigate to settings. There, you can click the reset configuration button.
* forward, reply and reply all using regify
 
* reconvert regify mails to ordinary e-mails
 
* automatically reconvert while receiving
 
* configure regify settings (account settings)
 
* invite new users to regify
 
  
=== Setup ===
+
'''Q:''' I can't open a rgf file by double click?<br>
The Outlook AddIn is installed automatically (in the correct version) during setup of the regify client. If you do not like to install the Outlook AddIn during setup, you can prevent it in the installer GUI. Please find additional information about setup options in the [https://manuals.regify.com/docs/regify_client/current/regify-client_deployment/ regify client deployment manual].
+
'''A:''' This is because the Outlook API does not let us know if a user is trying to open the attached rgf file (eg double click). Therefore, the regimail Add-In unfortunately does not know. So the operating system tries to open with some installed software instead of our Add-In (which fails). Just cancel and open the rgf from the Add-In button.
  
==Outlook BETA Add-In==
+
=== Beta/QA Version ===
We offer you to test the new regimail add-in for Outlook new and Outlook Web Access (OWA). If you want to install the beta version of the add-in, please follow these steps:[[File:NewOL Add-Ins-Button.png|right|middle|thumb]]
+
If you like to test the beta version, you can install it from a local file only. Follow this guide:
 +
# Right click this link [https://apps1.regify.com/ol-qa/outlook_regimail_qa.xml regimail outlook addin beta] and save the file ''outlook_regimail_qa.xml'' to your desktop or other folder (usually by right click on the link and then "Save as…").
 +
# Click the "Apps" or "More Apps" button <span style="display: inline-block; margin: 0; padding: 0;">[[File:Outlook-app-symbol.png|18px|frameless|alt=Outlook Marketplace Symbol]]</span> in Outlook main ribbon. There, select "Get add-ins".
 +
# Click "My add-ins" on the left and remove any existing regimail add-in.
 +
# Scroll down to "Custom add-ins" and click "Add a custom add-in" and select "Add from file…".
 +
# Select the previously downloaded ''outlook_regimail_qa.xml'' file.
  
 +
Now you see the regimail QA add-in loaded as beta version.
  
<a class="image"><img alt="NewOL Add-Ins-Button.png" src="/images/thumb/6/62/NewOL_Add-Ins-Button.png/180px-NewOL_Add-Ins-Button.png" decoding="async" width="180" height="34" class="thumbimage" srcset="/images/thumb/6/62/NewOL_Add-Ins-Button.png/270px-NewOL_Add-Ins-Button.png 1.5x, /images/thumb/6/62/NewOL_Add-Ins-Button.png/360px-NewOL_Add-Ins-Button.png 2x"></a>  <a class="internal" title="Enlarge"></a>
+
==Outlook Classic==
 
+
===Compatibility Notes ===
===Outlook Web (OWA)===
+
The current Add-In for Microsoft Outlook ''Classic'', '''shipped with the current regify client setup''', is available for the following versions:
 +
* Outlook 2019 (32 Bit & 64 Bit)
 +
* Outlook 2021 / Office 365 (32 Bit & 64 Bit)
 +
* Outlook 2024 / Office 365 (32 Bit & 64 Bit)
  
# Open https://outlook.live.com and select any message for display.
+
Please respect that we're no longer supporting Outlook versions before 2019. Running such old e-mail client is no longer secure. Please consider upgrading to a newer version. Or how about trying [https://www.thunderbird.net/ Mozilla Thunderbird] with its great email and calendar functions if you use IMAP or POP3 capable accounts?
# Click the add-ins button.
 
# Select "Get add-ins" option.
 
# In the ''Add-Ins for Outlook'' dialog, select "My add-ins" on the left.
 
# Scroll down to ''Custom Addins'' and click the "Add a custom add-in" button.
 
# If "Add from URL..." option is available:
 
#* Enter the URL https://apps1.regify.com/client-beta/outlook_regimail_beta.xml and follow instructions.
 
# If the "Add from URL..." option is not available:
 
#* Right click this Link: [https://apps1.regify.com/client-beta/outlook_regimail_beta.xml outlook_regimail_beta.xml] Select "Save target as..." option or similar to save it to your local PC.
 
#* Then select "Add from File..." option in Outlook add-in dialog and provide the just downloaded file.
 
# Now follow the instructions of Outlook.
 
  
===Outlook new===
+
===Functions===
 +
The regify Add-In for Microsoft Outlook ''Classic'' offers the following functions:
 +
* Create and encrypt new regimails.
 +
* Forward, Reply and Reply All using regimail.
 +
* Reconvert regimails to ordinary emails.
 +
* Automatically reconvert regimails while receiving.
 +
* Configure regify settings (regify account settings).
 +
* Invite new users to regify.
  
# Click the add-ins button.
+
===Setup===
# Select "Get add-ins" option.
+
The Outlook Add-In is installed automatically (in the correct version) during setup of the '''regify client'''. If you do not like to install the Outlook Add-In during setup, you can prevent it in the installer GUI. Please find additional information about setup options in the [https://manuals.regify.com/docs/regify_client/current/regify-client_deployment/ regify client deployment manual].
# In the ''Add-Ins for Outlook'' dialog, select "My add-ins" on the left.
 
# Scroll down to ''Custom Addins'' and click the "Add a custom add-in" button.
 
# If "Add from URL..." option is available:
 
#* Enter the URL https://apps1.regify.com/client-beta/outlook_regimail_beta.xml and follow instructions.
 
# If the "Add from URL..." option is not available:
 
#* Right click this Link: [https://apps1.regify.com/client-beta/outlook_regimail_beta.xml outlook_regimail_beta.xml] Select "Save target as..." option or similar to save it to your local PC.
 
#* Then select "Add from File..." option in Outlook add-in dialog and provide the just downloaded file.
 
# Now follow the instructions of Outlook.
 
[[File:NewOL Add-Ins-Select.png|right|middle|thumb]]
 

Latest revision as of 15:37, 10 February 2026

Outlook New/o365 web Add-In

Installation

Open your add-in marketplace Outlook Marketplace Symbol and search for "regimail". Then follow the instructions on the screen.

Usage

Writing: During writing, the top ribbon bar is switching to "Message" view. There, you can click the "Apps" button Outlook Marketplace Symbol to reach the regify Add-In for encryption. Follow the instructions on screen.

Reading: If an email is visible in preview, there appears a small "Apps" button Outlook Marketplace Symbol on top of the message window. There you can reach the regify Add-In for viewing the message.

Functions

The regimail Add-In for Outlook new and o365 supports the following functions:

  • Open and decrypt regimails and show content and extract attachments.
  • Encrypt regimails from your existing email draft.
  • Configure regify settings (regify account settings).
  • Additional functions may be added in the future.

Compatibility notes

We tested the following combinations with the regimail Add-In (December 2025):

Works with O365 web (eg outlook.live.com) on Windows, MacOS and Linux. (c)
Works with Outlook Classic 2024 with Hosted Exchange 2019 account on Windows. (a) (b)
Works with Outlook Classic 2024 and O365 account on Windows. (a)
Works with Outlook New with O365 account on Windows.
●︎ Not working with any Outlook Classic and On-Prem Exchange 2019 or 2016 backend. (a)
●︎ Not working with any Outlook Classic 2019 or 2016 and O365 account. (a)
Not working with Exchange 2019 OWA (web access).
Not working with Exchange 2016 OWA (web access).

(a) Consider using our regular Add-In for Outlook Classic contained in regify client setup (COM Add-In)!

(b) Due to Microsoft documentation, it works because of Outlook 2024 LTSC (volume licensing). It will not work with any previous Outlook Classic version.

(c) We've seen issues for saving decrypted regimail message attachments with Firefox browsers. If you need this, use any other up to date web browser like Edge, Chrome, Opera, Vivaldi etc.
Background: Firefox is interpreting content-security-policy values different than others. Due to this, Firefox blocks BLOB downloads because of Microsofts content-security-policy settings.

FAQ for Outlook New/o365

Q: Why don't you decrypt automatically if an encrypted regimail is received (rgf file)?
A: Office JavaScript Add-Ins cannot run code in the background or automatically when an email is selected or received. Add-In code only executes after the user explicitly opens the add-in. This is a security and performance feature of the Office platform, as documented by Microsoft. Therefore, the regimail Add-In is not able to handle regimails automatically.

Q: Why is there no regimail Add-in buttons in the Outlook GUI?
A: There are such buttons in local installed Outlook Classic 2024, but for Outlook New and o365 (in the web), the Microsoft Office Add-In API does not offer any integration into the ribbon menus. Therefore, you are forced to start the Add-In using the "Apps" or "More Apps" button Outlook Marketplace Symbol to run the regimail Add-In.

Q: I wan't to reset the Add-In settings. How can I enter the settings dialog?
A: Just create a new empty email. Now run the regimail Add-In using the "Apps" or "More Apps" button Outlook Marketplace Symbol in the "Message" tab. The "encrypt now" button appears. Instead of pressing, open the hamburger menu on the upper right and navigate to settings. There, you can click the reset configuration button.

Q: I can't open a rgf file by double click?
A: This is because the Outlook API does not let us know if a user is trying to open the attached rgf file (eg double click). Therefore, the regimail Add-In unfortunately does not know. So the operating system tries to open with some installed software instead of our Add-In (which fails). Just cancel and open the rgf from the Add-In button.

Beta/QA Version

If you like to test the beta version, you can install it from a local file only. Follow this guide:

  1. Right click this link regimail outlook addin beta and save the file outlook_regimail_qa.xml to your desktop or other folder (usually by right click on the link and then "Save as…").
  2. Click the "Apps" or "More Apps" button Outlook Marketplace Symbol in Outlook main ribbon. There, select "Get add-ins".
  3. Click "My add-ins" on the left and remove any existing regimail add-in.
  4. Scroll down to "Custom add-ins" and click "Add a custom add-in" and select "Add from file…".
  5. Select the previously downloaded outlook_regimail_qa.xml file.

Now you see the regimail QA add-in loaded as beta version.

Outlook Classic

Compatibility Notes

The current Add-In for Microsoft Outlook Classic, shipped with the current regify client setup, is available for the following versions:

  • Outlook 2019 (32 Bit & 64 Bit)
  • Outlook 2021 / Office 365 (32 Bit & 64 Bit)
  • Outlook 2024 / Office 365 (32 Bit & 64 Bit)

Please respect that we're no longer supporting Outlook versions before 2019. Running such old e-mail client is no longer secure. Please consider upgrading to a newer version. Or how about trying Mozilla Thunderbird with its great email and calendar functions if you use IMAP or POP3 capable accounts?

Functions

The regify Add-In for Microsoft Outlook Classic offers the following functions:

  • Create and encrypt new regimails.
  • Forward, Reply and Reply All using regimail.
  • Reconvert regimails to ordinary emails.
  • Automatically reconvert regimails while receiving.
  • Configure regify settings (regify account settings).
  • Invite new users to regify.

Setup

The Outlook Add-In is installed automatically (in the correct version) during setup of the regify client. If you do not like to install the Outlook Add-In during setup, you can prevent it in the installer GUI. Please find additional information about setup options in the regify client deployment manual.