# -*- coding: utf-8 -*- # Part of Odoo. See LICENSE file for full copyright and licensing details. from itertools import product from unittest.mock import patch from odoo.addons.mail.tests.common import mail_new_test_user from odoo.addons.test_mail.models.test_mail_models import MailTestTicket from odoo.addons.test_mail.tests.common import TestMailCommon, TestRecipients from odoo.exceptions import AccessError from odoo.tests import tagged from odoo.tests.common import users, Form from odoo.tools import email_normalize, mute_logger, formataddr @tagged('mail_composer') class TestMailComposer(TestMailCommon, TestRecipients): """ Test Composer internals """ @classmethod def setUpClass(cls): super(TestMailComposer, cls).setUpClass() # ensure employee can create partners, necessary for templates cls.user_employee.write({ 'groups_id': [(4, cls.env.ref('base.group_partner_manager').id)], }) cls.user_employee_2 = mail_new_test_user( cls.env, login='employee2', groups='base.group_user', notification_type='email', email='eglantine@example.com', name='Eglantine Employee', signature='--\nEglantine') cls.partner_employee_2 = cls.user_employee_2.partner_id # User without the group "mail.group_mail_template_editor" cls.user_rendering_restricted = mail_new_test_user( cls.env, login='user_rendering_restricted', groups='base.group_user', company_id=cls.company_admin.id, name='Code Template Restricted User', notification_type='inbox', signature='--\nErnest' ) cls.env.ref('mail.group_mail_template_editor').users -= cls.user_rendering_restricted cls.test_record = cls.env['mail.test.ticket'].with_context(cls._test_context).create({ 'name': 'TestRecord', 'customer_id': cls.partner_1.id, 'user_id': cls.user_employee_2.id, }) cls.test_records, cls.test_partners = cls._create_records_for_batch( 'mail.test.ticket', 2, additional_values={'user_id': cls.user_employee_2.id}, ) cls.test_report = cls.env['ir.actions.report'].create({ 'name': 'Test Report on mail test ticket', 'model': 'mail.test.ticket', 'report_type': 'qweb-pdf', 'report_name': 'test_mail.mail_test_ticket_test_template', }) cls.test_record_report = cls.env['ir.actions.report']._render_qweb_pdf(cls.test_report, cls.test_record.ids) cls.test_from = '"John Doe" ' cls.template = cls.env['mail.template'].create({ 'auto_delete': True, 'name': 'TestTemplate', 'subject': 'TemplateSubject {{ object.name }}', 'body_html': '

TemplateBody

', 'partner_to': '{{ object.customer_id.id if object.customer_id else "" }}', 'email_to': '{{ (object.email_from if not object.customer_id else "") }}', 'email_from': '{{ (object.user_id.email_formatted or user.email_formatted) }}', 'lang': '{{ object.customer_id.lang }}', 'mail_server_id': cls.mail_server_domain.id, 'model_id': cls.env['ir.model']._get('mail.test.ticket').id, 'reply_to': '{{ ctx.get("custom_reply_to") or "info@test.example.com" }}', }) # activate translations cls._activate_multi_lang( layout_arch_db=None, # use default mail.test_layout test_record=cls.test_records, test_template=cls.template, ) def _get_web_context(self, records, add_web=True, **values): """ Helper to generate composer context. Will make tests a bit less verbose. :param add_web: add web context, generally making noise especially in mass mail mode (active_id/ids both present in context) """ base_context = { 'default_model': records._name, } if len(records) == 1: base_context['default_composition_mode'] = 'comment' base_context['default_res_id'] = records.id else: base_context['default_composition_mode'] = 'mass_mail' base_context['active_ids'] = records.ids if add_web: base_context['active_model'] = records._name base_context['active_id'] = records[0].id if values: base_context.update(**values) return base_context @tagged('mail_composer') class TestComposerForm(TestMailComposer): def test_assert_initial_data(self): """ Ensure class initial data to ease understanding """ self.assertTrue(self.template.auto_delete) self.assertEqual(len(self.test_records), 2) self.assertEqual(self.test_records.user_id, self.user_employee_2) self.assertEqual(self.test_records.message_partner_ids, self.partner_employee_2) @users('employee') def test_mail_composer_comment(self): composer_form = Form(self.env['mail.compose.message'].with_context( self._get_web_context(self.test_record, add_web=True) )) self.assertFalse(composer_form.auto_delete) self.assertFalse(composer_form.auto_delete_message) self.assertEqual(composer_form.author_id, self.env.user.partner_id) self.assertFalse(composer_form.body) self.assertEqual(composer_form.composition_mode, 'comment') self.assertEqual(composer_form.email_from, self.env.user.email_formatted) self.assertFalse(composer_form.mail_server_id) self.assertEqual(composer_form.model, self.test_record._name) self.assertFalse(composer_form.partner_ids) self.assertEqual(composer_form.record_name, self.test_record.name, 'MailComposer: comment mode should compute record name') self.assertFalse(composer_form.reply_to) self.assertFalse(composer_form.reply_to_force_new) self.assertEqual(composer_form.res_id, self.test_record.id) self.assertEqual( composer_form.subject, 'Re: %s' % self.test_record.name, 'MailComposer: comment mode should have default subject Re: record_name') self.assertEqual(composer_form.subtype_id, self.env.ref('mail.mt_comment')) @users('employee') def test_mail_composer_comment_attachments(self): """Tests that all attachments are added to the composer, static attachments are not duplicated and while reports are re-generated, and that intermediary attachments are dropped.""" attachment_data = self._generate_attachments_data(2, self.template._name, self.template.id) template_1 = self.template.copy({ 'attachment_ids': [(0, 0, a) for a in attachment_data], 'report_name': 'TestReport for {{ object.name }}.html', # test cursor forces html 'report_template': self.test_report.id, }) template_1_attachments = template_1.attachment_ids self.assertEqual(len(template_1_attachments), 2) template_2 = self.template.copy({ 'attachment_ids': False, 'report_template': self.test_report.id, }) # begins without attachments composer_form = Form(self.env['mail.compose.message'].with_context( self._get_web_context(self.test_record, add_web=True, default_attachment_ids=[]) )) self.assertEqual(len(composer_form.attachment_ids), 0) # change template: 2 static (attachment_ids) and 1 dynamic (report) composer_form.template_id = template_1 self.assertEqual(len(composer_form.attachment_ids), 3) report_attachments = [att for att in composer_form.attachment_ids if att not in template_1_attachments] self.assertEqual(len(report_attachments), 1) tpl_attachments = composer_form.attachment_ids[:] - report_attachments[0] self.assertEqual(tpl_attachments, template_1_attachments) # change template: 0 static (attachment_ids) and 1 dynamic (report) composer_form.template_id = template_2 self.assertEqual(len(composer_form.attachment_ids), 1) report_attachments = [att for att in composer_form.attachment_ids if att not in template_1_attachments] self.assertEqual(len(report_attachments), 1) tpl_attachments = composer_form.attachment_ids[:] - report_attachments[0] self.assertFalse(tpl_attachments) # change back to template 1 composer_form.template_id = template_1 self.assertEqual(len(composer_form.attachment_ids), 3) report_attachments = [att for att in composer_form.attachment_ids if att not in template_1_attachments] self.assertEqual(len(report_attachments), 1) tpl_attachments = composer_form.attachment_ids[:] - report_attachments[0] self.assertEqual(tpl_attachments, template_1_attachments) # reset template composer_form.template_id = self.env['mail.template'] self.assertEqual(len(composer_form.attachment_ids), 0) @users('employee') def test_mail_composer_comment_wtpl(self): composer_form = Form(self.env['mail.compose.message'].with_context( self._get_web_context(self.test_record, add_web=True, default_template_id=self.template.id) )) # self.assertTrue(composer_form.auto_delete) self.assertFalse(composer_form.auto_delete) # FIXME: currently not taking template value self.assertFalse(composer_form.auto_delete_message) self.assertEqual(composer_form.author_id, self.env.user.partner_id) self.assertEqual(composer_form.body, '

TemplateBody %s

' % self.test_record.name) self.assertEqual(composer_form.composition_mode, 'comment') self.assertEqual(composer_form.email_from, self.user_employee_2.email_formatted) self.assertEqual(composer_form.mail_server_id, self.mail_server_domain) self.assertEqual(composer_form.model, self.test_record._name) self.assertEqual(composer_form.partner_ids[:], self.partner_1) self.assertEqual(composer_form.record_name, self.test_record.name, 'MailComposer: comment mode should compute record name') self.assertEqual(composer_form.reply_to, 'info@test.example.com') self.assertFalse(composer_form.reply_to_force_new) self.assertEqual(composer_form.res_id, self.test_record.id) self.assertEqual(composer_form.subject, 'TemplateSubject %s' % self.test_record.name) self.assertEqual(composer_form.subtype_id, self.env.ref('mail.mt_comment')) @users('employee') def test_mail_composer_comment_wtpl_norecords(self): """ Test specific case when running without records, to see the rendering when nothing is given as context. """ composer_form = Form(self.env['mail.compose.message'].with_context( default_composition_mode='comment', default_model='mail.test.ticket', default_template_id=self.template.id, )) # self.assertTrue(composer_form.auto_delete) self.assertFalse(composer_form.auto_delete) # FIXME: currently not taking template value self.assertFalse(composer_form.auto_delete_message) self.assertEqual(composer_form.author_id, self.env.user.partner_id) self.assertEqual(composer_form.body, '

TemplateBody

