[IMP] General: Email server config update

closes odoo/documentation#16192

Signed-off-by: Jessica Rogers (jero) <jero@odoo.com>
This commit is contained in:
jero-odoo
2026-01-29 13:47:15 -05:00
parent defe03297c
commit 5b392ea5a0
2 changed files with 30 additions and 30 deletions

View File

@@ -3,9 +3,9 @@ Connect Microsoft Outlook 365 to Odoo using Azure OAuth
======================================================= =======================================================
Odoo is compatible with Microsoft's Azure OAuth for Microsoft 365. In order to send and receive Odoo is compatible with Microsoft's Azure OAuth for Microsoft 365. In order to send and receive
secure emails from a custom domain, all that is required is to configure a few settings on the secure emails from a custom domain, all that is required is to configure a few settings on the Azure
Azure platform and on the back end of the Odoo database. This configuration works with either a platform and on the back end of the Odoo database. This configuration works with either a personal
personal email address or an address created by a custom domain. email address or an address created by a custom domain.
.. seealso:: .. seealso::
`Microsoft Learn: Register an application with the Microsoft identity platform `Microsoft Learn: Register an application with the Microsoft identity platform
@@ -22,10 +22,10 @@ Create a new application
------------------------ ------------------------
To get started, go to `Microsoft's Azure Portal <https://portal.azure.com/>`_. Log in with the To get started, go to `Microsoft's Azure Portal <https://portal.azure.com/>`_. Log in with the
:guilabel:`Microsoft Outlook Office 365` account if there is one, otherwise log in with the :guilabel:`Microsoft Outlook Office 365` account if there is one, otherwise log in with the personal
personal :guilabel:`Microsoft account`. A user with administrative access to the Azure Settings :guilabel:`Microsoft account`. A user with administrative access to the Azure Settings will need to
will need to connect and perform the following configuration. Next, navigate to the section connect and perform the following configuration. Next, navigate to the section labeled
labeled :guilabel:`Manage Microsoft Entra ID` (formally *Azure Active Directory*). :guilabel:`Manage Microsoft Entra ID` (formally *Azure Active Directory*).
Now, click on :guilabel:`Add (+)`, located in the top menu, and then select :guilabel:`App Now, click on :guilabel:`Add (+)`, located in the top menu, and then select :guilabel:`App
registration`. On the :guilabel:`Register an application` screen, rename the :guilabel:`Name` to registration`. On the :guilabel:`Register an application` screen, rename the :guilabel:`Name` to
@@ -93,28 +93,28 @@ application.
Create credentials Create credentials
------------------ ------------------
Now that the Microsoft Azure app is set up, credentials need to be created for the Odoo setup. Now that the Microsoft Azure app is set up, credentials need to be created for the Odoo setup. These
These include the :guilabel:`Client ID` and :guilabel:`Client Secret`. To start, the include the :guilabel:`Client ID` and :guilabel:`Client Secret`. To start, the :guilabel:`Client ID`
:guilabel:`Client ID` can be copied from the :guilabel:`Overview` page of the app. The can be copied from the :guilabel:`Overview` page of the app. The :guilabel:`Client ID` or
:guilabel:`Client ID` or :guilabel:`Application ID` is located under the :guilabel:`Display Name` :guilabel:`Application ID` is located under the :guilabel:`Display Name` in the
in the :guilabel:`Essentials` overview of the app. :guilabel:`Essentials` overview of the app.
.. image:: azure_oauth/application-id.png .. image:: azure_oauth/application-id.png
:align: center :align: center
:alt: Application/Client ID located in the Overview of the app. :alt: Application/Client ID located in the Overview of the app.
Next, the :guilabel:`Client Secret Value` needs to be retrieved. To get this value, click on Next, the :guilabel:`Client Secret Value` needs to be retrieved. To get this value, click on
:guilabel:`Certificates & Secrets` in the left sidebar menu. Then, a :guilabel:`Client Secret` :guilabel:`Certificates & Secrets` in the left sidebar menu. Then, a :guilabel:`Client Secret` needs
needs to be produced. In order to do this, click on the :guilabel:`(+) New Client Secret` button. to be produced. In order to do this, click on the :guilabel:`(+) New Client Secret` button.
A window on the right will populate with a button labeled :guilabel:`Add a client secret`. Under A window on the right will populate with a button labeled :guilabel:`Add a client secret`. Under
:guilabel:`Description`, type in `Odoo Fetchmail` or something recognizable, and then set the :guilabel:`Description`, type in `Odoo Fetchmail` or something recognizable, and then set the
:guilabel:`expiration date`. :guilabel:`expiration date`.
.. important:: .. important::
A new :guilabel:`Client Secret` will need to be produced and configured if the first one A new :guilabel:`Client Secret` will need to be produced and configured if the first one expires.
expires. In this event, there could be an interruption of service, so the expiration date should In this event, there could be an interruption of service, so the expiration date should be noted
be noted and set to the furthest possible date. and set to the furthest possible date.
Next, click on :guilabel:`Add` when these two values are entered. A :guilabel:`Client Secret Value` Next, click on :guilabel:`Add` when these two values are entered. A :guilabel:`Client Secret Value`
and :guilabel:`Secret ID` will be created. It is important to copy the :guilabel:`Value` or and :guilabel:`Secret ID` will be created. It is important to copy the :guilabel:`Value` or
@@ -142,14 +142,14 @@ First, open the Odoo database and navigate to the :guilabel:`Apps` module. Then,
:guilabel:`Apps` filter from the search bar and type in `Outlook`. After that, install the module :guilabel:`Apps` filter from the search bar and type in `Outlook`. After that, install the module
called :guilabel:`Microsoft Outlook`. called :guilabel:`Microsoft Outlook`.
Next, navigate to :menuselection:`Settings --> General Settings`, and under the :guilabel:`Discuss` Next, navigate to :menuselection:`Settings --> General Settings`, and under the *Emails* section,
section, ensure that the checkbox for :guilabel:`Custom Email Servers` is checked. This populates ensure that the checkbox for :guilabel:`Use Custom Email Servers` is checked. This populates a new
a new option for :guilabel:`Outlook Credentials`. option for :guilabel:`Outlook Credentials`.
:guilabel:`Save` the progress. :guilabel:`Save` the progress.
Then, copy and paste the :guilabel:`Client ID` (Application ID) and :guilabel:`Client Secret Then, copy and paste the :guilabel:`ID` (Application ID) and :guilabel:`Secret (Client Secret
(Client Secret Value)` into the respective fields and :guilabel:`Save` the settings. Value)` into the respective fields and :guilabel:`Save` the settings.
.. image:: azure_oauth/outlookcreds.png .. image:: azure_oauth/outlookcreds.png
:align: center :align: center
@@ -158,8 +158,8 @@ Then, copy and paste the :guilabel:`Client ID` (Application ID) and :guilabel:`C
Configure outgoing email server Configure outgoing email server
------------------------------- -------------------------------
On the :guilabel:`General Settings` page, under the :guilabel:`Custom Email Servers` setting, On the :guilabel:`General Settings` page, under the :guilabel:`Custom Email Servers` setting, click
click the :guilabel:`Outgoing Email Servers` link to configure the Microsoft account. the :guilabel:`Outgoing Email Servers` link to configure the Microsoft account.
Then, create a new email server and check the box for :guilabel:`Outlook`. Next, fill in the Then, create a new email server and check the box for :guilabel:`Outlook`. Next, fill in the
:guilabel:`Name` (it can be anything) and the Microsoft Outlook email :guilabel:`Username`. :guilabel:`Name` (it can be anything) and the Microsoft Outlook email :guilabel:`Username`.
@@ -193,8 +193,8 @@ can now send safe, secure emails through Microsoft Outlook using OAuth authentic
Configuration with a single outgoing mail server Configuration with a single outgoing mail server
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Configuring a single outgoing server is the simplest configuration available for Microsoft Azure Configuring a single outgoing server is the simplest configuration available for Microsoft Azure and
and it doesn't require extensive access rights for the users in the database. it doesn't require extensive access rights for the users in the database.
A generic email address would be used to send emails for all users within the database. For example A generic email address would be used to send emails for all users within the database. For example
it could be structured with a `notifications` alias (`notifications@example.com`) or `contact` alias it could be structured with a `notifications` alias (`notifications@example.com`) or `contact` alias
@@ -203,8 +203,8 @@ This address must also match the `{mail.default.from}@{mail.catchall.domain}` ke
system parameters. system parameters.
.. seealso:: .. seealso::
Visit the :ref:`From Filtering documentation <email-outbound-different-servers-personalized-from-filtering>` for more Visit the :ref:`From Filtering <email-outbound-different-servers-personalized-from-filtering>`
information. documentation for more information.
.. note:: .. note::
The :guilabel:`System Parameters` can be accessed by activating :ref:`developer-mode` in the The :guilabel:`System Parameters` can be accessed by activating :ref:`developer-mode` in the
@@ -245,8 +245,8 @@ so that only the user's email is sent from that server. In other words, only a u
address that matches the set :guilabel:`FROM Filtering` is able to use this server. address that matches the set :guilabel:`FROM Filtering` is able to use this server.
.. seealso:: .. seealso::
Visit the :ref:`From Filtering documentation <email-outbound-different-servers-personalized-from-filtering>` for more Visit the :ref:`From Filtering <email-outbound-different-servers-personalized-from-filtering>`
information. documentation for more information.
A :ref:`fallback server <azure_oauth/notifications>` must be setup to allow for the sending of A :ref:`fallback server <azure_oauth/notifications>` must be setup to allow for the sending of
:guilabel:`notifications`. The :guilabel:`FROM Filtering` for this server should have the value of :guilabel:`notifications`. The :guilabel:`FROM Filtering` for this server should have the value of

Binary file not shown.

Before

Width:  |  Height:  |  Size: 23 KiB

After

Width:  |  Height:  |  Size: 25 KiB