File: test_unisender_go_backend.py

package info (click to toggle)
django-anymail 13.0-1
  • links: PTS, VCS
  • area: main
  • in suites: trixie
  • size: 2,480 kB
  • sloc: python: 27,832; makefile: 132; javascript: 33; sh: 9
file content (936 lines) | stat: -rw-r--r-- 37,534 bytes parent folder | download | duplicates (2)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
import json
from base64 import b64encode
from datetime import date, datetime
from decimal import Decimal
from email.mime.base import MIMEBase
from email.mime.image import MIMEImage
from unittest.mock import patch

from django.core import mail
from django.test import SimpleTestCase, override_settings, tag
from django.utils.timezone import (
    get_fixed_timezone,
    override as override_current_timezone,
)

from anymail.exceptions import (
    AnymailAPIError,
    AnymailConfigurationError,
    AnymailRecipientsRefused,
    AnymailSerializationError,
    AnymailUnsupportedFeature,
)
from anymail.message import AnymailMessage, attach_inline_image_file

from .mock_requests_backend import (
    RequestsBackendMockAPITestCase,
    SessionSharingTestCases,
)
from .utils import (
    SAMPLE_IMAGE_FILENAME,
    AnymailTestMixin,
    sample_image_content,
    sample_image_path,
)


@tag("unisender_go")
@override_settings(
    EMAIL_BACKEND="anymail.backends.unisender_go.EmailBackend",
    ANYMAIL={
        "UNISENDER_GO_API_KEY": "test_api_key",
        "UNISENDER_GO_API_URL": "https://go1.unisender.ru/ru/transactional/api/v1",
    },
)
class UnisenderGoBackendMockAPITestCase(RequestsBackendMockAPITestCase):
    DEFAULT_RAW_RESPONSE = json.dumps(
        {
            "status": "success",
            "job_id": "1rctPx-00021H-CcC4",
            "emails": ["to@example.com"],
        }
    ).encode("utf-8")
    DEFAULT_STATUS_CODE = 200
    DEFAULT_CONTENT_TYPE = "application/json"

    def setUp(self):
        super().setUp()

        # Patch uuid4 to generate predictable message_ids for testing
        patch_uuid4 = patch(
            "anymail.backends.unisender_go.uuid.uuid4",
            side_effect=[f"mocked-uuid-{n:d}" for n in range(1, 10)],
        )
        patch_uuid4.start()
        self.addCleanup(patch_uuid4.stop)

        # Simple message useful for many tests
        self.message = AnymailMessage(
            "Subject", "Text Body", "from@example.com", ["to@example.com"]
        )

    def set_mock_response(
        self, success_emails=None, failed_emails=None, job_id=None, **kwargs
    ):
        """
        Pass success_emails and/or failure_emails to generate an appropriate
        API response for those specific emails. Otherwise, arguments are as
        for super call.
        :param success_emails {list[str]}: addr-specs of emails that were delivered
        :param failure_emails {dict[str,str]}: mapping of addr-spec -> failure reason
        :param job_id {str}: optional specific job_id for response
        """
        if success_emails or failed_emails:
            assert "raw" not in kwargs
            assert "json_response" not in kwargs
            assert kwargs.get("status_code", 200) == 200
            kwargs["status_code"] = 200
            kwargs["json_data"] = {
                "status": "success",
                "job_id": job_id or "1rctPx-00021H-CcC4",
                "emails": success_emails or [],
            }
            if failed_emails:
                kwargs["json_data"]["failed_emails"] = failed_emails

        return super().set_mock_response(**kwargs)


