[IMP] mail_environment: pre-commit stuff

mail_environment/README.rst

@@ -17,20 +17,20 @@ Mail configuration with server_environment
     :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/16.0/mail_environment
+    :target: https://github.com/OCA/server-env/tree/17.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-16-0/server-env-16-0-mail_environment
+    :target: https://translation.odoo-community.org/projects/server-env-17-0/server-env-17-0-mail_environment
     :alt: Translate me on Weblate
 .. |badge5| image:: https://img.shields.io/badge/runboat-Try%20me-875A7B.png
-    :target: https://runboat.odoo-community.org/builds?repo=OCA/server-env&target_branch=16.0
+    :target: https://runboat.odoo-community.org/builds?repo=OCA/server-env&target_branch=17.0
     :alt: Try me on Runboat
 
 |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
+using the server_environment mechanism: you can then have different mail
-mail servers for the production and the test environment.
+servers for the production and the test environment.
 
 **Table of contents**
 
@@ -47,58 +47,60 @@ Configuration
 =============
 
 With this module installed, the incoming and outgoing mail servers are
-configured in the `server_environment_files` module (which is a module
+configured in the server_environment_files module (which is a module you
-you should provide, see the documentation of `server_environment` for
+should provide, see the documentation of server_environment for more
-more information).
+information).
 
 In the configuration file of each environment, you may first use the
-sections `[outgoing_mail]` and `[incoming_mail]` to configure the
+sections [outgoing_mail] and [incoming_mail] to configure the default
-default values respectively for SMTP servers and the IMAP/POP servers.
+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
+default values with a section named [outgoing_mail.resource_name] or
-`[incoming_mail.resource_name]` where "resource_name" is the name of
+[incoming_mail.resource_name] where "resource_name" is the name of the
-the server.
+server.
 
-Example of config file ::
+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]
+   [outgoing_mail]
-  smtp_user = odoo
+   smtp_host = smtp.myserver.com
-  smtp_pass = odoo
+   smtp_port = 587
+   smtp_user =
+   smtp_pass =
+   smtp_encryption = ssl
 
-  [incoming_mail.odoo_pop_mail1]
+   [outgoing_mail.odoo_smtp_server1]
-  server = mail.myserver.com
+   smtp_user = odoo
-  port = 110
+   smtp_pass = odoo
-  server_type = pop
+
-  is_ssl = 0
+   [incoming_mail.odoo_pop_mail1]
-  attach = 0
+   server = mail.myserver.com
-  original = 0
+   port = 110
-  user = odoo@myserver.com
+   server_type = pop
-  password = uas1ohV0
+   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
+server with the field name set to "odoo_smtp_server1" and one incoming
-incoming mail server with the field `name` set to "odoo_pop_mail1".
+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
+configuration file related to each environment defined in the main Odoo
-Odoo file.
+file.
 
 Known issues / Roadmap
 ======================
 
-* Due to the special nature of this addon, you cannot test it on the OCA
+-  Due to the special nature of this addon, you cannot test it on the
-  runbot.
+   OCA runbot.
 
 Bug Tracker
 ===========
@@ -106,7 +108,7 @@ Bug Tracker
 Bugs are tracked on `GitHub Issues <https://github.com/OCA/server-env/issues>`_.
 In case of trouble, please check there if your issue has already been reported.
 If you spotted it first, help us to smash it by providing a detailed and welcomed
-`feedback <https://github.com/OCA/server-env/issues/new?body=module:%20mail_environment%0Aversion:%2016.0%0A%0A**Steps%20to%20reproduce**%0A-%20...%0A%0A**Current%20behavior**%0A%0A**Expected%20behavior**>`_.
+`feedback <https://github.com/OCA/server-env/issues/new?body=module:%20mail_environment%0Aversion:%2017.0%0A%0A**Steps%20to%20reproduce**%0A-%20...%0A%0A**Current%20behavior**%0A%0A**Expected%20behavior**>`_.
 
 Do not contact contributors directly about support or help with technical issues.
 
@@ -114,22 +116,22 @@ Credits
 =======
 
 Authors
-~~~~~~~
+-------
 
 * Camptocamp
 
 Contributors
-~~~~~~~~~~~~
+------------
 
-* Nicolas Bessi <nicolas.bessi@camptocamp.com>
+-  Nicolas Bessi <nicolas.bessi@camptocamp.com>
-* Yannick Vaucher <yannick.vaucher@camptocamp.com>
+-  Yannick Vaucher <yannick.vaucher@camptocamp.com>
-* Guewen Baconnier <guewen.baconnier@camptocamp.com>
+-  Guewen Baconnier <guewen.baconnier@camptocamp.com>
-* Joël Grand-Guillaume <joel.grandguillaume@camptocamp.com>
+-  Joël Grand-Guillaume <joel.grandguillaume@camptocamp.com>
-* Holger Brunn <hbrunn@therp.nl>
+-  Holger Brunn <hbrunn@therp.nl>
-* Alexandre Fayolle <alexandre.fayolle@camptocamp.com>
+-  Alexandre Fayolle <alexandre.fayolle@camptocamp.com>
 
 Maintainers
