Author: |
Camptocamp, Odoo Community Association (OCA) |
License: |
AGPL-3 |
Branch: |
15.0-t-59571-jok |
Repository: |
adhoc-dev/social |
Dependencies: |
mail |
Languages: |
HTML (368, 51.5%),
Python (140, 19.6%),
XML (123, 17.2%),
and
reStructuredText (83, 11.6%) |
Other repositories: |
Change2improve/social,
Digital5-Odoo/social,
OCA/social,
StefanRijnhart/social,
Studio73/social,
Tecnativa/social,
acsone/social,
agrista/odoo-social,
akretion/social,
aurestic/social,
brain-tec/social,
camptocamp/social,
coopiteasy/social,
nilshamerlinck/social,
pegonzalezspesol/social,
sunflowerit/social,
tafaRU/social,
tegin/social,
and
ursais/social |
<h1 class="title">Mail Layout Force</h1>
<p><a class="reference external image-reference" 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 image-reference" 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 image-reference" 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 image-reference" 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 image-reference" 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 <code>QWeb</code> 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><code>mail.mail_notification_light</code></li>
<li><code>mail.mail_notification_paynow</code></li>
</ul>
<p>This module allows to force a specific layout for a given <code>email.template</code>,
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>
<a name="configuration"></a>
<h2><a class="toc-backref" href="#id1">Configuration</a></h2>
<p># Go to Configuration > Technical > Emails > Templates
# Open the desired <code>email.template</code> 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><code>mail.mail_notification_light</code></li>
<li><code>mail.mail_notification_paynow</code></li>
<li><code>mail.mail_notification_borders</code></li>
</ul>
<a name="bug-tracker"></a>
<h2><a class="toc-backref" href="#id2">Bug Tracker</a></h2>
<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>
<a name="credits"></a>
<h2><a class="toc-backref" href="#id3">Credits</a></h2>
<a name="authors"></a>
<h3><a class="toc-backref" href="#id4">Authors</a></h3>
<ul class="simple">
<li>Camptocamp</li>
</ul>
<a name="contributors"></a>
<h3><a class="toc-backref" href="#id5">Contributors</a></h3>
<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>
<a name="maintainers"></a>
<h3><a class="toc-backref" href="#id6">Maintainers</a></h3>
<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 image-reference" 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>