') self.assertEqual(composer_form.composition_mode, 'comment') self.assertEqual(composer_form.email_from, self.env.user.partner_id.email_formatted) self.assertEqual(composer_form.mail_server_id, self.mail_server_domain) self.assertEqual(composer_form.model, self.test_record._name) self.assertFalse(composer_form.partner_ids[:]) self.assertFalse(composer_form.record_name) self.assertEqual(composer_form.reply_to, 'info@test.example.com') self.assertFalse(composer_form.reply_to_force_new) self.assertFalse(composer_form.res_id) self.assertEqual(composer_form.subject, 'TemplateSubject ') self.assertEqual(composer_form.subtype_id, self.env.ref('mail.mt_comment')) @users('employee') def test_mail_composer_mass(self): composer_form = Form(self.env['mail.compose.message'].with_context( self._get_web_context(self.test_records, add_web=True) )) self.assertFalse(composer_form.auto_delete) self.assertFalse(composer_form.auto_delete_message) self.assertEqual(composer_form.author_id, self.env.user.partner_id) self.assertFalse(composer_form.body) self.assertEqual(composer_form.composition_mode, 'mass_mail') self.assertEqual(composer_form.email_from, self.env.user.email_formatted) self.assertFalse(composer_form.mail_server_id) self.assertEqual(composer_form.model, self.test_records._name) self.assertFalse(composer_form.record_name, 'MailComposer: mass mode should have void record name') self.assertFalse(composer_form.reply_to) self.assertFalse(composer_form.reply_to_force_new) self.assertEqual(composer_form.res_id, self.test_records[0].id, 'MailComposer: even in mass mode web active_id presence may add a res_id') self.assertFalse(composer_form.subject, 'MailComposer: mass mode should have void default subject if no template') self.assertEqual(composer_form.subtype_id, self.env.ref('mail.mt_comment')) @users('employee') def test_mail_composer_mass_wtpl(self): composer_form = Form(self.env['mail.compose.message'].with_context( self._get_web_context(self.test_records, add_web=True, default_template_id=self.template.id) )) # self.assertTrue(composer_form.auto_delete) self.assertFalse(composer_form.auto_delete) # FIXME: currently not taking template value self.assertFalse(composer_form.auto_delete_message) self.assertEqual(composer_form.author_id, self.env.user.partner_id) self.assertEqual(composer_form.body, self.template.body_html, 'MailComposer: mass mode should have template raw body if template') self.assertEqual(composer_form.composition_mode, 'mass_mail') self.assertEqual(composer_form.email_from, self.template.email_from, 'MailComposer: mass mode should have template raw email_from if template') self.assertEqual(composer_form.mail_server_id, self.mail_server_domain) self.assertEqual(composer_form.model, self.test_records._name) self.assertFalse(composer_form.record_name, 'MailComposer: mass mode should have void record name') self.assertEqual(composer_form.reply_to, self.template.reply_to) self.assertFalse(composer_form.reply_to_force_new) self.assertEqual(composer_form.res_id, self.test_records[0].id, 'MailComposer: even in mass mode web active_id presence may add a res_id') self.assertEqual(composer_form.subject, self.template.subject, 'MailComposer: mass mode should have template raw subject if template') self.assertEqual(composer_form.subtype_id, self.env.ref('mail.mt_comment')) @users('employee') def test_mail_composer_mass_wtpl_norecords(self): """ Test specific case when running without records, to see the rendering when nothing is given as context. """ composer_form = Form(self.env['mail.compose.message'].with_context( default_composition_mode='mass_mail', default_model='mail.test.ticket', default_template_id=self.template.id, )) # self.assertTrue(composer_form.auto_delete) self.assertFalse(composer_form.auto_delete) # FIXME: currently not taking template value self.assertFalse(composer_form.auto_delete_message) self.assertEqual(composer_form.author_id, self.env.user.partner_id) self.assertEqual(composer_form.body, self.template.body_html, 'MailComposer: mass mode should have template raw body if template') self.assertEqual(composer_form.composition_mode, 'mass_mail') self.assertEqual(composer_form.email_from, self.template.email_from, 'MailComposer: mass mode should have template raw email_from if template') self.assertEqual(composer_form.mail_server_id, self.mail_server_domain) self.assertEqual(composer_form.model, self.test_records._name) self.assertFalse(composer_form.record_name, 'MailComposer: mass mode should have void record name') self.assertEqual(composer_form.reply_to, self.template.reply_to) self.assertFalse(composer_form.reply_to_force_new) self.assertEqual(composer_form.res_id, 0) self.assertEqual(composer_form.subject, self.template.subject, 'MailComposer: mass mode should have template raw subject if template') self.assertEqual(composer_form.subtype_id, self.env.ref('mail.mt_comment')) @users('employee') def test_mail_composer_template_switching(self): """ Ensure that the current user's identity serves as the sender, particularly when transitioning from a template with a designated sender to one lacking such specifications. Moreover, we verify that switching to a template lacking any subject maintains the existing subject intact. """ # Setup: Prepare Templates template_complete = self.template.copy({ "email_from": "not_current_user@template_complete.com", "subject": "subject: template_complete", }) template_no_sender = template_complete.copy({"email_from": ""}) template_no_subject = template_no_sender.copy({"subject": ""}) forms = { 'comment': Form(self.env['mail.compose.message'].with_context(default_composition_mode='comment')), 'mass_mail': Form(self.env['mail.compose.message'].with_context(default_composition_mode='mass_mail')), } for composition_mode, form in forms.items(): with self.subTest(composition_mode=composition_mode): # Use Template with Sender and Subject form.template_id = template_complete self.assertEqual(form.email_from, template_complete.email_from, "email_from not set correctly to form this test") self.assertEqual(form.subject, template_complete.subject, "subject not set correctly to form this test") # Switch to Template without Sender form.template_id = template_no_sender self.assertEqual(form.email_from, self.env.user.email_formatted, "email_from not updated to current user") # Switch to Template without Subject form.template_id = template_no_subject self.assertEqual(form.subject, template_complete.subject, "subject should be kept unchanged") @tagged('mail_composer') class TestComposerInternals(TestMailComposer): @users('employee') @mute_logger('odoo.addons.mail.models.mail_mail') def test_mail_composer_attachments(self): """ Test attachments management in both comment and mass mail mode. """ attachment_data = self._generate_attachments_data(3, self.template._name, self.template.id) self.template.write({ 'attachment_ids': [(0, 0, a) for a in attachment_data], 'report_name': 'TestReport for {{ object.name }}.html', # test cursor forces html 'report_template': self.test_report.id, }) template_void = self.template.copy(default={ 'attachment_ids': False, 'report_name': False, 'report_template': False, }) attachs = self.env['ir.attachment'].search([('name', 'in', [a['name'] for a in attachment_data])]) self.assertEqual(len(attachs), 3) for composition_mode, batch in (('comment', False), ('mass_mail', True)): with self.subTest(composition_mode=composition_mode, batch=batch): test_records = self.test_records if batch else self.test_record ctx = self._get_web_context( test_records, add_web=False, default_composition_mode=composition_mode, default_template_id=self.template.id ) composer = self.env['mail.compose.message'].with_context(ctx).create({ 'body': '

Test Body

', }) # currently onchange necessary composer._onchange_template_id_wrapper() # values coming from template: attachment_ids + report in comment if composition_mode == 'comment': self.assertEqual(len(composer.attachment_ids), 4) for attach in attachs: self.assertIn(attach, composer.attachment_ids) generated = composer.attachment_ids - attachs self.assertEqual(len(generated), 1, 'MailComposer: should have 1 additional attachment for report') self.assertEqual(generated.name, f'TestReport for {self.test_record.name}.html') self.assertEqual(generated.res_model, 'mail.compose.message') self.assertEqual(generated.res_id, 0) # values coming from template: attachment_ids only (report is dynamic) else: self.assertEqual( sorted(composer.attachment_ids.ids), sorted(attachs.ids) ) # update with template with void values: values are kept composer.write({'template_id': template_void.id}) # currently onchange necessary composer._onchange_template_id_wrapper() if composition_mode == 'comment': self.assertEqual(composer.attachment_ids, attachs + generated, 'TODO: Values are kept (should be reset ?)') else: self.assertEqual(composer.attachment_ids, attachs, 'TODO: Values are kept (should be reset ?)') # reset template: values are kept composer.write({'template_id': False}) # currently onchange necessary composer._onchange_template_id_wrapper() if composition_mode == 'comment': self.assertEqual(composer.attachment_ids, attachs + generated, 'TODO: Values are kept (should be reset ?)') else: self.assertEqual(composer.attachment_ids, attachs, 'TODO: Values are kept (should be reset ?)') @users('employee') @mute_logger('odoo.addons.mail.models.mail_mail') def test_mail_composer_author(self): """ Test author_id / email_from synchronization, in both comment and mass mail modes. """ template_void = self.template.copy(default={ 'email_from': False, }) for composition_mode, batch in (('comment', False), ('mass_mail', True)): with self.subTest(composition_mode=composition_mode, batch=batch): test_records = self.test_records if batch else self.test_record ctx = self._get_web_context( test_records, add_web=False, default_composition_mode=composition_mode ) composer = self.env['mail.compose.message'].with_context(ctx).create({ 'body': '

Test Body

', }) # default values are current user self.assertEqual(composer.author_id, self.env.user.partner_id) self.assertEqual(composer.email_from, self.env.user.email_formatted) # author values reset email (FIXME: currently not synchronized) composer.write({'author_id': self.partner_1}) self.assertEqual(composer.author_id, self.partner_1) self.assertEqual(composer.email_from, self.env.user.email_formatted) # self.assertEqual(composer.email_from, self.partner_1.email_formatted) # changing template should update its email_from composer.write({'template_id': self.template.id, 'author_id': self.env.user.partner_id}) # currently onchange necessary composer._onchange_template_id_wrapper() self.assertEqual(composer.author_id, self.env.user.partner_id, 'MailComposer: should take value given by user') if composition_mode == 'comment': self.assertEqual(composer.email_from, self.test_record.user_id.email_formatted, 'MailComposer: should take email_from rendered from template') else: self.assertEqual(composer.email_from, self.template.email_from, 'MailComposer: should take email_from raw from template') # manual values are kept over template values composer.write({'email_from': self.test_from}) self.assertEqual(composer.author_id, self.env.user.partner_id) self.assertEqual(composer.email_from, self.test_from) # Update with template with void email_from field, should result in reseting email_from to a default value # rendering mode as well as when copying template values composer.write({'template_id': template_void.id}) # currently onchange necessary composer._onchange_template_id_wrapper() if composition_mode == 'comment': self.assertEqual(composer.author_id, self.env.user.partner_id) self.assertEqual(composer.email_from, self.env.user.email_formatted) else: self.assertEqual(composer.author_id, self.env.user.partner_id) self.assertEqual(composer.email_from, self.env.user.email_formatted) # reset template: values are reset due to call to default_get composer.write({'template_id': False}) # currently onchange necessary composer._onchange_template_id_wrapper() if composition_mode == 'comment': self.assertEqual(composer.author_id, self.env.user.partner_id) self.assertEqual(composer.email_from, self.env.user.email_formatted) else: self.assertEqual(composer.author_id, self.env.user.partner_id) self.assertEqual(composer.email_from, self.env.user.email_formatted) @users('employee') def test_mail_composer_configuration(self): """ Test content configuration (auto_delete_*, email_*, message_type, subtype) in both comment and mass mailing mode. Template update is also tested when it applies. """ template_falsy = self.template.copy(default={ 'auto_delete': False, }) for composition_mode, batch in (('comment', False), ('mass_mail', True)): with self.subTest(composition_mode=composition_mode, batch=batch): test_records = self.test_records if batch else self.test_record ctx = self._get_web_context( test_records, add_web=False, default_composition_mode=composition_mode ) # 1. check without template (default values) + template update composer = self.env['mail.compose.message'].with_context(ctx).create({ 'email_layout_xmlid': 'mail.test_layout', }) # default creation values self.assertFalse(composer.auto_delete) self.assertFalse(composer.auto_delete_message) self.assertTrue(composer.email_add_signature) self.assertEqual(composer.email_layout_xmlid, 'mail.test_layout') self.assertEqual(composer.message_type, 'comment') self.assertEqual(composer.subtype_id, self.env.ref('mail.mt_comment')) # changing template should update its content composer.write({'template_id': self.template.id}) # currently onchange necessary composer._onchange_template_id_wrapper() # values come from template if composition_mode == 'comment': self.assertFalse(composer.auto_delete, 'TODO: should be updated with template') self.assertFalse(composer.auto_delete_message) self.assertTrue(composer.email_add_signature, 'TODO: should be False as template negates this config') self.assertEqual(composer.email_layout_xmlid, 'mail.test_layout') self.assertEqual(composer.message_type, 'comment') self.assertEqual(composer.subtype_id, self.env.ref('mail.mt_comment')) else: self.assertFalse(composer.auto_delete, 'TODO: should be updated with template') self.assertFalse(composer.auto_delete_message) self.assertTrue(composer.email_add_signature, 'TODO: should be False as template negates this config') self.assertEqual(composer.email_layout_xmlid, 'mail.test_layout') self.assertEqual(composer.message_type, 'comment') self.assertEqual(composer.subtype_id, self.env.ref('mail.mt_comment')) # manual update composer.write({ 'message_type': 'notification', 'subtype_id': self.env.ref('mail.mt_note').id, }) self.assertEqual(composer.message_type, 'notification') self.assertEqual(composer.subtype_id, self.env.ref('mail.mt_note')) # force some composer values to see changes (due to previous bugs) composer.write({ 'auto_delete': True, }) # update with template with void values: void value is forced for # booleans, cannot distinguish composer.write({'template_id': template_falsy.id}) # currently onchange necessary composer._onchange_template_id_wrapper() if composition_mode == 'comment': # self.assertFalse(composer.auto_delete, 'TODO: should be updated') self.assertTrue(composer.auto_delete) self.assertEqual(composer.message_type, 'notification') self.assertEqual(composer.subtype_id, self.env.ref('mail.mt_note')) else: # self.assertFalse(composer.auto_delete, 'TODO: should be updated') self.assertTrue(composer.auto_delete) self.assertEqual(composer.message_type, 'notification') self.assertEqual(composer.subtype_id, self.env.ref('mail.mt_note')) @users('employee') def test_mail_composer_content(self): """ Test content management (body, mail_server_id, record_name, subject) in both comment and mass mailing mode. Template update is also tested. """ template_void = self.template.copy(default={ 'body_html': False, 'mail_server_id': False, 'subject': False, }) for composition_mode, batch in (('comment', False), ('mass_mail', True)): with self.subTest(composition_mode=composition_mode, batch=batch): test_records = self.test_records if batch else self.test_record ctx = self._get_web_context( test_records, add_web=False, default_composition_mode=composition_mode ) # 1. check without template + template update composer = self.env['mail.compose.message'].with_context(ctx).create({ 'body': '

Test Body />

') self.assertEqual(composer.mail_server_id, self.mail_server_global) self.assertEqual(composer.subject, 'My amazing subject for {{ record.name }}') if composition_mode == 'comment': self.assertEqual(composer.record_name, self.test_record.name) else: self.assertFalse(composer.record_name) # changing template should update its content composer.write({'template_id': self.template.id}) # currently onchange necessary composer._onchange_template_id_wrapper() # values come from template if composition_mode == 'comment': self.assertEqual(composer.body, f'

TemplateBody {self.test_record.name}

') self.assertEqual(composer.mail_server_id, self.template.mail_server_id) self.assertEqual(composer.record_name, self.test_record.name) self.assertEqual(composer.subject, f'TemplateSubject {self.test_record.name}') else: self.assertEqual(composer.body, self.template.body_html) self.assertEqual(composer.mail_server_id, self.template.mail_server_id) self.assertFalse(composer.record_name) self.assertEqual(composer.subject, self.template.subject) # manual values is kept over template composer.write({ 'body': '

Back to my amazing body />

') self.assertEqual(composer.mail_server_id, self.mail_server_global) self.assertEqual(composer.record_name, 'Manual update') self.assertEqual(composer.subject, 'Back to my amazing subject for {{ record.name }}') # update with template with void values: void value is not forced in # rendering mode as well as when copying template values, except for # body in rendering mode composer.write({'template_id': template_void.id}) # currently onchange necessary composer._onchange_template_id_wrapper() if composition_mode == 'comment': self.assertFalse(composer.body, 'Void template body resets while other fields not, maybe to fix') self.assertEqual(composer.mail_server_id, self.mail_server_global) self.assertEqual(composer.record_name, 'Manual update') self.assertEqual(composer.subject, 'Back to my amazing subject for {{ record.name }}') else: self.assertEqual(composer.body, '

Back to my amazing body />

'}) composer.write({'template_id': False}) # currently onchange necessary composer._onchange_template_id_wrapper() # values are reset with default_get call, if it returns value # (aka subject for comment mode), and not record_name because # it was forgotten probably if composition_mode == 'comment': self.assertFalse(composer.body) # self.assertFalse(composer.mail_server_id.id) self.assertEqual(composer.mail_server_id, self.mail_server_global, 'TODO: Values are kept (should be reset ?)') # self.assertEqual(composer.record_name, self.test_record.name) self.assertEqual(composer.record_name, 'Manual update', 'TODO: Reset not called') self.assertEqual(composer.subject, 'Re: %s' % self.test_record.name) else: self.assertFalse(composer.body) # self.assertFalse(composer.mail_server_id.id) self.assertEqual(composer.mail_server_id, self.mail_server_global, 'TODO: Values are kept (should be reset ?)') # self.assertFalse(composer.record_name) self.assertEqual(composer.record_name, 'Manual update', 'TODO: Reset not called') # self.assertFalse(composer.subject) self.assertEqual(composer.subject, 'Back to my amazing subject for {{ record.name }}', 'TODO: Values are kept (should be reset ?)') # 2. check with default ctx['default_template_id'] = self.template.id composer = self.env['mail.compose.message'].with_context(ctx).create({ 'template_id': self.template.id, }) # currently onchange necessary composer._onchange_template_id_wrapper() # values come from template if composition_mode == 'comment': self.assertEqual(composer.body, f'

TemplateBody {self.test_record.name}

') self.assertEqual(composer.mail_server_id, self.template.mail_server_id) self.assertEqual(composer.record_name, self.test_record.name) self.assertEqual(composer.subject, f'TemplateSubject {self.test_record.name}') else: self.assertEqual(composer.body, self.template.body_html) self.assertEqual(composer.mail_server_id, self.template.mail_server_id) self.assertFalse(composer.record_name) self.assertEqual(composer.subject, self.template.subject) # 3. check at create ctx.pop('default_template_id') composer = self.env['mail.compose.message'].with_context(ctx).create({ 'template_id': self.template.id, }) # currently onchange necessary composer._onchange_template_id_wrapper() # values come from template if composition_mode == 'comment': self.assertEqual(composer.body, f'

TemplateBody {self.test_record.name}

') self.assertEqual(composer.mail_server_id, self.template.mail_server_id) self.assertEqual(composer.record_name, self.test_record.name) self.assertEqual(composer.subject, f'TemplateSubject {self.test_record.name}') else: self.assertEqual(composer.body, self.template.body_html) self.assertEqual(composer.mail_server_id, self.template.mail_server_id) self.assertFalse(composer.record_name) self.assertEqual(composer.subject, self.template.subject) # 4. template + user input ctx['default_template_id'] = self.template.id composer = self.env['mail.compose.message'].with_context(ctx).create({ 'body': '

Test Body

', 'mail_server_id': False, 'record_name': 'CustomName', 'subject': 'My amazing subject', }) # creation values are taken self.assertEqual(composer.body, '

Test Body

') self.assertEqual(composer.mail_server_id.id, False) self.assertEqual(composer.record_name, 'CustomName') self.assertEqual(composer.subject, 'My amazing subject') @users('employee') @mute_logger('odoo.models.unlink') def test_mail_composer_recipients(self): """ Test content management (partner_ids, reply_to) in both comment and mass mailing mode. Template update is also tested. Add some tests for partner creation based on unknown emails as this is part of the process. """ base_recipients = self.partner_1 + self.partner_2 self.template.write({ 'email_cc': 'test.cc.1@test.example.com, test.cc.2@test.example.com' }) template_void = self.template.copy(default={ 'email_cc': False, 'email_to': False, 'partner_to': False, 'reply_to': False, }) for composition_mode, batch in (('comment', False), ('mass_mail', True)): with self.subTest(composition_mode=composition_mode, batch=batch): self.assertFalse( self.env['res.partner'].search([ ('email_normalized', 'in', ['test.cc.1@test.example.com', 'test.cc.2@test.example.com']) ]) ) test_records = self.test_records if batch else self.test_record ctx = self._get_web_context( test_records, add_web=False, default_composition_mode=composition_mode ) # 1. check without template + template update composer = self.env['mail.compose.message'].with_context(ctx).create({ 'body': '

Test Body

', 'partner_ids': base_recipients.ids, 'reply_to': 'my_reply_to@test.example.com', 'subject': 'My amazing subject', }) # creation values are taken self.assertEqual(composer.partner_ids, base_recipients) self.assertEqual(composer.reply_to, 'my_reply_to@test.example.com') self.assertFalse(composer.reply_to_force_new) self.assertEqual(composer.reply_to_mode, 'update') # update with template with void values: void value is not forced in # rendering mode as well as when copying template values (and recipients # are not computed until sending in rendering mode) composer.write({'template_id': template_void.id}) # currently onchange necessary composer._onchange_template_id_wrapper() if composition_mode == 'comment': self.assertEqual(composer.partner_ids, base_recipients) self.assertEqual(composer.reply_to, 'my_reply_to@test.example.com') self.assertFalse(composer.reply_to_force_new) else: self.assertEqual(composer.partner_ids, base_recipients) self.assertEqual(composer.reply_to, 'my_reply_to@test.example.com') self.assertFalse(composer.reply_to_force_new) # changing template should update its content composer.write({'template_id': self.template.id}) # currently onchange necessary composer._onchange_template_id_wrapper() new_partners = self.env['res.partner'].search( [('email_normalized', 'in', ['test.cc.1@test.example.com', 'test.cc.2@test.example.com']) ] ) # values come from template if composition_mode == 'comment': self.assertEqual(len(new_partners), 2) self.assertEqual(composer.partner_ids, self.partner_1 + new_partners, 'Template took customer_id as set on record') self.assertEqual(composer.reply_to, 'info@test.example.com', 'Template was rendered') self.assertFalse(composer.reply_to_force_new) # should not change in comment mode else: self.assertEqual(len(new_partners), 0) self.assertEqual(composer.partner_ids, base_recipients, 'Mass mode: kept original values') self.assertEqual(composer.reply_to, self.template.reply_to, 'Mass mode: raw template value') self.assertFalse(composer.reply_to_force_new) # should probably become True, not supported currently # manual values is kept over template composer.write({'partner_ids': [(5, 0), (4, self.partner_admin.id)]}) self.assertEqual(composer.partner_ids, self.partner_admin) # reset template should reset values composer.write({'template_id': False}) # currently onchange necessary composer._onchange_template_id_wrapper() # values are kept, should probably be reset if composition_mode == 'comment': self.assertEqual(composer.partner_ids, self.partner_admin, 'TODO: Values are kept (should be reset ?)') self.assertEqual(composer.reply_to, 'info@test.example.com', 'TODO: Values are kept (should be reset ?)') self.assertFalse(composer.reply_to_force_new) else: self.assertEqual(composer.partner_ids, self.partner_admin, 'TODO: Values are kept (should be reset ?)') self.assertEqual(composer.reply_to, self.template.reply_to, 'TODO: Values are kept (should be reset ?)') self.assertFalse(composer.reply_to_force_new) # 2. check with default ctx['default_template_id'] = self.template.id composer = self.env['mail.compose.message'].with_context(ctx).create({ 'template_id': self.template.id, }) # currently onchange necessary composer._onchange_template_id_wrapper() # values come from template if composition_mode == 'comment': self.assertEqual(composer.partner_ids, self.partner_1 + new_partners) else: self.assertFalse(composer.partner_ids) if composition_mode == 'comment': self.assertEqual(composer.reply_to, "info@test.example.com") else: self.assertEqual(composer.reply_to, self.template.reply_to) self.assertFalse(composer.reply_to_force_new) # note: this should be updated with reply-to self.assertEqual(composer.reply_to_mode, 'update') # note: this should be updated with reply-to # 3. check at create ctx.pop('default_template_id') composer = self.env['mail.compose.message'].with_context(ctx).create({ 'template_id': self.template.id, }) # currently onchange necessary composer._onchange_template_id_wrapper() # values come from template if composition_mode == 'comment': self.assertEqual(composer.partner_ids, self.partner_1 + new_partners) else: self.assertFalse(composer.partner_ids) if composition_mode == 'comment': self.assertEqual(composer.reply_to, "info@test.example.com") else: self.assertEqual(composer.reply_to, self.template.reply_to) self.assertFalse(composer.reply_to_force_new) self.assertEqual(composer.reply_to_mode, 'update') # 4. template + user input ctx['default_template_id'] = self.template.id composer = self.env['mail.compose.message'].with_context(ctx).create({ 'body': '

Test Body

', 'partner_ids': base_recipients.ids, 'subject': 'My amazing subject', 'reply_to': False, }) # creation values are taken self.assertEqual(composer.partner_ids, base_recipients) self.assertFalse(composer.reply_to) self.assertFalse(composer.reply_to_force_new) self.assertEqual(composer.reply_to_mode, 'update') self.env['res.partner'].search([ ('email_normalized', 'in', ['test.cc.1@test.example.com', 'test.cc.2@test.example.com']) ]).unlink() @users('employee') @mute_logger('odoo.tests', 'odoo.addons.mail.models.mail_mail', 'odoo.models.unlink') def test_mail_composer_parent(self): """ Test specific management in comment mode when having parent_id set: record_name, subject, parent's partners. """ parent = self.test_record.message_post(body='Test', partner_ids=(self.partner_1 + self.partner_2).ids) composer = self.env['mail.compose.message'].with_context( self._get_web_context(self.test_record, add_web=False, default_parent_id=parent.id) ).create({ 'body': '

