diff --git a/mail_outbound_static/README.rst b/mail_outbound_static/README.rst new file mode 100644 index 000000000..6fd9b5114 --- /dev/null +++ b/mail_outbound_static/README.rst @@ -0,0 +1,110 @@ +==================== +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/15.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-15-0/social-15-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/15.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 dynamically configured From header, with the sender's e-mail +being appended into the proper Sender header instead. To accomplish this we: + +* Add a domain whitelist field in the mail server model. This one represent an + allowed Domains list separated by commas. If there is not given SMTP server + it will let us to search the proper mail server to be used to send the messages + where the message 'From' email domain match with the domain whitelist. If + there is not mail server that matches then will use the default mail server to + send the message. + +* Add a Email From field that will let us to email from a specific address taking + into account this conditions: + + 1) If the sender domain match with the domain whitelist then the original + message's 'From' will remain as it is and will not be changed because the + mail server is able to send in the name of the sender domain. + + 2) If the original message's 'From' does not match with the domain whitelist + then the email From is replaced with the Email From field value. + +* Add compatibility to define the smtp information in Odoo config file. Both + smtp_from and smtp_whitelist_domain values will be used if there is not mail + server configured in the system. + +**Table of contents** + +.. contents:: + :local: + +Usage +===== + +* Navigate to an Outbound Email Server +* Set the `Email From` option to an email address +* Set the `Domain Whitelist` option with the domain whitelist + +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 +~~~~~~~ + +* brain-tec AG +* LasLabs +* Adhoc SA + +Contributors +~~~~~~~~~~~~ + +* Frédéric Garbely +* Dave Lasley +* Lorenzo Battistini +* Pierre Pizzetta +* Katherine Zaoral +* Juan José Scarafía + +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 000000000..0639de1b6 --- /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 000000000..ca4068131 --- /dev/null +++ b/mail_outbound_static/__manifest__.py @@ -0,0 +1,16 @@ +# Copyright 2016-2022 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": "16.0.1.0.0", + "category": "Discuss", + "website": "https://github.com/OCA/social", + "author": "brain-tec AG, LasLabs, Adhoc SA, 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/i18n/es.po b/mail_outbound_static/i18n/es.po new file mode 100644 index 000000000..8e0d95675 --- /dev/null +++ b/mail_outbound_static/i18n/es.po @@ -0,0 +1,73 @@ +# Translation of Odoo Server. +# This file contains the translation of the following modules: +# * mail_outbound_static +# +msgid "" +msgstr "" +"Project-Id-Version: Odoo Server 13.0\n" +"Report-Msgid-Bugs-To: \n" +"POT-Creation-Date: 2020-09-03 12:53+0000\n" +"PO-Revision-Date: 2020-09-03 12:53+0000\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_outbound_static +#: code:addons/mail_outbound_static/models/ir_mail_server.py:0 +#, python-format +msgid "" +"%s is not a valid domain. Please define a list of valid domains separated by" +" comma" +msgstr "" +"%s no es un dominio válido. Por favor defina una lista de dominios validos separados por" +" comas" + +#. module: mail_outbound_static +#: model:ir.model.fields,help:mail_outbound_static.field_ir_mail_server__domain_whitelist +msgid "" +"Allowed Domains list separated by commas. If there is not given SMTP server " +"it will let us to search the proper mail server to be used to sent the " +"messages where the message 'From' email domain match with the domain " +"whitelist." +msgstr "" +"Lista de dominios permitidos separados por comas. Si no se ha seleccionado " +"un servidor SMTP nos permitirá seleccionar el servidor de mail apropiado " +"para enviar los mensajes donde el dominio del email del 'De' coincida con la" +" lista blanca de dominios." + +#. module: mail_outbound_static +#: model:ir.model.fields,field_description:mail_outbound_static.field_ir_mail_server__domain_whitelist +msgid "Domain Whitelist" +msgstr "Lista blanca de dominios" + +#. module: mail_outbound_static +#: model:ir.model.fields,field_description:mail_outbound_static.field_ir_mail_server__smtp_from +msgid "Email From" +msgstr "Email De" + +#. module: mail_outbound_static +#: model:ir.model,name:mail_outbound_static.model_ir_mail_server +msgid "Mail Server" +msgstr "Servidor de correo" + +#. module: mail_outbound_static +#: code:addons/mail_outbound_static/models/ir_mail_server.py:0 +#, python-format +msgid "Not a valid Email From" +msgstr "No es un Email De válido" + +#. module: mail_outbound_static +#: model:ir.model.fields,help:mail_outbound_static.field_ir_mail_server__smtp_from +msgid "" +"Set this in order to email from a specific address. If the original " +"message's 'From' does not match with the domain whitelist then it is " +"replaced with this value. If does match with the domain whitelist then the " +"original message's 'From' will not change" +msgstr "" +"Definalo para usar un dirección de correo 'De' especifica. Si el 'De' del " +"mensaje original no coincide con la lista blanca de dominios entonces este " +"será remplazado con este valor. Si coincide con la lista blanca de dominios " +"entonces el 'De' del mensajee original no cambiará" diff --git a/mail_outbound_static/i18n/mail_outbound_static.pot b/mail_outbound_static/i18n/mail_outbound_static.pot new file mode 100644 index 000000000..5a0c79898 --- /dev/null +++ b/mail_outbound_static/i18n/mail_outbound_static.pot @@ -0,0 +1,61 @@ +# Translation of Odoo Server. +# This file contains the translation of the following modules: +# * mail_outbound_static +# +msgid "" +msgstr "" +"Project-Id-Version: Odoo Server 15.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_outbound_static +#: code:addons/mail_outbound_static/models/ir_mail_server.py:0 +#, python-format +msgid "" +"%s is not a valid domain. Please define a list of valid domains separated by" +" comma" +msgstr "" + +#. module: mail_outbound_static +#: model:ir.model.fields,help:mail_outbound_static.field_ir_mail_server__domain_whitelist +msgid "" +"Allowed Domains list separated by commas. If there is not given SMTP server " +"it will let us to search the proper mail server to be used to sent the " +"messages where the message 'From' email domain match with the domain " +"whitelist." +msgstr "" + +#. module: mail_outbound_static +#: model:ir.model.fields,field_description:mail_outbound_static.field_ir_mail_server__domain_whitelist +msgid "Domain Whitelist" +msgstr "" + +#. module: mail_outbound_static +#: model:ir.model.fields,field_description:mail_outbound_static.field_ir_mail_server__smtp_from +msgid "Email From" +msgstr "" + +#. module: mail_outbound_static +#: model:ir.model,name:mail_outbound_static.model_ir_mail_server +msgid "Mail Server" +msgstr "" + +#. module: mail_outbound_static +#: code:addons/mail_outbound_static/models/ir_mail_server.py:0 +#, python-format +msgid "Not a valid Email From" +msgstr "" + +#. module: mail_outbound_static +#: model:ir.model.fields,help:mail_outbound_static.field_ir_mail_server__smtp_from +msgid "" +"Set this in order to email from a specific address. If the original " +"message's 'From' does not match with the domain whitelist then it is " +"replaced with this value. If does match with the domain whitelist then the " +"original message's 'From' will not change" +msgstr "" diff --git a/mail_outbound_static/models/__init__.py b/mail_outbound_static/models/__init__.py new file mode 100644 index 000000000..fbf8a561b --- /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 000000000..1f8936408 --- /dev/null +++ b/mail_outbound_static/models/ir_mail_server.py @@ -0,0 +1,146 @@ +# Copyright 2017 LasLabs Inc. +# License LGPL-3.0 or later (http://www.gnu.org/licenses/lgpl.html). + +import re +from email.utils import formataddr, parseaddr + +from odoo import _, api, fields, models, tools +from odoo.exceptions import ValidationError + + +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." + " If the original message's 'From' does not match with the domain" + " whitelist then it is replaced with this value. If does match with the" + " domain whitelist then the original message's 'From' will not change", + ) + domain_whitelist = fields.Char( + help="Allowed Domains list separated by commas. If there is not given" + " SMTP server it will let us to search the proper mail server to be" + " used to sent the messages where the message 'From' email domain" + " match with the domain whitelist." + ) + + @api.constrains("domain_whitelist") + def check_valid_domain_whitelist(self): + if self.domain_whitelist: + domains = list(self.domain_whitelist.split(",")) + for domain in domains: + if not self._is_valid_domain(domain): + raise ValidationError( + _( + "%s is not a valid domain. Please define a list of" + " valid domains separated by comma" + ) + % (domain) + ) + + @api.constrains("smtp_from") + def check_valid_smtp_from(self): + if self.smtp_from: + match = re.match( + r"^[_a-z0-9-]+(\.[_a-z0-9-]+)*@[a-z0-9-]+(\.[a-z0-9-]+)*(\." + r"[a-z]{2,4})$", + self.smtp_from, + ) + if match is None: + raise ValidationError(_("Not a valid Email From")) + + def _is_valid_domain(self, domain_name): + domain_regex = ( + r"(([\da-zA-Z])([_\w-]{,62})\.){,127}(([\da-zA-Z])" + r"[_\w-]{,61})?([\da-zA-Z]\.((xn\-\-[a-zA-Z\d]+)|([a-zA-Z\d]{2,})))" + ) + domain_regex = "{}$".format(domain_regex) + valid_domain_name_regex = re.compile(domain_regex, re.IGNORECASE) + domain_name = domain_name.lower().strip() + return True if re.match(valid_domain_name_regex, domain_name) else False + + @api.model + def _get_domain_whitelist(self, domain_whitelist_string): + res = domain_whitelist_string.split(",") if domain_whitelist_string else [] + res = [item.strip() for item in res] + return res + + @api.model + def send_email( + self, message, mail_server_id=None, smtp_server=None, *args, **kwargs + ): + # Get email_from and name_from + if message["From"].count("<") > 1: + split_from = message["From"].rsplit(" <", 1) + name_from = split_from[0] + email_from = split_from[-1].replace(">", "") + else: + name_from, email_from = parseaddr(message["From"]) + + email_domain = email_from.split("@")[1] + + # Replicate logic from core to get mail server + # Get proper mail server to use + if not smtp_server and not mail_server_id: + mail_server_id = self._get_mail_sever(email_domain) + + # If not mail sever defined use smtp_from defined in odoo config + if mail_server_id: + mail_server = self.sudo().browse(mail_server_id) + domain_whitelist = mail_server.domain_whitelist + smtp_from = mail_server.smtp_from + else: + domain_whitelist = tools.config.get("smtp_domain_whitelist") + smtp_from = tools.config.get("smtp_from") + + domain_whitelist = self._get_domain_whitelist(domain_whitelist) + + # Replace the From only if needed + if smtp_from and (not domain_whitelist or email_domain not in domain_whitelist): + email_from = formataddr((name_from, smtp_from)) + message.replace_header("From", email_from) + bounce_alias = ( + self.env["ir.config_parameter"].sudo().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 + ) + + @tools.ormcache("email_domain") + def _get_mail_sever(self, email_domain): + """return the mail server id that match with the domain_whitelist + If not match then return the default mail server id available one""" + mail_server_id = None + for item in self.sudo().search( + [("domain_whitelist", "!=", False)], order="sequence" + ): + domain_whitelist = self._get_domain_whitelist(item.domain_whitelist) + if email_domain in domain_whitelist: + mail_server_id = item.id + break + if not mail_server_id: + mail_server_id = self.sudo().search([], order="sequence", limit=1).id + return mail_server_id + + @api.model_create_multi + def create(self, vals_list): + self.clear_caches() + return super().create(vals_list) + + def write(self, values): + self.clear_caches() + return super().write(values) + + def unlink(self): + self.clear_caches() + return super().unlink() diff --git a/mail_outbound_static/readme/CONTRIBUTORS.rst b/mail_outbound_static/readme/CONTRIBUTORS.rst new file mode 100644 index 000000000..af6791baa --- /dev/null +++ b/mail_outbound_static/readme/CONTRIBUTORS.rst @@ -0,0 +1,6 @@ +* Frédéric Garbely +* Dave Lasley +* Lorenzo Battistini +* Pierre Pizzetta +* Katherine Zaoral +* Juan José Scarafía diff --git a/mail_outbound_static/readme/DESCRIPTION.rst b/mail_outbound_static/readme/DESCRIPTION.rst new file mode 100644 index 000000000..b4ffa0ac6 --- /dev/null +++ b/mail_outbound_static/readme/DESCRIPTION.rst @@ -0,0 +1,24 @@ +This module brings Odoo outbound emails in to strict compliance with RFC-2822 +by allowing for a dynamically configured From header, with the sender's e-mail +being appended into the proper Sender header instead. To accomplish this we: + +* Add a domain whitelist field in the mail server model. This one represent an + allowed Domains list separated by commas. If there is not given SMTP server + it will let us to search the proper mail server to be used to send the messages + where the message 'From' email domain match with the domain whitelist. If + there is not mail server that matches then will use the default mail server to + send the message. + +* Add a Email From field that will let us to email from a specific address taking + into account this conditions: + + 1) If the sender domain match with the domain whitelist then the original + message's 'From' will remain as it is and will not be changed because the + mail server is able to send in the name of the sender domain. + + 2) If the original message's 'From' does not match with the domain whitelist + then the email From is replaced with the Email From field value. + +* Add compatibility to define the smtp information in Odoo config file. Both + smtp_from and smtp_whitelist_domain values will be used if there is not mail + server configured in the system. diff --git a/mail_outbound_static/readme/ROADMAP.rst b/mail_outbound_static/readme/ROADMAP.rst new file mode 100644 index 000000000..e69de29bb diff --git a/mail_outbound_static/readme/USAGE.rst b/mail_outbound_static/readme/USAGE.rst new file mode 100644 index 000000000..195f5a939 --- /dev/null +++ b/mail_outbound_static/readme/USAGE.rst @@ -0,0 +1,3 @@ +* Navigate to an Outbound Email Server +* Set the `Email From` option to an email address +* Set the `Domain Whitelist` option with the domain whitelist diff --git a/mail_outbound_static/static/description/icon.png b/mail_outbound_static/static/description/icon.png new file mode 100644 index 000000000..3a0328b51 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 000000000..aa75a6202 --- /dev/null +++ b/mail_outbound_static/static/description/index.html @@ -0,0 +1,457 @@ + + + + + + +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 dynamically configured From header, with the sender’s e-mail +being appended into the proper Sender header instead. To accomplish this we:

