Difference between revisions of "Outlook Addin"

From regify WIKI
Jump to navigation Jump to search
 
(22 intermediate revisions by the same user not shown)
Line 1: Line 1:
== Outlook for Web (OWA) and Outlook new ==
+
==Outlook for Web (OWA) and Outlook new==
 
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):
 
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):
  
Line 17: Line 17:
 
[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>
 
[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>
  
=== What comes next? ===
+
===What comes next?===
 
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.  
 
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.  
  
Line 24: Line 24:
 
We will keep you updated on this page.
 
We will keep you updated on this page.
  
'''[24. JAN 2025]''' You may want to check the beta version of our new regimail add-in below on this page!
+
'''[28. JAN 2025]''' You may want to check the beta version of our new regimail add-in below on this page!
 
 
== Outlook Legacy ==
 
  
 +
==Outlook Legacy==
 
===Supported versions===
 
===Supported versions===
 
The current AddIn for Microsoft Outlook is available for the following versions:
 
The current AddIn for Microsoft Outlook is available for the following versions:
Line 36: Line 35:
 
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?
 
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?
  
=== Functions ===
+
===Functions===
 
 
 
The AddIn for Microsoft Outlook offers the following functions:
 
The AddIn for Microsoft Outlook offers the following functions:
 
* create new regify e-mails
 
* create new regify e-mails
Line 46: Line 44:
 
* invite new users to regify
 
* invite new users to regify
  
=== Setup ===
+
===Setup===
 
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].
 
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].
  
 
==Outlook BETA Add-In==
 
==Outlook BETA Add-In==
<div style="border: 2px solid red; background-color: #fcfcfc; color: red; padding: 5px;">
+
<div style="border: 5px solid red; background-color: #fff2f2; color: #771010; padding: 5px 5px 5px 20px;">
Please note that this add-in is still '''beta''' and does only offer very limited functionality. Check below compatibility notes!  
+
Please note that this add-in is still '''beta'''.
 +
* It offers only limited functionality.
 +
* It may not work at all or at all time.
 +
* It may not cover all message content and all content types.
 +
* It may not encrypt properly.
 +
* It may trigger additional "new device" email messages to users.
 +
* Also, please check below compatibility notes!  
  
If you experience any problems and want to report, please send an exact error report with exact versions, all steps you did and screenshots to support (at) regify.com.
+
If you experience any problems and you are willing to report, please send an exact error report with exact versions, all steps you did and maybe even screenshots to support (at) regify.com.
 
</div>
 
</div>
  
<div style="border: 2px solid blue; background-color: #fcfcfc; color: blue; padding: 5px; margin-top: 15px;">
+
<div style="border: 5px solid blue; background-color: #ececf4; color: #202080; padding: 5px 5px 5px 20px; margin-top: 15px;">
 
<b><u>Compatibility notes:</u></b><br>
 
<b><u>Compatibility notes:</u></b><br>
We tested the following combinations (Jan 2025):
+
We tested the following combinations on Windows 11 (Jan 2025):
* ✅ Works with '''O365 web''' (eg outlook.live.com).
+
* ✅ Works with '''O365 web''' (eg outlook.live.com). <sup>(c)</sup>
* ✅ Works with '''Outlook Classic 2024''' with '''Hosted Exchange 2019''' account. (*)
+
* ✅ Works with '''Outlook Classic 2024''' with '''Hosted Exchange 2019''' account. <sup>(a) (b)</sup>
* ✅ Works with '''Outlook Classic 2024''' and '''O365 account'''. (*)
+
* ✅ Works with '''Outlook Classic 2024''' and '''O365 account'''. <sup>(a)</sup>
 
* ✅ Works with '''Outlook New''' with '''O365 account'''.
 
* ✅ Works with '''Outlook New''' with '''O365 account'''.
 
* ❌ Not working with '''Outlook New''' with '''Hosted Exchange 2019''' account (Outlook New does not support such accounts in general).
 
* ❌ Not working with '''Outlook New''' with '''Hosted Exchange 2019''' account (Outlook New does not support such accounts in general).
 
* ❌ Not working with '''Exchange 2019 OWA''' (web access).
 