Test Body

', }) # creation values taken from parent self.assertEqual(composer.body, '

Test Body

') self.assertEqual(composer.parent_id, parent) self.assertEqual(composer.partner_ids, self.partner_1 + self.partner_2) self.assertEqual(composer.record_name, self.test_record.name) self.assertEqual(composer.subject, 'Re: %s' % self.test_record.name) @users('user_rendering_restricted') @mute_logger('odoo.tests', 'odoo.addons.base.models.ir_rule', 'odoo.addons.mail.models.mail_mail', 'odoo.models.unlink') def test_mail_composer_rights_attachments(self): """ Ensure a user without write access to a template can send an email""" template_1 = self.template.copy({ 'report_name': 'TestReport for {{ object.name }} (thanks TDE).html', # test cursor forces html 'report_template': self.test_report.id, }) attachment_data = self._generate_attachments_data(2, self.template._name, self.template.id) template_1.write({ 'attachment_ids': [(0, 0, dict(a, res_model="mail.template", res_id=template_1.id)) for a in attachment_data] }) with self.assertRaises(AccessError): # ensure user_rendering_restricted has no write access template_1.with_user(self.env.user).write({'name': 'New Name'}) template_1_attachments = template_1.attachment_ids self.assertEqual(len(template_1_attachments), 2) template_1_attachment_name = list(template_1_attachments.mapped('name')) + ["TestReport for TestRecord (thanks TDE).html"] composer = self.env['mail.compose.message'].with_context( self._get_web_context(self.test_record) ).create({ 'body': '