@tag("unisender_go")
class UnisenderGoBackendStandardEmailTests(UnisenderGoBackendMockAPITestCase):
    """Test backend support for Django standard email features"""

    def test_send_mail(self):
        """Test basic API for simple send"""
        mail.send_mail(
            "Subject here",
            "Here is the message.",
            "from@sender.example.com",
            ["to@example.com"],
            fail_silently=False,
        )
        self.assert_esp_called(
            "https://go1.unisender.ru/ru/transactional/api/v1/email/send.json"
        )
        http_headers = self.get_api_call_headers()
        self.assertEqual(http_headers["X-API-KEY"], "test_api_key")
        self.assertEqual(http_headers["Accept"], "application/json")
        self.assertEqual(http_headers["Content-Type"], "application/json")

        data = self.get_api_call_json()
        self.assertEqual(data["message"]["subject"], "Subject here")
        self.assertEqual(data["message"]["body"], {"plaintext": "Here is the message."})
        self.assertEqual(data["message"]["from_email"], "from@sender.example.com")
        self.assertEqual(
            data["message"]["recipients"],
            [
                {
                    "email": "to@example.com",
                    # make sure the backend assigned the message_id
                    # for event tracking and notification
                    "metadata": {"anymail_id": "mocked-uuid-1"},
                }
            ],
        )

    def test_name_addr(self):
        """Make sure RFC2822 name-addr format (with display-name) is allowed

        (Test both sender and recipient addresses)
        """
        msg = mail.EmailMessage(
            "Subject",
            "Message",
            "From Name <from@example.com>",
            ["Recipient #1 <to1@example.com>", "to2@example.com"],
            cc=["Carbon Copy <cc1@example.com>", "cc2@example.com"],
            bcc=["Blind Copy <bcc1@example.com>", "bcc2@example.com"],
        )
        msg.send()
        data = self.get_api_call_json()
        self.assertEqual(data["message"]["from_email"], "from@example.com")
        self.assertEqual(data["message"]["from_name"], "From Name")

        recipients = data["message"]["recipients"]
        self.assertEqual(len(recipients), 6)
        self.assertEqual(recipients[0]["email"], "to1@example.com")
        self.assertEqual(recipients[0]["substitutions"]["to_name"], "Recipient #1")
        self.assertEqual(recipients[1]["email"], "to2@example.com")
        self.assertNotIn("substitutions", recipients[1])  # to_name not needed
        self.assertEqual(recipients[2]["email"], "cc1@example.com")
        self.assertEqual(recipients[2]["substitutions"]["to_name"], "Carbon Copy")
        self.assertEqual(recipients[3]["email"], "cc2@example.com")
        self.assertNotIn("substitutions", recipients[3])  # to_name not needed
        self.assertEqual(recipients[4]["email"], "bcc1@example.com")
        self.assertEqual(recipients[4]["substitutions"]["to_name"], "Blind Copy")
        self.assertEqual(recipients[5]["email"], "bcc2@example.com")
        self.assertNotIn("substitutions", recipients[5])  # to_name not needed

        # This also covers Unisender Go's special handling for cc/bcc
        headers = data["message"]["headers"]
        self.assertEqual(
            headers["to"], "Recipient #1 <to1@example.com>, to2@example.com"
        )
        self.assertEqual(
            headers["cc"], "Carbon Copy <cc1@example.com>, cc2@example.com"
        )
        self.assertNotIn("bcc", headers)

    def test_display_names_with_special_chars(self):
        # Verify workaround for Unisender Go bug parsing to/cc headers
        # with display names containing commas, angle brackets, or at sign
        self.message.to = [
            '"With, Comma" <to1@example.com>',
            '"angle <brackets>" <to2@example.com>',
            '"(without) special / chars" <to3@example.com>',
        ]
        self.message.cc = [
            '"Someone @example.com" <cc1@example.com>',
            '"[without] special & chars" <cc2@example.com>',
        ]
        self.message.send()
        data = self.get_api_call_json()
        headers = data["message"]["headers"]
        # display-name with , < > @ converted to RFC 2047 encoded word;
        # not necessary for display names with other special characters
        self.assertEqual(
            headers["to"],
            "=?utf-8?q?With=2C_Comma?= <to1@example.com>, "
            "=?utf-8?q?angle_=3Cbrackets=3E?= <to2@example.com>, "
            '"(without) special / chars" <to3@example.com>',
        )
        self.assertEqual(
            headers["cc"],
            "=?utf-8?q?Someone_=40example=2Ecom?= <cc1@example.com>, "
            '"[without] special & chars" <cc2@example.com>',
        )

    def test_html_message(self):
        text_content = "This is an important message."
        html_content = "<p>This is an <strong>important</strong> message.</p>"
        email = mail.EmailMultiAlternatives(
            "Subject", text_content, "from@example.com", ["to@example.com"]
        )
        email.attach_alternative(html_content, "text/html")
        email.send()
        data = self.get_api_call_json()
        self.assertEqual(
            data["message"]["body"], {"plaintext": text_content, "html": html_content}
        )
        # Don't accidentally send the html part as an attachment:
        self.assertNotIn("attachments", data["message"])

    def test_html_only_message(self):
        html_content = "<p>This is an <strong>important</strong> message.</p>"
        email = mail.EmailMessage(
            "Subject", html_content, "from@example.com", ["to@example.com"]
        )
        email.content_subtype = "html"  # Main content is now text/html
        email.send()
        data = self.get_api_call_json()
        self.assertEqual(data["message"]["body"], {"html": html_content})

    def test_amp_html_alternative(self):
        # Unisender Go *does* support text/x-amp-html alongside text/html
        self.message.attach_alternative("<p>HTML</p>", "text/html")
        self.message.attach_alternative("<p>And AMP HTML</p>", "text/x-amp-html")
        self.message.send()
        data = self.get_api_call_json()
        self.assertEqual(data["message"]["body"]["html"], "<p>HTML</p>")
        self.assertEqual(data["message"]["body"]["amp"], "<p>And AMP HTML</p>")

    def test_extra_headers(self):
        self.message.extra_headers = {
            "X-Custom": "string",
            "X-Num": 123,
            "Reply-To": "noreply@example.com",
        }
        self.message.send()
        data = self.get_api_call_json()
        headers = data["message"]["headers"]
        self.assertEqual(headers["X-Custom"], "string")
        self.assertEqual(headers["X-Num"], 123)

        # Reply-To must be moved to separate param
        self.assertNotIn("Reply-To", headers)
        self.assertEqual(data["message"]["reply_to"], "noreply@example.com")
        self.assertNotIn("reply_to_name", data["message"])

    def test_extra_headers_serialization_error(self):
        self.message.extra_headers = {"X-Custom": Decimal(12.5)}
        with self.assertRaisesMessage(AnymailSerializationError, "Decimal"):
            self.message.send()

    def test_reply_to(self):
        # Unisender Go supports only a single reply-to
        self.message.reply_to = ['"Reply recipient" <reply@example.com']
        self.message.send()
        data = self.get_api_call_json()
        self.assertEqual(data["message"]["reply_to"], "reply@example.com")
        self.assertEqual(data["message"]["reply_to_name"], "Reply recipient")

    def test_reply_to_name_workaround(self):
        # Check workaround for reply-to display-name containing special chars
        self.message.reply_to = ['"Reply (parens)" <reply@example.com']
        self.message.send()
        data = self.get_api_call_json()
        # Special chars force RFC 2047 encoded word
        self.assertEqual(
            data["message"]["reply_to_name"], "=?utf-8?q?Reply_=28parens=29?="
        )

    def test_attachments(self):
        text_content = "* Item one\n* Item two\n* Item three"
        self.message.attach(
            filename="test.txt", content=text_content, mimetype="text/plain"
        )

        # Should guess mimetype if not provided...
        png_content = b"PNG\xb4 pretend this is the contents of a png file"
        self.message.attach(filename="test.png", content=png_content)

        # Should work with a MIMEBase object (also tests no filename)...
        pdf_content = b"PDF\xb4 pretend this is valid pdf data"
        mimeattachment = MIMEBase("application", "pdf")
        mimeattachment.set_payload(pdf_content)
        self.message.attach(mimeattachment)

        self.message.send()
        data = self.get_api_call_json()
        attachments = data["message"]["attachments"]
        self.assertEqual(len(attachments), 3)

        self.assertEqual(
            attachments[0],
            {
                "name": "test.txt",
                "content": b64encode(text_content.encode("utf-8")).decode("ascii"),
                "type": "text/plain",
            },
        )
        self.assertEqual(
            attachments[1],
            {
                "name": "test.png",
                "content": b64encode(png_content).decode("ascii"),
                "type": "image/png",  # (type inferred from filename)
            },
        )
        self.assertEqual(
            attachments[2],
            {
                "name": "",  # no filename -- but param is required
                "content": b64encode(pdf_content).decode("ascii"),
                "type": "application/pdf",
            },
        )

    def test_embedded_images(self):
        image_filename = SAMPLE_IMAGE_FILENAME
        image_path = sample_image_path(image_filename)
        image_data = sample_image_content(image_filename)

        cid = attach_inline_image_file(self.message, image_path)  # Read from a png file
        html_content = (
            '<p>This has an <img src="cid:%s" alt="inline" /> image.</p>' % cid
        )
        self.message.attach_alternative(html_content, "text/html")

        self.message.send()
        data = self.get_api_call_json()

        self.assertEqual(
            data["message"]["inline_attachments"],
            [
                {
                    "name": cid,
                    "content": b64encode(image_data).decode("ascii"),
                    "type": "image/png",  # (type inferred from filename)
                }
            ],
        )

    def test_attached_images(self):
        image_filename = SAMPLE_IMAGE_FILENAME
        image_path = sample_image_path(image_filename)
        image_data = sample_image_content(image_filename)

        # option 1: attach as a file
        self.message.attach_file(image_path)

        # option 2: construct the MIMEImage and attach it directly
        image = MIMEImage(image_data)
        self.message.attach(image)

        self.message.send()

        image_data_b64 = b64encode(image_data).decode("ascii")
        data = self.get_api_call_json()
        self.assertEqual(
            data["message"]["attachments"][0],
            {
                "name": image_filename,  # the named one
                "content": image_data_b64,
                "type": "image/png",
            },
        )
        self.assertEqual(
            data["message"]["attachments"][1],
            {
                "name": "",  # the unnamed one
                "content": image_data_b64,
                "type": "image/png",
            },
        )

    def test_multiple_html_alternatives(self):
        # Multiple alternatives not allowed
        self.message.attach_alternative("<p>First html is OK</p>", "text/html")
        self.message.attach_alternative("<p>But not second html</p>", "text/html")
        with self.assertRaises(AnymailUnsupportedFeature):
            self.message.send()

    def test_non_html_alternative(self):
        # Only html alternatives allowed
        self.message.attach_alternative("{'not': 'allowed'}", "application/json")
        with self.assertRaises(AnymailUnsupportedFeature):
            self.message.send()

    def test_api_failure(self):
        self.set_mock_response(status_code=400)
        with self.assertRaisesMessage(AnymailAPIError, "Unisender Go API response 400"):
            mail.send_mail("Subject", "Body", "from@example.com", ["to@example.com"])

        # Make sure fail_silently is respected
        self.set_mock_response(status_code=400)
        sent = mail.send_mail(
            "Subject",
            "Body",
            "from@example.com",
            ["to@example.com"],
            fail_silently=True,
        )
        self.assertEqual(sent, 0)

    def test_api_error_includes_details(self):
        """AnymailAPIError should include ESP's error message"""
        self.set_mock_response(
            status_code=400,
            json_data=[
                {
                    "status": "error",
                    "message": "Helpful explanation from Unisender Go",
                    "code": 999,
                },
            ],
        )
        with self.assertRaisesMessage(
            AnymailAPIError, "Helpful explanation from Unisender Go"
        ):
            self.message.send()


