From ff50d107d6f4ab2138417584b60472b8530ac054 Mon Sep 17 00:00:00 2001 From: jupe Date: Tue, 23 Jun 2026 21:56:18 +0200 Subject: [PATCH] Revert "[IMP] email: clarify domain formatting for dkim config" This reverts commit eb801dfbd7c1cbdc6640d3095fd44c00168013de. --- .../email_communication/email_domain.rst | 114 +++--------------- 1 file changed, 14 insertions(+), 100 deletions(-) diff --git a/content/applications/general/email_communication/email_domain.rst b/content/applications/general/email_communication/email_domain.rst index a45fccd9a94..96d4c04c5fb 100644 --- a/content/applications/general/email_communication/email_domain.rst +++ b/content/applications/general/email_communication/email_domain.rst @@ -1,6 +1,3 @@ -.. |nbsp| unicode:: 0xA0 - :trim: - ============================================ Configure DNS records to send emails in Odoo ============================================ @@ -67,101 +64,24 @@ DKIM (DomainKeys Identified Mail) The DomainKeys Identified Mail (DKIM) allows a user to authenticate emails with a digital signature. -When sending an email, the Odoo email server includes a unique DKIM signature in the headers. The -recipient's server decrypts this signature using the DKIM record in the database's domain name. If -the signature and the key contained in the record match, it proves the message is authentic and has -not been altered during transport. +When sending an email, the Odoo email server includes a unique :abbr:`DKIM (DomainKeys Identified +Mail)` signature in the headers. The recipient's server decrypts this signature using the DKIM +record in the database's domain name. If the signature and the key contained in the record match, it +proves the message is authentic and has not been altered during transport. Enabling DKIM is **required** when sending emails **from a custom domain** using the Odoo email server. -Add a CNAME record for domain ------------------------------ - -To enable DKIM, add a canonical name (CNAME) record to the domain name system (DNS) zone of the -domain name: +To enable DKIM, add a :abbr:`CNAME (Canonical Name)` record to the :abbr:`DNS (Domain Name System)` +zone of the domain name: .. code-block:: bash odoo._domainkey IN CNAME odoo._domainkey.odoo.com. - -If the domain name is *company-name.com*, make sure to create a CNAME record where the CNAME record -(key/name) is `odoo._domainkey.company-name.com`, and the canonical name (value/content) is -`odoo._domainkey.odoo.com.`. For example, note the differences between each key/value in italics\: - -.. list-table:: Example CNAME record - :widths: 6 5 20 20 - :header-rows: 0 - :stub-columns: 1 - - * - Key - - - - odoo.\_domainkey - - - * - Value - - - - odoo.\_domainkey.\ *odoo.com.* |nbsp| - - - * - - - OR - - odoo.\_domainkey.\ *dbname*\ .odoo.com. - - ... where *dbname* is the name of the Odoo database. - -On most DNS platforms, the DNS provider adds the custom domain (e.g., *company-name.com*) by -default. In this case, the key looks different while the value remains the same: - -.. list-table:: Example CNAME record with custom domain - :widths: 6 5 20 20 - :header-rows: 0 - :stub-columns: 1 - - * - Key - - - - odoo.\_domainkey.\ *company-name.com* |nbsp| - - ... where *company-name.com* is the custom domain. - * - Value - - - - odoo.\_domainkey.\ *odoo.com.* |nbsp| - - - * - - - OR - - odoo.\_domainkey.\ *dbname*\ .odoo.com. - - ... where *dbname* is the name of the Odoo database. - -.. note:: - If the DNS provider does not add the custom domain by default, make sure to include it. - -Add a CNAME record for subdomain --------------------------------- - -If there's a \ *subdomain* (e.g., *marketing* in *marketing*\ .company-name.com), add a CNAME record to include it -for compliance as well: - -.. list-table:: Example CNAME record with subdomain - :widths: 6 5 20 20 - :header-rows: 0 - :stub-columns: 1 - - * - Key - - - - odoo.\_domainkey.\ *marketing* |nbsp| - - ... where *marketing* is the subdomain. - * - - - OR - - odoo.\_domainkey.marketing.\ *company-name.com*\ |nbsp| - - ... where *company-name.com* is the custom domain. - * - Value - - - - odoo.\_domainkey.\ *odoo.com.* |nbsp| - - - * - - - OR - - odoo.\_domainkey.\ *dbname*\ .odoo.com. - - ... where *dbname* is the name of the Odoo database. - -See DNS provider documentation ------------------------------- +.. tip:: + If the domain name is `company-name.com`, make sure to create a subdomain + `odoo._domainkey.company-name.com` whose canonical name is `odoo._domainkey.odoo.com.`. The way to create or modify a CNAME record depends on the provider hosting the DNS zone of the domain name. The :ref:`most common providers ` and their @@ -169,7 +89,7 @@ documentation are listed below. Check if the DKIM record is valid using a tool like `MXToolbox DKIM Record Lookup `_. Enter `example.com:odoo` in the DKIM lookup tool, specifying -that the selector being tested is *odoo* for the custom domain *example.com*. +that the selector being tested is `odoo` for the custom domain `example.com`. .. _email-domain-dmarc: @@ -218,13 +138,10 @@ SPF, DKIM and DMARC documentation of common providers - `OVH DNS `_ - `GoDaddy TXT record `_ -- `GoDaddy SPF, DKIM, or DMARC records - `_ -- `NameCheap - `_ +- `GoDaddy CNAME record `_ +- `NameCheap `_ - `CloudFlare DNS `_ -- `Squarespace DNS records - `_ +- `Squarespace DNS records `_ - `Azure DNS `_ To fully test the configuration, use the `Mail-Tester `_ tool, which @@ -232,7 +149,4 @@ gives a full overview of the content and configuration in one sent email. Mail-T used to configure records for other, lesser-known providers. .. seealso:: - - `Using Mail-Tester to set SPF Records for specific carriers - `_ - - `Magic Sheet - SPF, DKIM and DMARC configuration [PDF] - `_ + `Using Mail-Tester to set SPF Records for specific carriers `_