Template Body

', 'partner_ids': [self.partner_employee_2.id], 'template_id': template_1.id, }) composer._onchange_template_id_wrapper() composer._action_send_mail() self.assertEqual( self.test_record.message_ids[0].subject, f'TemplateSubject {self.test_record.name}') self.assertEqual( sorted(self.test_record.message_ids[0].attachment_ids.mapped('name')), sorted(template_1_attachment_name)) @mute_logger('odoo.tests', 'odoo.addons.mail.models.mail_mail', 'odoo.models.unlink') def test_mail_composer_rights_portal(self): portal_user = self._create_portal_user() # give read access to the record to portal (for check access rule) self.test_record.message_subscribe(partner_ids=portal_user.partner_id.ids) # patch check access rights for write access, required to post a message by default with patch.object(MailTestTicket, 'check_access_rights', return_value=True): self.env['mail.compose.message'].with_user(portal_user).with_context( self._get_web_context(self.test_record) ).create({ 'subject': 'Subject', 'body': '

Body text

', 'partner_ids': [] })._action_send_mail() self.assertEqual(self.test_record.message_ids[0].body, '

Body text

') self.assertEqual(self.test_record.message_ids[0].author_id, portal_user.partner_id) self.env['mail.compose.message'].with_user(portal_user).with_context({ 'default_composition_mode': 'comment', 'default_parent_id': self.test_record.message_ids.ids[0], }).create({ 'subject': 'Subject', 'body': '

Body text 2

' })._action_send_mail() self.assertEqual(self.test_record.message_ids[0].body, '

Body text 2

') self.assertEqual(self.test_record.message_ids[0].author_id, portal_user.partner_id) @users('employee') def test_mail_composer_save_template(self): self.env['mail.compose.message'].with_context( self._get_web_context(self.test_record, add_web=False) ).create({ 'subject': 'Template Subject', 'body': '

Template Body

', }).action_save_as_template() # Test: email_template subject, body_html, model template = self.env['mail.template'].search([ ('model', '=', self.test_record._name), ('subject', '=', 'Template Subject') ], limit=1) self.assertEqual(template.name, "%s: %s" % (self.env['ir.model']._get(self.test_record._name).name, 'Template Subject')) self.assertEqual(template.body_html, '

Template Body

', 'email_template incorrect body_html') @tagged('mail_composer', 'multi_lang') class TestComposerResultsComment(TestMailComposer): """ Test global output of composer used in comment mode. Test notably notification and emails generated during this process. """ def test_assert_initial_data(self): """ Ensure class initial data to ease understanding """ self.assertTrue(self.template.auto_delete) self.assertEqual(len(self.test_records), 2) self.assertEqual(self.test_records.user_id, self.user_employee_2) self.assertEqual(self.test_records.message_partner_ids, self.partner_employee_2) self.assertEqual(self.test_records[0].customer_id.lang, 'en_US') self.assertEqual(self.test_records[1].customer_id.lang, 'en_US') self.assertEqual(len(self.test_partners), 2) self.assertEqual(self.user_employee.lang, 'en_US') self.assertEqual(self.user_employee_2.lang, 'en_US') @users('employee') @mute_logger('odoo.tests', 'odoo.addons.mail.models.mail_mail', 'odoo.models.unlink') def test_mail_composer_notifications_delete(self): """ Notifications are correctly deleted once sent """ composer = self.env['mail.compose.message'].with_context( self._get_web_context(self.test_record) ).create({ 'body': '

Test Body

', 'partner_ids': [(4, self.partner_1.id), (4, self.partner_2.id)] }) self.assertFalse(composer.auto_delete) self.assertFalse(composer.auto_delete_message) with self.mock_mail_gateway(mail_unlink_sent=True): composer._action_send_mail() # notifications message = self.test_record.message_ids[0] self.assertEqual(message.notified_partner_ids, self.partner_employee_2 + self.partner_1 + self.partner_2) # global outgoing self.assertEqual(len(self._mails), 3, 'Should have sent an email each recipient') self.assertEqual(len(self._new_mails), 2, 'Should have created 2 mail.mail (1 for users, 1 for customers)') self.assertFalse(self._new_mails.exists(), 'Should have deleted mail.mail records') # Check ``auto_delete`` field usage (note: currently not correctly managed) composer = self.env['mail.compose.message'].with_context( self._get_web_context(self.test_record), ).create({ 'auto_delete': False, 'body': '

Test Body

', 'partner_ids': [(4, self.partner_1.id), (4, self.partner_2.id)] }) self.assertFalse(composer.auto_delete) self.assertFalse(composer.auto_delete_message) with self.mock_mail_gateway(mail_unlink_sent=True): composer._action_send_mail() # notifications message = self.test_record.message_ids[0] self.assertEqual(message.notified_partner_ids, self.partner_employee_2 + self.partner_1 + self.partner_2) # global outgoing self.assertEqual(len(self._mails), 3, 'Should have sent an email each recipient') self.assertEqual(len(self._new_mails), 2, 'Should have created 2 mail.mail (1 for users, 1 for customers)') self.assertEqual(len(self._new_mails.exists()), 0, 'To fix: does not respect auto_delete') # ensure ``mail_auto_delete`` context key allow to override this behavior composer = self.env['mail.compose.message'].with_context( self._get_web_context(self.test_record), mail_auto_delete=False, ).create({ 'body': '

Test Body

', 'partner_ids': [(4, self.partner_1.id), (4, self.partner_2.id)] }) with self.mock_mail_gateway(mail_unlink_sent=True): composer._action_send_mail() # notifications message = self.test_record.message_ids[0] self.assertEqual(message.notified_partner_ids, self.partner_employee_2 + self.partner_1 + self.partner_2) # global outgoing self.assertEqual(len(self._mails), 3, 'Should have sent an email each recipient') self.assertEqual(len(self._new_mails), 2, 'Should have created 2 mail.mail (1 for users, 1 for customers)') self.assertEqual(len(self._new_mails.exists()), 2, 'Should not have deleted mail.mail records') @users('employee') @mute_logger('odoo.tests', 'odoo.addons.mail.models.mail_mail', 'odoo.models.unlink') def test_mail_composer_post_parameters(self): """ Test various fields and tweaks in comment mode used for message_post parameters and process.. """ # default behavior composer = self.env['mail.compose.message'].with_context( self._get_web_context(self.test_record) ).create({ 'body': '

Test Body

', }) _mail, message = composer._action_send_mail() self.assertEqual(message.body, '

Test Body

') self.assertTrue(message.email_add_signature) self.assertFalse(message.email_layout_xmlid) self.assertEqual(message.message_type, 'comment', 'Mail: default message type with composer is user comment') self.assertEqual(message.record_name, self.test_record.name) self.assertEqual(message.subtype_id, self.env.ref('mail.mt_comment', 'Mail: default subtype is comment')) # tweaks composer = self.env['mail.compose.message'].with_context( self._get_web_context(self.test_record) ).create({ 'body': '

Test Body 2

', 'email_add_signature': False, 'email_layout_xmlid': 'mail.mail_notification_light', 'is_log': False, 'message_type': 'notification', 'subtype_id': self.env.ref('mail.mt_note').id, 'partner_ids': [(4, self.partner_1.id), (4, self.partner_2.id)], 'record_name': 'Custom record name', }) _mail, message = composer._action_send_mail() self.assertEqual(message.body, '

Test Body 2

') self.assertFalse(message.email_add_signature) self.assertEqual(message.email_layout_xmlid, 'mail.mail_notification_light') self.assertEqual(message.message_type, 'notification') self.assertEqual(message.record_name, 'Custom record name') self.assertEqual(message.subtype_id, self.env.ref('mail.mt_note')) # log forces note composer.write({ 'is_log': True, 'subtype_id': self.env.ref('mail.mt_comment').id, }) _mail, message = composer._action_send_mail() self.assertEqual(message.subtype_id, self.env.ref('mail.mt_note')) @users('employee') @mute_logger('odoo.tests', 'odoo.addons.mail.models.mail_mail', 'odoo.models.unlink') def test_mail_composer_recipients(self): """ Test partner_ids given to composer are given to the final message. """ composer = self.env['mail.compose.message'].with_context( self._get_web_context(self.test_record) ).create({ 'body': '

Test Body

', 'partner_ids': [(4, self.partner_1.id), (4, self.partner_2.id)] }) composer._action_send_mail() message = self.test_record.message_ids[0] self.assertEqual(message.author_id, self.user_employee.partner_id) self.assertEqual(message.body, '

Test Body