@tag("unisender_go")
class UnisenderGoBackendAnymailFeatureTests(UnisenderGoBackendMockAPITestCase):
    """Test backend support for Anymail added features"""

    def test_envelope_sender(self):
        # Unisender Go does not have a way to change envelope sender.
        self.message.envelope_sender = "anything@bounces.example.com"
        with self.assertRaisesMessage(AnymailUnsupportedFeature, "envelope_sender"):
            self.message.send()

    def test_metadata(self):
        self.message.metadata = {"user_id": "12345", "items": 6, "float": 98.6}
        self.message.send()
        data = self.get_api_call_json()
        self.assertEqual(
            data["message"]["global_metadata"],
            {
                "user_id": "12345",
                "items": 6,
                "float": 98.6,
            },
        )

    def test_send_at(self):
        utc_plus_6 = get_fixed_timezone(6 * 60)
        utc_minus_8 = get_fixed_timezone(-8 * 60)

        with override_current_timezone(utc_plus_6):
            # Timezone-naive datetime assumed to be Django current_timezone
            self.message.send_at = datetime(2022, 10, 11, 12, 13, 14, 567)
            self.message.send()
            data = self.get_api_call_json()
            self.assertEqual(
                data["message"]["options"]["send_at"], "2022-10-11 06:13:14"
            )  # 12:13 UTC+6 == 06:13 UTC

            # Timezone-aware datetime converted to UTC:
            self.message.send_at = datetime(2016, 3, 4, 5, 6, 7, tzinfo=utc_minus_8)
            self.message.send()
            data = self.get_api_call_json()
            self.assertEqual(
                data["message"]["options"]["send_at"], "2016-03-04 13:06:07"
            )  # 05:06 UTC-8 == 13:06 UTC

            # Date-only treated as midnight in current timezone
            self.message.send_at = date(2022, 10, 22)
            self.message.send()
            data = self.get_api_call_json()
            self.assertEqual(
                data["message"]["options"]["send_at"], "2022-10-21 18:00:00"
            )  # 00:00 UTC+6 == 18:00-1d UTC

            # POSIX timestamp
            self.message.send_at = 1651820889  # 2022-05-06 07:08:09 UTC
            self.message.send()
            data = self.get_api_call_json()
            self.assertEqual(
                data["message"]["options"]["send_at"], "2022-05-06 07:08:09"
            )

            # String passed unchanged (this is *not* portable between ESPs)
            self.message.send_at = "2013-11-12 01:02:03"
            self.message.send()
            data = self.get_api_call_json()
            self.assertEqual(
                data["message"]["options"]["send_at"], "2013-11-12 01:02:03"
            )

    def test_tags(self):
        self.message.tags = ["receipt", "repeat-user"]
        self.message.send()
        data = self.get_api_call_json()
        self.assertCountEqual(data["message"]["tags"], ["receipt", "repeat-user"])

    def test_tracking(self):
        # Test one way...
        self.message.track_clicks = False
        self.message.track_opens = True
        self.message.send()
        data = self.get_api_call_json()
        self.assertEqual(data["message"]["track_links"], 0)
        self.assertEqual(data["message"]["track_read"], 1)

        # ...and the opposite way
        self.message.track_clicks = True
        self.message.track_opens = False
        self.message.send()
        data = self.get_api_call_json()
        self.assertEqual(data["message"]["track_links"], 1)
        self.assertEqual(data["message"]["track_read"], 0)

    def test_template_id(self):
        self.message.template_id = "5997fcf6-2b9f-484d-acd5-7e9a99f0dc1f"
        self.message.send()
        data = self.get_api_call_json()
        self.assertEqual(
            data["message"]["template_id"], "5997fcf6-2b9f-484d-acd5-7e9a99f0dc1f"
        )

    def test_merge_data(self):
        self.message.from_email = "from@example.com"
        self.message.to = [
            "alice@example.com",
            "Bob <bob@example.com>",
            "celia@example.com",
        ]
        self.message.merge_data = {
            "alice@example.com": {"name": "Alice", "group": "Developers"},
            "bob@example.com": {"name": "Robert"},  # and leave group undefined
            # and no data for celia@example.com
        }
        self.message.merge_global_data = {
            "group": "Users",
            "site": "ExampleCo",
        }
        self.message.send()

        data = self.get_api_call_json()
        recipients = data["message"]["recipients"]
        self.assertEqual(recipients[0]["email"], "alice@example.com")
        self.assertEqual(
            recipients[0]["substitutions"], {"name": "Alice", "group": "Developers"}
        )
        self.assertEqual(recipients[1]["email"], "bob@example.com")
        self.assertEqual(
            # Make sure email display name (as "to_name") is combined with merge_data
            recipients[1]["substitutions"],
            {"name": "Robert", "to_name": "Bob"},
        )
        self.assertEqual(recipients[2]["email"], "celia@example.com")
        self.assertNotIn("substitutions", recipients[2])
        self.assertEqual(
            data["message"]["global_substitutions"],
            {"group": "Users", "site": "ExampleCo"},
        )

        # For batch send, must not include common "to" header
        headers = data["message"].get("headers", {})
        self.assertNotIn("to", headers)
        self.assertNotIn("cc", headers)

    def test_merge_metadata(self):
        self.message.to = ["alice@example.com", "Bob <bob@example.com>"]
        self.message.merge_metadata = {
            "alice@example.com": {"order_id": 123},
            "bob@example.com": {"order_id": 678, "tier": "premium"},
        }
        self.message.send()
        data = self.get_api_call_json()
        recipients = data["message"]["recipients"]
        # anymail_id added to other recipient metadata
        self.assertEqual(
            recipients[0]["metadata"],
            {
                "anymail_id": "mocked-uuid-1",
                "order_id": 123,
            },
        )
        self.assertEqual(
            recipients[1]["metadata"],
            {
                "anymail_id": "mocked-uuid-2",
                "order_id": 678,
                "tier": "premium",
            },
        )

        # For batch send, must not include common "to" header
        headers = data["message"].get("headers", {})
        self.assertNotIn("to", headers)
        self.assertNotIn("cc", headers)

    def test_merge_headers(self):
        self.message.to = ["alice@example.com", "Bob <bob@example.com>"]
        self.message.extra_headers = {
            "List-Unsubscribe-Post": "List-Unsubscribe=One-Click",
            "List-Unsubscribe": "<mailto:unsubscribe@example.com>",
        }
        self.message.merge_headers = {
            "alice@example.com": {
                "List-Unsubscribe": "<https://example.com/a/>",
            },
            "bob@example.com": {
                "List-Unsubscribe": "<https://example.com/b/>",
            },
        }
        self.message.send()
        data = self.get_api_call_json()
        headers = data["message"]["headers"]
        recipients = data["message"]["recipients"]

        self.assertEqual(headers["List-Unsubscribe-Post"], "List-Unsubscribe=One-Click")

        # merge_headers List-Unsubscribe is handled as substitution:
        self.assertEqual(headers["List-Unsubscribe"], "{{Header__List_Unsubscribe}}")
        self.assertEqual(
            recipients[0]["substitutions"],
            {"Header__List_Unsubscribe": "<https://example.com/a/>"},
        )
        self.assertEqual(
            recipients[1]["substitutions"],
            # Header substitutions merged with other substitutions:
            {"Header__List_Unsubscribe": "<https://example.com/b/>", "to_name": "Bob"},
        )

    def test_unsupported_merge_headers(self):
        # Unisender Go only allows substitutions in the List-Unsubscribe header
        self.message.merge_headers = {"to@example.com": {"X-Other": "not supported"}}
        with self.assertRaisesMessage(
            AnymailUnsupportedFeature, "'X-Other' in merge_headers"
        ):
            self.message.send()

    def test_cc_unsupported_with_batch_send(self):
        self.message.merge_data = {}
        self.message.cc = ["cc@example.com"]
        with self.assertRaisesMessage(
            AnymailUnsupportedFeature,
            "cc with batch send (merge_data, merge_metadata, or merge_headers)",
        ):
            self.message.send()

    @override_settings(ANYMAIL_IGNORE_UNSUPPORTED_FEATURES=True)
    def test_ignore_unsupported_cc_with_batch_send(self):
        self.message.merge_data = {}
        self.message.cc = ["cc@example.com"]
        self.message.bcc = ["bcc@example.com"]
        self.message.send()
        self.assertEqual(self.message.anymail_status.status, {"queued"})
        data = self.get_api_call_json()
        # Unisender Go prohibits "cc" header without "to" header,
        # and we can't include a "to" header for batch send,
        # so make sure we've removed the "cc" header when ignoring unsupported cc
        headers = data["message"].get("headers", {})
        self.assertNotIn("cc", headers)
        self.assertNotIn("to", headers)

    @override_settings(ANYMAIL_UNISENDER_GO_GENERATE_MESSAGE_ID=False)
    def test_default_omits_options(self):
        """Make sure by default we don't send any ESP-specific options.

        Options not specified by the caller should be omitted entirely from
        the API call (*not* sent as False or empty). This ensures
        that your ESP account settings apply by default.
        """
        self.message.send()
        message_data = self.get_api_call_json()["message"]
        self.assertNotIn("attachments", message_data)
        self.assertNotIn("from_name", message_data)
        self.assertNotIn("global_substitutions", message_data)
        self.assertNotIn("global_metadata", message_data)
        self.assertNotIn("inline_attachments", message_data)
        self.assertNotIn("options", message_data)
        self.assertNotIn("reply_to", message_data)
        self.assertNotIn("reply_to_name", message_data)
        self.assertNotIn("tags", message_data)
        self.assertNotIn("template_id", message_data)
        self.assertNotIn("track_links", message_data)
        self.assertNotIn("track_read", message_data)

        for recipient_data in message_data["recipients"]:
            self.assertNotIn("metadata", recipient_data)
            self.assertNotIn("substitutions", recipient_data)

    def test_esp_extra(self):
        self.message.send_at = "2022-02-22 22:22:22"
        self.message.esp_extra = {
            "global_language": "en",
            "skip_unsubscribe": 1,
            "template_engine": "velocity",
            "options": {
                "unsubscribe_url": "https://example.com/unsubscribe?id={{user_id}}",
                "smtp_pool_id": "custom-smtp-pool",
            },
        }
        self.message.send()
        data = self.get_api_call_json()
        # merged from esp_extra:
        self.assertEqual(data["message"]["global_language"], "en")
        self.assertEqual(data["message"]["skip_unsubscribe"], 1)
        self.assertEqual(data["message"]["template_engine"], "velocity")
        self.assertEqual(
            data["message"]["options"],
            {  # deep merge
                "send_at": "2022-02-22 22:22:22",
                "unsubscribe_url": "https://example.com/unsubscribe?id={{user_id}}",
                "smtp_pool_id": "custom-smtp-pool",
            },
        )

    # noinspection PyUnresolvedReferences
    def test_send_attaches_anymail_status(self):
        """The anymail_status should be attached to the message when it is sent"""
        msg = mail.EmailMessage(
            "Subject",
            "Message",
            "from@example.com",
            ["to@example.com"],
        )
        sent = msg.send()
        self.assertEqual(sent, 1)
        self.assertEqual(msg.anymail_status.status, {"queued"})
        self.assertEqual(msg.anymail_status.message_id, "mocked-uuid-1")
        self.assertEqual(
            msg.anymail_status.recipients["to@example.com"].status, "queued"
        )
        self.assertEqual(
            msg.anymail_status.recipients["to@example.com"].message_id, "mocked-uuid-1"
        )
        self.assertEqual(
            msg.anymail_status.esp_response.content, self.DEFAULT_RAW_RESPONSE
        )

    def test_batch_recipients_get_unique_message_ids(self):
        """In a batch send, each recipient should get a distinct message_id"""
        # Unisender Go *always* uses batch send; no need to force by setting merge_data.
        self.set_mock_response(success_emails=["to1@example.com", "to2@example.com"])
        msg = mail.EmailMessage(
            "Subject",
            "Message",
            "from@example.com",
            ["to1@example.com", "Someone Else <to2@example.com>"],
        )
        msg.send()
        self.assertEqual(
            msg.anymail_status.message_id, {"mocked-uuid-1", "mocked-uuid-2"}
        )
        self.assertEqual(
            msg.anymail_status.recipients["to1@example.com"].message_id, "mocked-uuid-1"
        )
        self.assertEqual(
            msg.anymail_status.recipients["to2@example.com"].message_id, "mocked-uuid-2"
        )

    def test_rejected_recipient_status(self):
        self.message.to = [
            "duplicate@example.com",
            "Again <duplicate@example.com>",
            "Duplicate@example.com",  # addresses are case-insensitive
            "bounce@example.com",
            "mailbox-full@example.com",
            "webmaster@localhost",
            "spam-report@example.com",
        ]
        self.set_mock_response(
            # Note "duplicate" email will appear in both success and failed lists
            # (because Unisender Go sends the first one, fails remaining duplicates)
            success_emails=["duplicate@example.com"],
            failed_emails={
                "duplicate@example.com": "duplicate",
                "Duplicate@example.com": "duplicate",
                "bounce@example.com": "permanent_unavailable",
                "mailbox-full@example.com": "temporary_unavailable",
                "webmaster@localhost": "invalid",
                "spam-report@example.com": "unsubscribed",
            },
        )
        self.message.send()
        recipient_status = self.message.anymail_status.recipients
        self.assertEqual(recipient_status["duplicate@example.com"].status, "queued")
        self.assertEqual(
            # duplicate uses _first_ message_id (because first instance will be sent)
            recipient_status["duplicate@example.com"].message_id,
            "mocked-uuid-1",
        )
        self.assertEqual(recipient_status["bounce@example.com"].status, "rejected")
        self.assertIsNone(recipient_status["bounce@example.com"].message_id)
        self.assertEqual(recipient_status["mailbox-full@example.com"].status, "failed")
        self.assertIsNone(recipient_status["mailbox-full@example.com"].message_id)
        self.assertEqual(recipient_status["webmaster@localhost"].status, "invalid")
        self.assertIsNone(recipient_status["webmaster@localhost"].message_id)
        self.assertEqual(recipient_status["spam-report@example.com"].status, "rejected")
        self.assertIsNone(recipient_status["spam-report@example.com"].message_id)

    @override_settings(ANYMAIL_UNISENDER_GO_GENERATE_MESSAGE_ID=False)
    def test_disable_generate_message_id(self):
        """
        When not generating per-recipient message_id,
        use Unisender Go's job_id for all recipients.
        """
        self.set_mock_response(
            success_emails=["to1@example.com", "to2@example.com"],
            job_id="123456-000HHH-CcCc",
        )
        self.message.to = ["to1@example.com", "to2@example.com"]
        self.message.send()
        self.assertEqual(self.message.anymail_status.message_id, "123456-000HHH-CcCc")
        recipient_status = self.message.anymail_status.recipients
        self.assertEqual(
            recipient_status["to1@example.com"].message_id, "123456-000HHH-CcCc"
        )
        self.assertEqual(
            recipient_status["to2@example.com"].message_id, "123456-000HHH-CcCc"
        )

    # noinspection PyUnresolvedReferences
    def test_send_failed_anymail_status(self):
        """If the send fails, anymail_status should contain initial values"""
        self.set_mock_response(status_code=500)
        sent = self.message.send(fail_silently=True)
        self.assertEqual(sent, 0)
        self.assertIsNone(self.message.anymail_status.status)
        self.assertIsNone(self.message.anymail_status.message_id)
        self.assertEqual(self.message.anymail_status.recipients, {})
        self.assertIsNone(self.message.anymail_status.esp_response)

    def test_json_serialization_errors(self):
        """Try to provide more information about non-json-serializable data"""
        self.message.metadata = {"total": Decimal("19.99")}
        with self.assertRaises(AnymailSerializationError) as cm:
            self.message.send()
        err = cm.exception
        self.assertIsInstance(err, TypeError)  # compatibility with json.dumps
        # our added context:
        self.assertIn("Don't know how to send this data to Unisender Go", str(err))
        # original message:
        self.assertRegex(str(err), r"Decimal.*is not JSON serializable")


