[ADD] mail_notification_custom_subject: Apply a custom subject to mail notifications

This module allows you to specify templates to override the subject on the notification
emails sent by Odoo.

TT27191

Co-authored-by: Pedro M. Baeza <pedro.baeza@tecnativa.com>
This commit is contained in:
João Marques 2021-01-05 09:18:36 +00:00 committed by Víctor Martínez
parent 90ac99b71d
commit 586be98e65
18 changed files with 1224 additions and 0 deletions

View File

@ -0,0 +1,106 @@
================================
Mail Notification Custom Subject
================================
.. !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
!! This file is generated by oca-gen-addon-readme !!
!! changes will be overwritten. !!
!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
.. |badge1| image:: https://img.shields.io/badge/maturity-Production%2FStable-green.png
:target: https://odoo-community.org/page/development-status
:alt: Production/Stable
.. |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/12.0/mail_notification_custom_subject
:alt: OCA/social
.. |badge4| image:: https://img.shields.io/badge/weblate-Translate%20me-F47D42.png
:target: https://translation.odoo-community.org/projects/social-12-0/social-12-0-mail_notification_custom_subject
: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/12.0
:alt: Try me on Runbot
|badge1| |badge2| |badge3| |badge4| |badge5|
This module allows you to specify templates to override the subject on the notification
emails sent by Odoo
**Table of contents**
.. contents::
:local:
Configuration
=============
* Activate access to **Technical Features** (debug mode).
* Go to **Settings > Technical > Email > Subject Replacement Templates**
* Create a new template.
* The field **Model** specifies the model to which the subject template should apply in the notification emails sent by Odoo.
* The field **Subject Template** accepts `Jinjah<ttps://jinja.palletsprojects.com/en/2.11.x/>` expressions.
* The field **Replace** specifies if the template should replace existing content or append to it.
Usage
=====
To use this module, you need to:
* Open the chatter in Odoo (e.g. Open an Invoice).
* Send a message.
* Observe the rendered Subject template.
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_notification_custom_subject%0Aversion:%2012.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
~~~~~~~
* Tecnativa
Contributors
~~~~~~~~~~~~
* Tecnativa <https://www.tecnativa.com>
* Pedro M. Baeza
* João Marques
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-joao-p-marques| image:: https://github.com/joao-p-marques.png?size=40px
:target: https://github.com/joao-p-marques
:alt: joao-p-marques
Current `maintainer <https://odoo-community.org/page/maintainer-role>`__:
|maintainer-joao-p-marques|
This module is part of the `OCA/social <https://github.com/OCA/social/tree/12.0/mail_notification_custom_subject>`_ project on GitHub.
You are welcome to contribute. To learn how please visit https://odoo-community.org/page/Contribute.

View File

@ -0,0 +1 @@
from . import models

View File

@ -0,0 +1,23 @@
# Copyright 2020-2021 Tecnativa - João Marques
# Copyright 2021 Tecnativa - Pedro M. Baeza
# License AGPL-3.0 or later (http://www.gnu.org/licenses/agpl.html).
{
"name": "Mail Notification Custom Subject",
"summary": "Apply a custom subject to mail notifications",
"version": "12.0.1.0.0",
"category": "Social Network",
"website": "https://github.com/OCA/social/",
"author": "Tecnativa, Odoo Community Association (OCA)",
"license": "AGPL-3",
"installable": True,
"depends": [
"mail",
],
"data": [
"security/ir.model.access.csv",
"views/mail_notification_custom_subject_views.xml",
],
"development_status": "Production/Stable",
"maintainers": ["joao-p-marques"],
}

View File

