diff --git a/mail_environment_google_gmail/README.rst b/mail_environment_google_gmail/README.rst index f86ee85..16879d6 100644 --- a/mail_environment_google_gmail/README.rst +++ b/mail_environment_google_gmail/README.rst @@ -1 +1,115 @@ -TO BE GENERATED +=========================================================== +Mail configuration with server_environment for Google Gmail +=========================================================== + +.. !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! + !! 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/15.0/mail_environment_google_gmail + :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-15-0/server-env-15-0-mail_environment_google_gmail + :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/15.0 + :alt: Try me on Runbot + +|badge1| |badge2| |badge3| |badge4| |badge5| + +This module allows to configure Gmail outgoing servers with server-env. + +**Table of contents** + +.. contents:: + :local: + +Configuration +============= + +Example of config file :: + + [ir.config_parameter] + google_gmail_client_id = YOUR_GMAIL_API_CLIENT_ID + google_gmail_client_secret = YOUR_GMAIL_API_CLIENT_SECRET + + [outgoing_mail.gmail_smtp_server] + smtp_host = smtp.gmail.com + smtp_port = 587 + smtp_user = example@gmail.com + smtp_encryption = starttls + use_google_gmail_service = True + google_gmail_authorization_code = YOUR_ACCOUNT_AUTH_CODE + google_gmail_refresh_token = YOUR_REFRESH_TOKEN + + + +These two are global parameters, in core they're configured in General Settings: + +* `YOUR_GMAIL_API_CLIENT_ID`: The client ID of your Google API project. +* `YOUR_GMAIL_API_CLIENT_SECRET`: The client secret of your Google API project. + +These two are account-specific parameters: + +* `YOUR_ACCOUNT_AUTH_CODE`: In core, there's a button that opens an URL to generate it. +* `YOUR_REFRESH_TOKEN`: In core, it's generated automatically when the + `google_gmail_authorization_code` is written. It's not shown on the form, but I recommend + having Odoo generate it and extract it from there, before setting up the server-env. + +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 +~~~~~~~~~~~~ + +* `Camptocamp `_ + + * Iván Todorovich + +Maintainers +~~~~~~~~~~~ + +This module is maintained by the OCA. + +.. image:: https://odoo-community.org/logo.png + :alt: Odoo Community Association + :target: https://odoo-community.org + +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. + +.. |maintainer-ivantodorovich| image:: https://github.com/ivantodorovich.png?size=40px + :target: https://github.com/ivantodorovich + :alt: ivantodorovich + +Current `maintainer `__: + +|maintainer-ivantodorovich| + +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_google_gmail/static/description/index.html b/mail_environment_google_gmail/static/description/index.html new file mode 100644 index 0000000..5e0ee34 --- /dev/null +++ b/mail_environment_google_gmail/static/description/index.html @@ -0,0 +1,458 @@ + + + + + + +Mail configuration with server_environment for Google Gmail + + + +
+

Mail configuration with server_environment for Google Gmail

+ + +

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

+

This module allows to configure Gmail outgoing servers with server-env.

+

Table of contents

+ +
+

Configuration

+

Example of config file

+
+[ir.config_parameter]
+google_gmail_client_id = YOUR_GMAIL_API_CLIENT_ID
+google_gmail_client_secret = YOUR_GMAIL_API_CLIENT_SECRET
+
+[outgoing_mail.gmail_smtp_server]
+smtp_host = smtp.gmail.com
+smtp_port = 587
+smtp_user = example@gmail.com
+smtp_encryption = starttls
+use_google_gmail_service = True
+google_gmail_authorization_code = YOUR_ACCOUNT_AUTH_CODE
+google_gmail_refresh_token = YOUR_REFRESH_TOKEN
+
+

These two are global parameters, in core they’re configured in General Settings:

+
    +
  • YOUR_GMAIL_API_CLIENT_ID: The client ID of your Google API project.
    • +
  • YOUR_GMAIL_API_CLIENT_SECRET: The client secret of your Google API project.
    • +
+

These two are account-specific parameters:

+
    +
  • YOUR_ACCOUNT_AUTH_CODE: In core, there’s a button that opens an URL to generate it.
    • +
  • YOUR_REFRESH_TOKEN: In core, it’s generated automatically when the +google_gmail_authorization_code is written. It’s not shown on the form, but I recommend +having Odoo generate it and extract it from there, before setting up the server-env.
    • +
+
+
+

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.

+

Current maintainer:

+

ivantodorovich

+

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.

+
+
+
+ +