From dbcce842de8835bb5d56bf13c03806f4e6845808 Mon Sep 17 00:00:00 2001 From: sebalix Date: Fri, 4 Jan 2019 11:36:11 +0100 Subject: [PATCH] [IMP] mail_environment: new README structure --- mail_environment/README.rst | 64 ++- mail_environment/readme/CONFIGURE.rst | 40 ++ mail_environment/readme/CONTRIBUTORS.rst | 6 + mail_environment/readme/DESCRIPTION.rst | 3 + mail_environment/readme/INSTALL.rst | 2 + mail_environment/readme/ROADMAP.rst | 2 + mail_environment/readme/USAGE.rst | 3 + .../static/description/index.html | 488 ++++++++++++++++++ 8 files changed, 589 insertions(+), 19 deletions(-) create mode 100644 mail_environment/readme/CONFIGURE.rst create mode 100644 mail_environment/readme/CONTRIBUTORS.rst create mode 100644 mail_environment/readme/DESCRIPTION.rst create mode 100644 mail_environment/readme/INSTALL.rst create mode 100644 mail_environment/readme/ROADMAP.rst create mode 100644 mail_environment/readme/USAGE.rst create mode 100644 mail_environment/static/description/index.html diff --git a/mail_environment/README.rst b/mail_environment/README.rst index 4093b45..190904d 100644 --- a/mail_environment/README.rst +++ b/mail_environment/README.rst @@ -1,15 +1,39 @@ -.. image:: https://img.shields.io/badge/licence-AGPL--3-blue.svg - :target: http://www.gnu.org/licenses/agpl-3.0-standalone.html - :alt: License: AGPL-3 - ========================================== Mail configuration with server_environment ========================================== +.. !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! + !! This file is generated by oca-gen-addon-readme !! + !! changes will be overwritten. !! + !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! + +.. |badge1| image:: https://img.shields.io/badge/maturity-Beta-yellow.png + :target: https://odoo-community.org/page/development-status + :alt: Beta +.. |badge2| image:: https://img.shields.io/badge/licence-AGPL--3-blue.png + :target: http://www.gnu.org/licenses/agpl-3.0-standalone.html + :alt: License: AGPL-3 +.. |badge3| image:: https://img.shields.io/badge/github-OCA%2Fserver--env-lightgray.png?logo=github + :target: https://github.com/OCA/server-env/tree/12.0/mail_environment + :alt: OCA/server-env +.. |badge4| image:: https://img.shields.io/badge/weblate-Translate%20me-F47D42.png + :target: https://translation.odoo-community.org/projects/server-env-12-0/server-env-12-0-mail_environment + :alt: Translate me on Weblate +.. |badge5| image:: https://img.shields.io/badge/runbot-Try%20me-875A7B.png + :target: https://runbot.odoo-community.org/runbot/254/12.0 + :alt: Try me on Runbot + +|badge1| |badge2| |badge3| |badge4| |badge5| + This module allows to configure the incoming and outgoing mail servers using the `server_environment` mechanism: you can then have different mail servers for the production and the test environment. +**Table of contents** + +.. contents:: + :local: + Installation ============ @@ -60,7 +84,6 @@ You will need to create 2 records in the database, one outgoing mail server with the field `name` set to "odoo_smtp_server1" and one incoming mail server with the field `name` set to "odoo_pop_mail1". - Usage ===== @@ -68,7 +91,6 @@ Once configured, Odoo will read the mail servers values from the configuration file related to each environment defined in the main Odoo file. - Known issues / Roadmap ====================== @@ -78,21 +100,23 @@ Known issues / Roadmap Bug Tracker =========== -Bugs are tracked on `GitHub Issues -`_. In case of trouble, please -check there if your issue has already been reported. If you spotted it first, -help us smash it by providing a detailed and welcomed feedback. +Bugs are tracked on `GitHub Issues `_. +In case of trouble, please check there if your issue has already been reported. +If you spotted it first, help us smashing it by providing a detailed and welcomed +`feedback `_. + +Do not contact contributors directly about support or help with technical issues. Credits ======= -Images ------- +Authors +~~~~~~~ -* Odoo Community Association: `Icon `_. +* Camptocamp Contributors ------------- +~~~~~~~~~~~~ * Nicolas Bessi * Yannick Vaucher @@ -101,17 +125,19 @@ Contributors * Holger Brunn * Alexandre Fayolle -Maintainer ----------- +Maintainers +~~~~~~~~~~~ + +This module is maintained by the OCA. .. image:: https://odoo-community.org/logo.png :alt: Odoo Community Association :target: https://odoo-community.org -This module is maintained by the OCA. - OCA, or the Odoo Community Association, is a nonprofit organization whose mission is to support the collaborative development of Odoo features and promote its widespread use. -To contribute to this module, please visit https://odoo-community.org. +This module is part of the `OCA/server-env `_ project on GitHub. + +You are welcome to contribute. To learn how please visit https://odoo-community.org/page/Contribute. diff --git a/mail_environment/readme/CONFIGURE.rst b/mail_environment/readme/CONFIGURE.rst new file mode 100644 index 0000000..439c6be --- /dev/null +++ b/mail_environment/readme/CONFIGURE.rst @@ -0,0 +1,40 @@ +With this module installed, the incoming and outgoing mail servers are +configured in the `server_environment_files` module (which is a module +you should provide, see the documentation of `server_environment` for +more information). + +In the configuration file of each environment, you may first use the +sections `[outgoing_mail]` and `[incoming_mail]` to configure the +default values respectively for SMTP servers and the IMAP/POP servers. + +Then for each server, you can define additional values or override the +default values with a section named `[outgoing_mail.resource_name]` or +`[incoming_mail.resource_name]` where "resource_name" is the name of +the server. + +Example of config file :: + + [outgoing_mail] + smtp_host = smtp.myserver.com + smtp_port = 587 + smtp_user = + smtp_pass = + smtp_encryption = ssl + + [outgoing_mail.odoo_smtp_server1] + smtp_user = odoo + smtp_pass = odoo + + [incoming_mail.odoo_pop_mail1] + server = mail.myserver.com + port = 110 + type = pop + is_ssl = 0 + attach = 0 + original = 0 + user = odoo@myserver.com + password = uas1ohV0 + +You will need to create 2 records in the database, one outgoing mail +server with the field `name` set to "odoo_smtp_server1" and one +incoming mail server with the field `name` set to "odoo_pop_mail1". diff --git a/mail_environment/readme/CONTRIBUTORS.rst b/mail_environment/readme/CONTRIBUTORS.rst new file mode 100644 index 0000000..a3fe21e --- /dev/null +++ b/mail_environment/readme/CONTRIBUTORS.rst @@ -0,0 +1,6 @@ +* Nicolas Bessi +* Yannick Vaucher +* Guewen Baconnier +* Joël Grand-Guillaume +* Holger Brunn +* Alexandre Fayolle diff --git a/mail_environment/readme/DESCRIPTION.rst b/mail_environment/readme/DESCRIPTION.rst new file mode 100644 index 0000000..d1ac368 --- /dev/null +++ b/mail_environment/readme/DESCRIPTION.rst @@ -0,0 +1,3 @@ +This module allows to configure the incoming and outgoing mail servers +using the `server_environment` mechanism: you can then have different +mail servers for the production and the test environment. diff --git a/mail_environment/readme/INSTALL.rst b/mail_environment/readme/INSTALL.rst new file mode 100644 index 0000000..9b48078 --- /dev/null +++ b/mail_environment/readme/INSTALL.rst @@ -0,0 +1,2 @@ +To install this module, you need to have the server_environment module +installed and properly configured. diff --git a/mail_environment/readme/ROADMAP.rst b/mail_environment/readme/ROADMAP.rst new file mode 100644 index 0000000..647e064 --- /dev/null +++ b/mail_environment/readme/ROADMAP.rst @@ -0,0 +1,2 @@ +* Due to the special nature of this addon, you cannot test it on the OCA + runbot. diff --git a/mail_environment/readme/USAGE.rst b/mail_environment/readme/USAGE.rst new file mode 100644 index 0000000..735c18b --- /dev/null +++ b/mail_environment/readme/USAGE.rst @@ -0,0 +1,3 @@ +Once configured, Odoo will read the mail servers values from the +configuration file related to each environment defined in the main +Odoo file. diff --git a/mail_environment/static/description/index.html b/mail_environment/static/description/index.html new file mode 100644 index 0000000..67f8d8f --- /dev/null +++ b/mail_environment/static/description/index.html @@ -0,0 +1,488 @@ + + + + + + +Mail configuration with server_environment + + + +
+