@ -0,0 +1,69 @@
# Translation of Odoo Server.
# This file contains the translation of the following modules:
# * mail_notification_custom_subject
#
msgid ""
msgstr ""
"Project-Id-Version: Odoo Server 12.0\n"
"Report-Msgid-Bugs-To: \n"
"POT-Creation-Date: 2021-01-05 09:11+0000\n"
"PO-Revision-Date: 2021-01-05 09:17+0000\n"
"Language-Team: \n"
"MIME-Version: 1.0\n"
"Content-Type: text/plain; charset=UTF-8\n"
"Content-Transfer-Encoding: 8bit\n"
"Plural-Forms: nplurals=2; plural=(n != 1);\n"
"X-Generator: Poedit 2.4.2\n"
"Last-Translator: \n"
"Language: es_ES\n"
#. module: mail_notification_custom_subject
#: code:addons/mail_notification_custom_subject/models/mail_message_custom_subject.py:150
#, python-format
msgid "Append After"
msgstr "Añadir después"
#. module: mail_notification_custom_subject
#: code:addons/mail_notification_custom_subject/models/mail_message_custom_subject.py:149
#, python-format
msgid "Append Before"
msgstr "Añadir antes"
#. module: mail_notification_custom_subject
#: model:ir.model,name:mail_notification_custom_subject.model_mail_thread
msgid "Email Thread"
msgstr "Hilo de correo electrónico"
#. module: mail_notification_custom_subject
#: code:addons/mail_notification_custom_subject/models/mail_message_custom_subject.py:238
#, python-format
msgid "Failed to render template %r using values %r"
msgstr "Error al procesar la plantilla %r usando los valores %r"
#. module: mail_notification_custom_subject
#: model:ir.model,name:mail_notification_custom_subject.model_mail_message_custom_subject
msgid "Mail Message Custom Subject"
msgstr "Asunto Personalizado en Mensaje de Correo"
#. module: mail_notification_custom_subject
#: code:addons/mail_notification_custom_subject/models/mail_message_custom_subject.py:151
#, python-format
msgid "Replace"
msgstr "Sustituir"
#. module: mail_notification_custom_subject
#: model_terms:ir.ui.view,arch_db:mail_notification_custom_subject.mail_notification_custom_subject_form
msgid "Subject (placeholders may be used here)"
msgstr "Asunto (se pueden utilizar aquí expresiones de campos)"
#. module: mail_notification_custom_subject
#: model:ir.actions.act_window,name:mail_notification_custom_subject.action_mail_notification_custom_subject_tree_all
#: model:ir.ui.menu,name:mail_notification_custom_subject.menu_mail_notification_custom_subject
#: model_terms:ir.ui.view,arch_db:mail_notification_custom_subject.mail_notification_custom_subject_form
msgid "Subject Replacement Templates"
msgstr "Plantillas de Sustitución de Asuntos"
#. module: mail_notification_custom_subject
#: model_terms:ir.ui.view,arch_db:mail_notification_custom_subject.mail_notification_custom_subject_tree
msgid "Templates"
msgstr "Plantillas"

View File

