documentation/content/applications/general/email_communication/email_domain.rst
2022-11-18 18:04:50 +01:00

164 lines
7.7 KiB
ReStructuredText

========================
Sending emails with Odoo
========================
Using your email domain in Odoo
===============================
Documents in Odoo (a CRM opportunity, a sales order, an invoice ...) have a discussion thread,
called *chatter*.
When you post a message in the chatter, this message is sent by email to the followers of the
document. If a follower replies to the message, the reply updates the chatter, and Odoo relays the
reply to the followers.
Emails from your users to partners (customers, vendors) are sent from the email address of your
users. Similarly, emails from partners to users are sent from the email address of the partners.
This allows you to recognize at a glance who sent an email relayed by Odoo.
If your database is hosted on our cloud (Odoo Online or Odoo.sh), it is not necessary to add an
outgoing email server to send emails from your custom domain. You can enjoy this feature by using
the default Odoo email server.
.. important::
The Odoo server is subject to a daily email limit to prevent abuse. The default limit is 200
emails sent per day for databases with an Enterprise subscription. This limit can be increased
under certain conditions. See our :doc:`FAQ <faq>` or contact support for more
information.
However, it is recommended that you configure your domain name to ensure that emails from your
users reach your partners, rather than being considered spam.
For the same reason, we recommend that you always give your users an email address from a domain
you manage, rather than a generic email address (gmail.com, outlook.com, etc.).
.. _email_communication/spf_compliant:
Be SPF compliant
================
The Sender Policy Framework (SPF) protocol allows the owner of a domain name to specify which
servers are allowed to send email from that domain. When a server receives an incoming email,
it checks whether the IP address of the sending server is on the list of allowed IPs according
to the SPF record of the sender.
.. note::
The SPF verification is performed on the domain mentioned in the Return-Path field of the email.
In the case of an email sent by Odoo, this domain corresponds to the value of the
`mail.catchall.domain` key in the database system parameters.
See the :ref:`documentation on incoming emails <email_communication/inbound_messages>`.
The SPF policy of a domain is set using a TXT record. How to create or modify a TXT record depends
on the provider hosting the DNS zone of your domain name. In order for the verification to work
properly, each domain can only have one SPF record.
If your domain name does not yet have an SPF record, the content of the record to create is as
follows:
``v=spf1 include:_spf.odoo.com ~all``
If your domain name already has an SPF record, you need to update this record (and do not create a
new one).
.. example::
If your TXT record is `v=spf1 include:_spf.google.com ~all`, you need to edit it to add
`include:_spf.odoo.com`: `v=spf1 include:_spf.odoo.com include:_spf.google.com ~all`
You can check if your SPF record is valid with a free tool like
`MXToolbox SPF <https://mxtoolbox.com/spf.aspx>`_.
.. _email_communication/DKIM_compliant:
Enable DKIM
===========
The DomainKeys Identified Mail (DKIM) allows you to authenticate your emails with a digital signature.
When sending an email, the Odoo server includes a unique DKIM signature in the headers. The
recipient's server decrypts this signature using the DKIM record in your domain name. If the
signature and the key contained in the record match, this guarantees that your message is authentic
and has not been altered during transport.
To enable DKIM, you must add a CNAME record to the DNS zone of your domain name:
``odoo._domainkey IN CNAME odoo._domainkey.odoo.com.``
.. tip::
If your domain name is `mycompany.com`, you need to create a subdomain
`odoo._domainkey.mycompany.com` whose canonical name is `odoo._domainkey.odoo.com.`.
How to create or modify a CNAME record depends on the provider hosting the DNS zone of your domain
name. The most common providers are list below.
You can check if your DKIM record is valid with a free tool like
`DKIM Core <https://dkimcore.org/tools/>`_. If a selector is asked, enter `odoo`.
Check your DMARC policy
=======================
The Domain-based Message Authentication, Reporting & Conformance (DMARC) is a protocol that unifies SPF
and DKIM. The instructions contained in the DMARC record of a domain name tell the destination
server what to do with an incoming email that fails the SPF and/or DKIM check.
There are three DMARC policies:
- ``p=none``
- ``p=quarantine``
- ``p=reject``
``p=quarantine`` and ``p=reject`` instruct the server that receives an email to quarantine that
email or ignore it if the SPF and/or DKIM check fails.
If your domain name uses DMARC and has defined one of these policies, it is therefore imperative
to be SPF compliant or to enable DKIM.
.. danger::
Yahoo or AOL are examples of email providers with a DMARC policy set to ``p=reject``. We
strongly advise against using an *@yahoo.com* or *@aol.com* address for your users. These emails
will never reach their recipient.
``p=none`` is used for the domain owner to receive reports about entities using their domain. It
should not impact the deliverability if the DMARC check fails.
You can check the DMARC record of a domain name with a tool like
`MXToolbox DMARC <https://mxtoolbox.com/DMARC.aspx>`_.
If one of your partners, customer or vendor, uses DMARC and has defined one of these policies, the
Odoo server cannot relay emails from this partner to your users.
You need to :ref:`handle user notifications in Odoo <discuss_app/notification_preferences>`, or replace the
email address of the partner with a default email address.
.. _email_communication/SPFDKIM_common_providers:
SPF, DKIM & DMARC documentation of common providers
===================================================
- `OVH DNS <https://docs.ovh.com/us/en/domains/web_hosting_how_to_edit_my_dns_zone/>`_
- `OVH SPF <https://docs.ovh.com/us/en/domains/web_hosting_the_spf_record/>`_
- `GoDaddy TXT record <https://www.godaddy.com/help/add-a-txt-record-19232>`_
- `GoDaddy SPF <https://www.godaddy.com/help/add-an-spf-record-19218>`_
- `GoDaddy DKIM <https://www.godaddy.com/help/add-a-cname-record-19236>`_
- `NameCheap <https://www.namecheap.com/support/knowledgebase/article.aspx/317/2237/how-do-i-add-txtspfdkimdmarc-records-for-my-domain/>`_
- `CloudFlare DNS <https://support.cloudflare.com/hc/en-us/articles/360019093151>`_
- `Google Domains <https://support.google.com/domains/answer/3290350?hl=en>`_
- `Azure DNS <https://docs.microsoft.com/en-us/azure/dns/dns-getstarted-portal>`_
To fully test your configuration, the tool `Mail-Tester <https://www.mail-tester.com/>`_ will give
you a full overview of the content and configuration you have in one email sent! Mail-Tester can
also be used for other lesser known providers.
Use a default email address
===========================
To force the email address from which emails are sent, you need to create the following key in
the System Parameters of the database:
- If ``mail.default.from`` is set, and contains a full email address, all outgoing emails are sent
from the given address. This is a requirement to use `Outlook with Odoo
<https://docs.microsoft.com/en-us/exchange/mail-flow-best-practices/how-to-set-up-a-multifunction-device-or-application-to-send-email-using-microsoft-365-or-office-365#option-1-authenticate-your-device-or-application-directly-with-a-microsoft-365-or-office-365-mailbox-and-send-mail-using-smtp-auth-client-submission>`_.
You access the **System Parameters** in :ref:`developer mode <developer-mode>` in the :menuselection:`Settings -->
Technical --> Parameters --> System Parameters` menu.