Skip to content

Commit

Permalink
Merge PR #209 into 16.0
Browse files Browse the repository at this point in the history
Signed-off-by rvalyi
  • Loading branch information
OCA-git-bot committed Oct 16, 2024
2 parents f585490 + b682f34 commit c8a99a2
Show file tree
Hide file tree
Showing 13 changed files with 675 additions and 0 deletions.
118 changes: 118 additions & 0 deletions mail_environment_google_gmail/README.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,118 @@
===========================================================
Mail configuration with server_environment for Google Gmail
===========================================================

..
!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
!! This file is generated by oca-gen-addon-readme !!
!! changes will be overwritten. !!
!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
!! source digest: sha256:5635acb0fde6b9d916f7ce3b6c1bab560bc579f1b3c80f918ce67fc5c2555ed9
!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
.. |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/16.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-16-0/server-env-16-0-mail_environment_google_gmail
: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
:alt: Try me on Runboat

|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 <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_google_gmail%0Aversion:%2016.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.

Credits
=======

Authors
~~~~~~~

* Camptocamp

Contributors
~~~~~~~~~~~~

* `Camptocamp <https://www.camptocamp.com>`_

* Iván Todorovich <ivan.todorovich@camptocamp.com>

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 <https://odoo-community.org/page/maintainer-role>`__:

|maintainer-ivantodorovich|

This module is part of the `OCA/server-env <https://github.com/OCA/server-env/tree/16.0/mail_environment_google_gmail>`_ project on GitHub.

You are welcome to contribute. To learn how please visit https://odoo-community.org/page/Contribute.
1 change: 1 addition & 0 deletions mail_environment_google_gmail/__init__.py
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
from . import models
19 changes: 19 additions & 0 deletions mail_environment_google_gmail/__manifest__.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
# Copyright 2022 Camptocamp SA (https://www.camptocamp.com).
# @author Iván Todorovich <ivan.todorovich@camptocamp.com>
# License AGPL-3.0 or later (https://www.gnu.org/licenses/agpl).

{
"name": "Mail configuration with server_environment for Google Gmail",
"summary": "Configure Gmail mail servers with server_environment_files",
"version": "16.0.1.0.0",
"author": "Camptocamp, Odoo Community Association (OCA)",
"maintainers": ["ivantodorovich"],
"website": "https://github.com/OCA/server-env",
"license": "AGPL-3",
"category": "Tools",
"depends": [
"google_gmail",
"server_environment",
"server_environment_ir_config_parameter",
],
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
# Translation of Odoo Server.
# This file contains the translation of the following modules:
# * mail_environment_google_gmail
#
msgid ""
msgstr ""
"Project-Id-Version: Odoo Server 16.0\n"
"Report-Msgid-Bugs-To: \n"
"Last-Translator: \n"
"Language-Team: \n"
"MIME-Version: 1.0\n"
"Content-Type: text/plain; charset=UTF-8\n"
"Content-Transfer-Encoding: \n"
"Plural-Forms: \n"

#. module: mail_environment_google_gmail
#: model:ir.model,name:mail_environment_google_gmail.model_ir_mail_server
msgid "Mail Server"
msgstr ""
1 change: 1 addition & 0 deletions mail_environment_google_gmail/models/__init__.py
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
from . import ir_mail_server
19 changes: 19 additions & 0 deletions mail_environment_google_gmail/models/ir_mail_server.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
# Copyright 2022 Camptocamp SA (https://www.camptocamp.com).
# @author Iván Todorovich <ivan.todorovich@camptocamp.com>
# License AGPL-3.0 or later (https://www.gnu.org/licenses/agpl).

from odoo import models


class IrMailServer(models.Model):
_inherit = "ir.mail_server"

@property
def _server_env_fields(self):
base_fields = super()._server_env_fields
gmail_fields = {
"google_gmail_authorization_code": {},
"google_gmail_refresh_token": {},
}
gmail_fields.update(base_fields)
return gmail_fields
28 changes: 28 additions & 0 deletions mail_environment_google_gmail/readme/CONFIGURE.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
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.
3 changes: 3 additions & 0 deletions mail_environment_google_gmail/readme/CONTRIBUTORS.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
* `Camptocamp <https://www.camptocamp.com>`_

* Iván Todorovich <ivan.todorovich@camptocamp.com>
1 change: 1 addition & 0 deletions mail_environment_google_gmail/readme/DESCRIPTION.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
This module allows to configure Gmail outgoing servers with server-env.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading

0 comments on commit c8a99a2

Please sign in to comment.