@ -0,0 +1,134 @@
# Translation of Odoo Server.
# This file contains the translation of the following modules:
# * mail_notification_custom_subject
#
msgid ""
msgstr ""
"Project-Id-Version: Odoo Server 12.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_notification_custom_subject
#: code:addons/mail_notification_custom_subject/models/mail_message_custom_subject.py:31
#: selection:mail.message.custom.subject,position:0
#, python-format
msgid "Append After"
msgstr ""
#. module: mail_notification_custom_subject
#: code:addons/mail_notification_custom_subject/models/mail_message_custom_subject.py:30
#: selection:mail.message.custom.subject,position:0
#, python-format
msgid "Append Before"
msgstr ""
#. module: mail_notification_custom_subject
#: model:ir.model.fields,field_description:mail_notification_custom_subject.field_mail_message_custom_subject__subtype_ids
msgid "Applied Subtypes"
msgstr ""
#. module: mail_notification_custom_subject
#: model:ir.model.fields,field_description:mail_notification_custom_subject.field_mail_message_custom_subject__create_uid
msgid "Created by"
msgstr ""
#. module: mail_notification_custom_subject
#: model:ir.model.fields,field_description:mail_notification_custom_subject.field_mail_message_custom_subject__create_date
msgid "Created on"
msgstr ""
#. module: mail_notification_custom_subject
#: model:ir.model.fields,field_description:mail_notification_custom_subject.field_mail_message_custom_subject__display_name
msgid "Display Name"
msgstr ""
#. module: mail_notification_custom_subject
#: model:ir.model,name:mail_notification_custom_subject.model_mail_thread
msgid "Email Thread"
msgstr ""
#. module: mail_notification_custom_subject
#: model:ir.model.fields,field_description:mail_notification_custom_subject.field_mail_message_custom_subject__id
msgid "ID"
msgstr ""
#. module: mail_notification_custom_subject
#: model:ir.model.fields,field_description:mail_notification_custom_subject.field_mail_message_custom_subject____last_update
msgid "Last Modified on"
msgstr ""
#. module: mail_notification_custom_subject
#: model:ir.model.fields,field_description:mail_notification_custom_subject.field_mail_message_custom_subject__write_uid
msgid "Last Updated by"
msgstr ""
#. module: mail_notification_custom_subject
#: model:ir.model.fields,field_description:mail_notification_custom_subject.field_mail_message_custom_subject__write_date
msgid "Last Updated on"
msgstr ""
#. module: mail_notification_custom_subject
#: model:ir.model,name:mail_notification_custom_subject.model_mail_message_custom_subject
msgid "Mail Message Custom Subject"
msgstr ""
#. module: mail_notification_custom_subject
#: model:ir.model.fields,field_description:mail_notification_custom_subject.field_mail_message_custom_subject__model_id
msgid "Model"
msgstr ""
#. module: mail_notification_custom_subject
#: model:ir.model.fields,help:mail_notification_custom_subject.field_mail_message_custom_subject__model_id
msgid "Model where this template applies"
msgstr ""
#. module: mail_notification_custom_subject
#: model:ir.model.fields,field_description:mail_notification_custom_subject.field_mail_message_custom_subject__position
msgid "Position"
msgstr ""
#. module: mail_notification_custom_subject
#: code:addons/mail_notification_custom_subject/models/mail_message_custom_subject.py:32
#: selection:mail.message.custom.subject,position:0
#, python-format
msgid "Replace"
msgstr ""
#. module: mail_notification_custom_subject
#: model:ir.model.fields,help:mail_notification_custom_subject.field_mail_message_custom_subject__subject_template
#: model_terms:ir.ui.view,arch_db:mail_notification_custom_subject.mail_notification_custom_subject_form
msgid "Subject (placeholders may be used here)"
msgstr ""
#. module: mail_notification_custom_subject
#: model:ir.actions.act_window,name:mail_notification_custom_subject.action_mail_notification_custom_subject_tree_all
#: model:ir.ui.menu,name:mail_notification_custom_subject.menu_mail_notification_custom_subject
#: model_terms:ir.ui.view,arch_db:mail_notification_custom_subject.mail_notification_custom_subject_form
msgid "Subject Replacement Templates"
msgstr ""
#. module: mail_notification_custom_subject
#: model:ir.model.fields,field_description:mail_notification_custom_subject.field_mail_message_custom_subject__subject_template
msgid "Subject Template"
msgstr ""
#. module: mail_notification_custom_subject
#: model:ir.model.fields,field_description:mail_notification_custom_subject.field_mail_message_custom_subject__name
msgid "Template Name"
msgstr ""
#. module: mail_notification_custom_subject
#: model_terms:ir.ui.view,arch_db:mail_notification_custom_subject.mail_notification_custom_subject_tree
msgid "Templates"
msgstr ""
#. module: mail_notification_custom_subject
#: model:ir.model.fields,help:mail_notification_custom_subject.field_mail_message_custom_subject__position
msgid "Whether to replace, append at beggining or append at end to other templates that apply to a given context"
msgstr ""

View File

@ -0,0 +1,2 @@
from . import mail_thread
from . import mail_message_custom_subject

View File

