diff --git a/mail_layout_force/README.rst b/mail_layout_force/README.rst new file mode 100644 index 0000000000..9a98313f68 --- /dev/null +++ b/mail_layout_force/README.rst @@ -0,0 +1,125 @@ +================= +Mail Layout Force +================= + +.. + !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! + !! This file is generated by oca-gen-addon-readme !! + !! changes will be overwritten. !! + !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! + !! source digest: sha256:c5314ada1e6f4529b208d4653748418fd6191918d30118ac8c012aca2a801b06 + !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! + +.. |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%2Fsocial-lightgray.png?logo=github + :target: https://github.com/OCA/social/tree/17.0/mail_layout_force + :alt: OCA/social +.. |badge4| image:: https://img.shields.io/badge/weblate-Translate%20me-F47D42.png + :target: https://translation.odoo-community.org/projects/social-17-0/social-17-0-mail_layout_force + :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/social&target_branch=17.0 + :alt: Try me on Runboat + +|badge1| |badge2| |badge3| |badge4| |badge5| + +Odoo will add a default email layout on most commercial communications. + +The email layout is a ``QWeb`` view that ends up wrapping the message +body when sending an email. It usually displays the related document +reference, the company logo, and a small footer saying "Powered by +Odoo". + +There are notably two main layouts used in Odoo, and the user can't +control when they're used, as it's hardcoded into the different +applications. + +- ``mail.mail_notification_light`` +- ``mail.mail_notification_paynow`` + +This module allows to force a specific layout for a given +``email.template``, effectively overwritting the one hardcoded by Odoo. + +This allows you to fully customize the way Odoo emails are rendered and +sent to your customers. + +**Table of contents** + +.. contents:: + :local: + +Configuration +============= + +# Go to Configuration > Technical > Emails > Templates # Open the +desired ``email.template`` record. # In Advanced Parameters tab, find +the Force Layout field. + +You can leave it empty to use the default email layout (chosen by Odoo). +You can force a custom email layout of your own. You can use the *Mail: +No-Layout notification template* to prevent Odoo from adding a layout. + +To configure a custom layout of your own, some technical knowledge is +needed. You can see how the existing layouts are defined for details or +inspiration: + +- ``mail.mail_notification_light`` +- ``mail.mail_notification_paynow`` +- ``mail.mail_notification_borders`` + +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 `_. + +Do not contact contributors directly about support or help with technical issues. + +Credits +======= + +Authors +------- + +* Camptocamp + +Contributors +------------ + +- `Camptocamp `__ + + - Iván Todorovich + +- Abraham Anes + +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/social `_ project on GitHub. + +You are welcome to contribute. To learn how please visit https://odoo-community.org/page/Contribute. diff --git a/mail_layout_force/__init__.py b/mail_layout_force/__init__.py new file mode 100644 index 0000000000..0650744f6b --- /dev/null +++ b/mail_layout_force/__init__.py @@ -0,0 +1 @@ +from . import models diff --git a/mail_layout_force/__manifest__.py b/mail_layout_force/__manifest__.py new file mode 100644 index 0000000000..8872c8bf26 --- /dev/null +++ b/mail_layout_force/__manifest__.py @@ -0,0 +1,17 @@ +# Copyright 2022 Camptocamp SA (https://www.camptocamp.com). +# @author Iván Todorovich +# License AGPL-3.0 or later (https://www.gnu.org/licenses/agpl). + +{ + "name": "Mail Layout Force", + "summary": "Force a mail layout on selected email templates", + "version": "17.0.1.0.0", + "author": "Camptocamp, Odoo Community Association (OCA)", + "maintainers": ["ivantodorovich"], + "website": "https://github.com/OCA/social", + "license": "AGPL-3", + "category": "Marketing", + "depends": ["mail"], + "demo": ["demo/mail_layout.xml"], + "data": ["data/mail_layout.xml", "views/mail_template.xml"], +} diff --git a/mail_layout_force/data/mail_layout.xml b/mail_layout_force/data/mail_layout.xml new file mode 100644 index 0000000000..7575cbd5d7 --- /dev/null +++ b/mail_layout_force/data/mail_layout.xml @@ -0,0 +1,13 @@ + + + + + + + diff --git a/mail_layout_force/demo/mail_layout.xml b/mail_layout_force/demo/mail_layout.xml new file mode 100644 index 0000000000..b218fda2ec --- /dev/null +++ b/mail_layout_force/demo/mail_layout.xml @@ -0,0 +1,115 @@ + + + + + + + diff --git a/mail_layout_force/i18n/it.po b/mail_layout_force/i18n/it.po new file mode 100644 index 0000000000..d4c4476462 --- /dev/null +++ b/mail_layout_force/i18n/it.po @@ -0,0 +1,42 @@ +# Translation of Odoo Server. +# This file contains the translation of the following modules: +# * mail_layout_force +# +msgid "" +msgstr "" +"Project-Id-Version: Odoo Server 16.0\n" +"Report-Msgid-Bugs-To: \n" +"PO-Revision-Date: 2024-04-02 11:43+0000\n" +"Last-Translator: mymage \n" +"Language-Team: none\n" +"Language: it\n" +"MIME-Version: 1.0\n" +"Content-Type: text/plain; charset=UTF-8\n" +"Content-Transfer-Encoding: \n" +"Plural-Forms: nplurals=2; plural=n != 1;\n" +"X-Generator: Weblate 4.17\n" + +#. module: mail_layout_force +#: model:ir.model,name:mail_layout_force.model_mail_template +msgid "Email Templates" +msgstr "Modelli e-mail" + +#. module: mail_layout_force +#: model:ir.model,name:mail_layout_force.model_mail_thread +msgid "Email Thread" +msgstr "Discussione e-mail" + +#. module: mail_layout_force +#: model:ir.model,name:mail_layout_force.model_mail_compose_message +msgid "Email composition wizard" +msgstr "Procedura guidata creazione e-mail" + +#. module: mail_layout_force +#: model:ir.model.fields,field_description:mail_layout_force.field_mail_template__force_email_layout_id +msgid "Force Layout" +msgstr "Forza disposizione" + +#. module: mail_layout_force +#: model:ir.model.fields,help:mail_layout_force.field_mail_template__force_email_layout_id +msgid "Force a mail layout for this template." +msgstr "Forza disposizione e-mail per questo modello." diff --git a/mail_layout_force/i18n/mail_layout_force.pot b/mail_layout_force/i18n/mail_layout_force.pot new file mode 100644 index 0000000000..4bd3d79a9a --- /dev/null +++ b/mail_layout_force/i18n/mail_layout_force.pot @@ -0,0 +1,39 @@ +# Translation of Odoo Server. +# This file contains the translation of the following modules: +# * mail_layout_force +# +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_layout_force +#: model:ir.model,name:mail_layout_force.model_mail_template +msgid "Email Templates" +msgstr "" + +#. module: mail_layout_force +#: model:ir.model,name:mail_layout_force.model_mail_thread +msgid "Email Thread" +msgstr "" + +#. module: mail_layout_force +#: model:ir.model,name:mail_layout_force.model_mail_compose_message +msgid "Email composition wizard" +msgstr "" + +#. module: mail_layout_force +#: model:ir.model.fields,field_description:mail_layout_force.field_mail_template__force_email_layout_id +msgid "Force Layout" +msgstr "" + +#. module: mail_layout_force +#: model:ir.model.fields,help:mail_layout_force.field_mail_template__force_email_layout_id +msgid "Force a mail layout for this template." +msgstr "" diff --git a/mail_layout_force/models/__init__.py b/mail_layout_force/models/__init__.py new file mode 100644 index 0000000000..44e83956eb --- /dev/null +++ b/mail_layout_force/models/__init__.py @@ -0,0 +1 @@ +from . import mail_template diff --git a/mail_layout_force/models/mail_template.py b/mail_layout_force/models/mail_template.py new file mode 100644 index 0000000000..aacf4cf1f3 --- /dev/null +++ b/mail_layout_force/models/mail_template.py @@ -0,0 +1,23 @@ +# Copyright 2022 Camptocamp SA (https://www.camptocamp.com). +# @author Iván Todorovich +# License AGPL-3.0 or later (https://www.gnu.org/licenses/agpl). + +from odoo import fields, models + + +class MailTemplate(models.Model): + _inherit = "mail.template" + + force_email_layout_id = fields.Many2one( + comodel_name="ir.ui.view", + string="Force Layout", + domain=[("type", "=", "qweb"), ("mode", "=", "primary")], + context={"default_type": "qweb"}, + help="Force a mail layout for this template.", + ) + + email_layout_xmlid = fields.Char(compute="_compute_email_layout_id") + + def _compute_email_layout_id(self): + for template in self: + template.email_layout_xmlid = template.force_email_layout_id.xml_id diff --git a/mail_layout_force/pyproject.toml b/mail_layout_force/pyproject.toml new file mode 100644 index 0000000000..4231d0cccb --- /dev/null +++ b/mail_layout_force/pyproject.toml @@ -0,0 +1,3 @@ +[build-system] +requires = ["whool"] +build-backend = "whool.buildapi" diff --git a/mail_layout_force/readme/CONFIGURE.md b/mail_layout_force/readme/CONFIGURE.md new file mode 100644 index 0000000000..fc8ab9c2a9 --- /dev/null +++ b/mail_layout_force/readme/CONFIGURE.md @@ -0,0 +1,15 @@ +\# Go to Configuration \> Technical \> Emails \> Templates \# Open the +desired `email.template` record. \# In Advanced Parameters tab, find the +Force Layout field. + +You can leave it empty to use the default email layout (chosen by Odoo). +You can force a custom email layout of your own. You can use the *Mail: +No-Layout notification template* to prevent Odoo from adding a layout. + +To configure a custom layout of your own, some technical knowledge is +needed. You can see how the existing layouts are defined for details or +inspiration: + +- `mail.mail_notification_light` +- `mail.mail_notification_paynow` +- `mail.mail_notification_borders` diff --git a/mail_layout_force/readme/CONTRIBUTORS.md b/mail_layout_force/readme/CONTRIBUTORS.md new file mode 100644 index 0000000000..ab093779ce --- /dev/null +++ b/mail_layout_force/readme/CONTRIBUTORS.md @@ -0,0 +1,5 @@ +- [Camptocamp](https://www.camptocamp.com) + + > - Iván Todorovich \<\> + +- Abraham Anes \<\> diff --git a/mail_layout_force/readme/DESCRIPTION.md b/mail_layout_force/readme/DESCRIPTION.md new file mode 100644 index 0000000000..80b8fa08a6 --- /dev/null +++ b/mail_layout_force/readme/DESCRIPTION.md @@ -0,0 +1,19 @@ +Odoo will add a default email layout on most commercial communications. + +The email layout is a `QWeb` view that ends up wrapping the message body +when sending an email. It usually displays the related document +reference, the company logo, and a small footer saying "Powered by +Odoo". + +There are notably two main layouts used in Odoo, and the user can't +control when they're used, as it's hardcoded into the different +applications. + +- `mail.mail_notification_light` +- `mail.mail_notification_paynow` + +This module allows to force a specific layout for a given +`email.template`, effectively overwritting the one hardcoded by Odoo. + +This allows you to fully customize the way Odoo emails are rendered and +sent to your customers. diff --git a/mail_layout_force/static/description/icon.png b/mail_layout_force/static/description/icon.png new file mode 100644 index 0000000000..3a0328b516 Binary files /dev/null and b/mail_layout_force/static/description/icon.png differ diff --git a/mail_layout_force/static/description/index.html b/mail_layout_force/static/description/index.html new file mode 100644 index 0000000000..cb4569a4ba --- /dev/null +++ b/mail_layout_force/static/description/index.html @@ -0,0 +1,466 @@ + + + + + +Mail Layout Force + + + +
+

