mirror of https://github.com/OCA/social.git
OCA-git-bot
commit
089f7b52f1
|
|
@ -0,0 +1,118 @@
|
|||
=================
|
||||
Mail Layout Force
|
||||
=================
|
||||
|
||||
.. !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
|
||||
!! 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%2Fsocial-lightgray.png?logo=github
|
||||
:target: https://github.com/OCA/social/tree/15.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-15-0/social-15-0-mail_layout_force
|
||||
:alt: Translate me on Weblate
|
||||
.. |badge5| image:: https://img.shields.io/badge/runbot-Try%20me-875A7B.png
|
||||
:target: https://runbot.odoo-community.org/runbot/205/15.0
|
||||
:alt: Try me on Runbot
|
||||
|
||||
|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 <https://github.com/OCA/social/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 <https://github.com/OCA/social/issues/new?body=module:%20mail_layout_force%0Aversion:%2015.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/social <https://github.com/OCA/social/tree/15.0/mail_layout_force>`_ project on GitHub.
|
||||
|
||||
You are welcome to contribute. To learn how please visit https://odoo-community.org/page/Contribute.
|
||||
|
|
@ -0,0 +1,2 @@
|
|||
from . import models
|
||||
from . import wizards
|
||||
|
|
@ -0,0 +1,17 @@
|
|||
# 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 Layout Force",
|
||||
"summary": "Force a mail layout on selected email templates",
|
||||
"version": "15.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"],
|
||||
}
|
||||
|
|
@ -0,0 +1,13 @@
|
|||
<?xml version="1.0" encoding="utf-8" ?>
|
||||
<!--
|
||||
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).
|
||||
-->
|
||||
<odoo>
|
||||
|
||||
<template id="mail_layout_noop" name="Mail: No-Layout notification template">
|
||||
<t t-out="message.body" />
|
||||
</template>
|
||||
|
||||
</odoo>
|
||||
|
|
@ -0,0 +1,115 @@
|
|||
<?xml version="1.0" encoding="utf-8" ?>
|
||||
<!--
|
||||
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).
|
||||
-->
|
||||
<odoo>
|
||||
|
||||
<template id="mail_layout_custom">
|
||||
<table
|
||||
border="0"
|
||||
cellpadding="0"
|
||||
cellspacing="0"
|
||||
style="padding-top: 32px; background-color: red; width: 100%; border-collapse:separate;"
|
||||
>
|
||||
<tr>
|
||||
<td align="center">
|
||||
<table
|
||||
border="0"
|
||||
cellpadding="0"
|
||||
cellspacing="0"
|
||||
width="590"
|
||||
style="padding: 24px; background-color: white; border-collapse:separate;"
|
||||
>
|
||||
<tbody>
|
||||
<!-- HEADER -->
|
||||
<tr>
|
||||
<td align="center" style="min-width: 590px;">
|
||||
<table
|
||||
border="0"
|
||||
cellpadding="0"
|
||||
cellspacing="0"
|
||||
width="100%"
|
||||
style="background-color: white; padding: 0; border-collapse:separate;"
|
||||
>
|
||||
<tr>
|
||||
<td valign="middle">
|
||||
<t
|
||||
t-esc="model_description or 'document'"
|
||||
/>
|
||||
<t
|
||||
t-esc="message.record_name and message.record_name.replace('/','-') or ''"
|
||||
/>
|
||||
</td>
|
||||
<td valign="middle" align="right">
|
||||
<img
|
||||
t-att-src="'/logo.png?company=%s' % (company.id or 0)"
|
||||
style="padding: 0px; margin: 0px; height: 48px;"
|
||||
t-att-alt="'%s' % company.name"
|
||||
/>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td colspan="2" style="text-align:center;">
|
||||
<hr
|
||||
width="100%"
|
||||
style="background-color: red; border: medium none; clear: both; display: block; margin:4px 0px 32px 0px;"
|
||||
/>
|
||||
</td>
|
||||
</tr>
|
||||
</table>
|
||||
</td>
|
||||
</tr>
|
||||
<!-- CONTENT -->
|
||||
<tr>
|
||||
<td style="min-width: 590px;">
|
||||
<t t-out="message.body" />
|
||||
</td>
|
||||
</tr>
|
||||
<!-- FOOTER -->
|
||||
<tr>
|
||||
<td
|
||||
align="center"
|
||||
style="min-width: 590px; padding: 0 8px 0 8px; font-size:11px;"
|
||||
>
|
||||
<hr
|
||||
width="100%"
|
||||
style="background-color: red; border: medium none; clear: both; display: block; margin:4px 0px 32px 0px;"
|
||||
/>
|
||||
<div style="color: #FF9999;">
|
||||
<b t-esc="company.name" /><br />
|
||||
<t t-esc="company.name" />
|
||||
<t t-if="company.phone">
|
||||
::
|
||||
<t t-esc="company.phone" />
|
||||
</t>
|
||||
<t t-if="company.email">
|
||||
::
|
||||
<a
|
||||
t-att-href="'mailto:%s' % company.email"
|
||||
style="text-decoration:none;color:red;"
|
||||
>
|
||||
<t t-esc="company.email" />
|
||||
</a>
|
||||
</t>
|
||||
<t t-if="company.website">
|
||||
::
|
||||
<a
|
||||
t-att-href="'%s' % company.website"
|
||||
style="text-decoration:none;color:red;"
|
||||
>
|
||||
<t t-esc="company.website" />
|
||||
</a>
|
||||
</t>
|
||||
</div>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</td>
|
||||
</tr>
|
||||
</table>
|
||||
</template>
|
||||
|
||||
</odoo>
|
||||
|
|
@ -0,0 +1,60 @@
|
|||
# Translation of Odoo Server.
|
||||
# This file contains the translation of the following modules:
|
||||
# * mail_layout_force
|
||||
#
|
||||
msgid ""
|
||||
msgstr ""
|
||||
"Project-Id-Version: Odoo Server 14.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.fields,field_description:mail_layout_force.field_mail_compose_message__display_name
|
||||
#: model:ir.model.fields,field_description:mail_layout_force.field_mail_template__display_name
|
||||
#: model:ir.model.fields,field_description:mail_layout_force.field_mail_thread__display_name
|
||||
msgid "Display Name"
|
||||
msgstr ""
|
||||
|
||||
#. 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 ""
|
||||
|
||||
#. module: mail_layout_force
|
||||
#: model:ir.model.fields,field_description:mail_layout_force.field_mail_compose_message__id
|
||||
#: model:ir.model.fields,field_description:mail_layout_force.field_mail_template__id
|
||||
#: model:ir.model.fields,field_description:mail_layout_force.field_mail_thread__id
|
||||
msgid "ID"
|
||||
msgstr ""
|
||||
|
||||
#. module: mail_layout_force
|
||||
#: model:ir.model.fields,field_description:mail_layout_force.field_mail_compose_message____last_update
|
||||
#: model:ir.model.fields,field_description:mail_layout_force.field_mail_template____last_update
|
||||
#: model:ir.model.fields,field_description:mail_layout_force.field_mail_thread____last_update
|
||||
msgid "Last Modified on"
|
||||
msgstr ""
|
||||
|
|
@ -0,0 +1,2 @@
|
|||
from . import mail_template
|
||||
from . import mail_thread
|
||||
|
|
@ -0,0 +1,44 @@
|
|||
# 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 api, 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.",
|
||||
)
|
||||
|
||||
def _ensure_force_email_layout_xml_id(self):
|
||||
missing = self.force_email_layout_id.filtered(lambda rec: not rec.xml_id)
|
||||
if missing:
|
||||
vals = [
|
||||
{
|
||||
"module": "__export__",
|
||||
"name": "force_email_layout_%s" % rec.id,
|
||||
"model": rec._name,
|
||||
"res_id": rec.id,
|
||||
}
|
||||
for rec in missing
|
||||
]
|
||||
self.env["ir.model.data"].sudo().create(vals)
|
||||
self.force_email_layout_id.invalidate_cache(["xml_id"])
|
||||
|
||||
@api.model_create_multi
|
||||
def create(self, vals_list):
|
||||
records = super().create(vals_list)
|
||||
records._ensure_force_email_layout_xml_id()
|
||||
return records
|
||||
|
||||
def write(self, vals):
|
||||
res = super().write(vals)
|
||||
if "force_email_layout_id" in vals:
|
||||
self._ensure_force_email_layout_xml_id()
|
||||
return res
|
||||
|
|
@ -0,0 +1,20 @@
|
|||
# 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 MailThread(models.AbstractModel):
|
||||
_inherit = "mail.thread"
|
||||
|
||||
def message_post_with_template(
|
||||
self, template_id, email_layout_xmlid=None, **kwargs
|
||||
):
|
||||
# OVERRIDE to force the email_layout_xmlid defined on the mail.template
|
||||
template = self.env["mail.template"].sudo().browse(template_id)
|
||||
if template.force_email_layout_id:
|
||||
email_layout_xmlid = template.force_email_layout_id.xml_id
|
||||
return super().message_post_with_template(
|
||||
template_id, email_layout_xmlid=email_layout_xmlid, **kwargs
|
||||
)
|
||||
|
|
@ -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``
|
||||
|
|
@ -0,0 +1,3 @@
|
|||
* `Camptocamp <https://www.camptocamp.com>`_
|
||||
|
||||
* Iván Todorovich <ivan.todorovich@camptocamp.com>
|
||||
|
|
@ -0,0 +1,17 @@
|
|||
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.
|
||||
Binary file not shown.
|
After Width: | Height: | Size: 9.2 KiB |
|
|
@ -0,0 +1,458 @@
|
|||
<?xml version="1.0" encoding="utf-8" ?>
|
||||
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
||||
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
|
||||
<head>
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
|
||||
<meta name="generator" content="Docutils: http://docutils.sourceforge.net/" />
|
||||
<title>Mail Layout Force</title>
|
||||
<style type="text/css">
|
||||
|
||||
/*
|
||||
:Author: David Goodger (goodger@python.org)
|
||||
:Id: $Id: html4css1.css 7952 2016-07-26 18:15:59Z milde $
|
||||
:Copyright: This stylesheet has been placed in the public domain.
|
||||
|
||||
Default cascading style sheet for the HTML output of Docutils.
|
||||
|
||||
See http://docutils.sf.net/docs/howto/html-stylesheets.html for how to
|
||||
customize this style sheet.
|
||||
*/
|
||||
|
||||
/* used to remove borders from tables and images */
|
||||
.borderless, table.borderless td, table.borderless th {
|
||||
border: 0 }
|
||||
|
||||
table.borderless td, table.borderless th {
|
||||
/* Override padding for "table.docutils td" with "! important".
|
||||
The right padding separates the table cells. */
|
||||
padding: 0 0.5em 0 0 ! important }
|
||||
|
||||
.first {
|
||||
/* Override more specific margin styles with "! important". */
|
||||
margin-top: 0 ! important }
|
||||
|
||||
.last, .with-subtitle {
|
||||
margin-bottom: 0 ! important }
|
||||
|
||||
.hidden {
|
||||
display: none }
|
||||
|
||||
.subscript {
|
||||
vertical-align: sub;
|
||||
font-size: smaller }
|
||||
|
||||
.superscript {
|
||||
vertical-align: super;
|
||||
font-size: smaller }
|
||||
|
||||
a.toc-backref {
|
||||
text-decoration: none ;
|
||||
color: black }
|
||||
|
||||
blockquote.epigraph {
|
||||
margin: 2em 5em ; }
|
||||
|
||||
dl.docutils dd {
|
||||
margin-bottom: 0.5em }
|
||||
|
||||
object[type="image/svg+xml"], object[type="application/x-shockwave-flash"] {
|
||||
overflow: hidden;
|
||||
}
|
||||
|
||||
/* Uncomment (and remove this text!) to get bold-faced definition list terms
|
||||
dl.docutils dt {
|
||||
font-weight: bold }
|
||||
*/
|
||||
|
||||
div.abstract {
|
||||
margin: 2em 5em }
|
||||
|
||||
div.abstract p.topic-title {
|
||||
font-weight: bold ;
|
||||
text-align: center }
|
||||
|
||||
div.admonition, div.attention, div.caution, div.danger, div.error,
|
||||
div.hint, div.important, div.note, div.tip, div.warning {
|
||||
margin: 2em ;
|
||||
border: medium outset ;
|
||||
padding: 1em }
|
||||
|
||||
div.admonition p.admonition-title, div.hint p.admonition-title,
|
||||
div.important p.admonition-title, div.note p.admonition-title,
|
||||
div.tip p.admonition-title {
|
||||
font-weight: bold ;
|
||||
font-family: sans-serif }
|
||||
|
||||
div.attention p.admonition-title, div.caution p.admonition-title,
|
||||
div.danger p.admonition-title, div.error p.admonition-title,
|
||||
div.warning p.admonition-title, .code .error {
|
||||
color: red ;
|
||||
font-weight: bold ;
|
||||
font-family: sans-serif }
|
||||
|
||||
/* Uncomment (and remove this text!) to get reduced vertical space in
|
||||
compound paragraphs.
|
||||
div.compound .compound-first, div.compound .compound-middle {
|
||||
margin-bottom: 0.5em }
|
||||
|
||||
div.compound .compound-last, div.compound .compound-middle {
|
||||
margin-top: 0.5em }
|
||||
*/
|
||||
|
||||
div.dedication {
|
||||
margin: 2em 5em ;
|
||||
text-align: center ;
|
||||
font-style: italic }
|
||||
|
||||
div.dedication p.topic-title {
|
||||
font-weight: bold ;
|
||||
font-style: normal }
|
||||
|
||||
div.figure {
|
||||
margin-left: 2em ;
|
||||
margin-right: 2em }
|
||||
|
||||
div.footer, div.header {
|
||||
clear: both;
|
||||
font-size: smaller }
|
||||
|
||||
div.line-block {
|
||||
display: block ;
|
||||
margin-top: 1em ;
|
||||
margin-bottom: 1em }
|
||||
|
||||
div.line-block div.line-block {
|
||||
margin-top: 0 ;
|
||||
margin-bottom: 0 ;
|
||||
margin-left: 1.5em }
|
||||
|
||||
div.sidebar {
|
||||
margin: 0 0 0.5em 1em ;
|
||||
border: medium outset ;
|
||||
padding: 1em ;
|
||||
background-color: #ffffee ;
|
||||
width: 40% ;
|
||||
float: right ;
|
||||
clear: right }
|
||||
|
||||
div.sidebar p.rubric {
|
||||
font-family: sans-serif ;
|
||||
font-size: medium }
|
||||
|
||||
div.system-messages {
|
||||
margin: 5em }
|
||||
|
||||
div.system-messages h1 {
|
||||
color: red }
|
||||
|
||||
div.system-message {
|
||||
border: medium outset ;
|
||||
padding: 1em }
|
||||
|
||||
div.system-message p.system-message-title {
|
||||
color: red ;
|
||||
font-weight: bold }
|
||||
|
||||
div.topic {
|
||||
margin: 2em }
|
||||
|
||||
h1.section-subtitle, h2.section-subtitle, h3.section-subtitle,
|
||||
h4.section-subtitle, h5.section-subtitle, h6.section-subtitle {
|
||||
margin-top: 0.4em }
|
||||
|
||||
h1.title {
|
||||
text-align: center }
|
||||
|
||||
h2.subtitle {
|
||||
text-align: center }
|
||||
|
||||
hr.docutils {
|
||||
width: 75% }
|
||||
|
||||
img.align-left, .figure.align-left, object.align-left, table.align-left {
|
||||
clear: left ;
|
||||
float: left ;
|
||||
margin-right: 1em }
|
||||
|
||||
img.align-right, .figure.align-right, object.align-right, table.align-right {
|
||||
clear: right ;
|
||||
float: right ;
|
||||
margin-left: 1em }
|
||||
|
||||
img.align-center, .figure.align-center, object.align-center {
|
||||
display: block;
|
||||
margin-left: auto;
|
||||
margin-right: auto;
|
||||
}
|
||||
|
||||
table.align-center {
|
||||
margin-left: auto;
|
||||
margin-right: auto;
|
||||
}
|
||||
|
||||
.align-left {
|
||||
text-align: left }
|
||||
|
||||
.align-center {
|
||||
clear: both ;
|
||||
text-align: center }
|
||||
|
||||
.align-right {
|
||||
text-align: right }
|
||||
|
||||
/* reset inner alignment in figures */
|
||||
div.align-right {
|
||||
text-align: inherit }
|
||||
|
||||
/* div.align-center * { */
|
||||
/* text-align: left } */
|
||||
|
||||
.align-top {
|
||||
vertical-align: top }
|
||||
|
||||
.align-middle {
|
||||
vertical-align: middle }
|
||||
|
||||
.align-bottom {
|
||||
vertical-align: bottom }
|
||||
|
||||
ol.simple, ul.simple {
|
||||
margin-bottom: 1em }
|
||||
|
||||
ol.arabic {
|
||||
list-style: decimal }
|
||||
|
||||
ol.loweralpha {
|
||||
list-style: lower-alpha }
|
||||
|
||||
ol.upperalpha {
|
||||
list-style: upper-alpha }
|
||||
|
||||
ol.lowerroman {
|
||||
list-style: lower-roman }
|
||||
|
||||
ol.upperroman {
|
||||
list-style: upper-roman }
|
||||
|
||||
p.attribution {
|
||||
text-align: right ;
|
||||
margin-left: 50% }
|
||||
|
||||
p.caption {
|
||||
font-style: italic }
|
||||
|
||||
p.credits {
|
||||
font-style: italic ;
|
||||
font-size: smaller }
|
||||
|
||||
p.label {
|
||||
white-space: nowrap }
|
||||
|
||||
p.rubric {
|
||||
font-weight: bold ;
|
||||
font-size: larger ;
|
||||
color: maroon ;
|
||||
text-align: center }
|
||||
|
||||
p.sidebar-title {
|
||||
font-family: sans-serif ;
|
||||
font-weight: bold ;
|
||||
font-size: larger }
|
||||
|
||||
p.sidebar-subtitle {
|
||||
font-family: sans-serif ;
|
||||
font-weight: bold }
|
||||
|
||||
p.topic-title {
|
||||
font-weight: bold }
|
||||
|
||||
pre.address {
|
||||
margin-bottom: 0 ;
|
||||
margin-top: 0 ;
|
||||
font: inherit }
|
||||
|
||||
pre.literal-block, pre.doctest-block, pre.math, pre.code {
|
||||
margin-left: 2em ;
|
||||
margin-right: 2em }
|
||||
|
||||
pre.code .ln { color: grey; } /* line numbers */
|
||||
pre.code, code { background-color: #eeeeee }
|
||||
pre.code .comment, code .comment { color: #5C6576 }
|
||||
pre.code .keyword, code .keyword { color: #3B0D06; font-weight: bold }
|
||||
pre.code .literal.string, code .literal.string { color: #0C5404 }
|
||||
pre.code .name.builtin, code .name.builtin { color: #352B84 }
|
||||
pre.code .deleted, code .deleted { background-color: #DEB0A1}
|
||||
pre.code .inserted, code .inserted { background-color: #A3D289}
|
||||
|
||||
span.classifier {
|
||||
font-family: sans-serif ;
|
||||
font-style: oblique }
|
||||
|
||||
span.classifier-delimiter {
|
||||
font-family: sans-serif ;
|
||||
font-weight: bold }
|
||||
|
||||
span.interpreted {
|
||||
font-family: sans-serif }
|
||||
|
||||
span.option {
|
||||
white-space: nowrap }
|
||||
|
||||
span.pre {
|
||||
white-space: pre }
|
||||
|
||||
span.problematic {
|
||||
color: red }
|
||||
|
||||
span.section-subtitle {
|
||||
/* font-size relative to parent (h1..h6 element) */
|
||||
font-size: 80% }
|
||||
|
||||
table.citation {
|
||||
border-left: solid 1px gray;
|
||||
margin-left: 1px }
|
||||
|
||||
table.docinfo {
|
||||
margin: 2em 4em }
|
||||
|
||||
table.docutils {
|
||||
margin-top: 0.5em ;
|
||||
margin-bottom: 0.5em }
|
||||
|
||||
table.footnote {
|
||||
border-left: solid 1px black;
|
||||
margin-left: 1px }
|
||||
|
||||
table.docutils td, table.docutils th,
|
||||
table.docinfo td, table.docinfo th {
|
||||
padding-left: 0.5em ;
|
||||
padding-right: 0.5em ;
|
||||
vertical-align: top }
|
||||
|
||||
table.docutils th.field-name, table.docinfo th.docinfo-name {
|
||||
font-weight: bold ;
|
||||
text-align: left ;
|
||||
white-space: nowrap ;
|
||||
padding-left: 0 }
|
||||
|
||||
/* "booktabs" style (no vertical lines) */
|
||||
table.docutils.booktabs {
|
||||
border: 0px;
|
||||
border-top: 2px solid;
|
||||
border-bottom: 2px solid;
|
||||
border-collapse: collapse;
|
||||
}
|
||||
table.docutils.booktabs * {
|
||||
border: 0px;
|
||||
}
|
||||
table.docutils.booktabs th {
|
||||
border-bottom: thin solid;
|
||||
text-align: left;
|
||||
}
|
||||
|
||||
h1 tt.docutils, h2 tt.docutils, h3 tt.docutils,
|
||||
h4 tt.docutils, h5 tt.docutils, h6 tt.docutils {
|
||||
font-size: 100% }
|
||||
|
||||
ul.auto-toc {
|
||||
list-style-type: none }
|
||||
|
||||
</style>
|
||||
</head>
|
||||
<body>
|
||||
<div class="document" id="mail-layout-force">
|
||||
<h1 class="title">Mail Layout Force</h1>
|
||||
|
||||
<!-- !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
|
||||
!! This file is generated by oca-gen-addon-readme !!
|
||||
!! changes will be overwritten. !!
|
||||
!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! -->
|
||||
<p><a class="reference external" 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" 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" href="https://github.com/OCA/social/tree/15.0/mail_layout_force"><img alt="OCA/social" src="https://img.shields.io/badge/github-OCA%2Fsocial-lightgray.png?logo=github" /></a> <a class="reference external" href="https://translation.odoo-community.org/projects/social-15-0/social-15-0-mail_layout_force"><img alt="Translate me on Weblate" src="https://img.shields.io/badge/weblate-Translate%20me-F47D42.png" /></a> <a class="reference external" href="https://runbot.odoo-community.org/runbot/205/15.0"><img alt="Try me on Runbot" src="https://img.shields.io/badge/runbot-Try%20me-875A7B.png" /></a></p>
|
||||
<p>Odoo will add a default email layout on most commercial communications.</p>
|
||||
<p>The email layout is a <tt class="docutils literal">QWeb</tt> 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”.</p>
|
||||
<p>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.</p>
|
||||
<ul class="simple">
|
||||
<li><tt class="docutils literal">mail.mail_notification_light</tt></li>
|
||||
<li><tt class="docutils literal">mail.mail_notification_paynow</tt></li>
|
||||
</ul>
|
||||
<p>This module allows to force a specific layout for a given <tt class="docutils literal">email.template</tt>,
|
||||
effectively overwritting the one hardcoded by Odoo.</p>
|
||||
<p>This allows you to fully customize the way Odoo emails are rendered and sent
|
||||
to your customers.</p>
|
||||
<p><strong>Table of contents</strong></p>
|
||||
<div class="contents local topic" id="contents">
|
||||
<ul class="simple">
|
||||
<li><a class="reference internal" href="#configuration" id="id1">Configuration</a></li>
|
||||
<li><a class="reference internal" href="#bug-tracker" id="id2">Bug Tracker</a></li>
|
||||
<li><a class="reference internal" href="#credits" id="id3">Credits</a><ul>
|
||||
<li><a class="reference internal" href="#authors" id="id4">Authors</a></li>
|
||||
<li><a class="reference internal" href="#contributors" id="id5">Contributors</a></li>
|
||||
<li><a class="reference internal" href="#maintainers" id="id6">Maintainers</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="section" id="configuration">
|
||||
<h1><a class="toc-backref" href="#id1">Configuration</a></h1>
|
||||
<p># Go to Configuration > Technical > Emails > Templates
|
||||
# Open the desired <tt class="docutils literal">email.template</tt> record.
|
||||
# In Advanced Parameters tab, find the Force Layout field.</p>
|
||||
<p>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 <em>Mail: No-Layout notification template</em> to prevent Odoo
|
||||
from adding a layout.</p>
|
||||
<p>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:</p>
|
||||
<ul class="simple">
|
||||
<li><tt class="docutils literal">mail.mail_notification_light</tt></li>
|
||||
<li><tt class="docutils literal">mail.mail_notification_paynow</tt></li>
|
||||
<li><tt class="docutils literal">mail.mail_notification_borders</tt></li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="section" id="bug-tracker">
|
||||
<h1><a class="toc-backref" href="#id2">Bug Tracker</a></h1>
|
||||
<p>Bugs are tracked on <a class="reference external" href="https://github.com/OCA/social/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 smashing it by providing a detailed and welcomed
|
||||
<a class="reference external" href="https://github.com/OCA/social/issues/new?body=module:%20mail_layout_force%0Aversion:%2015.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">
|
||||
<h1><a class="toc-backref" href="#id3">Credits</a></h1>
|
||||
<div class="section" id="authors">
|
||||
<h2><a class="toc-backref" href="#id4">Authors</a></h2>
|
||||
<ul class="simple">
|
||||
<li>Camptocamp</li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="section" id="contributors">
|
||||
<h2><a class="toc-backref" href="#id5">Contributors</a></h2>
|
||||
<ul>
|
||||
<li><p class="first"><a class="reference external" href="https://www.camptocamp.com">Camptocamp</a></p>
|
||||
<blockquote>
|
||||
<ul class="simple">
|
||||
<li>Iván Todorovich <<a class="reference external" href="mailto:ivan.todorovich@camptocamp.com">ivan.todorovich@camptocamp.com</a>></li>
|
||||
</ul>
|
||||
</blockquote>
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="section" id="maintainers">
|
||||
<h2><a class="toc-backref" href="#id6">Maintainers</a></h2>
|
||||
<p>This module is maintained by the OCA.</p>
|
||||
<a class="reference external image-reference" href="https://odoo-community.org"><img alt="Odoo Community Association" src="https://odoo-community.org/logo.png" /></a>
|
||||
<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>Current <a class="reference external" href="https://odoo-community.org/page/maintainer-role">maintainer</a>:</p>
|
||||
<p><a class="reference external" href="https://github.com/ivantodorovich"><img alt="ivantodorovich" src="https://github.com/ivantodorovich.png?size=40px" /></a></p>
|
||||
<p>This module is part of the <a class="reference external" href="https://github.com/OCA/social/tree/15.0/mail_layout_force">OCA/social</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>
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
|
|
@ -0,0 +1 @@
|
|||
from . import test_mail_layout_force
|
||||
|
|
@ -0,0 +1,73 @@
|
|||
# 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.tests import TransactionCase
|
||||
|
||||
|
||||
class TestMailLayoutForce(TransactionCase):
|
||||
@classmethod
|
||||
def setUpClass(cls):
|
||||
super().setUpClass()
|
||||
cls.layout_noop = cls.env.ref("mail_layout_force.mail_layout_noop")
|
||||
cls.layout_test = cls.env["ir.ui.view"].create(
|
||||
{
|
||||
"name": "Test Layout",
|
||||
"type": "qweb",
|
||||
"mode": "primary",
|
||||
"arch": "<t t-name='test'><h1></h1><t t-out='message.body'/></t>",
|
||||
}
|
||||
)
|
||||
cls.template = cls.env["mail.template"].create(
|
||||
{
|
||||
"name": "Test Template",
|
||||
"body_html": "<p>Test</p>",
|
||||
"subject": "Test",
|
||||
"model_id": cls.env.ref("base.model_res_partner").id,
|
||||
"auto_delete": False,
|
||||
}
|
||||
)
|
||||
cls.partner = cls.env.ref("base.res_partner_10")
|
||||
cls.partner.message_ids.unlink()
|
||||
cls.partner.message_subscribe([cls.partner.id])
|
||||
|
||||
def test_noop_layout(self):
|
||||
self.template.force_email_layout_id = self.layout_noop
|
||||
self.partner.message_post_with_template(
|
||||
self.template.id,
|
||||
# This is ignored because the template has a force_email_layout_id
|
||||
email_layout_xmlid="mail.mail_notification_light",
|
||||
)
|
||||
message = self.partner.message_ids[-1]
|
||||
self.assertEqual(message.mail_ids.body_html.strip(), "<p>Test</p>")
|
||||
|
||||
def test_custom_layout(self):
|
||||
self.template.force_email_layout_id = self.layout_test
|
||||
self.partner.message_post_with_template(
|
||||
self.template.id,
|
||||
# This is ignored because the template has a force_email_layout_id
|
||||
email_layout_xmlid="mail.mail_notification_light",
|
||||
)
|
||||
message = self.partner.message_ids[-1]
|
||||
self.assertEqual(message.mail_ids.body_html.strip(), "<h1></h1><p>Test</p>")
|
||||
|
||||
def test_custom_layout_composer(self):
|
||||
self.template.force_email_layout_id = self.layout_test
|
||||
composer = (
|
||||
self.env["mail.compose.message"]
|
||||
.with_context(
|
||||
# This is ignored because the template has a force_email_layout_id
|
||||
custom_layout="mail.mail_notification_light"
|
||||
)
|
||||
.create(
|
||||
{
|
||||
"res_id": self.partner.id,
|
||||
"model": self.partner._name,
|
||||
"template_id": self.template.id,
|
||||
}
|
||||
)
|
||||
)
|
||||
composer._onchange_template_id_wrapper()
|
||||
composer._action_send_mail()
|
||||
message = self.partner.message_ids[-1]
|
||||
self.assertEqual(message.mail_ids.body_html.strip(), "<h1></h1><p>Test</p>")
|
||||
|
|
@ -0,0 +1,19 @@
|
|||
<?xml version="1.0" encoding="utf-8" ?>
|
||||
<!--
|
||||
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).
|
||||
-->
|
||||
<odoo>
|
||||
|
||||
<record id="email_template_form" model="ir.ui.view">
|
||||
<field name="model">mail.template</field>
|
||||
<field name="inherit_id" ref="mail.email_template_form" />
|
||||
<field name="arch" type="xml">
|
||||
<field name="auto_delete" position="before">
|
||||
<field name="force_email_layout_id" />
|
||||
</field>
|
||||
</field>
|
||||
</record>
|
||||
|
||||
</odoo>
|
||||
|
|
@ -0,0 +1 @@
|
|||
from . import mail_compose_message
|
||||
|
|
@ -0,0 +1,22 @@
|
|||
# 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 MailComposer(models.TransientModel):
|
||||
_inherit = "mail.compose.message"
|
||||
|
||||
def _action_send_mail(self, auto_commit=False):
|
||||
# OVERRIDE to force the email_layout_xmlid defined on the mail.template
|
||||
res = []
|
||||
for rec in self:
|
||||
if rec.template_id.force_email_layout_id:
|
||||
rec = rec.with_context(
|
||||
custom_layout=self.template_id.force_email_layout_id.xml_id
|
||||
)
|
||||
res.append(
|
||||
super(MailComposer, rec)._action_send_mail(auto_commit=auto_commit)
|
||||
)
|
||||
return all(res)
|
||||
|
|
@ -0,0 +1 @@
|
|||
../../../../mail_layout_force
|
||||
|
|
@ -0,0 +1,6 @@
|
|||
import setuptools
|
||||
|
||||
setuptools.setup(
|
||||
setup_requires=['setuptools-odoo'],
|
||||
odoo_addon=True,
|
||||
)
|
||||
Loading…
Reference in New Issue