@ -0,0 +1,38 @@
# Copyright 2020 Tecnativa - João Marques
# License AGPL-3.0 or later (http://www.gnu.org/licenses/agpl.html).
from odoo import _, fields, models
class MailMessageCustomSubject(models.Model):
_name = "mail.message.custom.subject"
_description = "Mail Message Custom Subject"
name = fields.Char(string="Template Name")
model_id = fields.Many2one(
comodel_name="ir.model",
string="Model",
required=True,
help="Model where this template applies",
)
subtype_ids = fields.Many2many(
comodel_name="mail.message.subtype",
string="Applied Subtypes",
required=True,
)
subject_template = fields.Char(
string="Subject Template",
required=True,
help="Subject (placeholders may be used here)",
)
position = fields.Selection(
selection=[
("append_before", _("Append Before")),
("append_after", _("Append After")),
("replace", _("Replace")),
],
string="Position",
default="replace",
help="Whether to replace, append at beggining or append at end to other"
" templates that apply to a given context",
)

View File

@ -0,0 +1,75 @@
# Copyright 2020-2021 Tecnativa - João Marques
# Copyright 2021 Tecnativa - Pedro M. Baeza
# License AGPL-3.0 or later (http://www.gnu.org/licenses/agpl.html).
from odoo import api, models
class MailThread(models.AbstractModel):
_inherit = "mail.thread"
@api.returns("mail.message", lambda value: value.id)
def message_post(
self,
body="",
subject=None,
message_type="notification",
subtype=None,
parent_id=False,
attachments=None,
notif_layout=False,
add_sign=True,
model_description=False,
mail_auto_delete=True,
**kwargs
):
subtype_id = kwargs.get('subtype_id', False)
if not subtype_id:
subtype = subtype or 'mt_note'
if '.' not in subtype:
subtype = 'mail.%s' % subtype
subtype_id = self.env['ir.model.data'].xmlid_to_res_id(
subtype, raise_if_not_found=False,
)
if subtype_id:
custom_subjects = self.env["mail.message.custom.subject"].search(
[
("model_id.model", "=", self._name),
("subtype_ids", "=", subtype_id),
]
)
if not subject:
subject = 'Re: %s' % self.env["mail.message"].with_context(
default_model=self._name,
default_res_id=self.id,
)._get_record_name({})
for template in custom_subjects:
try:
rendered_subject_template = self.env[
"mail.template"
]._render_template(
template_txt=template.subject_template,
model=self._name,
res_ids=self.id,
)
if template.position == "replace":
subject = rendered_subject_template
elif template.position == "append_before":
subject = rendered_subject_template + subject
elif template.position == "append_after":
subject += rendered_subject_template
except Exception:
rendered_subject_template = False
return super().message_post(
body=body,
subject=subject,
message_type=message_type,
subtype=subtype,
parent_id=parent_id,
attachments=attachments,
notif_layout=notif_layout,
add_sign=add_sign,
model_description=model_description,
mail_auto_delete=mail_auto_delete,
**kwargs
)

View File

@ -0,0 +1,8 @@
* Activate access to **Technical Features** (debug mode).
* Go to **Settings > Technical > Email > Subject Replacement Templates**
* Create a new template.
* The field **Model** specifies the model to which the subject template should apply in the notification emails sent by Odoo.
* The field **Subject Template** accepts `Jinjah<ttps://jinja.palletsprojects.com/en/2.11.x/>` expressions.
* The field **Replace** specifies if the template should replace existing content or append to it.

View File

@ -0,0 +1,4 @@
* Tecnativa <https://www.tecnativa.com>
* Pedro M. Baeza
* João Marques

View File

@ -0,0 +1,2 @@
This module allows you to specify templates to override the subject on the notification
emails sent by Odoo

View File

@ -0,0 +1,5 @@
To use this module, you need to:
* Open the chatter in Odoo (e.g. Open an Invoice).
* Send a message.
* Observe the rendered Subject template.

View File