+
    +
  • Add a domain whitelist field in the mail server model. This one represent an +allowed Domains list separated by commas. If there is not given SMTP server +it will let us to search the proper mail server to be used to send the messages +where the message ‘From’ email domain match with the domain whitelist. If +there is not mail server that matches then will use the default mail server to +send the message.
    • +
  • Add a Email From field that will let us to email from a specific address taking +into account this conditions:
      +
    1. If the sender domain match with the domain whitelist then the original +message’s ‘From’ will remain as it is and will not be changed because the +mail server is able to send in the name of the sender domain.
      2. +
    2. If the original message’s ‘From’ does not match with the domain whitelist +then the email From is replaced with the Email From field value.
      3. +
    +
    • +
  • Add compatibility to define the smtp information in Odoo config file. Both +smtp_from and smtp_whitelist_domain values will be used if there is not mail +server configured in the system.
    • +
+

Table of contents

+ +
+

Usage

+
    +
  • Navigate to an Outbound Email Server
    • +
  • Set the Email From option to an email address
    • +
  • Set the Domain Whitelist option with the domain whitelist
    • +
+
+
+

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

+
    +
  • brain-tec AG
    • +
  • LasLabs
    • +
  • Adhoc SA
    • +
+
+
+

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 000000000..8b601d0ba --- /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 000000000..1f0b96da3 --- /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 000000000..c5f05b0d5 --- /dev/null +++ b/mail_outbound_static/tests/test_ir_mail_server.py @@ -0,0 +1,369 @@ +# Copyright 2017 LasLabs Inc. +# License LGPL-3.0 or later (http://www.gnu.org/licenses/lgpl.html). + +import logging +import os +from email import message_from_string + +import odoo.tools as tools +from odoo.exceptions import ValidationError +from odoo.tests.common import TransactionCase + +from odoo.addons.base.tests.common import MockSmtplibCase + +_logger = logging.getLogger(__name__) + + +class TestIrMailServer(TransactionCase, MockSmtplibCase): + @classmethod + def setUpClass(cls): + super().setUpClass() + cls.email_from = "derp@example.com" + cls.email_from_another = "another@example.com" + cls.IrMailServer = cls.env["ir.mail_server"] + cls.parameter_model = cls.env["ir.config_parameter"] + cls._delete_mail_servers() + cls.IrMailServer.create( + { + "name": "localhost", + "smtp_host": "localhost", + "smtp_from": cls.email_from, + } + ) + message_file = os.path.join( + os.path.dirname(os.path.realpath(__file__)), "test.msg" + ) + with open(message_file, "r") as fh: + cls.message = message_from_string(fh.read()) + + @classmethod + def _delete_mail_servers(cls): + """Delete all available mail servers""" + all_mail_servers = cls.IrMailServer.search([]) + if all_mail_servers: + all_mail_servers.unlink() + + def _init_mail_server_domain_whilelist_based(self): + self._delete_mail_servers() + self.assertFalse(self.IrMailServer.search([])) + self.mail_server_domainone = self.IrMailServer.create( + { + "name": "sandbox domainone", + "smtp_host": "localhost", + "smtp_from": "notifications@domainone.com", + "domain_whitelist": "domainone.com", + } + ) + self.mail_server_domaintwo = self.IrMailServer.create( + { + "name": "sandbox domaintwo", + "smtp_host": "localhost", + "smtp_from": "hola@domaintwo.com", + "domain_whitelist": "domaintwo.com", + } + ) + self.mail_server_domainthree = self.IrMailServer.create( + { + "name": "sandbox domainthree", + "smtp_host": "localhost", + "smtp_from": "notifications@domainthree.com", + "domain_whitelist": "domainthree.com,domainmulti.com", + } + ) + + def _skip_test(self, reason): + _logger.warning(reason) + self.skipTest(reason) + + def _send_mail( + self, + message, + mail_server_id=None, + smtp_server=None, + smtp_port=None, + smtp_user=None, + smtp_password=None, + smtp_encryption=None, + smtp_ssl_certificate=None, + smtp_ssl_private_key=None, + smtp_debug=False, + smtp_session=None, + ): + smtp = smtp_session + if not smtp: + smtp = self.IrMailServer.connect( + smtp_server, + smtp_port, + smtp_user, + smtp_password, + smtp_encryption, + smtp_from=message["From"], + ssl_certificate=smtp_ssl_certificate, + ssl_private_key=smtp_ssl_private_key, + smtp_debug=smtp_debug, + mail_server_id=mail_server_id, + ) + + send_from, send_to, message_string = self.IrMailServer._prepare_email_message( + message, smtp + ) + self.IrMailServer.send_email(message) + return 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") + # A mail server is configured for the email + with self.mock_smtplib_connection(): + message = self._send_mail(self.message) + 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) + bounce_parameter = self.parameter_model.search( + [("key", "=", "mail.bounce.alias")] + ) + if bounce_parameter: + # Remove mail.bounce.alias to test Return-Path + bounce_parameter.unlink() + # Also check passing mail_server_id + mail_server_id = ( + self.IrMailServer.sudo().search([], order="sequence", limit=1)[0].id + ) + # A mail server is configured for the email + with self.mock_smtplib_connection(): + message = self._send_mail(self.message, mail_server_id=mail_server_id) + self.assertEqual(message["From"], '"{}" <{}>'.format(user, self.email_from)) + self.assertEqual( + message["Return-Path"], '"{}" <{}>'.format(user, self.email_from) + ) + + def test_01_from_outgoing_server_domainone(self): + self._init_mail_server_domain_whilelist_based() + domain = "domainone.com" + email_from = "Mitchell Admin " % domain + expected_mail_server = self.mail_server_domainone + + self.message.replace_header("From", email_from) + # A mail server is configured for the email + with self.mock_smtplib_connection(): + message = self._send_mail(self.message) + self.assertEqual(message["From"], email_from) + + used_mail_server = self.IrMailServer._get_mail_sever(domain) + used_mail_server = self.IrMailServer.browse(used_mail_server) + self.assertEqual( + used_mail_server, + expected_mail_server, + "It using %s but we expect to use %s" + % (used_mail_server.name, expected_mail_server.name), + ) + + def test_02_from_outgoing_server_domaintwo(self): + self._init_mail_server_domain_whilelist_based() + domain = "domaintwo.com" + email_from = "Mitchell Admin " % domain + expected_mail_server = self.mail_server_domaintwo + + self.message.replace_header("From", email_from) + # A mail server is configured for the email + with self.mock_smtplib_connection(): + message = self._send_mail(self.message) + self.assertEqual(message["From"], email_from) + + used_mail_server = self.IrMailServer._get_mail_sever(domain) + used_mail_server = self.IrMailServer.browse(used_mail_server) + self.assertEqual( + used_mail_server, + expected_mail_server, + "It using %s but we expect to use %s" + % (used_mail_server.name, expected_mail_server.name), + ) + + def test_03_from_outgoing_server_another(self): + self._init_mail_server_domain_whilelist_based() + domain = "example.com" + email_from = "Mitchell Admin " % domain + expected_mail_server = self.mail_server_domainone + + self.message.replace_header("From", email_from) + # A mail server is configured for the email + with self.mock_smtplib_connection(): + message = self._send_mail(self.message) + self.assertEqual( + message["From"], "Mitchell Admin <%s>" % expected_mail_server.smtp_from + ) + + used_mail_server = self.IrMailServer._get_mail_sever(domain) + used_mail_server = self.IrMailServer.browse(used_mail_server) + self.assertEqual( + used_mail_server, + expected_mail_server, + "It using %s but we expect to use %s" + % (used_mail_server.name, expected_mail_server.name), + ) + + def test_04_from_outgoing_server_none_use_config(self): + self._init_mail_server_domain_whilelist_based() + domain = "example.com" + email_from = "Mitchell Admin " % domain + + self._delete_mail_servers() + self.assertFalse(self.IrMailServer.search([])) + # Find config values + config_smtp_from = tools.config.get("smtp_from") + config_smtp_domain_whitelist = tools.config.get("smtp_domain_whitelist") + if not config_smtp_from or not config_smtp_domain_whitelist: + self._skip_test( + "Cannot test transactions because there is not either smtp_from" + " or smtp_domain_whitelist." + ) + + self.message.replace_header("From", email_from) + # A mail server is configured for the email + with self.mock_smtplib_connection(): + message = self._send_mail(self.message) + self.assertEqual(message["From"], "Mitchell Admin <%s>" % config_smtp_from) + + used_mail_server = self.IrMailServer._get_mail_sever("example.com") + used_mail_server = self.IrMailServer.browse(used_mail_server) + self.assertFalse( + used_mail_server, "using this mail server %s" % (used_mail_server.name) + ) + + def test_05_from_outgoing_server_none_same_domain(self): + self._init_mail_server_domain_whilelist_based() + + # Find config values + config_smtp_from = tools.config.get("smtp_from") + config_smtp_domain_whitelist = domain = tools.config.get( + "smtp_domain_whitelist" + ) + if not config_smtp_from or not config_smtp_domain_whitelist: + self._skip_test( + "Cannot test transactions because there is not either smtp_from" + " or smtp_domain_whitelist." + ) + + email_from = "Mitchell Admin " % domain + + self._delete_mail_servers() + self.assertFalse(self.IrMailServer.search([])) + self.message.replace_header("From", email_from) + # A mail server is configured for the email + with self.mock_smtplib_connection(): + message = self._send_mail(self.message) + self.assertEqual(message["From"], email_from) + + used_mail_server = self.IrMailServer._get_mail_sever(domain) + used_mail_server = self.IrMailServer.browse(used_mail_server) + self.assertFalse(used_mail_server) + + def test_06_from_outgoing_server_no_name_from(self): + self._init_mail_server_domain_whilelist_based() + domain = "example.com" + email_from = "test@%s" % domain + expected_mail_server = self.mail_server_domainone + + self.message.replace_header("From", email_from) + # A mail server is configured for the email + with self.mock_smtplib_connection(): + message = self._send_mail(self.message) + self.assertEqual(message["From"], expected_mail_server.smtp_from) + + used_mail_server = self.IrMailServer._get_mail_sever(domain) + used_mail_server = self.IrMailServer.browse(used_mail_server) + self.assertEqual( + used_mail_server, + expected_mail_server, + "It using %s but we expect to use %s" + % (used_mail_server.name, expected_mail_server.name), + ) + + def test_07_from_outgoing_server_multidomain_1(self): + self._init_mail_server_domain_whilelist_based() + domain = "domainthree.com" + email_from = "Mitchell Admin " % domain + expected_mail_server = self.mail_server_domainthree + + self.message.replace_header("From", email_from) + # A mail server is configured for the email + with self.mock_smtplib_connection(): + message = self._send_mail(self.message) + self.assertEqual(message["From"], email_from) + + used_mail_server = self.IrMailServer._get_mail_sever(domain) + used_mail_server = self.IrMailServer.browse(used_mail_server) + self.assertEqual( + used_mail_server, + expected_mail_server, + "It using %s but we expect to use %s" + % (used_mail_server.name, expected_mail_server.name), + ) + + def test_08_from_outgoing_server_multidomain_3(self): + self._init_mail_server_domain_whilelist_based() + domain = "domainmulti.com" + email_from = "test@%s" % domain + expected_mail_server = self.mail_server_domainthree + + self.message.replace_header("From", email_from) + # A mail server is configured for the email + with self.mock_smtplib_connection(): + message = self._send_mail(self.message) + self.assertEqual(message["From"], email_from) + + used_mail_server = self.IrMailServer._get_mail_sever(domain) + used_mail_server = self.IrMailServer.browse(used_mail_server) + self.assertEqual( + used_mail_server, + expected_mail_server, + "It using %s but we expect to use %s" + % (used_mail_server.name, expected_mail_server.name), + ) + + def test_09_not_valid_domain_whitelist(self): + self._init_mail_server_domain_whilelist_based() + mail_server = self.mail_server_domainone + mail_server.domain_whitelist = "example.com" + error_msg = ( + "%s is not a valid domain. Please define a list of valid" + " domains separated by comma" + ) + + with self.assertRaisesRegex(ValidationError, error_msg % "asdasd"): + mail_server.domain_whitelist = "asdasd" + + with self.assertRaisesRegex(ValidationError, error_msg % "asdasd"): + mail_server.domain_whitelist = "example.com, asdasd" + + with self.assertRaisesRegex(ValidationError, error_msg % "invalid"): + mail_server.domain_whitelist = "example.com; invalid" + + with self.assertRaisesRegex(ValidationError, error_msg % ";"): + mail_server.domain_whitelist = ";" + + with self.assertRaisesRegex(ValidationError, error_msg % "."): + mail_server.domain_whitelist = "hola.com,." + + def test_10_not_valid_smtp_from(self): + self._init_mail_server_domain_whilelist_based() + mail_server = self.mail_server_domainone + error_msg = "Not a valid Email From" + + with self.assertRaisesRegex(ValidationError, error_msg): + mail_server.smtp_from = "asdasd" + + with self.assertRaisesRegex(ValidationError, error_msg): + mail_server.smtp_from = "example.com" + + with self.assertRaisesRegex(ValidationError, error_msg): + mail_server.smtp_from = "." + + mail_server.smtp_from = "notifications@test.com" 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 000000000..5b533e96b --- /dev/null +++ b/mail_outbound_static/views/ir_mail_server_view.xml @@ -0,0 +1,20 @@ + + + + + + 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 000000000..a9b9cff56 --- /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 000000000..28c57bb64 --- /dev/null +++ b/setup/mail_outbound_static/setup.py @@ -0,0 +1,6 @@ +import setuptools + +setuptools.setup( + setup_requires=['setuptools-odoo'], + odoo_addon=True, +)