Mail Layout Force

+ + +

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

+

Odoo will add a default email layout on most commercial communications.

+

The email layout is a QWeb view that ends up wrapping the message +body when sending an email. It usually displays the related document +reference, the company logo, and a small footer saying “Powered by +Odoo”.

+

There are notably two main layouts used in Odoo, and the user can’t +control when they’re used, as it’s hardcoded into the different +applications.

+
    +
  • mail.mail_notification_light
    • +
  • mail.mail_notification_paynow
    • +
+

This module allows to force a specific layout for a given +email.template, effectively overwritting the one hardcoded by Odoo.

+

This allows you to fully customize the way Odoo emails are rendered and +sent to your customers.

+

Table of contents

+ +
+

Configuration

+

# Go to Configuration > Technical > Emails > Templates # Open the +desired email.template record. # In Advanced Parameters tab, find +the Force Layout field.

+

You can leave it empty to use the default email layout (chosen by Odoo). +You can force a custom email layout of your own. You can use the Mail: +No-Layout notification template to prevent Odoo from adding a layout.

+

To configure a custom layout of your own, some technical knowledge is +needed. You can see how the existing layouts are defined for details or +inspiration:

+
    +
  • mail.mail_notification_light
    • +
  • mail.mail_notification_paynow
    • +
  • mail.mail_notification_borders
    • +
+
+
+

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.

+

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/social project on GitHub.

+

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

+
+
+
+ + diff --git a/mail_layout_force/views/mail_template.xml b/mail_layout_force/views/mail_template.xml new file mode 100644 index 0000000000..b0a80ffb15 --- /dev/null +++ b/mail_layout_force/views/mail_template.xml @@ -0,0 +1,19 @@ + + + + + + mail.template + + + + + + + + +