') self.assertEqual(message.subject, 'Re: %s' % self.test_record.name) self.assertEqual(message.subtype_id, self.env.ref('mail.mt_comment')) self.assertEqual(message.partner_ids, self.partner_1 | self.partner_2) @users('employee') @mute_logger('odoo.models.unlink', 'odoo.addons.mail.models.mail_mail') def test_mail_composer_wtpl_complete(self): """ Test a posting process using a complex template, holding several additional recipients and attachments. This tests notifies: 2 new email_to (+ 1 duplicated), 1 email_cc, test_record followers and partner_admin added in partner_to. Test with and without notification layout specified. Test with and without languages. """ attachment_data = self._generate_attachments_data(2, self.template._name, self.template.id) email_to_1 = 'test.to.1@test.example.com' email_to_2 = 'test.to.2@test.example.com' email_to_3 = 'test.to.1@test.example.com' # duplicate: should not sent twice the email email_cc_1 = 'test.cc.1@test.example.com' self.template.write({ 'auto_delete': False, # keep sent emails to check content 'attachment_ids': [(0, 0, a) for a in attachment_data], 'email_to': '%s, %s, %s' % (email_to_1, email_to_2, email_to_3), 'email_cc': email_cc_1, 'partner_to': '%s, {{ object.customer_id.id if object.customer_id else "" }}' % self.partner_admin.id, 'report_name': 'TestReport for {{ object.name }}', # test cursor forces html 'report_template': self.test_report.id, }) attachs = self.env['ir.attachment'].search([('name', 'in', [a['name'] for a in attachment_data])]) self.assertEqual(len(attachs), 2) # ensure initial data self.assertEqual(self.test_record.user_id, self.user_employee_2) self.assertEqual(self.test_record.message_partner_ids, self.partner_employee_2) for email_layout_xmlid, use_lang in product( (False, 'mail.test_layout'), (False, True), ): with self.subTest(email_layout_xmlid=email_layout_xmlid, use_lang=use_lang): # update test configuration if use_lang: exp_lang = 'es_ES' self.partner_1.lang = exp_lang if not use_lang: exp_lang = False self.partner_1.lang = False test_record = self.test_record.with_env(self.env) # ensure initial data self.assertEqual(test_record.user_id, self.user_employee_2) self.assertEqual(test_record.message_partner_ids, self.partner_employee_2) ctx = { 'default_model': test_record._name, 'default_composition_mode': 'comment', 'default_res_id': test_record.id, 'default_template_id': self.template.id, # avoid successive tests issues with followers 'mail_create_nosubscribe': True, } if email_layout_xmlid: ctx['default_email_layout_xmlid'] = email_layout_xmlid # open a composer and run it in comment mode composer_form = Form(self.env['mail.compose.message'].with_context(ctx)) composer = composer_form.save() # ensure some parameters used afterwards author = self.partner_employee self.assertEqual(composer.author_id, author, 'Author is synchronized with rendered email_from') self.assertEqual(composer.email_from, self.partner_employee_2.email_formatted) self.assertFalse(composer.reply_to_force_new, 'Mail: thread-enabled models should use auto thread by default') with self.mock_mail_gateway(mail_unlink_sent=False), \ self.mock_mail_app(): composer._action_send_mail() # monorecord: force_send notifications self.assertEqual(self._new_mails.mapped('state'), ['sent'] * len(self._new_mails)) self.assertEqual(len(self._mails), 5, 'Should have sent 5 emails, one per recipient per record') # check new partners have been created based on emails given new_partners = self.env['res.partner'].search([ ('email', 'in', [email_to_1, email_to_2, email_to_3, email_cc_1]) ]) self.assertEqual(len(new_partners), 3) self.assertEqual( set(new_partners.mapped('email')), {'test.to.1@test.example.com', 'test.to.2@test.example.com', 'test.cc.1@test.example.com'}, ) self.assertEqual( set(new_partners.mapped('lang')), {'en_US'}, ) message = test_record.message_ids[0] # check created mail.mail and outgoing emails. In comment # 2 mails are generated (due to group-based layouting): # - one for recipient that is a user # - one for recipients that are customers # Then each recipient receives its own outging email. See # 'assertMailMail' for more details. if exp_lang == 'es_ES': exp_body = f'SpanishBody for {test_record.name}' exp_subject = f'SpanishSubject for {test_record.name}' else: exp_body = f'TemplateBody {test_record.name}' exp_subject = f'TemplateSubject {test_record.name}' self.assertMailMail(self.partner_employee_2, 'sent', mail_message=message, author=author, # author is different in batch and monorecord mode (raw or rendered email_from) email_values={ 'body_content': exp_body, 'email_from': test_record.user_id.email_formatted, # set by template 'subject': exp_subject, 'attachments_info': [ {'name': 'AttFileName_00.txt', 'raw': b'AttContent_00', 'type': 'text/plain'}, {'name': 'AttFileName_01.txt', 'raw': b'AttContent_01', 'type': 'text/plain'}, {'name': f'TestReport for {test_record.name}.html', 'type': 'text/plain'}, ] }, fields_values={ 'mail_server_id': self.mail_server_domain, }, ) self.assertMailMail(test_record.customer_id + new_partners, 'sent', mail_message=message, author=author, # author is different in batch and monorecord mode (raw or rendered email_from) email_values={ 'body_content': exp_body, 'email_from': test_record.user_id.email_formatted, # set by template 'subject': exp_subject, 'attachments_info': [ {'name': 'AttFileName_00.txt', 'raw': b'AttContent_00', 'type': 'text/plain'}, {'name': 'AttFileName_01.txt', 'raw': b'AttContent_01', 'type': 'text/plain'}, {'name': f'TestReport for {test_record.name}.html', 'type': 'text/plain'}, ] }, fields_values={ 'mail_server_id': self.mail_server_domain, }, ) # Low-level checks on outgoing email for the recipient to # check layouting and language. Note that standard layout # is not tested against translations, only the custom one # to ease translations checks. email = self._find_sent_email(test_record.user_id.email_formatted, [test_record.customer_id.email_formatted]) self.assertTrue(bool(email), 'Email not found, check recipients') # TDE FIXME: as it currently depends on a context-based hack # translation is not supported when scheduling notifications # or when a domain is given. Moreover access buttons are not # translated exp_layout_content_en = 'English Layout for Ticket-like model' exp_layout_content_es = 'Spanish Layout para Spanish Model Description' exp_button_en = 'View Ticket-like model' # exp_button_es = 'SpanishView Spanish Model Description' if email_layout_xmlid: if exp_lang == 'es_ES': self.assertIn(exp_layout_content_es, email['body']) self.assertIn(exp_button_en, email['body'], 'TODO: buttons should be translated') else: self.assertIn(exp_layout_content_en, email['body']) self.assertIn(exp_button_en, email['body']) else: # check default layouting applies if exp_lang == 'es_ES': self.assertIn('html lang="es_ES"', email['body']) else: self.assertIn('html lang="en_US"', email['body']) # message is posted and notified admin self.assertEqual(message.subtype_id, self.env.ref('mail.mt_comment')) self.assertNotified(message, [{'partner': self.partner_admin, 'is_read': False, 'type': 'inbox'}]) # attachments are copied on message and linked to document self.assertEqual( set(message.attachment_ids.mapped('name')), set(['AttFileName_00.txt', 'AttFileName_01.txt', f'TestReport for {test_record.name}.html']) ) self.assertEqual(set(message.attachment_ids.mapped('res_model')), set([test_record._name])) self.assertEqual(set(message.attachment_ids.mapped('res_id')), set(test_record.ids)) self.assertTrue(all(attach not in message.attachment_ids for attach in attachs), 'Should have copied attachments') @users('employee') @mute_logger('odoo.addons.mail.models.mail_mail') def test_mail_composer_wtpl_recipients_email_fields(self): """ Test various combinations of corner case / not standard filling of email fields: multi email, formatted emails, ... on template, used to post a message using the composer.""" existing_partners = self.env['res.partner'].search([]) partner_format_tofind, partner_multi_tofind, partner_at_tofind = self.env['res.partner'].create([ { 'email': '"FindMe Format" ', 'name': 'FindMe Format', }, { 'email': 'find.me.multi.1@test.example.com, "FindMe Multi" ', 'name': 'FindMe Multi', }, { 'email': '"Bike@Home" ', 'name': 'NotBike@Home', } ]) email_ccs = ['"Raoul" ', '"Raoulette" ', 'test.cc.2.2@example.com>', 'invalid', ' '] email_tos = ['"Micheline, l\'Immense" ', 'test.to.2@example.com', 'wrong', ' '] self.template.write({ 'email_cc': ', '.join(email_ccs), 'email_from': '{{ user.email_formatted }}', 'email_to': ', '.join(email_tos + (partner_format_tofind + partner_multi_tofind + partner_at_tofind).mapped('email')), 'partner_to': f'{self.partner_1.id},{self.partner_2.id},0,test', }) self.user_employee.write({'email': 'email.from.1@test.mycompany.com, email.from.2@test.mycompany.com'}) self.partner_1.write({'email': '"Valid Formatted" '}) self.partner_2.write({'email': 'valid.other.1@agrolait.com, valid.other.cc@agrolait.com'}) # ensure values used afterwards for testing self.assertEqual( self.partner_employee.email_formatted, '"Ernest Employee" ', 'Formatting: wrong formatting due to multi-email') self.assertEqual( self.partner_1.email_formatted, '"Valid Lelitre" ', 'Formatting: avoid wrong double encapsulation') self.assertEqual( self.partner_2.email_formatted, '"Valid Poilvache" ', 'Formatting: wrong formatting due to multi-email') # instantiate composer, post message composer_form = Form(self.env['mail.compose.message'].with_context( self._get_web_context( self.test_record, add_web=True, default_template_id=self.template.id, ) )) composer = composer_form.save() with self.mock_mail_gateway(mail_unlink_sent=False), self.mock_mail_app(): composer.action_send_mail() # find partners created during sending (as emails are transformed into partners) # FIXME: currently email finding based on formatted / multi emails does # not work new_partners = self.env['res.partner'].search([]).search([('id', 'not in', existing_partners.ids)]) self.assertEqual(len(new_partners), 9, 'Mail (FIXME): multiple partner creation due to formatted / multi emails: 1 extra partner') self.assertIn(partner_format_tofind, new_partners) self.assertIn(partner_multi_tofind, new_partners) self.assertIn(partner_at_tofind, new_partners) self.assertEqual(new_partners[0:3].ids, (partner_format_tofind + partner_multi_tofind + partner_at_tofind).ids) self.assertEqual( sorted(new_partners.mapped('email')), sorted(['"Bike@Home" ', '"FindMe Format" ', 'find.me.multi.1@test.example.com, "FindMe Multi" ', 'find.me.multi.2@test.example.com', 'test.cc.1@example.com', 'test.cc.2@example.com', 'test.cc.2.2@example.com', 'test.to.1@example.com', 'test.to.2@example.com']), 'Mail: created partners for valid emails (wrong / invalid not taken into account) + did not find corner cases (FIXME)' ) self.assertEqual( sorted(new_partners.mapped('email_formatted')), sorted(['"NotBike@Home" ', '"FindMe Format" ', '"FindMe Multi" ', '"find.me.multi.2@test.example.com" ', '"test.cc.1@example.com" ', '"test.cc.2@example.com" ', '"test.cc.2.2@example.com" ', '"test.to.1@example.com" ', '"test.to.2@example.com" ']), ) self.assertEqual( sorted(new_partners.mapped('name')), sorted(['NotBike@Home', 'FindMe Format', 'FindMe Multi', 'find.me.multi.2@test.example.com', 'test.cc.1@example.com', 'test.to.1@example.com', 'test.to.2@example.com', 'test.cc.2@example.com', 'test.cc.2.2@example.com']), 'Mail: currently setting name = email, not taking into account formatted emails' ) # global outgoing: two mail.mail (all customer recipients, then all employee recipients) # and 11 emails, and 1 inbox notification (admin) # FIXME template is sent only to partners (email_to are transformed) -> # wrong / weird emails (see email_formatted of partners) is kept # FIXME: more partners created than real emails (see above) -> due to # transformation from email -> partner in template 'generate_recipients' # there are more partners than email to notify; self.assertEqual(len(self._new_mails), 2, 'Should have created 2 mail.mail') self.assertEqual( len(self._mails), len(new_partners) + 3, f'Should have sent {len(new_partners) + 3} emails, one / recipient ({len(new_partners)} mailed partners + partner_1 + partner_2 + partner_employee)') self.assertMailMail( self.partner_employee_2, 'sent', author=self.partner_employee, email_values={ 'body_content': f'TemplateBody {self.test_record.name}', # single email event if email field is multi-email 'email_from': formataddr((self.user_employee.name, 'email.from.1@test.mycompany.com')), 'subject': f'TemplateSubject {self.test_record.name}', }, fields_values={ # currently holding multi-email 'email_from' 'email_from': formataddr((self.user_employee.name, 'email.from.1@test.mycompany.com,email.from.2@test.mycompany.com')), }, mail_message=self.test_record.message_ids[0], ) recipients = self.partner_1 + self.partner_2 + new_partners self.assertMailMail( recipients, 'sent', author=self.partner_employee, email_to_recipients=[ [self.partner_1.email_formatted], [f'"{self.partner_2.name}" ', f'"{self.partner_2.name}" '], ] + [[new_partners[0]['email_formatted']], ['"FindMe Multi" ', '"FindMe Multi" '] ] + [[email] for email in new_partners[2:].mapped('email_formatted')], email_values={ 'body_content': f'TemplateBody {self.test_record.name}', # single email event if email field is multi-email 'email_from': formataddr((self.user_employee.name, 'email.from.1@test.mycompany.com')), 'subject': f'TemplateSubject {self.test_record.name}', }, fields_values={ # currently holding multi-email 'email_from' 'email_from': formataddr((self.user_employee.name, 'email.from.1@test.mycompany.com,email.from.2@test.mycompany.com')), }, mail_message=self.test_record.message_ids[0], ) # actual emails sent through smtp for recipient in recipients: # multi emails -> send multiple emails (smart) if recipient == self.partner_2: smtp_to_list = ['valid.other.1@agrolait.com', 'valid.other.cc@agrolait.com'] # find.me.format elif recipient == new_partners[0]: self.assertEqual(recipient, partner_format_tofind) smtp_to_list = ['find.me.format@test.example.com'] # find.me.multi was split into two partners elif recipient == new_partners[1]: self.assertEqual(recipient, partner_multi_tofind) smtp_to_list = ['find.me.multi.1@test.example.com', 'find.me.multi.2@test.example.com'] elif recipient == new_partners[3]: smtp_to_list = ['find.me.multi.2@test.example.com'] # bike@home: name is not recognized as email anymore elif recipient == new_partners[2]: self.assertEqual(recipient, partner_at_tofind) smtp_to_list = ['find.me.at@test.example.com'] else: smtp_to_list = [recipient.email_normalized] self.assert_email_sent_smtp( smtp_from=f'{self.alias_bounce}@{self.alias_domain}', smtp_to_list=smtp_to_list, mail_server=self.mail_server_domain, # msg_from takes only first found normalized email to make a valid email_from message_from=formataddr( (self.user_employee.name, 'email.from.1@test.mycompany.com', )), # similar envelope, assert_email_sent_smtp cannot distinguish # records (would have to dive into content, too complicated) emails_count=1, ) @tagged('mail_composer', 'mail_blacklist') class TestComposerResultsCommentStatus(TestMailComposer): """ Test cases involving blacklist, opt-out, state management, ... specific class to avoid bloating the base comment-based composer tests. """ @classmethod def setUpClass(cls): """ Test data: 4 records with a customer set, then some additional records based on emails, duplicates, ... Record0: partner is blacklisted Record1: Record4 has the same email (but no customer set) Record5 and Record6 have same email (notlinked to any customer) """ super(TestComposerResultsCommentStatus, cls).setUpClass() # ensure employee can create partners, necessary for templates cls.user_employee.write({ 'groups_id': [(4, cls.env.ref('base.group_partner_manager').id)], }) # add 2 new records with customers cls.test_records, cls.test_partners = cls._create_records_for_batch( 'mail.test.ticket.el', 4, additional_values={'user_id': cls.user_employee_2.id}, prefix='el_' ) # create bl / optout / duplicates, see docstring cls.env['mail.blacklist']._add( cls.test_partners[0].email_formatted ) cls.test_records += cls.env[cls.test_records._name].create([ { 'email_from': cls.test_records[1].email_from, 'name': 'Email of Record2', 'user_id': cls.user_employee_2.id, }, { 'email_from': 'test.duplicate@test.example.com', 'name': 'Dupe email (first)', 'user_id': cls.user_employee_2.id, }, { 'email_from': 'test.duplicate@test.example.com', 'name': 'Dupe email (second)', 'user_id': cls.user_employee_2.id, }, ]) cls.template.write({ 'auto_delete': False, 'model_id': cls.env['ir.model']._get_id(cls.test_records._name), }) def test_assert_initial_data(self): """ Ensure class initial data to ease understanding """ self.assertFalse(self.template.auto_delete) self.assertEqual(len(self.test_records), 7) self.assertEqual(self.test_records.user_id, self.user_employee_2) self.assertEqual(self.test_records.message_partner_ids, self.partner_employee_2) self.assertEqual(self.test_records[1].email_from, self.test_records[4].email_from) self.assertEqual(self.test_records[5].email_from, self.test_records[6].email_from) self.assertEqual(len(self.test_partners), 4) self.assertTrue(self.test_partners[0].is_blacklisted) @users('employee') @mute_logger('odoo.tests', 'odoo.addons.mail.models.mail_mail', 'odoo.models.unlink') def test_comment_blacklist(self): """ Tests a document-based comment with the excluded emails. It is currently bypassed, as we consider posting bypasses the exclusion list. """ test_record = self.test_records[0].with_env(self.env) composer_form = Form(self.env['mail.compose.message'].with_context( self._get_web_context(test_record, add_web=True, default_template_id=self.template.id) )) composer = composer_form.save() with self.mock_mail_gateway(mail_unlink_sent=False), self.mock_mail_app(): composer._action_send_mail() # one mail to the customer, one mail to the follower message = test_record.message_ids[0] for recipient in test_record.customer_id + self.partner_employee_2: with self.subTest(recipient=recipient): self.assertMailMail( recipient, 'sent', mail_message=message, author=self.partner_employee, # author != email_from (template sets only email_from) email_values={ 'email_from': self.user_employee_2.email_formatted, # set by template }, ) self.assertEqual(len(self._mails), 2, 'Should have sent 2 emails, skipping the exclusion list') @tagged('mail_composer', 'multi_lang') class TestComposerResultsMass(TestMailComposer): @classmethod def setUpClass(cls): super(TestComposerResultsMass, cls).setUpClass() # ensure employee can create partners, necessary for templates cls.user_employee.write({ 'groups_id': [(4, cls.env.ref('base.group_partner_manager').id)], }) @users('employee') @mute_logger('odoo.tests', 'odoo.addons.mail.models.mail_mail', 'odoo.models.unlink') def test_mail_composer_delete(self): """ Check mail / msg delete support """ # ensure initial data self.assertTrue(self.template.auto_delete) self.assertEqual(self.test_records.user_id, self.user_employee_2) self.assertEqual(self.test_records.message_partner_ids, self.partner_employee_2) composer_form = Form(self.env['mail.compose.message'].with_context( self._get_web_context(self.test_records, add_web=True, default_template_id=self.template.id) )) composer = composer_form.save() self.assertFalse(composer.auto_delete, 'Fixme: should take composer value') self.assertFalse(composer.auto_delete_message) with self.mock_mail_gateway(mail_unlink_sent=True), self.mock_mail_app(): composer._action_send_mail() self.assertEqual(len(self._mails), 2, 'Should have sent 1 email per record') self.assertEqual(len(self._new_mails), 2, 'Should have created 1 mail.mail per record') self.assertFalse(self._new_mails.exists(), 'Should have deleted mail.mail records') self.assertEqual(len(self._new_msgs), 2, 'Should have created 1 mail.mail per record') self.assertEqual(self._new_msgs.exists(), self._new_msgs, 'Should not have deleted mail.message records') # force composer auto_delete field composer_form = Form(self.env['mail.compose.message'].with_context( self._get_web_context(self.test_records, add_web=True, default_template_id=self.template.id) )) composer = composer_form.save() composer.auto_delete = False with self.mock_mail_gateway(mail_unlink_sent=True), self.mock_mail_app(): composer._action_send_mail() self.assertEqual(len(self._mails), 2, 'Should have sent 1 email per record') self.assertEqual(len(self._new_mails), 2, 'Should have created 1 mail.mail per record') # self.assertEqual(self._new_mails.exists(), self._new_mails, 'Should not have deleted mail.mail records') self.assertFalse(self._new_mails.exists(), 'TODO: Template is forced over composer value, which is not correct') self.assertEqual(len(self._new_msgs), 2, 'Should have created 1 mail.mail per record') self.assertEqual(self._new_msgs.exists(), self._new_msgs, 'Should not have deleted mail.message records') # check composer auto_delete_message composer_form = Form(self.env['mail.compose.message'].with_context( self._get_web_context(self.test_records, add_web=True, default_template_id=self.template.id) )) composer = composer_form.save() composer.auto_delete_message = True with self.mock_mail_gateway(mail_unlink_sent=True), self.mock_mail_app(): composer._action_send_mail() # global outgoing self.assertEqual(len(self._mails), 2, 'Should have sent 1 email per record') self.assertEqual(len(self._new_mails), 2, 'Should have created 1 mail.mail per record') self.assertFalse(self._new_mails.exists(), 'Should have deleted mail.mail records') self.assertEqual(len(self._new_msgs), 2, 'Should have created 1 mail.mail per record') self.assertFalse(self._new_msgs.exists(), 'Should have deleted mail.message records') @users('employee') @mute_logger('odoo.models.unlink', 'odoo.addons.mail.models.mail_mail') def test_mail_composer_wtpl(self): self.template.auto_delete = False # keep sent emails to check content # ensure initial data self.assertEqual(self.test_records.user_id, self.user_employee_2) self.assertEqual(self.test_records.message_partner_ids, self.partner_employee_2) composer_form = Form(self.env['mail.compose.message'].with_context( self._get_web_context(self.test_records, add_web=True, default_template_id=self.template.id) )) composer = composer_form.save() self.assertFalse(composer.reply_to_force_new, 'Mail: thread-enabled models should use auto thread by default') with self.mock_mail_gateway(mail_unlink_sent=True): composer._action_send_mail() # global outgoing self.assertEqual(len(self._new_mails), 2, 'Should have created 1 mail.mail per record') self.assertEqual(len(self._mails), 2, 'Should have sent 1 email per record') for record in self.test_records: # message copy is kept message = record.message_ids[0] # template is sent directly using customer field, meaning we have recipients self.assertMailMail(record.customer_id, 'sent', mail_message=message, author=self.partner_employee, email_values={ 'email_from': self.partner_employee_2.email_formatted, }) # message content self.assertEqual(message.subject, 'TemplateSubject %s' % record.name) self.assertEqual(message.body, '

