Metadata-Version: 2.1
Name: odoo-addon-mail_layout_force
Version: 18.0.1.0.0.3
Requires-Python: >=3.10
Requires-Dist: odoo==18.0.*
Summary: Force a mail layout on selected email templates
Home-page: https://github.com/OCA/mail
License: AGPL-3
Author: Camptocamp, Odoo Community Association (OCA)
Author-email: support@odoo-community.org
Classifier: Programming Language :: Python
Classifier: Framework :: Odoo
Classifier: Framework :: Odoo :: 18.0
Classifier: License :: OSI Approved :: GNU Affero General Public License v3
Description-Content-Type: text/x-rst

.. image:: https://odoo-community.org/readme-banner-image
   :target: https://odoo-community.org/get-involved?utm_source=readme
   :alt: Odoo Community Association

=================
Mail Layout Force
=================

.. 
   !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
   !! This file is generated by oca-gen-addon-readme !!
   !! changes will be overwritten.                   !!
   !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
   !! source digest: sha256:baadb7cfc76ac450e9fdd0b52f04a5ea57a275da88e050ae8ad80ffdbb90bb6e
   !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!

.. |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/license-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%2Fmail-lightgray.png?logo=github
    :target: https://github.com/OCA/mail/tree/18.0/mail_layout_force
    :alt: OCA/mail
.. |badge4| image:: https://img.shields.io/badge/weblate-Translate%20me-F47D42.png
    :target: https://translation.odoo-community.org/projects/mail-18-0/mail-18-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/mail&target_branch=18.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 three 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_layout``
- ``mail.mail_notification_layout_with_responsible_signature``
- ``mail.mail_notification_light``

This module allows to force a specific layout for a given
``email.template``, effectively overwriting the one hardcoded by Odoo.
Additionally, it enables forcing a custom layout for emails that do not
use an existing ``email.template`` record (e.g., when sending an email
from the chatter).

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

**Table of contents**

.. contents::
   :local:

Configuration
=============

To configure a forced layout for email templates:

1. Go to *Settings > Technical > Email > Email Templates*
2. Open the desired ``email.template`` record
3. In the *Settings* 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_layout``
- ``mail.mail_notification_layout_with_responsible_signature``
- ``mail.mail_notification_light``

To force a custom layout for emails that do not use an existing
``email.template`` record (e.g., emails sent from the chatter) or for
cases where emails are sent directly via ``message_post`` without
opening the mail composer (e.g., invoice send actions like
``action_invoice_sent``), you can use the Layout Mapping feature:

1. Go to *Settings > Technical > User Interface > Views*
2. Copy the current layout (e.g.,
   ``mail.mail_notification_layout_with_responsible_signature``) to
   create a new custom layout, and customize it as needed
3. Open the original layout view that you want to replace. Under the
   *Layout Mapping* tab:

   - Click *Add a line*
   - Set *Substitute Layout* to the new custom layout you created
   - Set *Models* if you want to apply the replacement only to specific
     models. If left empty, the email layout will be replaced for all
     models

Bug Tracker
===========

Bugs are tracked on `GitHub Issues <https://github.com/OCA/mail/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/mail/issues/new?body=module:%20mail_layout_force%0Aversion:%2018.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

- Abraham Anes abrahamanes@gmail.com

- ``Quartile <https://www.quartile.co>``\ \_

  - Aung Ko Ko Lin
  - Yoshi Tashiro

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/mail <https://github.com/OCA/mail/tree/18.0/mail_layout_force>`_ project on GitHub.

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