* ❌ Not working with '''Exchange 2019 OWA''' (web access).
 
* ❌ Not working with '''Exchange 2016 OWA''' (web access).
 
* ❌ Not working with '''Exchange 2016 OWA''' (web access).
* - Untested with any '''Outlook Classic''' and '''On-Prem''' Exchange 2019 or 2016 backend. (*)
+
* - Untested with any '''Outlook Classic''' and '''On-Prem''' Exchange 2019 or 2016 backend. <sup>(a)</sup>
* - Untested with any '''Outlook Classic 2019 or 2016''' and O365 account. (*)
+
* - Untested with any '''Outlook Classic 2019 or 2016''' and O365 account. <sup>(a)</sup>
 +
* - Untested with any '''MacOS''' version.
 +
 
 +
<span style="font-size: 80%;">(a) Consider using our regular Add-In contained in regify client setup (COM Add-In)!</span>
 +
 
 +
<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 version.</span>
  
(*) Consider using our regular Add-In contained in regify client setup (COM Add-In)!
+
<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'''.<br>Background: Firefox is interpreting ''content-security-policy'' values different than others. Due to this, he blocks BLOB downloads due to Microsofts ''content-security-policy settings''.</span>
 
</div>
 
</div>
  
We offer you to test the new '''beta''' 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:
+
 
 +
 
 +
 
 +
We offer you to test the new '''BETA''' 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:
  
 
===Outlook Web (OWA)===
 
===Outlook Web (OWA)===
  
# Open https://outlook.live.com and select to create a '''new email'''.[[File:NewOL Add-Ins-Button.png|right|middle|450px]]
+
# Select to create a '''new email'''.[[File:NewOL Add-Ins-Button.png|right|middle|450px|Outlook WEB, find add-ins button in new email dialog]]
 
# Click the add-ins button.
 
# Click the add-ins button.
# Select "Get add-ins" option. [[File:NewOL Add-Ins-Select.png|right|middle|200px]]
+
# Select "Get add-ins" option. [[File:NewOL Add-Ins-Select.png|right|middle|200px|Outlook WEB, add additional add-ins from here]]
 
# In the ''Add-Ins for Outlook'' dialog, select "My add-ins" on the left.
 
# 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.
 
# Scroll down to ''Custom Addins'' and click the "Add a custom add-in" button.
Line 87: Line 99:
 
#* Then select "Add from File..." option in Outlook add-in dialog and provide the just downloaded file.
 
#* Then select "Add from File..." option in Outlook add-in dialog and provide the just downloaded file.
 
# Now follow the instructions of Outlook.
 
# Now follow the instructions of Outlook.
 +
 +
 +
 +
  
 
===Outlook new===
 
===Outlook new===
  
# Click the add-ins button.
+
# Click the add-ins button.[[File:Outlook new message.png|right|middle|500px|Outlook new, encrypt as regimail]]
 
# Select "Get add-ins" option.
 
# Select "Get add-ins" option.
 
# In the ''Add-Ins for Outlook'' dialog, select "My add-ins" on the left.
 
# In the ''Add-Ins for Outlook'' dialog, select "My add-ins" on the left.
Line 96: Line 112:
 
# If "Add from URL..." option is available:
 
# If "Add from URL..." option is available:
 
#* Enter the URL https://apps1.regify.com/client-beta/outlook_regimail_beta.xml and follow instructions.
 
#* 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:
+
# If the "Add from URL..." option is not available: [[File:Outlook read message.png|right|middle|500px|Outlook new, decrypt a regimail]]
 
#* 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.
 
#* 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.
 
#* Then select "Add from File..." option in Outlook add-in dialog and provide the just downloaded file.
 
# Now follow the instructions of Outlook.
 
# Now follow the instructions of Outlook.
 +
 +
 +
 +
 +
 +
 +
 +
 +
 +
 +
===Outlook 2024===
 +
 +
# Click "File" -> "Manage Add-ins" (button at the bottom). Now the web browser opens up on your webmail email account.
 +
# Log-in to your webmail email account.
 +
# Click the plus (+) on top of the Add-Ins list.
 +
# Select "Add from URL..." and enter https://apps1.regify.com/client-beta/outlook_regimail_beta.xml
 +
# Confirm security question.
 +
# Close the web browser.

Latest revision as of 15:51, 11 February 2025

Outlook for Web (OWA) and Outlook new

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):

  • Composing regimails
    • No API to reliable get attachments and inline images (source).
    • No API to get attachments from forwarded messages (source).
    • No API to trigger sending after encryption (source).
  • Reading regimails
    • No API to set/replace body or delete/replace attachments (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) (source). Microsoft also did not yet announce, what API requirements set it will support for upcomming Exchange 2025.

Therefore, we recommend you to not update to Outlook new if you want to keep your current regimail add-in working!
Here is how you can stop Outlook from automatic update to Outlook new.

What comes next?

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.

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.

We will keep you updated on this page.

[28. JAN 2025] You may want to check the beta version of our new regimail add-in below on this page!

Outlook Legacy

Supported versions

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?

Functions

The AddIn for Microsoft Outlook offers the following functions:

  • create new regify e-mails
  • 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

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 regify client deployment manual.

Outlook BETA Add-In

Please note that this add-in is still beta.

  • It offers only limited functionality.
  • It may not work at all or at all time.
  • It may not cover all message content and all content types.
  • It may not encrypt properly.
  • It may trigger additional "new device" email messages to users.
  • Also, please check below compatibility notes!

If you experience any problems and you are willing to report, please send an exact error report with exact versions, all steps you did and maybe even screenshots to support (at) regify.com.

Compatibility notes:
We tested the following combinations on Windows 11 (Jan 2025):

  • ✅ Works with O365 web (eg outlook.live.com). (c)
  • ✅ Works with Outlook Classic 2024 with Hosted Exchange 2019 account. (a) (b)
  • ✅ Works with Outlook Classic 2024 and O365 account. (a)
  • ✅ Works with Outlook New with O365 account.
  • ❌ Not working with Outlook New with Hosted Exchange 2019 account (Outlook New does not support such accounts in general).
  • ❌ Not working with Exchange 2019 OWA (web access).
  • ❌ Not working with Exchange 2016 OWA (web access).
  • - Untested with any Outlook Classic and On-Prem Exchange 2019 or 2016 backend. (a)
  • - Untested with any Outlook Classic 2019 or 2016 and O365 account. (a)
  • - Untested with any MacOS version.

(a) Consider using our regular Add-In 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 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.
Background: Firefox is interpreting content-security-policy values different than others. Due to this, he blocks BLOB downloads due to Microsofts content-security-policy settings.



We offer you to test the new BETA 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:

Outlook Web (OWA)

  1. Select to create a new email.
    Outlook WEB, find add-ins button in new email dialog
  2. Click the add-ins button.
  3. Select "Get add-ins" option.
    Outlook WEB, add additional add-ins from here
  4. In the Add-Ins for Outlook dialog, select "My add-ins" on the left.
  5. Scroll down to Custom Addins and click the "Add a custom add-in" button.
  6. If "Add from URL..." option is available:
  7. If the "Add from URL..." option is not available:
    • Right click this Link: 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.
  8. Now follow the instructions of Outlook.



Outlook new

  1. Click the add-ins button.
    Outlook new, encrypt as regimail
  2. Select "Get add-ins" option.
  3. In the Add-Ins for Outlook dialog, select "My add-ins" on the left.
  4. Scroll down to Custom Addins and click the "Add a custom add-in" button.
  5. If "Add from URL..." option is available:
  6. If the "Add from URL..." option is not available:
    Outlook new, decrypt a regimail
    • Right click this Link: 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.
  7. Now follow the instructions of Outlook.






Outlook 2024

  1. Click "File" -> "Manage Add-ins" (button at the bottom). Now the web browser opens up on your webmail email account.
  2. Log-in to your webmail email account.
  3. Click the plus (+) on top of the Add-Ins list.
  4. Select "Add from URL..." and enter https://apps1.regify.com/client-beta/outlook_regimail_beta.xml
  5. Confirm security question.
  6. Close the web browser.