From aa5de574aa3917e3e0a2b2e3aa41d0f95e052ed2 Mon Sep 17 00:00:00 2001
From: Nicolas Bayet <nby@odoo.com>
Date: Fri, 1 Feb 2019 15:00:17 +0000
Subject: [IMP] doc: add email gateway documentation

Explain how to use addons/mail/static/scripts/odoo-mailgate.py through
an incoming mail server like Postfix or Exim.

closes odoo/odoo#31363
---
 doc/setup/email_gateway.rst | 39 +++++++++++++++++++++++++++++++++++++++
 1 file changed, 39 insertions(+)
 create mode 100644 doc/setup/email_gateway.rst

(limited to 'doc/setup')

diff --git a/doc/setup/email_gateway.rst b/doc/setup/email_gateway.rst
new file mode 100644
index 00000000000..e82ef348409
--- /dev/null
+++ b/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>`.
-- 
cgit v1.2.3