TemplateBody %s

' % record.name) self.assertEqual(message.author_id, self.user_employee.partner_id) # post-related fields are void self.assertFalse(message.subtype_id) self.assertFalse(message.partner_ids) @users('employee') @mute_logger('odoo.models.unlink', 'odoo.addons.mail.models.mail_mail') def test_mail_composer_wtpl_complete(self): """ Test a composer in mass mode with a quite complete template, containing notably email-based recipients and attachments. Translations and email layout supported are also tested. """ # as we use the email queue, don't have failing tests due to other outgoing emails self.env['mail.mail'].sudo().search([]).unlink() attachment_data = self._generate_attachments_data(2, self.template._name, self.template.id) email_to_1 = 'test.to.1@test.example.com' email_to_2 = 'test.to.2@test.example.com' email_to_3 = 'test.to.1@test.example.com' # duplicate: should not sent twice the email email_cc_1 = 'test.cc.1@test.example.com' self.template.write({ 'auto_delete': False, # keep sent emails to check content 'attachment_ids': [(0, 0, a) for a in attachment_data], 'email_to': '%s, %s, %s' % (email_to_1, email_to_2, email_to_3), 'email_cc': email_cc_1, 'partner_to': '%s, {{ object.customer_id.id if object.customer_id else "" }}' % self.partner_admin.id, 'report_name': 'TestReport for {{ object.name }}', # test cursor forces html 'report_template': self.test_report.id, }) attachs = self.env['ir.attachment'].search([('name', 'in', [a['name'] for a in attachment_data])]) self.assertEqual(len(attachs), 2) # ensure initial data self.assertEqual(self.test_records.user_id, self.user_employee_2) self.assertEqual(self.test_records.message_partner_ids, self.partner_employee_2) for email_layout_xmlid, use_lang in product( (False, 'mail.test_layout'), (False, True), ): with self.subTest(email_layout_xmlid=email_layout_xmlid, use_lang=use_lang): # update test configuration if use_lang: langs = ('es_ES', 'en_US') self.test_partners[0].lang = langs[0] self.test_partners[1].lang = langs[1] else: langs = (False, False) self.test_partners.lang = False ctx = { 'active_ids': self.test_records.ids, 'default_model': self.test_records._name, 'default_composition_mode': 'mass_mail', 'default_template_id': self.template.id, } if email_layout_xmlid: ctx['default_email_layout_xmlid'] = email_layout_xmlid # launch composer in mass mode composer_form = Form(self.env['mail.compose.message'].with_context(ctx)) composer = composer_form.save() # ensure some parameters used afterwards author = self.env.user.partner_id self.assertEqual(composer.author_id, author, 'Author cannot be synchronized with a raw email_from') self.assertEqual(composer.email_from, self.template.email_from) with self.mock_mail_gateway(mail_unlink_sent=False): composer._action_send_mail() new_partners = self.env['res.partner'].search([ ('email', 'in', [email_to_1, email_to_2, email_to_3, email_cc_1]) ]) self.assertEqual(len(new_partners), 3) # global outgoing: emails sent self.assertEqual(len(self._new_mails), 2, 'Should have created 1 mail.mail per record') self.assertEqual(len(self._mails), 10, 'Should have sent emails') self.assertEqual(self._new_mails.mapped('scheduled_date'), [False] * 2) self.assertEqual(len(self._mails), 10, 'Should have sent 5 emails per record') for record, exp_lang in zip(self.test_records, langs): # message copy is kept message = record.message_ids[0] # translation are currently not supported at all as they # are fetched composer side, which is most probably not # translated (only template is) if False and exp_lang == 'es_ES': exp_body = f'SpanishBody for {record.name}' exp_subject = f'SpanishSubject for {record.name}' else: exp_body = f'TemplateBody {record.name}' exp_subject = f'TemplateSubject {record.name}' # template is sent only to partners (email_to are transformed) self.assertMailMail(record.customer_id + new_partners + self.partner_admin, 'sent', mail_message=message, author=author, email_values={ 'attachments_info': [ {'name': 'AttFileName_00.txt', 'raw': b'AttContent_00', 'type': 'text/plain'}, {'name': 'AttFileName_01.txt', 'raw': b'AttContent_01', 'type': 'text/plain'}, {'name': 'TestReport for %s.html' % record.name, 'type': 'text/plain'}, ], 'body_content': exp_body, 'email_from': self.partner_employee_2.email_formatted, # profit from this test to check references are set to message_id in mailing emails 'references_message_id_check': True, 'subject': exp_subject, }, fields_values={ 'email_from': self.partner_employee_2.email_formatted, 'mail_server_id': self.mail_server_domain, 'reply_to': formataddr(( f'{self.env.user.company_id.name} {record.name}', f'{self.alias_catchall}@{self.alias_domain}' )), 'subject': exp_subject, }, ) # Low-level checks on outgoing email for the recipient to # check layouting and language. Note that standard layout # is not tested against translations, only the custom one # to ease translations checks. sent_mail = self._find_sent_email( self.partner_employee_2.email_formatted, [formataddr((record.customer_id.name, email_normalize(record.customer_id.email, strict=False)))] ) debug_info = '' if not sent_mail: debug_info = '-'.join('From: %s-To: %s' % (mail['email_from'], mail['email_to']) for mail in self._mails) self.assertTrue( bool(sent_mail), f'Expected mail from {self.partner_employee_2.email_formatted} to {formataddr((record.customer_id.name, record.customer_id.email))} not found in {debug_info}' ) # Currently layouting in mailing mode is not supported. # Hence no translations. self.assertEqual( sent_mail['body'], f'

