From c02c521b63ef0efef440d89e8b6e0fb2267c4dbc Mon Sep 17 00:00:00 2001 From: Marcos Oitaben Date: Wed, 15 Nov 2023 11:21:20 +0100 Subject: [PATCH] [IMP] mail_environment: pre-commit stuff --- mail_environment/README.rst | 100 +++++++++--------- mail_environment/pyproject.toml | 3 + mail_environment/readme/CONFIGURE.md | 40 +++++++ mail_environment/readme/CONFIGURE.rst | 40 ------- mail_environment/readme/CONTRIBUTORS.md | 6 ++ mail_environment/readme/CONTRIBUTORS.rst | 6 -- mail_environment/readme/DESCRIPTION.md | 3 + mail_environment/readme/DESCRIPTION.rst | 3 - .../readme/{INSTALL.rst => INSTALL.md} | 0 mail_environment/readme/ROADMAP.md | 2 + mail_environment/readme/ROADMAP.rst | 2 - .../readme/{USAGE.rst => USAGE.md} | 4 +- .../static/description/index.html | 40 +++---- 13 files changed, 127 insertions(+), 122 deletions(-) create mode 100644 mail_environment/pyproject.toml create mode 100644 mail_environment/readme/CONFIGURE.md delete mode 100644 mail_environment/readme/CONFIGURE.rst create mode 100644 mail_environment/readme/CONTRIBUTORS.md delete mode 100644 mail_environment/readme/CONTRIBUTORS.rst create mode 100644 mail_environment/readme/DESCRIPTION.md delete mode 100644 mail_environment/readme/DESCRIPTION.rst rename mail_environment/readme/{INSTALL.rst => INSTALL.md} (100%) create mode 100644 mail_environment/readme/ROADMAP.md delete mode 100644 mail_environment/readme/ROADMAP.rst rename mail_environment/readme/{USAGE.rst => USAGE.md} (90%) diff --git a/mail_environment/README.rst b/mail_environment/README.rst index a0c25e1..ff6a30c 100644 --- a/mail_environment/README.rst +++ b/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 -mail servers for the production and the test environment. +using the server_environment mechanism: you can then have different mail +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 -you should provide, see the documentation of `server_environment` for -more information). +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. +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. +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 :: +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 + [outgoing_mail] + smtp_host = smtp.myserver.com + smtp_port = 587 + smtp_user = + smtp_pass = + smtp_encryption = ssl - [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 + [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". +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. +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. +- Due to the special nature of this addon, you cannot test it on the + OCA runbot. Bug Tracker =========== @@ -106,7 +108,7 @@ 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 to smash it by providing a detailed and welcomed -`feedback `_. +`feedback `_. Do not contact contributors directly about support or help with technical issues. @@ -114,22 +116,22 @@ Credits ======= Authors -~~~~~~~ +------- * Camptocamp Contributors -~~~~~~~~~~~~ +------------ -* Nicolas Bessi -* Yannick Vaucher -* Guewen Baconnier -* Joël Grand-Guillaume -* Holger Brunn -* Alexandre Fayolle +- Nicolas Bessi +- Yannick Vaucher +- Guewen Baconnier +- Joël Grand-Guillaume +- Holger Brunn +- Alexandre Fayolle 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 `_ project on GitHub. +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/pyproject.toml b/mail_environment/pyproject.toml new file mode 100644 index 0000000..4231d0c --- /dev/null +++ b/mail_environment/pyproject.toml @@ -0,0 +1,3 @@ +[build-system] +requires = ["whool"] +build-backend = "whool.buildapi" diff --git a/mail_environment/readme/CONFIGURE.md b/mail_environment/readme/CONFIGURE.md new file mode 100644 index 0000000..c7ef3c9 --- /dev/null +++ b/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". diff --git a/mail_environment/readme/CONFIGURE.rst b/mail_environment/readme/CONFIGURE.rst deleted file mode 100644 index 4ff2783..0000000 --- a/mail_environment/readme/CONFIGURE.rst +++ /dev/null @@ -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". diff --git a/mail_environment/readme/CONTRIBUTORS.md b/mail_environment/readme/CONTRIBUTORS.md new file mode 100644 index 0000000..40b1b0f --- /dev/null +++ b/mail_environment/readme/CONTRIBUTORS.md @@ -0,0 +1,6 @@ +- Nicolas Bessi \<\> +- Yannick Vaucher \<\> +- Guewen Baconnier \<\> +- Joël Grand-Guillaume \<\> +- Holger Brunn \<\> +- Alexandre Fayolle \<\> diff --git a/mail_environment/readme/CONTRIBUTORS.rst b/mail_environment/readme/CONTRIBUTORS.rst deleted file mode 100644 index a3fe21e..0000000 --- a/mail_environment/readme/CONTRIBUTORS.rst +++ /dev/null @@ -1,6 +0,0 @@ -* Nicolas Bessi -* Yannick Vaucher -* Guewen Baconnier -* Joël Grand-Guillaume -* Holger Brunn -* Alexandre Fayolle diff --git a/mail_environment/readme/DESCRIPTION.md b/mail_environment/readme/DESCRIPTION.md new file mode 100644 index 0000000..2d39b83 --- /dev/null +++ b/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. diff --git a/mail_environment/readme/DESCRIPTION.rst b/mail_environment/readme/DESCRIPTION.rst deleted file mode 100644 index d1ac368..0000000 --- a/mail_environment/readme/DESCRIPTION.rst +++ /dev/null @@ -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. diff --git a/mail_environment/readme/INSTALL.rst b/mail_environment/readme/INSTALL.md similarity index 100% rename from mail_environment/readme/INSTALL.rst rename to mail_environment/readme/INSTALL.md diff --git a/mail_environment/readme/ROADMAP.md b/mail_environment/readme/ROADMAP.md new file mode 100644 index 0000000..9d5b75d --- /dev/null +++ b/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. diff --git a/mail_environment/readme/ROADMAP.rst b/mail_environment/readme/ROADMAP.rst deleted file mode 100644 index 647e064..0000000 --- a/mail_environment/readme/ROADMAP.rst +++ /dev/null @@ -1,2 +0,0 @@ -* 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.md similarity index 90% rename from mail_environment/readme/USAGE.rst rename to mail_environment/readme/USAGE.md index 735c18b..77a8774 100644 --- a/mail_environment/readme/USAGE.rst +++ b/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 -Odoo file. +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 index d6cf970..33542cd 100644 --- a/mail_environment/static/description/index.html +++ b/mail_environment/static/description/index.html @@ -369,10 +369,10 @@ ul.auto-toc { !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! !! source digest: sha256:98c12a3139202085663c933e6fb71273de1950ab8c96e24c2f0ba966a8860bea !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! --> -

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

+

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

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.

+using the server_environment mechanism: you can then have different mail +servers for the production and the test environment.

Table of contents

    @@ -397,17 +397,17 @@ 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).

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

    +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

    +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
@@ -431,20 +431,20 @@ 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”.

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

    +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.
      • +
    • Due to the special nature of this addon, you cannot test it on the +OCA runbot.
    @@ -452,7 +452,7 @@ runbot.

    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 to smash it by providing a detailed and welcomed -feedback.

    +feedback.

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

    @@ -481,7 +481,7 @@ If you spotted it first, help us to smash it by providing a detailed and welcome

    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.

    +

    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.