summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorNicolas Bayet <nby@odoo.com>2019-02-01 15:00:17 +0000
committerNicolas Bayet <nicolas.bayet@gmail.com>2019-02-22 12:43:19 +0000
commitaa5de574aa3917e3e0a2b2e3aa41d0f95e052ed2 (patch)
tree5ee1ca4cd6625b82d16dc53f6ae58b7d5c3e3788
parentdd28160c28e03c54b869a9bbc789e7f0aa255780 (diff)
[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
-rw-r--r--doc/_static/banners/email_gateway.jpgbin0 -> 83480 bytes
-rw-r--r--doc/_static/banners/email_gateway.small.jpgbin0 -> 28803 bytes
-rw-r--r--doc/setup.rst1
-rw-r--r--doc/setup/email_gateway.rst39
4 files changed, 40 insertions, 0 deletions
diff --git a/doc/_static/banners/email_gateway.jpg b/doc/_static/banners/email_gateway.jpg
new file mode 100644
index 00000000000..b9301e27040
--- /dev/null
+++ b/doc/_static/banners/email_gateway.jpg
Binary files differ
diff --git a/doc/_static/banners/email_gateway.small.jpg b/doc/_static/banners/email_gateway.small.jpg
new file mode 100644
index 00000000000..435c312eb52
--- /dev/null
+++ b/doc/_static/banners/email_gateway.small.jpg
Binary files differ
diff --git a/doc/setup.rst b/doc/setup.rst
index 99b4bd3ad51..7b03c885e77 100644
--- a/doc/setup.rst
+++ b/doc/setup.rst
@@ -12,3 +12,4 @@ Setting Up
setup/update
setup/cdn
setup/enterprise
+ setup/email_gateway
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>`.