TemplateBody {record.name}

' ) @users('employee') @mute_logger('odoo.models.unlink', 'odoo.addons.mail.models.mail_mail') def test_mail_composer_wtpl_recipients(self): """ Test various combinations of recipients: active_domain, active_id, active_ids, ... to ensure fallback behavior are working. """ # 1: active_domain composer_form = Form(self.env['mail.compose.message'].with_context( self._get_web_context(self.test_records, add_web=True, default_template_id=self.template.id, active_ids=[], default_use_active_domain=True, default_active_domain=[('id', 'in', self.test_records.ids)]) )) composer = composer_form.save() with self.mock_mail_gateway(mail_unlink_sent=True): composer._action_send_mail() # global outgoing self.assertEqual(len(self._new_mails), 2, 'Should have created 1 mail.mail per record') self.assertEqual(len(self._mails), 2, 'Should have sent 1 email per record') for record in self.test_records: # template is sent directly using customer field, even if author is partner_employee self.assertSentEmail(self.partner_employee_2.email_formatted, record.customer_id) # 2: active_domain not taken into account if use_active_domain is False composer_form = Form(self.env['mail.compose.message'].with_context( self._get_web_context(self.test_records, add_web=True, default_template_id=self.template.id, default_use_active_domain=False, default_active_domain=[('id', 'in', -1)]) )) composer = composer_form.save() with self.mock_mail_gateway(mail_unlink_sent=True): composer._action_send_mail() # global outgoing self.assertEqual(len(self._new_mails), 2, 'Should have created 1 mail.mail per record') self.assertEqual(len(self._mails), 2, 'Should have sent 1 email per record') # 3: fallback on active_id if not active_ids composer_form = Form(self.env['mail.compose.message'].with_context( self._get_web_context(self.test_records, add_web=True, default_template_id=self.template.id, active_ids=[]) )) composer = composer_form.save() with self.mock_mail_gateway(mail_unlink_sent=False): composer._action_send_mail() # global outgoing self.assertEqual(len(self._new_mails), 1, 'Should have created 1 mail.mail per record') self.assertEqual(len(self._mails), 1, 'Should have sent 1 email per record') # 3: void is void: raise in comment mode, just don't send anything in mass mail mode composer_form = Form(self.env['mail.compose.message'].with_context( default_model='mail.test.ticket', default_template_id=self.template.id )) composer = composer_form.save() self.assertEqual(composer.composition_mode, 'comment') with self.mock_mail_gateway(mail_unlink_sent=False), self.assertRaises(ValueError): composer._action_send_mail() self.assertNotSentEmail() composer_form = Form(self.env['mail.compose.message'].with_context( default_composition_mode='mass_mail', default_model='mail.test.ticket', default_template_id=self.template.id )) composer = composer_form.save() self.assertEqual(composer.composition_mode, 'mass_mail') with self.mock_mail_gateway(mail_unlink_sent=False): composer._action_send_mail() self.assertNotSentEmail() @users('employee') @mute_logger('odoo.addons.mail.models.mail_mail') def test_mail_composer_wtpl_recipients_email_fields(self): """ Test various combinations of corner case / not standard filling of email fields: multi email, formatted emails, ... """ existing_partners = self.env['res.partner'].search([]) partner_format_tofind, partner_multi_tofind, partner_at_tofind = self.env['res.partner'].create([ { 'email': '"FindMe Format" ', 'name': 'FindMe Format', }, { 'email': 'find.me.multi.1@test.example.com, "FindMe Multi" ', 'name': 'FindMe Multi', }, { 'email': '"Bike@Home" ', 'name': 'NotBike@Home', } ]) email_ccs = ['"Raoul" ', '"Raoulette" ', 'test.cc.2.2@example.com>', 'invalid', ' '] email_tos = ['"Micheline, l\'Immense" ', 'test.to.2@example.com', 'wrong', ' '] self.template.write({ 'email_cc': ', '.join(email_ccs), 'email_from': '{{ user.email_formatted }}', 'email_to': ', '.join(email_tos + (partner_format_tofind + partner_multi_tofind + partner_at_tofind).mapped('email')), 'partner_to': f'{self.partner_1.id},{self.partner_2.id},0,test', }) self.user_employee.write({'email': 'email.from.1@test.mycompany.com, email.from.2@test.mycompany.com'}) self.partner_1.write({'email': '"Valid Formatted" '}) self.partner_2.write({'email': 'valid.other.1@agrolait.com, valid.other.cc@agrolait.com'}) # ensure values used afterwards for testing self.assertEqual( self.partner_employee.email_formatted, '"Ernest Employee" ', 'Formatting: wrong formatting due to multi-email') self.assertEqual( self.partner_1.email_formatted, '"Valid Lelitre" ', 'Formatting: avoid wrong double encapsulation') self.assertEqual( self.partner_2.email_formatted, '"Valid Poilvache" ', 'Formatting: wrong formatting due to multi-email') # instantiate composer, send mailing composer_form = Form(self.env['mail.compose.message'].with_context( self._get_web_context( self.test_records, add_web=True, default_template_id=self.template.id, ) )) composer = composer_form.save() with self.mock_mail_gateway(mail_unlink_sent=False), self.mock_mail_app(): # don't want to test duplicates, more email management composer.with_context(mailing_document_based=True).action_send_mail() # find partners created during sending (as emails are transformed into partners) # FIXME: currently email finding based on formatted / multi emails does # not work new_partners = self.env['res.partner'].search([]).search([('id', 'not in', existing_partners.ids)]) self.assertEqual(len(new_partners), 9, 'Mail (FIXME): did not find existing partners for formatted / multi emails: 1 extra partner') self.assertIn(partner_format_tofind, new_partners) self.assertIn(partner_multi_tofind, new_partners) self.assertIn(partner_at_tofind, new_partners) self.assertEqual(new_partners[0:3].ids, (partner_format_tofind + partner_multi_tofind + partner_at_tofind).ids) self.assertEqual( sorted(new_partners.mapped('email')), sorted(['"Bike@Home" ', '"FindMe Format" ', 'find.me.multi.1@test.example.com, "FindMe Multi" ', 'find.me.multi.2@test.example.com', 'test.cc.1@example.com', 'test.cc.2@example.com', 'test.cc.2.2@example.com', 'test.to.1@example.com', 'test.to.2@example.com']), 'Mail: created partners for valid emails (wrong / invalid not taken into account) + did not find corner cases (FIXME)' ) self.assertEqual( sorted(new_partners.mapped('email_formatted')), sorted(['"NotBike@Home" ', '"FindMe Format" ', '"FindMe Multi" ', '"find.me.multi.2@test.example.com" ', '"test.cc.1@example.com" ', '"test.cc.2@example.com" ', '"test.cc.2.2@example.com" ', '"test.to.1@example.com" ', '"test.to.2@example.com" ']), ) self.assertEqual( sorted(new_partners.mapped('name')), sorted(['NotBike@Home', 'FindMe Format', 'FindMe Multi', 'find.me.multi.2@test.example.com', 'test.cc.1@example.com', 'test.to.1@example.com', 'test.to.2@example.com', 'test.cc.2@example.com', 'test.cc.2.2@example.com']), 'Mail: when possible, find name in formatted emails, otherwise fallback on email' ) # global outgoing: one mail.mail (all customer recipients), * 2 records # Note that employee is not mailed here compared to 'comment' mode as he # is not in the template recipients, only a follower # FIXME template is sent only to partners (email_to are transformed) -> # wrong / weird emails (see email_formatted of partners) is kept # FIXME: more partners created than real emails (see above) -> due to # transformation from email -> partner in template 'generate_recipients' # there are more partners than email to notify; self.assertEqual(len(self._new_mails), 2, 'Should have created 2 mail.mail') self.assertEqual( len(self._mails), (len(new_partners) + 2) * 2, f'Should have sent {(len(new_partners) + 2) * 2} emails, one / recipient ({len(new_partners)} mailed partners + partner_1 + partner_2) * 2 records') for record in self.test_records: recipients = self.partner_1 + self.partner_2 + new_partners self.assertMailMail( recipients, 'sent', author=self.partner_employee, email_to_recipients=[ [self.partner_1.email_formatted], [f'"{self.partner_2.name}" ', f'"{self.partner_2.name}" '], ] + [[new_partners[0]['email_formatted']], ['"FindMe Multi" ', '"FindMe Multi" '] ] + [[email] for email in new_partners[2:].mapped('email_formatted')], email_values={ 'body_content': f'TemplateBody {record.name}', # single email event if email field is multi-email 'email_from': formataddr((self.user_employee.name, 'email.from.1@test.mycompany.com')), 'reply_to': formataddr(( f'{self.env.user.company_id.name} {record.name}', f'{self.alias_catchall}@{self.alias_domain}' )), 'subject': f'TemplateSubject {record.name}', }, fields_values={ # currently holding multi-email 'email_from' 'email_from': self.partner_employee.email_formatted, 'reply_to': formataddr(( f'{self.env.user.company_id.name} {record.name}', f'{self.alias_catchall}@{self.alias_domain}' )), }, mail_message=record.message_ids[0], # message copy is kept ) # actual emails sent through smtp for recipient in recipients: # multi emails -> send multiple emails (smart) if recipient == self.partner_2: smtp_to_list = ['valid.other.1@agrolait.com', 'valid.other.cc@agrolait.com'] # find.me.format elif recipient == new_partners[0]: self.assertEqual(recipient, partner_format_tofind) smtp_to_list = ['find.me.format@test.example.com'] # find.me.multi was split into two partners elif recipient == new_partners[1]: self.assertEqual(recipient, partner_multi_tofind) smtp_to_list = ['find.me.multi.1@test.example.com', 'find.me.multi.2@test.example.com'] elif recipient == new_partners[3]: smtp_to_list = ['find.me.multi.2@test.example.com'] # bike@home: name is not recognized as email anymore elif recipient == new_partners[2]: self.assertEqual(recipient, partner_at_tofind) smtp_to_list = ['find.me.at@test.example.com'] else: smtp_to_list = [recipient.email_normalized] self.assert_email_sent_smtp( smtp_from=f'{self.alias_bounce}@{self.alias_domain}', smtp_to_list=smtp_to_list, mail_server=self.mail_server_domain, # msg_from takes only first found normalized email to make a valid email_from message_from=formataddr( (self.user_employee.name, 'email.from.1@test.mycompany.com', )), # similar envelope, assert_email_sent_smtp cannot distinguish # records (would have to dive into content, too complicated) emails_count=2, ) @users('employee') @mute_logger('odoo.models.unlink', 'odoo.addons.mail.models.mail_mail') def test_mail_composer_wtpl_reply_to(self): # test without catchall filling reply-to composer_form = Form(self.env['mail.compose.message'].with_context( self._get_web_context(self.test_records, add_web=True, default_template_id=self.template.id) )) composer = composer_form.save() with self.mock_mail_gateway(mail_unlink_sent=False): # remove alias so that _notify_get_reply_to will return the default value instead of alias self.env['ir.config_parameter'].sudo().set_param("mail.catchall.domain", None) composer.action_send_mail() for record in self.test_records: # template is sent only to partners (email_to are transformed) self.assertMailMail(record.customer_id, 'sent', mail_message=record.message_ids[0], author=self.partner_employee, email_values={ 'email_from': self.partner_employee_2.email_formatted, 'reply_to': self.partner_employee_2.email_formatted, }, fields_values={ 'email_from': self.partner_employee_2.email_formatted, 'reply_to': self.partner_employee_2.email_formatted, }, ) @users('employee') @mute_logger('odoo.models.unlink', 'odoo.addons.mail.models.mail_mail') def test_mail_composer_wtpl_reply_to_force_new(self): """ Test no auto thread behavior, notably with reply-to. """ # launch composer in mass mode composer_form = Form(self.env['mail.compose.message'].with_context( self._get_web_context(self.test_records, add_web=True, default_template_id=self.template.id) )) composer_form.reply_to_mode = 'new' composer_form.reply_to = "{{ '\"' + object.name + '\" <%s>' % 'dynamic.reply.to@test.com' }}" composer = composer_form.save() self.assertTrue(composer.reply_to_force_new) with self.mock_mail_gateway(mail_unlink_sent=False): composer.action_send_mail() for record in self.test_records: self.assertMailMail(record.customer_id, 'sent', mail_message=record.message_ids[0], author=self.partner_employee, email_values={ 'body_content': 'TemplateBody %s' % record.name, 'email_from': self.partner_employee_2.email_formatted, 'reply_to': formataddr(( f'{record.name}', 'dynamic.reply.to@test.com' )), 'subject': 'TemplateSubject %s' % record.name, }, fields_values={ 'email_from': self.partner_employee_2.email_formatted, 'reply_to': formataddr(( f'{record.name}', 'dynamic.reply.to@test.com' )), }, ) @tagged('mail_composer', 'mail_blacklist') class TestComposerResultsMassStatus(TestMailComposer): """ Test cases involving blacklist, opt-out, state management, ... specific class to avoid bloating the base mailing-based composer tests. """ @classmethod def setUpClass(cls): """ Test data: 4 records with a customer set, then some additional records based on emails, duplicates, ... Record0: partner is blacklisted Record1: Record4 has the same email (but no customer set) Record5 and Record6 have same email (notlinked to any customer) """ super(TestComposerResultsMassStatus, cls).setUpClass() # ensure employee can create partners, necessary for templates cls.user_employee.write({ 'groups_id': [(4, cls.env.ref('base.group_partner_manager').id)], }) # add 2 new records with customers cls.test_records, cls.test_partners = cls._create_records_for_batch( 'mail.test.ticket.el', 4, additional_values={'user_id': cls.user_employee_2.id}, prefix='el_' ) # create bl / optout / duplicates, see docstring cls.env['mail.blacklist']._add( cls.test_partners[0].email_formatted ) cls.test_records += cls.env[cls.test_records._name].create([ { 'email_from': cls.test_records[1].email_from, 'name': 'Email of Record2', 'user_id': cls.user_employee_2.id, }, { 'email_from': 'test.duplicate@test.example.com', 'name': 'Dupe email (first)', 'user_id': cls.user_employee_2.id, }, { 'email_from': 'test.duplicate@test.example.com', 'name': 'Dupe email (second)', 'user_id': cls.user_employee_2.id, }, ]) cls.template.write({ 'model_id': cls.env['ir.model']._get_id(cls.test_records._name), }) def test_assert_initial_data(self): """ Ensure class initial data to ease understanding """ self.assertTrue(self.template.auto_delete) self.assertEqual(len(self.test_records), 7) self.assertEqual(self.test_records.user_id, self.user_employee_2) self.assertEqual(self.test_records.message_partner_ids, self.partner_employee_2) self.assertEqual(self.test_records[1].email_from, self.test_records[4].email_from) self.assertEqual(self.test_records[5].email_from, self.test_records[6].email_from) self.assertEqual(len(self.test_partners), 4) self.assertTrue(self.test_partners[0].is_blacklisted) @users('employee') @mute_logger('odoo.tests', 'odoo.addons.mail.models.mail_mail', 'odoo.models.unlink') def test_mailing_blacklist_mixin(self): """ Tests a document-based mass mailing with excluded emails. Their emails are canceled if the model inherits from the blacklist mixin. """ test_records = self.test_records[:2].with_env(self.env) composer_form = Form(self.env['mail.compose.message'].with_context( self._get_web_context(test_records, add_web=True, default_template_id=self.template.id) )) composer = composer_form.save() with self.mock_mail_gateway(mail_unlink_sent=False), self.mock_mail_app(): composer._action_send_mail() for record, expected_state, expected_ft in zip( test_records, ['cancel', 'sent'], ['mail_bl', False] ): with self.subTest(record=record, expected_state=expected_state, expected_ft=expected_ft): self.assertMailMail( record.customer_id, expected_state, # author is current user, email_from is coming from template (user_id of record) author=self.user_employee.partner_id, fields_values={ 'email_from': self.user_employee_2.email_formatted, 'failure_reason': False, 'failure_type': expected_ft, }, email_values={ 'email_from': self.user_employee_2.email_formatted, } ) self.assertEqual(len(self._mails), 1, 'Should have sent 1 email, and skipped an excluded email.') @users('employee') @mute_logger('odoo.tests', 'odoo.addons.mail.models.mail_mail', 'odoo.models.unlink') def test_mailing_duplicates_document_based(self): """ Tests a document-based mass mailing with the same address mails This should be allowed and not considered as duplicate in this context """ test_records = self.test_records.with_env(self.env) composer_form = Form(self.env['mail.compose.message'].with_context( self._get_web_context(test_records, add_web=True, default_template_id=self.template.id) )) composer = composer_form.save() # by default duplicates are canceled with self.mock_mail_gateway(mail_unlink_sent=False), self.mock_mail_app(): composer._action_send_mail() for record, expected_state, expected_ft in zip( test_records, ['cancel', 'sent', 'sent', 'sent', 'cancel', 'sent', 'cancel'], ['mail_bl', False, False, False, 'mail_dup', False, 'mail_dup'] ): with self.subTest(record=record, expected_state=expected_state, expected_ft=expected_ft): self.assertMailMailWRecord( record, record.customer_id, expected_state, # author is current user, email_from is coming from template (user_id of record) author=self.user_employee.partner_id, fields_values={ 'email_from': self.user_employee_2.email_formatted, 'failure_reason': False, 'failure_type': expected_ft, }, email_values={ 'email_from': self.user_employee_2.email_formatted, } ) self.assertEqual(len(self._mails), 4, 'Should have sent 4 emails, and skipped an excluded and 2 duplicate emails.') # magic context key allowing to send duplicates when necessary with self.mock_mail_gateway(mail_unlink_sent=False), self.mock_mail_app(): composer.with_context(mailing_document_based=True)._action_send_mail() for record, expected_state, expected_ft in zip( test_records, ['cancel', 'sent', 'sent', 'sent', 'sent', 'sent', 'sent'], ['mail_bl', False, False, False, False, False, False] ): with self.subTest(record=record, expected_state=expected_state, expected_ft=expected_ft): self.assertMailMailWRecord( record, record.customer_id, expected_state, # author is current user, email_from is coming from template (user_id of record) author=self.user_employee.partner_id, fields_values={ 'email_from': self.user_employee_2.email_formatted, 'failure_reason': False, 'failure_type': expected_ft, }, email_values={ 'email_from': self.user_employee_2.email_formatted, } ) self.assertEqual(len(self._mails), 6, 'Should have sent 6 emails, and skipped an excluded email')