-~~~~~~~~~~~
+-----------
 
 This module is maintained by the OCA.
 
@@ -141,6 +143,6 @@ 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 <https://github.com/OCA/server-env/tree/16.0/mail_environment>`_ project on GitHub.
+This module is part of the `OCA/server-env <https://github.com/OCA/server-env/tree/17.0/mail_environment>`_ project on GitHub.
 
 You are welcome to contribute. To learn how please visit https://odoo-community.org/page/Contribute.

mail_environment/pyproject.toml

@@ -0,0 +1,3 @@
+[build-system]
+requires = ["whool"]
+build-backend = "whool.buildapi"

mail_environment/readme/CONFIGURE.md

@@ -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
+    server_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".

mail_environment/readme/CONFIGURE.rst

@@ -1,40 +0,0 @@
-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
-  server_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".

mail_environment/readme/CONTRIBUTORS.md

@@ -0,0 +1,6 @@
+- Nicolas Bessi \<<nicolas.bessi@camptocamp.com>\>
+- Yannick Vaucher \<<yannick.vaucher@camptocamp.com>\>
+- Guewen Baconnier \<<guewen.baconnier@camptocamp.com>\>
+- Joël Grand-Guillaume \<<joel.grandguillaume@camptocamp.com>\>
+- Holger Brunn \<<hbrunn@therp.nl>\>
+- Alexandre Fayolle \<<alexandre.fayolle@camptocamp.com>\>

mail_environment/readme/CONTRIBUTORS.rst

@@ -1,6 +0,0 @@
-* Nicolas Bessi <nicolas.bessi@camptocamp.com>
-* Yannick Vaucher <yannick.vaucher@camptocamp.com>
-* Guewen Baconnier <guewen.baconnier@camptocamp.com>
-* Joël Grand-Guillaume <joel.grandguillaume@camptocamp.com>
-* Holger Brunn <hbrunn@therp.nl>
-* Alexandre Fayolle <alexandre.fayolle@camptocamp.com>

mail_environment/readme/DESCRIPTION.md

@@ -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.

mail_environment/readme/DESCRIPTION.rst

@@ -1,3 +0,0 @@
-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.

mail_environment/readme/ROADMAP.md

@@ -0,0 +1,2 @@
+- Due to the special nature of this addon, you cannot test it on the OCA
+  runbot.

mail_environment/readme/ROADMAP.rst

@@ -1,2 +0,0 @@
-* Due to the special nature of this addon, you cannot test it on the OCA
-  runbot.

mail_environment/readme/USAGE.md

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

mail_environment/static/description/index.html

