diff --git a/doc/_static/banners/email_gateway.jpg b/doc/_static/banners/email_gateway.jpg new file mode 100644 index 0000000000000..b9301e2704033 Binary files /dev/null and b/doc/_static/banners/email_gateway.jpg differ diff --git a/doc/_static/banners/email_gateway.small.jpg b/doc/_static/banners/email_gateway.small.jpg new file mode 100644 index 0000000000000..435c312eb52ef Binary files /dev/null and b/doc/_static/banners/email_gateway.small.jpg differ diff --git a/doc/setup.rst b/doc/setup.rst index 99b4bd3ad51b5..7b03c885e7714 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 0000000000000..e82ef348409f0 --- /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 -u -p " +.. note:: Resources + - `Postfix ` + - `Postfix aliases ` + - `Postfix virtual ` + + +For Exim +-------- +.. code-block:: text + *: |/odoo-directory/addons/mail/static/scripts/odoo-mailgate.py -d -u -p +.. note:: Resources + - `Exim ` + + +.. note:: If you don't have access/manage your email server, use `inbound messages`.