@ -0,0 +1,3 @@
id,name,model_id:id,group_id:id,perm_read,perm_write,perm_create,perm_unlink
access_mail_notification_custom_subject_user,mail_notification_custom_object,model_mail_message_custom_subject,base.group_user,1,0,0,0
access_mail_notification_custom_subject_admin,mail_notification_custom_object,model_mail_message_custom_subject,base.group_system,1,1,1,1
1 id name model_id:id group_id:id perm_read perm_write perm_create perm_unlink
2 access_mail_notification_custom_subject_user mail_notification_custom_object model_mail_message_custom_subject base.group_user 1 0 0 0
3 access_mail_notification_custom_subject_admin mail_notification_custom_object model_mail_message_custom_subject base.group_system 1 1 1 1

Binary file not shown.

After

Width:  |  Height:  |  Size: 9.2 KiB

View File

@ -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 0.15.1: http://docutils.sourceforge.net/" />
<title>Mail Notification Custom Subject</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-notification-custom-subject">
<h1 class="title">Mail Notification Custom Subject</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="Production/Stable" src="https://img.shields.io/badge/maturity-Production%2FStable-green.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/12.0/mail_notification_custom_subject"><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-12-0/social-12-0-mail_notification_custom_subject"><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/12.0"><img alt="Try me on Runbot" src="https://img.shields.io/badge/runbot-Try%20me-875A7B.png" /></a></p>
<p>This module allows you to specify templates to override the subject on the notification
emails sent by Odoo</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="#usage" id="id2">Usage</a></li>
<li><a class="reference internal" href="#bug-tracker" id="id3">Bug Tracker</a></li>
<li><a class="reference internal" href="#credits" id="id4">Credits</a><ul>
<li><a class="reference internal" href="#authors" id="id5">Authors</a></li>
<li><a class="reference internal" href="#contributors" id="id6">Contributors</a></li>
<li><a class="reference internal" href="#maintainers" id="id7">Maintainers</a></li>
</ul>
</li>
</ul>
</div>
<div class="section" id="configuration">
<h1><a class="toc-backref" href="#id1">Configuration</a></h1>
<ul>
<li><p class="first">Activate access to <strong>Technical Features</strong> (debug mode).</p>
</li>
<li><p class="first">Go to <strong>Settings &gt; Technical &gt; Email &gt; Subject Replacement Templates</strong></p>
</li>
<li><p class="first">Create a new template.</p>
<blockquote>
<ul class="simple">
<li>The field <strong>Model</strong> specifies the model to which the subject template should apply in the notification emails sent by Odoo.</li>
<li>The field <strong>Subject Template</strong> accepts <cite>Jinjah&lt;ttps://jinja.palletsprojects.com/en/2.11.x/&gt;</cite> expressions.</li>
<li>The field <strong>Replace</strong> specifies if the template should replace existing content or append to it.</li>
</ul>
</blockquote>
</li>
</ul>
</div>
<div class="section" id="usage">
<h1><a class="toc-backref" href="#id2">Usage</a></h1>
<p>To use this module, you need to:</p>
<ul class="simple">
<li>Open the chatter in Odoo (e.g. Open an Invoice).</li>
<li>Send a message.</li>
<li>Observe the rendered Subject template.</li>
</ul>
</div>
<div class="section" id="bug-tracker">
<h1><a class="toc-backref" href="#id3">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_notification_custom_subject%0Aversion:%2012.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="#id4">Credits</a></h1>
<div class="section" id="authors">
<h2><a class="toc-backref" href="#id5">Authors</a></h2>
<ul class="simple">
<li>Tecnativa</li>
</ul>
</div>
<div class="section" id="contributors">
<h2><a class="toc-backref" href="#id6">Contributors</a></h2>
<ul>
<li><p class="first">Tecnativa &lt;<a class="reference external" href="https://www.tecnativa.com">https://www.tecnativa.com</a>&gt;</p>
<blockquote>
<ul class="simple">
<li>Pedro M. Baeza</li>
<li>João Marques</li>
</ul>
</blockquote>
</li>
</ul>
</div>
<div class="section" id="maintainers">
<h2><a class="toc-backref" href="#id7">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/joao-p-marques"><img alt="joao-p-marques" src="https://github.com/joao-p-marques.png?size=40px" /></a></p>
<p>This module is part of the <a class="reference external" href="https://github.com/OCA/social/tree/12.0/mail_notification_custom_subject">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>

