diff --git a/mail_outbound_static/README.rst b/mail_outbound_static/README.rst new file mode 100644 index 00000000..deaeba1e --- /dev/null +++ b/mail_outbound_static/README.rst @@ -0,0 +1,87 @@ +==================== +Mail Outbound Static +==================== + +.. !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! + !! 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-LGPL--3-blue.png + :target: http://www.gnu.org/licenses/lgpl-3.0-standalone.html + :alt: License: LGPL-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_outbound_static + :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_outbound_static + :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 brings Odoo outbound emails in to strict compliance with RFC-2822 +by allowing for a statically configured From header, with the sender's e-mail +being appended into the proper Sender header instead. + +**Table of contents** + +.. contents:: + :local: + +Usage +===== + +* Navigate to an Outbound Email Server +* Set the `Email From` option to an email address + +Known issues / Roadmap +====================== + +* Allow for domain-based whitelist that will not be manipulated + +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 +~~~~~~~ + +* LasLabs + +Contributors +~~~~~~~~~~~~ + +* Dave Lasley +* Lorenzo Battistini + +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_outbound_static/__init__.py b/mail_outbound_static/__init__.py new file mode 100644 index 00000000..0639de1b --- /dev/null +++ b/mail_outbound_static/__init__.py @@ -0,0 +1,4 @@ +# Copyright 2017 LasLabs Inc. +# License LGPL-3.0 or later (http://www.gnu.org/licenses/lgpl.html). + +from . import models diff --git a/mail_outbound_static/__manifest__.py b/mail_outbound_static/__manifest__.py new file mode 100644 index 00000000..abdeb61a --- /dev/null +++ b/mail_outbound_static/__manifest__.py @@ -0,0 +1,20 @@ +# Copyright 2016-2017 LasLabs Inc. +# License LGPL-3.0 or later (http://www.gnu.org/licenses/lgpl.html). + +{ + 'name': 'Mail Outbound Static', + 'summary': 'Allows you to configure the from header for a mail server.', + 'version': '12.0.1.0.0', + 'category': 'Discuss', + 'website': 'https://laslabs.com/', + 'author': 'LasLabs, Odoo Community Association (OCA)', + 'license': 'LGPL-3', + 'application': False, + 'installable': True, + 'depends': [ + 'base', + ], + 'data': [ + 'views/ir_mail_server_view.xml', + ], +} diff --git a/mail_outbound_static/models/__init__.py b/mail_outbound_static/models/__init__.py new file mode 100644 index 00000000..fbf8a561 --- /dev/null +++ b/mail_outbound_static/models/__init__.py @@ -0,0 +1,4 @@ +# Copyright 2017 LasLabs Inc. +# License LGPL-3.0 or later (http://www.gnu.org/licenses/lgpl.html). + +from . import ir_mail_server diff --git a/mail_outbound_static/models/ir_mail_server.py b/mail_outbound_static/models/ir_mail_server.py new file mode 100644 index 00000000..e002b465 --- /dev/null +++ b/mail_outbound_static/models/ir_mail_server.py @@ -0,0 +1,49 @@ +# Copyright 2017 LasLabs Inc. +# License LGPL-3.0 or later (http://www.gnu.org/licenses/lgpl.html). + +from odoo import api, fields, models + + +class IrMailServer(models.Model): + + _inherit = 'ir.mail_server' + + smtp_from = fields.Char( + string='Email From', + help='Set this in order to email from a specific address.' + ) + + @api.model + def send_email(self, message, mail_server_id=None, smtp_server=None, + *args, **kwargs): + + # Replicate logic from core to get mail server + mail_server = None + if mail_server_id: + mail_server = self.sudo().browse(mail_server_id) + elif not smtp_server: + mail_server = self.sudo().search([], order='sequence', limit=1) + + if mail_server and mail_server.smtp_from: + split_from = message['From'].rsplit(' <', 1) + if len(split_from) > 1: + email_from = '%s <%s>' % ( + split_from[0], mail_server.smtp_from, + ) + else: + email_from = mail_server.smtp_from + + message.replace_header('From', email_from) + bounce_alias = self.env['ir.config_parameter'].get_param( + "mail.bounce.alias") + if not bounce_alias: + # then, bounce handling is disabled and we want + # Return-Path = From + if 'Return-Path' in message: + message.replace_header('Return-Path', email_from) + else: + message.add_header('Return-Path', email_from) + + return super(IrMailServer, self).send_email( + message, mail_server_id, smtp_server, *args, **kwargs + ) diff --git a/mail_outbound_static/readme/CONTRIBUTORS.rst b/mail_outbound_static/readme/CONTRIBUTORS.rst new file mode 100644 index 00000000..3b4618c2 --- /dev/null +++ b/mail_outbound_static/readme/CONTRIBUTORS.rst @@ -0,0 +1,2 @@ +* Dave Lasley +* Lorenzo Battistini diff --git a/mail_outbound_static/readme/DESCRIPTION.rst b/mail_outbound_static/readme/DESCRIPTION.rst new file mode 100644 index 00000000..b49deb9c --- /dev/null +++ b/mail_outbound_static/readme/DESCRIPTION.rst @@ -0,0 +1,3 @@ +This module brings Odoo outbound emails in to strict compliance with RFC-2822 +by allowing for a statically configured From header, with the sender's e-mail +being appended into the proper Sender header instead. diff --git a/mail_outbound_static/readme/ROADMAP.rst b/mail_outbound_static/readme/ROADMAP.rst new file mode 100644 index 00000000..9cc75479 --- /dev/null +++ b/mail_outbound_static/readme/ROADMAP.rst @@ -0,0 +1 @@ +* Allow for domain-based whitelist that will not be manipulated diff --git a/mail_outbound_static/readme/USAGE.rst b/mail_outbound_static/readme/USAGE.rst new file mode 100644 index 00000000..e0283cf9 --- /dev/null +++ b/mail_outbound_static/readme/USAGE.rst @@ -0,0 +1,2 @@ +* Navigate to an Outbound Email Server +* Set the `Email From` option to an email address diff --git a/mail_outbound_static/static/description/icon.png b/mail_outbound_static/static/description/icon.png new file mode 100644 index 00000000..3a0328b5 Binary files /dev/null and b/mail_outbound_static/static/description/icon.png differ diff --git a/mail_outbound_static/static/description/index.html b/mail_outbound_static/static/description/index.html new file mode 100644 index 00000000..3ac7728d --- /dev/null +++ b/mail_outbound_static/static/description/index.html @@ -0,0 +1,437 @@ + + + + + + +Mail Outbound Static + + + +
+