Mail configuration with server_environment

+ + +

Beta License: AGPL-3 OCA/server-env Translate me on Weblate Try me on Runbot

+

This module allows to configure the incoming and outgoing mail servers +using the server_environment mechanism: you can then have different +mail servers for the production and the test environment.

+

Table of contents

+ +
+

Installation

+

To install this module, you need to have the server_environment module +installed and properly configured.

+
+
+

Configuration

+

With this module installed, the incoming and outgoing mail servers are +configured in the server_environment_files module (which is a module +you should provide, see the documentation of server_environment for +more information).

+

In the configuration file of each environment, you may first use the +sections [outgoing_mail] and [incoming_mail] to configure the +default values respectively for SMTP servers and the IMAP/POP servers.

+

Then for each server, you can define additional values or override the +default values with a section named [outgoing_mail.resource_name] or +[incoming_mail.resource_name] where “resource_name” is the name of +the server.

+

Example of config file

+
+[outgoing_mail]
+smtp_host = smtp.myserver.com
+smtp_port = 587
+smtp_user =
+smtp_pass =
+smtp_encryption = ssl
+
+[outgoing_mail.odoo_smtp_server1]
+smtp_user = odoo
+smtp_pass = odoo
+
+[incoming_mail.odoo_pop_mail1]
+server = mail.myserver.com
+port = 110
+type = pop
+is_ssl = 0
+attach = 0
+original = 0
+user = odoo@myserver.com
+password = uas1ohV0
+
+

You will need to create 2 records in the database, one outgoing mail +server with the field name set to “odoo_smtp_server1” and one +incoming mail server with the field name set to “odoo_pop_mail1”.

+
+
+

Usage

+

Once configured, Odoo will read the mail servers values from the +configuration file related to each environment defined in the main +Odoo file.

+
+
+

Known issues / Roadmap

+
    +
  • Due to the special nature of this addon, you cannot test it on the OCA +runbot.
    • +
+
+
+

Bug Tracker

+

Bugs are tracked on GitHub Issues. +In case of trouble, please check there if your issue has already been reported. +If you spotted it first, help us smashing it by providing a detailed and welcomed +feedback.

+

Do not contact contributors directly about support or help with technical issues.

+
+
+

Credits

+
+

Authors

+
    +
  • Camptocamp
    • +
+
+
+

Contributors

+ +
+
+

Maintainers

+

This module is maintained by the OCA.

+Odoo Community Association +

OCA, or the Odoo Community Association, is a nonprofit organization whose +mission is to support the collaborative development of Odoo features and +promote its widespread use.

+

This module is part of the OCA/server-env project on GitHub.

+

You are welcome to contribute. To learn how please visit https://odoo-community.org/page/Contribute.

+
+
+
+ +