View File

@ -0,0 +1 @@
from . import test_mail_notification_custom_subject

View File

@ -0,0 +1,245 @@
# Copyright 2020 Tecnativa - João Marques
# License AGPL-3.0 or later (http://www.gnu.org/licenses/agpl.html).
from odoo.tests import common
class TestMailNotificationCustomSubject(common.TransactionCase):
def setUp(self):
super(TestMailNotificationCustomSubject, self).setUp()
self.partner_1 = self.env["res.partner"].create(
{
"name": "Test partner 1",
"supplier": True,
"email": "partner1@example.com",
}
)
self.partner_2 = self.env["res.partner"].create(
{
"name": "Test partner 2",
"supplier": True,
"email": "partner2@example.com",
}
)
def test_email_subject_template_overrides(self):
self.env["mail.message.custom.subject"].create(
{
"name": "Test template 1",
"model_id": self.env.ref("base.model_res_partner").id,
"subtype_ids": [
(
6,
0,
[
self.env.ref("mail.mt_comment").id,
],
)
],
"subject_template": "${object.name or 'n/a'} and something more",
}
)
# Send message in partner
mail_message_1 = self.partner_1.message_post(
body="Test", subtype="mail.mt_comment"
)
# Get message and check subject
self.assertEquals(mail_message_1.subject, "Test partner 1 and something more")
# Send message in partner 2
mail_message_2 = self.partner_2.message_post(
body="Test", subtype="mail.mt_comment"
)
# Get message and check subject
self.assertEquals(mail_message_2.subject, "Test partner 2 and something more")
# Explicit subject should also be overwritten
mail_message_3 = self.partner_2.message_post(
body="Test", subtype="mail.mt_comment", subject="Test"
)
# Get message and check subject
self.assertEquals(mail_message_3.subject, "Test partner 2 and something more")
def test_email_subject_template_normal(self):
self.env["mail.message.custom.subject"].create(
{
"name": "Test template 1",
"model_id": self.env.ref("base.model_res_partner").id,
"subtype_ids": [
(
6,
0,
[
self.env.ref("mail.mt_comment").id,
],
)
],
"subject_template": "${object.name or 'n/a'} and something more",
}
)
# Send note in partner
mail_message_1 = self.partner_1.message_post(
body="Test", subtype="mail.mt_note", subject="Test"
)
# Get message and check subject. Subject Template should not apply
self.assertEquals(mail_message_1.subject, "Test")
def test_email_subject_template_multi(self):
self.env["mail.message.custom.subject"].create(
{
"name": "Test template 1",
"model_id": self.env.ref("base.model_res_partner").id,
"subtype_ids": [
(
6,
0,
[
self.env.ref("mail.mt_comment").id,
],
)
],
"subject_template": "${object.name or 'n/a'} and something more",
}
)
self.env["mail.message.custom.subject"].create(
{
"name": "Test template 2",
"model_id": self.env.ref("base.model_res_partner").id,
"subtype_ids": [
(
6,
0,
[
self.env.ref("mail.mt_comment").id,
],
)
],
"subject_template": "${object.name or 'n/a'} and something different",
}
)
# Send message in partner
mail_message_1 = self.partner_1.message_post(
body="Test", subtype="mail.mt_comment"
)
# Get message and check subject
self.assertEquals(
mail_message_1.subject, "Test partner 1 and something different"
)
self.env["mail.message.custom.subject"].create(
{
"name": "Test template 3",
"model_id": self.env.ref("base.model_res_partner").id,
"subtype_ids": [
(
6,
0,
[
self.env.ref("mail.mt_comment").id,
],
)
],
"subject_template": "${' and yet something else'}",
"position": "append_after",
}
)
# Send message in partner
mail_message_2 = self.partner_1.message_post(
body="Test", subtype="mail.mt_comment"
)
# Get message and check subject
self.assertEquals(
mail_message_2.subject,
"Test partner 1 and something different and yet something else",
)
self.env["mail.message.custom.subject"].create(
{
"name": "Test template 4",
"model_id": self.env.ref("base.model_res_partner").id,
"subtype_ids": [
(
6,
0,
[
self.env.ref("mail.mt_comment").id,
],
)
],
"subject_template": "${'Re: '}",
"position": "append_before",
}
)
# Send message in partner
mail_message_3 = self.partner_1.message_post(
body="Test", subtype="mail.mt_comment"
)
# Get message and check subject
self.assertEquals(
mail_message_3.subject,
"Re: Test partner 1 and something different and yet something else",
)
def test_email_subject_template_w_original(self):
self.env["mail.message.custom.subject"].create(
{
"name": "Test template 1",
"model_id": self.env.ref("base.model_res_partner").id,
"subtype_ids": [
(
6,
0,
[
self.env.ref("mail.mt_comment").id,
],
)
],
"subject_template": "${' and something more'}",
"position": "append_after",
}
)
# Send message in partner
mail_message_1 = self.partner_1.message_post(
body="Test", subtype="mail.mt_comment", subject="Test",
)
# Get message and check subject
self.assertEquals(
mail_message_1.subject, "Test and something more"
)
def test_bad_template_does_not_break(self):
self.env["mail.message.custom.subject"].create(
{
"name": "Test bad template 1",
"model_id": self.env.ref("base.model_res_partner").id,
"subtype_ids": [
(
6,
0,
[
self.env.ref("mail.mt_comment").id,
],
)
],
"subject_template": "${obaject.number_a} and something",
"position": "append_after",
}
)
# Send message in partner
mail_message_1 = self.partner_1.message_post(
body="Test", subtype="mail.mt_comment", subject="Test",
)
# Get message and check subject
# No exception should be raised but subject should remain as original.
self.assertEquals(
mail_message_1.subject, "Test"
)
def test_no_template_default_result(self):
# Send message in partner
mail_message_1 = self.partner_1.message_post(
body="Test", subtype="mail.mt_comment", subject="Test partner 1"
)
# Get message and check subject
# No exception should be raised but subject should remain as original.
self.assertEquals(
mail_message_1.subject, "Test partner 1"
)