@tag("unisender_go")
class UnisenderGoBackendRecipientsRefusedTests(UnisenderGoBackendMockAPITestCase):
    """
    Should raise AnymailRecipientsRefused when *all* recipients are rejected or invalid
    """

    def test_recipients_refused(self):
        self.message.to = ["invalid@localhost", "reject@example.com"]
        self.set_mock_response(
            failed_emails={
                "invalid@localhost": "invalid",
                "reject@example.com": "permanent_unavailable",
            }
        )
        with self.assertRaises(AnymailRecipientsRefused):
            self.message.send()

    def test_fail_silently(self):
        self.message.to = ["invalid@localhost", "reject@example.com"]
        self.set_mock_response(
            failed_emails={
                "invalid@localhost": "invalid",
                "reject@example.com": "permanent_unavailable",
            }
        )
        sent = self.message.send(fail_silently=True)
        self.assertEqual(sent, 0)

    def test_mixed_response(self):
        """If *any* recipients are valid or queued, no exception is raised"""
        self.message.to = [
            "invalid@localhost",
            "valid@example.com",
            "reject@example.com",
            "also.valid@example.com",
        ]
        self.set_mock_response(
            success_emails=["valid@example.com", "also.valid@example.com"],
            failed_emails={
                "invalid@localhost": "invalid",
                "reject@example.com": "permanent_unavailable",
            },
        )
        sent = self.message.send()
        # one message sent, successfully, to 2 of 4 recipients:
        self.assertEqual(sent, 1)
        status = self.message.anymail_status
        self.assertEqual(status.recipients["invalid@localhost"].status, "invalid")
        self.assertEqual(status.recipients["valid@example.com"].status, "queued")
        self.assertEqual(status.recipients["reject@example.com"].status, "rejected")
        self.assertEqual(status.recipients["also.valid@example.com"].status, "queued")

    @override_settings(ANYMAIL_IGNORE_RECIPIENT_STATUS=True)
    def test_settings_override(self):
        """No exception with ignore setting"""
        self.message.to = ["invalid@localhost", "reject@example.com"]
        self.set_mock_response(
            failed_emails={
                "invalid@localhost": "invalid",
                "reject@example.com": "permanent_unavailable",
            }
        )
        sent = self.message.send()
        self.assertEqual(sent, 1)  # refused message is included in sent count


@tag("unisender_go")
class UnisenderGoBackendSessionSharingTestCase(
    SessionSharingTestCases, UnisenderGoBackendMockAPITestCase
):
    """Requests session sharing tests"""

    pass  # tests are defined in SessionSharingTestCases


@tag("unisender_go")
@override_settings(EMAIL_BACKEND="anymail.backends.unisender_go.EmailBackend")
class UnisenderGoBackendImproperlyConfiguredTests(AnymailTestMixin, SimpleTestCase):
    """Test ESP backend without required settings in place"""

    def test_missing_auth(self):
        with self.assertRaisesRegex(
            AnymailConfigurationError, r"\bUNISENDER_GO_API_KEY\b"
        ):
            mail.send_mail("Subject", "Message", "from@example.com", ["to@example.com"])