Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[IMP] doc: add email gateway documentation #31363

Closed
wants to merge 1 commit into from
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
Binary file added doc/_static/banners/email_gateway.jpg
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added doc/_static/banners/email_gateway.small.jpg
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
1 change: 1 addition & 0 deletions doc/setup.rst
Expand Up @@ -12,3 +12,4 @@ Setting Up
setup/update
setup/cdn
setup/enterprise
setup/email_gateway
39 changes: 39 additions & 0 deletions doc/setup/email_gateway.rst
@@ -0,0 +1,39 @@
:banner: banners/email_gateway.jpg

==================
Odoo email gateway
==================

The Odoo mail gateway allows you to inject directly all the received emails in Odoo.

Its principle is straightforward: your SMTP server executes the "mailgate" script for every new incoming email.

The script takes care of connecting to your Odoo database through XML-RPC, and send the emails via the MailThread.message_process() feature.

Prerequisites
-------------
- Administrator access to the Odoo database.
- Your own mail server such as Postfix or Exim.
- Technical knowledge on how to configure an email server.

For Postfix
-----------
In you alias config (/etc/aliases):

.. code-block:: text
email@address: "|/odoo-directory/addons/mail/static/scripts/odoo-mailgate.py -d <database-name> -u <userid> -p <password>"
.. note:: Resources
- `Postfix <http://www.postfix.org/documentation.html>`
- `Postfix aliases <http://www.postfix.org/aliases.5.html>`
- `Postfix virtual <http://www.postfix.org/virtual.8.html>`


For Exim
--------
.. code-block:: text
*: |/odoo-directory/addons/mail/static/scripts/odoo-mailgate.py -d <database-name> -u <userid> -p <password>
.. note:: Resources
- `Exim <https://www.exim.org/docs.html>`


.. note:: If you don't have access/manage your email server, use `inbound messages<https://www.odoo.com/documentation/user/12.0/discuss/email_servers.html#how-to-manage-inbound-messages>`.