Difference between revisions of "Outlook Addin"

From regify WIKI
Jump to navigation Jump to search
 
(12 intermediate revisions by the same user not shown)
Line 1: Line 1:
== Outlook for Web (OWA) and New Outlook ==
+
== Outlook for Web (OWA) and Outlook new ==
We really tried to develop an add-in for new outlook and OWA. Unfortunately, the API that Microsoft offers does not allow us to create a 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):
  
 
* Composing regimails
 
* Composing regimails
Line 10: Line 10:
 
** No API to create a new message in inbox folder with custom content.
 
** 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.
 
** 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, 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 source]). Microsoft also did not yet announce, what API requirements set it will support for upcomming Exchange 2025 end of 2025.
+
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.
 +
 
 +
<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>
 +
[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? ===
 +
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.
  
 
== Outlook Legacy ==
 
== Outlook Legacy ==
Line 34: Line 45:
  
 
=== 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, please refer the "regify client software deployment documentation" for possible options. It is provided to you by your regify provider.
+
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==
 +
<div style="border: 2px solid red; background-color: white; color: red; padding: 5px;">Please note that this add-in is still '''beta''' and very likely only works with O365 accounts or most recent Outlook Classic versions. 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.</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:
 +
 
 +
===Outlook Web (OWA)===
 +
 
 +
# Open https://outlook.live.com and select to create a '''new email'''.[[File:NewOL Add-Ins-Button.png|right|middle|450px]]
 +
# Click the add-ins button.
 +
# Select "Get add-ins" option. [[File:NewOL Add-Ins-Select.png|right|middle|200px]]
 +
# 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===
 +
 
 +
# 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.

Latest revision as of 11:33, 15 January 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.

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 and very likely only works with O365 accounts or most recent Outlook Classic versions. 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.

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. Open https://outlook.live.com and select to create a new email.
    NewOL Add-Ins-Button.png
  2. Click the add-ins button.
  3. Select "Get add-ins" option.
    NewOL Add-Ins-Select.png
  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.
  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:
    • 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.