@@ -369,10 +369,10 @@ ul.auto-toc {
 !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
 !! source digest: sha256:98c12a3139202085663c933e6fb71273de1950ab8c96e24c2f0ba966a8860bea
 !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! -->
-<p><a class="reference external image-reference" href="https://odoo-community.org/page/development-status"><img alt="Beta" src="https://img.shields.io/badge/maturity-Beta-yellow.png" /></a> <a class="reference external image-reference" href="http://www.gnu.org/licenses/agpl-3.0-standalone.html"><img alt="License: AGPL-3" src="https://img.shields.io/badge/licence-AGPL--3-blue.png" /></a> <a class="reference external image-reference" href="https://github.com/OCA/server-env/tree/16.0/mail_environment"><img alt="OCA/server-env" src="https://img.shields.io/badge/github-OCA%2Fserver--env-lightgray.png?logo=github" /></a> <a class="reference external image-reference" href="https://translation.odoo-community.org/projects/server-env-16-0/server-env-16-0-mail_environment"><img alt="Translate me on Weblate" src="https://img.shields.io/badge/weblate-Translate%20me-F47D42.png" /></a> <a class="reference external image-reference" href="https://runboat.odoo-community.org/builds?repo=OCA/server-env&amp;target_branch=16.0"><img alt="Try me on Runboat" src="https://img.shields.io/badge/runboat-Try%20me-875A7B.png" /></a></p>
+<p><a class="reference external image-reference" href="https://odoo-community.org/page/development-status"><img alt="Beta" src="https://img.shields.io/badge/maturity-Beta-yellow.png" /></a> <a class="reference external image-reference" href="http://www.gnu.org/licenses/agpl-3.0-standalone.html"><img alt="License: AGPL-3" src="https://img.shields.io/badge/licence-AGPL--3-blue.png" /></a> <a class="reference external image-reference" href="https://github.com/OCA/server-env/tree/17.0/mail_environment"><img alt="OCA/server-env" src="https://img.shields.io/badge/github-OCA%2Fserver--env-lightgray.png?logo=github" /></a> <a class="reference external image-reference" href="https://translation.odoo-community.org/projects/server-env-17-0/server-env-17-0-mail_environment"><img alt="Translate me on Weblate" src="https://img.shields.io/badge/weblate-Translate%20me-F47D42.png" /></a> <a class="reference external image-reference" href="https://runboat.odoo-community.org/builds?repo=OCA/server-env&amp;target_branch=17.0"><img alt="Try me on Runboat" src="https://img.shields.io/badge/runboat-Try%20me-875A7B.png" /></a></p>
 <p>This module allows to configure the incoming and outgoing mail servers
-using the <cite>server_environment</cite> mechanism: you can then have different
+using the server_environment mechanism: you can then have different mail
-mail servers for the production and the test environment.</p>
+servers for the production and the test environment.</p>
 <p><strong>Table of contents</strong></p>
 <div class="contents local topic" id="contents">
 <ul class="simple">
@@ -397,17 +397,17 @@ installed and properly configured.</p>
 <div class="section" id="configuration">
 <h1><a class="toc-backref" href="#toc-entry-2">Configuration</a></h1>
 <p>With this module installed, the incoming and outgoing mail servers are
-configured in the <cite>server_environment_files</cite> module (which is a module
+configured in the server_environment_files module (which is a module you
-you should provide, see the documentation of <cite>server_environment</cite> for
+should provide, see the documentation of server_environment for more
-more information).</p>
+information).</p>
 <p>In the configuration file of each environment, you may first use the
-sections <cite>[outgoing_mail]</cite> and <cite>[incoming_mail]</cite> to configure the
+sections [outgoing_mail] and [incoming_mail] to configure the default
-default values respectively for SMTP servers and the IMAP/POP servers.</p>
+values respectively for SMTP servers and the IMAP/POP servers.</p>
 <p>Then for each server, you can define additional values or override the
-default values with a section named <cite>[outgoing_mail.resource_name]</cite> or
+default values with a section named [outgoing_mail.resource_name] or
-<cite>[incoming_mail.resource_name]</cite> where “resource_name” is the name of
+[incoming_mail.resource_name] where “resource_name” is the name of the
-the server.</p>
+server.</p>
-<p>Example of config file</p>
+<p>Example of config file :</p>
 <pre class="literal-block">
 [outgoing_mail]
 smtp_host = smtp.myserver.com
@@ -431,20 +431,20 @@ user = odoo&#64;myserver.com
 password = uas1ohV0
 </pre>
 <p>You will need to create 2 records in the database, one outgoing mail
-server with the field <cite>name</cite> set to “odoo_smtp_server1” and one
+server with the field name set to “odoo_smtp_server1” and one incoming
-incoming mail server with the field <cite>name</cite> set to “odoo_pop_mail1”.</p>
+mail server with the field name set to “odoo_pop_mail1”.</p>
 </div>
 <div class="section" id="usage">
 <h1><a class="toc-backref" href="#toc-entry-3">Usage</a></h1>
 <p>Once configured, Odoo will read the mail servers values from the
-configuration file related to each environment defined in the main
+configuration file related to each environment defined in the main Odoo
-Odoo file.</p>
+file.</p>
 </div>
 <div class="section" id="known-issues-roadmap">
 <h1><a class="toc-backref" href="#toc-entry-4">Known issues / Roadmap</a></h1>
 <ul class="simple">
-<li>Due to the special nature of this addon, you cannot test it on the OCA
+<li>Due to the special nature of this addon, you cannot test it on the
-runbot.</li>
+OCA runbot.</li>
 </ul>
 </div>
 <div class="section" id="bug-tracker">
@@ -452,7 +452,7 @@ runbot.</li>
 <p>Bugs are tracked on <a class="reference external" href="https://github.com/OCA/server-env/issues">GitHub Issues</a>.
 In case of trouble, please check there if your issue has already been reported.
 If you spotted it first, help us to smash it by providing a detailed and welcomed
-<a class="reference external" href="https://github.com/OCA/server-env/issues/new?body=module:%20mail_environment%0Aversion:%2016.0%0A%0A**Steps%20to%20reproduce**%0A-%20...%0A%0A**Current%20behavior**%0A%0A**Expected%20behavior**">feedback</a>.</p>
+<a class="reference external" href="https://github.com/OCA/server-env/issues/new?body=module:%20mail_environment%0Aversion:%2017.0%0A%0A**Steps%20to%20reproduce**%0A-%20...%0A%0A**Current%20behavior**%0A%0A**Expected%20behavior**">feedback</a>.</p>
 <p>Do not contact contributors directly about support or help with technical issues.</p>
 </div>
 <div class="section" id="credits">
@@ -481,7 +481,7 @@ If you spotted it first, help us to smash it by providing a detailed and welcome
 <p>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.</p>
-<p>This module is part of the <a class="reference external" href="https://github.com/OCA/server-env/tree/16.0/mail_environment">OCA/server-env</a> project on GitHub.</p>
+<p>This module is part of the <a class="reference external" href="https://github.com/OCA/server-env/tree/17.0/mail_environment">OCA/server-env</a> project on GitHub.</p>
 <p>You are welcome to contribute. To learn how please visit <a class="reference external" href="https://odoo-community.org/page/Contribute">https://odoo-community.org/page/Contribute</a>.</p>
 </div>
 </div>