diff --git a/mail_autogenerated_header/README.rst b/mail_autogenerated_header/README.rst new file mode 100644 index 000000000..d0d6f1055 --- /dev/null +++ b/mail_autogenerated_header/README.rst @@ -0,0 +1,87 @@ +===================== +Autogenerated headers +===================== + +.. !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! + !! 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/12.0/mail_autogenerated_header + :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_autogenerated_header + :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 was written to mark Odoo's emails as being autogenerated according to `RFC 3834 `_, section 5. This allows receiving mail servers to act accordingly by for example not sending a vacation autoreply. + +On the receiving side, this module drops all notifications for autogenerated incoming e-mails. + +The combination of both avoids possible mail loops with misconfigured or broken email servers on the opposite side. + +**Table of contents** + +.. contents:: + :local: + +Usage +===== + +There's nothing the user has to do. Developers can set the context flag +``mail_autogenerated_header_disable`` in calls to ``send_email`` in order to +suppress adding any headers at all, and override +``_message_route_process_autoreply`` to fine tune dropping autogenerated mails +per model. + +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 smashing it by providing a detailed and welcomed +`feedback `_. + +Do not contact contributors directly about support or help with technical issues. + +Credits +======= + +Authors +~~~~~~~ + +* Hunki Enterprises BV +* Therp BV + +Contributors +~~~~~~~~~~~~ + +* Holger Brunn (https://hunki-enterprises.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. + +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_autogenerated_header/__init__.py b/mail_autogenerated_header/__init__.py new file mode 100644 index 000000000..ffe1a38a3 --- /dev/null +++ b/mail_autogenerated_header/__init__.py @@ -0,0 +1,4 @@ +# Copyright 2018 Therp BV +# Copyright 2022 Hunki Enterprises BV +# License AGPL-3.0 or later (https://www.gnu.org/licenses/agpl.html). +from . import models diff --git a/mail_autogenerated_header/__manifest__.py b/mail_autogenerated_header/__manifest__.py new file mode 100644 index 000000000..b79adfa47 --- /dev/null +++ b/mail_autogenerated_header/__manifest__.py @@ -0,0 +1,14 @@ +# Copyright 2018 Therp BV +# Copyright 2022 Hunki Enterprises BV +# License AGPL-3.0 or later (https://www.gnu.org/licenses/agpl.html). +{ + "name": "Autogenerated headers", + "version": "12.0.1.0.0", + "author": "Hunki Enterprises BV, Therp BV,Odoo Community Association (OCA)", + "license": "AGPL-3", + "category": "Tools", + "summary": "Add headers to Odoo's mails indicating they are autogenerated", + "depends": [ + 'mail', + ], +} diff --git a/mail_autogenerated_header/models/__init__.py b/mail_autogenerated_header/models/__init__.py new file mode 100644 index 000000000..af47c23c8 --- /dev/null +++ b/mail_autogenerated_header/models/__init__.py @@ -0,0 +1,6 @@ +# Copyright 2018 Therp BV +# Copyright 2022 Hunki Enterprises BV +# License AGPL-3.0 or later (https://www.gnu.org/licenses/agpl.html). +from . import ir_mail_server +from . import mail_thread +from . import res_partner diff --git a/mail_autogenerated_header/models/ir_mail_server.py b/mail_autogenerated_header/models/ir_mail_server.py new file mode 100644 index 000000000..badde4408 --- /dev/null +++ b/mail_autogenerated_header/models/ir_mail_server.py @@ -0,0 +1,55 @@ +# Copyright 2018 Therp BV +# Copyright 2022 Hunki Enterprises BV +# License AGPL-3.0 or later (https://www.gnu.org/licenses/agpl.html). +from odoo import api, models + + +class IrMailServer(models.Model): + _inherit = 'ir.mail_server' + + @api.model + def send_email( + self, message, mail_server_id=None, smtp_server=None, smtp_port=None, + smtp_user=None, smtp_password=None, smtp_encryption=None, + smtp_debug=False, smtp_session=None, + ): + """ Inject autogenerated header for autogoing mails """ + + if not self.env.context.get('mail_autogenerated_header_disable') and\ + self._send_email_set_autogenerated( + message, mail_server_id=mail_server_id, + smtp_server=smtp_server, smtp_port=smtp_port, + smtp_user=smtp_user, smtp_password=smtp_password, + smtp_encryption=smtp_encryption, smtp_debug=smtp_debug, + smtp_session=smtp_session, + ): + # MS Exchange's broken version as of + # http://blogs.technet.com/b/exchange/archive/2006/10/06/ + # 3395024.aspx + message['Precedence'] = 'bulk' + message['X-Auto-Response-Suppress'] = 'OOF' + # The right way to do it as of + # https://tools.ietf.org/html/rfc3834 + message['Auto-Submitted'] = 'auto-generated' + + return super(IrMailServer, self).send_email( + message, mail_server_id=mail_server_id, smtp_server=smtp_server, + smtp_port=smtp_port, smtp_user=smtp_user, + smtp_password=smtp_password, smtp_encryption=smtp_encryption, + smtp_debug=smtp_debug, smtp_session=smtp_session, + ) + + @api.model + def _send_email_set_autogenerated( + self, message, mail_server_id=None, smtp_server=None, smtp_port=None, + smtp_user=None, smtp_password=None, smtp_encryption=None, + smtp_debug=False, smtp_session=None, + ): + """Determine if some mail should have the autogenerated headers""" + + mail = self.env['mail.mail'].search([ + ('message_id', '=', message['Message-Id']), + ]) + if not mail: + return False + return mail.subtype_id != self.env.ref('mail.mt_comment') diff --git a/mail_autogenerated_header/models/mail_thread.py b/mail_autogenerated_header/models/mail_thread.py new file mode 100644 index 000000000..0fc5c6a87 --- /dev/null +++ b/mail_autogenerated_header/models/mail_thread.py @@ -0,0 +1,34 @@ +# Copyright 2018 Therp BV +# Copyright 2022 Hunki Enterprises BV +# License AGPL-3.0 or later (https://www.gnu.org/licenses/agpl.html). +import logging +from odoo import api, models +_logger = logging.getLogger(__name__) + + +class MailThread(models.AbstractModel): + _inherit = 'mail.thread' + + @api.model + def message_route_process(self, message, message_dict, routes): + """ Set context key to suppress notification for autogenerated incoming + mails """ + if self._message_route_process_autoreply(message, message_dict, routes): + _logger.info( + 'Ignoring email %s from %s because it seems to be an auto ' + 'reply', message.get('Message-ID'), message.get('From'), + ) + self = self.with_context(mail_autogenerated_header=message) + return super(MailThread, self).message_route_process( + message, message_dict, routes, + ) + + @api.model + def _message_route_process_autoreply(self, message, message_dict, routes): + """ Determine if some message is an autoreply """ + return ( + message['Auto-Submitted'] and message['Auto-Submitted'] != 'no' or + message['X-Auto-Response-Suppress'] and set( + message['X-Auto-Response-Suppress'].split(', ') + ) & set('AutoReply', 'All') + ) diff --git a/mail_autogenerated_header/models/res_partner.py b/mail_autogenerated_header/models/res_partner.py new file mode 100644 index 000000000..ff276ca67 --- /dev/null +++ b/mail_autogenerated_header/models/res_partner.py @@ -0,0 +1,24 @@ +# Copyright 2022 Hunki Enterprises BV +# License AGPL-3.0 or later (https://www.gnu.org/licenses/agpl.html). +from odoo import api, models + + +class ResPartner(models.Model): + _inherit = 'res.partner' + + @api.model + def _notify( + self, message, rdata, record, force_send=False, + send_after_commit=True, model_description=False, + mail_auto_delete=True, + ): + """ Inhibit notifications if this is the notification for an incoming + autogenerated mail from another system """ + if self.env.context.get('mail_autogenerated_header'): + return True + return super()._notify( + message, rdata, record, force_send=force_send, + send_after_commit=send_after_commit, + model_description=model_description, + mail_auto_delete=mail_auto_delete, + ) diff --git a/mail_autogenerated_header/readme/CONTRIBUTORS.rst b/mail_autogenerated_header/readme/CONTRIBUTORS.rst new file mode 100644 index 000000000..33b6eb2c3 --- /dev/null +++ b/mail_autogenerated_header/readme/CONTRIBUTORS.rst @@ -0,0 +1 @@ +* Holger Brunn (https://hunki-enterprises.com) diff --git a/mail_autogenerated_header/readme/DESCRIPTION.rst b/mail_autogenerated_header/readme/DESCRIPTION.rst new file mode 100644 index 000000000..bda994624 --- /dev/null +++ b/mail_autogenerated_header/readme/DESCRIPTION.rst @@ -0,0 +1,5 @@ +This module was written to mark Odoo's emails as being autogenerated according to `RFC 3834 `_, section 5. This allows receiving mail servers to act accordingly by for example not sending a vacation autoreply. + +On the receiving side, this module drops all notifications for autogenerated incoming e-mails. + +The combination of both avoids possible mail loops with misconfigured or broken email servers on the opposite side. diff --git a/mail_autogenerated_header/readme/USAGE.rst b/mail_autogenerated_header/readme/USAGE.rst new file mode 100644 index 000000000..8412aba96 --- /dev/null +++ b/mail_autogenerated_header/readme/USAGE.rst @@ -0,0 +1,5 @@ +There's nothing the user has to do. Developers can set the context flag +``mail_autogenerated_header_disable`` in calls to ``send_email`` in order to +suppress adding any headers at all, and override +``_message_route_process_autoreply`` to fine tune dropping autogenerated mails +per model. diff --git a/mail_autogenerated_header/readme/newsfragments/.gitkeep b/mail_autogenerated_header/readme/newsfragments/.gitkeep new file mode 100644 index 000000000..e69de29bb diff --git a/mail_autogenerated_header/static/description/icon.png b/mail_autogenerated_header/static/description/icon.png new file mode 100644 index 000000000..3a0328b51 Binary files /dev/null and b/mail_autogenerated_header/static/description/icon.png differ diff --git a/mail_autogenerated_header/static/description/index.html b/mail_autogenerated_header/static/description/index.html new file mode 100644 index 000000000..0d9d9a598 --- /dev/null +++ b/mail_autogenerated_header/static/description/index.html @@ -0,0 +1,431 @@ + + + + + + +Autogenerated headers + + + +
+

Autogenerated headers

+ + +

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

+

This module was written to mark Odoo’s emails as being autogenerated according to RFC 3834, section 5. This allows receiving mail servers to act accordingly by for example not sending a vacation autoreply.

+

On the receiving side, this module drops all notifications for autogenerated incoming e-mails.

+

The combination of both avoids possible mail loops with misconfigured or broken email servers on the opposite side.

+

Table of contents

+ +
+

Usage

+

There’s nothing the user has to do. Developers can set the context flag +mail_autogenerated_header_disable in calls to send_email in order to +suppress adding any headers at all, and override +_message_route_process_autoreply to fine tune dropping autogenerated mails +per model.

+
+
+

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 smashing it by providing a detailed and welcomed +feedback.

+

Do not contact contributors directly about support or help with technical issues.

+
+
+

Credits

+
+

Authors

+
    +
  • Hunki Enterprises BV
    • +
  • Therp BV
    • +
+
+ +
+

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.

+

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_autogenerated_header/tests/__init__.py b/mail_autogenerated_header/tests/__init__.py new file mode 100644 index 000000000..b707cdfc9 --- /dev/null +++ b/mail_autogenerated_header/tests/__init__.py @@ -0,0 +1,4 @@ +# Copyright 2018 Therp BV +# Copyright 2022 Hunki Enterprises BV +# License AGPL-3.0 or later (https://www.gnu.org/licenses/agpl.html). +from . import test_mail_autogenerated_header diff --git a/mail_autogenerated_header/tests/test_mail_autogenerated_header.py b/mail_autogenerated_header/tests/test_mail_autogenerated_header.py new file mode 100644 index 000000000..5754e87d7 --- /dev/null +++ b/mail_autogenerated_header/tests/test_mail_autogenerated_header.py @@ -0,0 +1,63 @@ +# Copyright 2018 Therp BV +# Copyright 2022 Hunki Enterprises BV +# License AGPL-3.0 or later (https://www.gnu.org/licenses/agpl.html). +from odoo.tests.common import TransactionCase +from odoo.tools.mail import generate_tracking_message_id + + +class TestMailAutogeneratedHeader(TransactionCase): + def setUp(self): + super().setUp() + self.mail = self.env['mail.mail'].create({ + 'subject': 'testmessage', + 'email_from': 'test@test.com', + 'email_to': 'test@test.com', + 'message_id': 'message_id', + }) + self.message = self.env['ir.mail_server'].build_email( + [self.mail.email_from], [self.mail.email_to], self.mail.subject, '', + message_id=self.mail.message_id, + ) + + def test_sending(self): + """ Test that sending a mail has the Auto-Submitted header """ + self.env['ir.mail_server'].send_email(self.message) + self.assertEqual(self.message['Auto-Submitted'], 'auto-generated') + + def test_receiving(self): + """ Test that receiving mails with some auto submitted marker won't + cause new notifications being sent """ + demo_user = self.env.ref('base.user_demo') + self.message.replace_header( + 'Message-Id', generate_tracking_message_id(42), + ) + partner_id = self.env['mail.thread'].message_process( + 'res.partner', self.message.as_string(), + ) + partner = self.env['res.partner'].browse(partner_id) + partner.message_subscribe(partner_ids=demo_user.partner_id.ids) + reply = self.message + reply['References'] = self.message['Message-Id'] + reply.replace_header('Message-Id', 'message_id3') + thread_id = self.env['mail.thread'].message_process( + 'res.partner', reply.as_string(), + ) + self.assertEqual(thread_id, partner.id) + notifications = self.env['mail.notification'].search([ + ('res_partner_id', '=', demo_user.partner_id.id) + ]) + # mail is not autogenerated, should have generated mails + self.assertTrue(notifications.is_email) + notifications.unlink() + + reply.replace_header('Message-Id', 'message_id4') + reply['Auto-Submitted'] = 'auto-generated' + thread_id = self.env['mail.thread'].message_process( + 'res.partner', reply.as_string(), + ) + self.assertEqual(thread_id, partner.id) + notifications = self.env['mail.notification'].search([ + ('res_partner_id', '=', demo_user.partner_id.id) + ]) + # mail is autogenerated, shouldn't have generated mails + self.assertFalse(notifications.is_email)