Mail Outbound Static

+ + +

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

+

This module brings Odoo outbound emails in to strict compliance with RFC-2822 +by allowing for a statically configured From header, with the sender’s e-mail +being appended into the proper Sender header instead.

+

Table of contents

+ +
+

Usage

+
    +
  • Navigate to an Outbound Email Server
    • +
  • Set the Email From option to an email address
    • +
+
+
+

Known issues / Roadmap

+
    +
  • Allow for domain-based whitelist that will not be manipulated
    • +
+
+
+

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

+
    +
  • LasLabs
    • +
+
+
+

Contributors

+ +
+
+

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_outbound_static/tests/__init__.py b/mail_outbound_static/tests/__init__.py new file mode 100644 index 00000000..8b601d0b --- /dev/null +++ b/mail_outbound_static/tests/__init__.py @@ -0,0 +1,4 @@ +# Copyright 2017 LasLabs Inc. +# License LGPL-3.0 or later (http://www.gnu.org/licenses/lgpl.html). + +from . import test_ir_mail_server diff --git a/mail_outbound_static/tests/test.msg b/mail_outbound_static/tests/test.msg new file mode 100644 index 00000000..1f0b96da --- /dev/null +++ b/mail_outbound_static/tests/test.msg @@ -0,0 +1,70 @@ +Delivered-To: test@gmail.com +Received: by 10.74.138.167 with SMTP id m36csp7226976ooj; + Tue, 12 Sep 2017 10:37:56 -0700 (PDT) +X-Google-Smtp-Source: AOwi7QDKSb3BE6lIhVXub9wcPA/HxFKKpnNPconNr9f1L35SVw+EIm8itVQkbOdAW6TohImypmrF +X-Received: by 10.28.158.208 with SMTP id h199mr250060wme.47.1505237876258; + Tue, 12 Sep 2017 10:37:56 -0700 (PDT) +ARC-Seal: i=1; a=rsa-sha256; t=1505237876; cv=none; + d=google.com; s=arc-20160816; + b=E2B6KUxHOJQk1YrT12BpitEMCgkxyqEXcFlwPWKjA/i/Xyvlh+09spNOF4VPmD/ZJm + 5lkY6hYyxvIH2RpRPeZVPkRIYhaEASkMIygdJu9Gd4weBdO2rd8iP/zSGHYyAmO/hLN2 + 64hXtKexrWnO/YNWlpfhAo1kiwgSRVnZx55EopbWP49cy7BzKfwr1kHN0T9A5Lw1w+BW + ZrXdCX6LRxHS2USKHb76PAVt0bhwsM/ZznBauR2zNKYcPxAWzdpN/vK3BDmWUdqbbSaB + BOKINjuI9EmWynogDZE7Riu+sbc5QafE3owla1/2d0Bogp9FLtJe0YyQeW2qLvZKcmlI + ftSQ== +ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=google.com; s=arc-20160816; + h=to:list-archive:list-unsubscribe:list-subscribe:precedence + :list-post:list-id:date:reply-to:from:subject:references:message-id + :mime-version:arc-authentication-results; + bh=DwvSiw5K7ryb4S8O/8HcIaGhJqbOxcXKsnPAr63iQZ4=; + b=U0Ac9Rqvv+tfqO9fCx+F79oZknn3rOv9N9ekViEuL5DtjpJxKDDkO1xw//sV3eRILT + nqGuxd2yQXwC4U+WAwraBwoLC3ScHb/9gWtzlrLCgv6WbNE7HZi5g6L8c0LWRN24cIe9 + AOdc/8fOdGoaL8yajrGEHgMz9B2KMltA9tZyxFOeKsyODxJ6iWjXcG1BSQTxERwosV3h + ch8AznQr7xLLvc/u9VTEqC5ome3RqsxKRxOGenEqIbCOr11sxwpZQdQcNR6faNRom3+2 + 6gz++4tVIV9cqYX1j9eEU/ufoUzBJ6Uzm0jMGZZQOHAF+YX3tZUEsPmc75PsvRCAIWby + urMg== +ARC-Authentication-Results: i=1; mx.google.com; + spf=pass (google.com: domain of postmaster-odoo@odoo-community.org designates 2a01:4f8:a0:430d::2 as permitted sender) smtp.mailfrom=postmaster-odoo@odoo-community.org; + dmarc=fail (p=QUARANTINE sp=QUARANTINE dis=QUARANTINE) header.from=laslabs.com +Return-Path: +Received: from odoo-community.org (odoo-community.org. [2a01:4f8:a0:430d::2]) + by mx.google.com with ESMTP id j72si1795626wmg.60.2017.09.12.10.37.55 + for ; + Tue, 12 Sep 2017 10:37:56 -0700 (PDT) +Received-SPF: pass (google.com: domain of postmaster-odoo@odoo-community.org designates 2a01:4f8:a0:430d::2 as permitted sender) client-ip=2a01:4f8:a0:430d::2; +Authentication-Results: mx.google.com; + spf=pass (google.com: domain of postmaster-odoo@odoo-community.org designates 2a01:4f8:a0:430d::2 as permitted sender) smtp.mailfrom=postmaster-odoo@odoo-community.org; + dmarc=fail (p=QUARANTINE sp=QUARANTINE dis=QUARANTINE) header.from=laslabs.com +Received: from odoo.odoo-community.org (localhost.localdomain [127.0.0.1]) + by odoo-community.org (Postfix) with ESMTP id DB5DC2EC2277; + Tue, 12 Sep 2017 19:37:53 +0200 (CEST) +Content-Type: multipart/mixed; boundary="===============7439524030966430607==" +MIME-Version: 1.0 +Message-Id: +references: <0db43737-b846-4890-6801-44ff9617e3b3@camptocamp.com> +Subject: Re: OCA Code sprint: sprint topics +From: Dave Lasley +Reply-To: "Odoo Community Association \(OCA\) Contributors" + +Date: Tue, 12 Sep 2017 17:37:53 -0000 +List-Id: contributors.odoo-community.org +List-Post: +Precedence: list +X-Auto-Response-Suppress: OOF +List-Subscribe: +List-Unsubscribe: +List-Archive: +To: "Contributors" + +--===============7439524030966430607== +Content-Type: multipart/alternative; + boundary="===============8317593469411551167==" +MIME-Version: 1.0 + +--===============8317593469411551167== +Content-Type: text/plain; charset="utf-8" +MIME-Version: 1.0 +Content-Transfer-Encoding: base64 + +VGhpcyBpcyBhIGZha2UsIHRlc3QgbWVzc2FnZQ== +--===============7439524030966430607==-- diff --git a/mail_outbound_static/tests/test_ir_mail_server.py b/mail_outbound_static/tests/test_ir_mail_server.py new file mode 100644 index 00000000..93fef504 --- /dev/null +++ b/mail_outbound_static/tests/test_ir_mail_server.py @@ -0,0 +1,67 @@ +# Copyright 2017 LasLabs Inc. +# License LGPL-3.0 or later (http://www.gnu.org/licenses/lgpl.html). + +import os +import threading + +from mock import MagicMock +from email import message_from_string + +from odoo.tests.common import TransactionCase + + +class TestIrMailServer(TransactionCase): + + def setUp(self): + super(TestIrMailServer, self).setUp() + self.email_from = 'derp@example.com' + self.email_from_another = 'another@example.com' + self.Model = self.env['ir.mail_server'] + self.Model.create({ + 'name': 'localhost', + 'smtp_host': 'localhost', + 'smtp_from': self.email_from, + }) + message_file = os.path.join( + os.path.dirname(os.path.realpath(__file__)), 'test.msg', + ) + with open(message_file, 'r') as fh: + self.message = message_from_string(fh.read()) + + def _send_mail(self, message=None, mail_server_id=None, smtp_server=None): + if message is None: + message = self.message + connect = MagicMock() + thread = threading.currentThread() + setattr(thread, 'testing', False) + try: + self.Model._patch_method('connect', connect) + try: + self.Model.send_email(message, mail_server_id, smtp_server) + finally: + self.Model._revert_method('connect') + finally: + setattr(thread, 'testing', True) + send_from, send_to, message_string = connect().sendmail.call_args[0] + return message_from_string(message_string) + + def test_send_email_injects_from_no_canonical(self): + """It should inject the FROM header correctly when no canonical name. + """ + self.message.replace_header('From', 'test@example.com') + message = self._send_mail() + self.assertEqual(message['From'], self.email_from) + + def test_send_email_injects_from_with_canonical(self): + """It should inject the FROM header correctly with a canonical name. + + Note that there is an extra `<` in the canonical name to test for + proper handling in the split. + """ + user = 'Test < User' + self.message.replace_header('From', '%s ' % user) + message = self._send_mail() + self.assertEqual( + message['From'], + '%s <%s>' % (user, self.email_from), + ) diff --git a/mail_outbound_static/views/ir_mail_server_view.xml b/mail_outbound_static/views/ir_mail_server_view.xml new file mode 100644 index 00000000..b74d4aa8 --- /dev/null +++ b/mail_outbound_static/views/ir_mail_server_view.xml @@ -0,0 +1,21 @@ + + + + + + + + IR Mail Server - From Address + ir.mail_server + + + + + + + + + diff --git a/setup/mail_outbound_static/odoo/addons/mail_outbound_static b/setup/mail_outbound_static/odoo/addons/mail_outbound_static new file mode 120000 index 00000000..a9b9cff5 --- /dev/null +++ b/setup/mail_outbound_static/odoo/addons/mail_outbound_static @@ -0,0 +1 @@ +../../../../mail_outbound_static \ No newline at end of file diff --git a/setup/mail_outbound_static/setup.py b/setup/mail_outbound_static/setup.py new file mode 100644 index 00000000..28c57bb6 --- /dev/null +++ b/setup/mail_outbound_static/setup.py @@ -0,0 +1,6 @@ +import setuptools + +setuptools.setup( + setup_requires=['setuptools-odoo'], + odoo_addon=True, +)