From 0058013c86231fc608f1324bc03586e3764760fe Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Thibault=20Delavall=C3=A9e?= <tde@odoo.com>
Date: Mon, 11 Apr 2022 11:34:21 +0200
Subject: [PATCH] [IMP] mail: split multi-emails partners for outgoing emails
PURPOSE
Be defensive when dealing with email fields, notably when having multi-emails
or email field containing an already-formatted email.
SPECIFICATIONS
When building the final 'email_to' of outgoing emails using 'formataddr' we
have issues if email contains multi emails or formatted email. Main fix of
this commit is to extract emails and rebuild the 'email_to' list based on
found emails.
E.g. partner Raoul - email: "Raoul" <raoul@raoul.fr>
-> before: to: "Raoul" <"Raoul" <raoul@raoul.fr>> (double format)
-> after: to: "Raoul" <raoul@raoul.fr>
E.g. partner Raoul - email: raoul1@raoul.fr, raoul2@raoul.fr
-> before: to: "Raoul" <raoul1@raoul.fr, raoul2@raoul.fr>
single email with multiple emails, depends on server fault tolerance)
-> after: to: "Raoul" <raoul1@raoul.fr>, "Raoul" <raoul2@raoul.fr>
multi emails
Fix that computation by using all normalized emails found in 'email' fields
and rebuilding a formatted email based on name + those emails. We do not
use `email_formatted` as it is not really multi-enabled. We prefer a local
defensive approach to be as tolerant as possible with respect to user inputs.
Task-2612945 (Mail: Defensive email formatting)
Part-of: odoo/odoo#74474
---
addons/mail/models/mail_mail.py | 9 ++++++++-
addons/test_mail/tests/test_mail_composer.py | 8 ++++++++
addons/test_mail/tests/test_mail_mail.py | 16 ++++++++++------
addons/test_mail/tests/test_message_post.py | 9 +++++----
addons/test_mass_mailing/tests/test_mailing.py | 2 ++
5 files changed, 33 insertions(+), 11 deletions(-)
diff --git a/addons/mail/models/mail_mail.py b/addons/mail/models/mail_mail.py
index 80d1ece80f38..399f82722beb 100644
--- a/addons/mail/models/mail_mail.py
+++ b/addons/mail/models/mail_mail.py
@@ -206,7 +206,14 @@ class MailMail(models.Model):
body = self._send_prepare_body()
body_alternative = tools.html2plaintext(body)
if partner:
- email_to = [tools.formataddr((partner.name or 'False', partner.email or 'False'))]
+ emails_normalized = tools.email_normalize_all(partner.email)
+ if emails_normalized:
+ email_to = [
+ tools.formataddr((partner.name or "False", email or "False"))
+ for email in emails_normalized
+ ]
+ else:
+ email_to = [tools.formataddr((partner.name or "False", partner.email or "False"))]
else:
email_to = tools.email_split_and_format(self.email_to)
res = {
diff --git a/addons/test_mail/tests/test_mail_composer.py b/addons/test_mail/tests/test_mail_composer.py
index 99b6664fa6b7..807b8f1000a7 100644
--- a/addons/test_mail/tests/test_mail_composer.py
+++ b/addons/test_mail/tests/test_mail_composer.py
@@ -734,6 +734,10 @@ class TestComposerResultsComment(TestMailComposer):
self.assertMailMail(
self.partner_1 + self.partner_2 + mailed_new_partners, 'sent',
author=self.partner_employee,
+ email_to_recipients=[
+ [self.partner_1.email_formatted],
+ [f'"{self.partner_2.name}" <valid.other.1@agrolait.com>', f'"{self.partner_2.name}" <valid.other.cc@agrolait.com>'],
+ ] + [[email] for email in mailed_new_partners.mapped('email_formatted')],
email_values={
'body_content': f'TemplateBody {self.test_record.name}',
'email_from': formataddr((self.user_employee.name, 'email.from.1@test.example.com,email.from.2@test.example.com')),
@@ -1165,6 +1169,10 @@ class TestComposerResultsMass(TestMailComposer):
self.partner_1 + self.partner_2 + mailed_new_partners,
'sent',
author=self.partner_employee,
+ email_to_recipients=[
+ [self.partner_1.email_formatted],
+ [f'"{self.partner_2.name}" <valid.other.1@agrolait.com>', f'"{self.partner_2.name}" <valid.other.cc@agrolait.com>'],
+ ] + [[email] for email in mailed_new_partners.mapped('email_formatted')],
email_values={
'body_content': f'TemplateBody {record.name}',
# currently holding multi-email 'email_from'
diff --git a/addons/test_mail/tests/test_mail_mail.py b/addons/test_mail/tests/test_mail_mail.py
index 9cc292c6dfd9..194baa3688ac 100644
--- a/addons/test_mail/tests/test_mail_mail.py
+++ b/addons/test_mail/tests/test_mail_mail.py
@@ -95,9 +95,9 @@ class TestMailMail(TestMailCommon):
sorted(sorted(_mail['email_to']) for _mail in self._mails),
sorted([sorted(['"Raoul, le Grand" <test.email.1@test.example.com>', '"Micheline, l\'immense" <test.email.2@test.example.com>']),
[tools.formataddr((self.user_employee.name, self.user_employee.email_normalized))],
- [tools.formataddr(("Tony Customer", '"Formatted Emails" <tony.customer@test.example.com>'))]
+ [tools.formataddr(("Tony Customer", 'tony.customer@test.example.com'))]
]),
- 'Mail (FIXME): double encapsulation of emails ("Tony" <"Formatted" <tony@e.com>>)'
+ 'Mail: formatting issues should have been removed as much as possible'
)
# Currently broken: CC are added to ALL emails (spammy)
self.assertEqual(
@@ -127,9 +127,11 @@ class TestMailMail(TestMailCommon):
sorted(sorted(_mail['email_to']) for _mail in self._mails),
sorted([sorted(['test.email.1@test.example.com', 'test.email.2@test.example.com']),
[tools.formataddr((self.user_employee.name, self.user_employee.email_normalized))],
- [tools.formataddr(("Tony Customer", 'tony.customer@test.example.com, norbert.customer@test.example.com'))]
+ sorted([tools.formataddr(("Tony Customer", 'tony.customer@test.example.com')),
+ tools.formataddr(("Tony Customer", 'norbert.customer@test.example.com'))]),
]),
- 'Mail: currenty broken (multi email in a single address) but supported by some providers ("Tony" <tony@e.com, tony2@e.com>)'
+ 'Mail: formatting issues should have been removed as much as possible (multi emails in a single address are managed '
+ 'like separate emails when sending with recipient_ids'
)
# Currently broken: CC are added to ALL emails (spammy)
self.assertEqual(
@@ -155,9 +157,11 @@ class TestMailMail(TestMailCommon):
sorted(sorted(_mail['email_to']) for _mail in self._mails),
sorted([sorted(['test.email.1@test.example.com', 'test.email.2@test.example.com']),
[tools.formataddr((self.user_employee.name, self.user_employee.email_normalized))],
- [tools.formataddr(("Tony Customer", 'tony.customer@test.example.com, "Norbert Customer" <norbert.customer@test.example.com>'))]
+ sorted([tools.formataddr(("Tony Customer", 'tony.customer@test.example.com')),
+ tools.formataddr(("Tony Customer", 'norbert.customer@test.example.com'))]),
]),
- 'Mail: currently broken, double encapsulation with formatting ("Tony" <tony@e.com, "Tony2" <tony2@e.com>>)'
+ 'Mail: formatting issues should have been removed as much as possible (multi emails in a single address are managed '
+ 'like separate emails when sending with recipient_ids (and partner name is always used as name part)'
)
# Currently broken: CC are added to ALL emails (spammy)
self.assertEqual(
diff --git a/addons/test_mail/tests/test_message_post.py b/addons/test_mail/tests/test_message_post.py
index d2b450100a9c..cabdbadef694 100644
--- a/addons/test_mail/tests/test_message_post.py
+++ b/addons/test_mail/tests/test_message_post.py
@@ -249,10 +249,11 @@ class TestMessagePost(TestMailCommon, TestRecipients):
False, '', ' ', # falsy
]
expected_tos = [
- # Currently semi-broken: sending to an incorrect email "Name" <address1, address2>
- [f'"{self.partner_1.name}" <valid.lelitre@agrolait.com, valid.lelitre.cc@agrolait.com>',],
- # Currently broken: sending to an incorrect email "Name" <"Name" <address>>
- [f'"{self.partner_1.name}" <"Valid Lelitre" <valid.lelitre@agrolait.com>>',],
+ # Sends multi-emails
+ [f'"{self.partner_1.name}" <valid.lelitre@agrolait.com>',
+ f'"{self.partner_1.name}" <valid.lelitre.cc@agrolait.com>',],
+ # Avoid double encapsulation
+ [f'"{self.partner_1.name}" <valid.lelitre@agrolait.com>',],
# sent "normally": formats email based on wrong / falsy email
[f'"{self.partner_1.name}" <@wrong>',],
[f'"{self.partner_1.name}" <@False>',],
diff --git a/addons/test_mass_mailing/tests/test_mailing.py b/addons/test_mass_mailing/tests/test_mailing.py
index 83c6bb283804..ae4de93985c5 100644
--- a/addons/test_mass_mailing/tests/test_mailing.py
+++ b/addons/test_mass_mailing/tests/test_mailing.py
@@ -211,6 +211,8 @@ class TestMassMailing(TestMassMailCommon):
'partner': customer_mult,
'state': 'ignored'},
{'email': 'test.customer.format@example.com',
+ # mail to avoids double encapsulation
+ 'email_to_recipients': [[f'"{customer_fmt.name}" <test.customer.format@example.com>']],
'failure_type': False,
'partner': customer_fmt,
'state': 'sent'},
--
GitLab