View File

@ -0,0 +1,50 @@
<?xml version="1.0" encoding="UTF-8"?>
<odoo>
<data>
<record model="ir.ui.view" id="mail_notification_custom_subject_form">
<field name="name">mail.message.custom.subject.form</field>
<field name="model">mail.message.custom.subject</field>
<field name="arch" type="xml">
<form string="Subject Replacement Templates">
<sheet>
<div class="oe_title">
<label for="name" class="oe_edit_only"/>
<h1 name="name"><field name="name"/></h1>
</div>
<group>
<field name="subject_template" placeholder="Subject (placeholders may be used here)"/>
<field name="model_id"/>
<field name="subtype_ids" widget="many2many_tags" />
<field name="position"/>
</group>
</sheet>
</form>
</field>
</record>
<record model="ir.ui.view" id="mail_notification_custom_subject_tree">
<field name="name">mail.message.custom.subject.tree</field>
<field name="model">mail.message.custom.subject</field>
<field name="arch" type="xml">
<tree string="Templates">
<field name="name"/>
<field name="model_id"/>
<field name="subtype_ids"/>
<field name="subject_template"/>
</tree>
</field>
</record>
<record model="ir.actions.act_window" id="action_mail_notification_custom_subject_tree_all">
<field name="name">Subject Replacement Templates</field>
<field name="res_model">mail.message.custom.subject</field>
<field name="view_type">form</field>
<field name="view_mode">form,tree</field>
<field name="view_id" ref="mail_notification_custom_subject_tree" />
</record>
<menuitem id="menu_mail_notification_custom_subject" parent="base.menu_email" action="action_mail_notification_custom_subject_tree_all"
sequence="21"/>
</data>
</odoo>