tests.py 38 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823
  1. # coding: utf-8
  2. from __future__ import unicode_literals
  3. import asyncore
  4. import email
  5. import os
  6. import shutil
  7. import smtpd
  8. import sys
  9. import tempfile
  10. import threading
  11. from smtplib import SMTPException
  12. from ssl import SSLError
  13. from django.core import mail
  14. from django.core.mail import (EmailMessage, mail_admins, mail_managers,
  15. EmailMultiAlternatives, send_mail, send_mass_mail)
  16. from django.core.mail.backends import console, dummy, locmem, filebased, smtp
  17. from django.core.mail.message import BadHeaderError
  18. from django.test import TestCase
  19. from django.test.utils import override_settings
  20. from django.utils.encoding import force_str, force_text
  21. from django.utils.six import PY3, StringIO
  22. from django.utils.translation import ugettext_lazy
  23. class MailTests(TestCase):
  24. """
  25. Non-backend specific tests.
  26. """
  27. def test_ascii(self):
  28. email = EmailMessage('Subject', 'Content', 'from@example.com', ['to@example.com'])
  29. message = email.message()
  30. self.assertEqual(message['Subject'], 'Subject')
  31. self.assertEqual(message.get_payload(), 'Content')
  32. self.assertEqual(message['From'], 'from@example.com')
  33. self.assertEqual(message['To'], 'to@example.com')
  34. def test_multiple_recipients(self):
  35. email = EmailMessage('Subject', 'Content', 'from@example.com', ['to@example.com', 'other@example.com'])
  36. message = email.message()
  37. self.assertEqual(message['Subject'], 'Subject')
  38. self.assertEqual(message.get_payload(), 'Content')
  39. self.assertEqual(message['From'], 'from@example.com')
  40. self.assertEqual(message['To'], 'to@example.com, other@example.com')
  41. def test_cc(self):
  42. """Regression test for #7722"""
  43. email = EmailMessage('Subject', 'Content', 'from@example.com', ['to@example.com'], cc=['cc@example.com'])
  44. message = email.message()
  45. self.assertEqual(message['Cc'], 'cc@example.com')
  46. self.assertEqual(email.recipients(), ['to@example.com', 'cc@example.com'])
  47. # Test multiple CC with multiple To
  48. email = EmailMessage('Subject', 'Content', 'from@example.com', ['to@example.com', 'other@example.com'], cc=['cc@example.com', 'cc.other@example.com'])
  49. message = email.message()
  50. self.assertEqual(message['Cc'], 'cc@example.com, cc.other@example.com')
  51. self.assertEqual(email.recipients(), ['to@example.com', 'other@example.com', 'cc@example.com', 'cc.other@example.com'])
  52. # Testing with Bcc
  53. email = EmailMessage('Subject', 'Content', 'from@example.com', ['to@example.com', 'other@example.com'], cc=['cc@example.com', 'cc.other@example.com'], bcc=['bcc@example.com'])
  54. message = email.message()
  55. self.assertEqual(message['Cc'], 'cc@example.com, cc.other@example.com')
  56. self.assertEqual(email.recipients(), ['to@example.com', 'other@example.com', 'cc@example.com', 'cc.other@example.com', 'bcc@example.com'])
  57. def test_recipients_as_tuple(self):
  58. email = EmailMessage('Subject', 'Content', 'from@example.com', ('to@example.com', 'other@example.com'), cc=('cc@example.com', 'cc.other@example.com'), bcc=('bcc@example.com',))
  59. message = email.message()
  60. self.assertEqual(message['Cc'], 'cc@example.com, cc.other@example.com')
  61. self.assertEqual(email.recipients(), ['to@example.com', 'other@example.com', 'cc@example.com', 'cc.other@example.com', 'bcc@example.com'])
  62. def test_header_injection(self):
  63. email = EmailMessage('Subject\nInjection Test', 'Content', 'from@example.com', ['to@example.com'])
  64. self.assertRaises(BadHeaderError, email.message)
  65. email = EmailMessage(ugettext_lazy('Subject\nInjection Test'), 'Content', 'from@example.com', ['to@example.com'])
  66. self.assertRaises(BadHeaderError, email.message)
  67. def test_space_continuation(self):
  68. """
  69. Test for space continuation character in long (ascii) subject headers (#7747)
  70. """
  71. email = EmailMessage('Long subject lines that get wrapped should contain a space continuation character to get expected behavior in Outlook and Thunderbird', 'Content', 'from@example.com', ['to@example.com'])
  72. message = email.message()
  73. # Note that in Python 3, maximum line length has increased from 76 to 78
  74. self.assertEqual(message['Subject'].encode(), b'Long subject lines that get wrapped should contain a space continuation\n character to get expected behavior in Outlook and Thunderbird')
  75. def test_message_header_overrides(self):
  76. """
  77. Specifying dates or message-ids in the extra headers overrides the
  78. default values (#9233)
  79. """
  80. headers = {"date": "Fri, 09 Nov 2001 01:08:47 -0000", "Message-ID": "foo"}
  81. email = EmailMessage('subject', 'content', 'from@example.com', ['to@example.com'], headers=headers)
  82. self.assertEqual(sorted(email.message().items()), [
  83. ('Content-Transfer-Encoding', '7bit'),
  84. ('Content-Type', 'text/plain; charset="utf-8"'),
  85. ('From', 'from@example.com'),
  86. ('MIME-Version', '1.0'),
  87. ('Message-ID', 'foo'),
  88. ('Subject', 'subject'),
  89. ('To', 'to@example.com'),
  90. ('date', 'Fri, 09 Nov 2001 01:08:47 -0000'),
  91. ])
  92. def test_from_header(self):
  93. """
  94. Make sure we can manually set the From header (#9214)
  95. """
  96. email = EmailMessage('Subject', 'Content', 'bounce@example.com', ['to@example.com'], headers={'From': 'from@example.com'})
  97. message = email.message()
  98. self.assertEqual(message['From'], 'from@example.com')
  99. def test_to_header(self):
  100. """
  101. Make sure we can manually set the To header (#17444)
  102. """
  103. email = EmailMessage('Subject', 'Content', 'bounce@example.com',
  104. ['list-subscriber@example.com', 'list-subscriber2@example.com'],
  105. headers={'To': 'mailing-list@example.com'})
  106. message = email.message()
  107. self.assertEqual(message['To'], 'mailing-list@example.com')
  108. self.assertEqual(email.to, ['list-subscriber@example.com', 'list-subscriber2@example.com'])
  109. # If we don't set the To header manually, it should default to the `to` argument to the constructor
  110. email = EmailMessage('Subject', 'Content', 'bounce@example.com',
  111. ['list-subscriber@example.com', 'list-subscriber2@example.com'])
  112. message = email.message()
  113. self.assertEqual(message['To'], 'list-subscriber@example.com, list-subscriber2@example.com')
  114. self.assertEqual(email.to, ['list-subscriber@example.com', 'list-subscriber2@example.com'])
  115. def test_multiple_message_call(self):
  116. """
  117. Regression for #13259 - Make sure that headers are not changed when
  118. calling EmailMessage.message()
  119. """
  120. email = EmailMessage('Subject', 'Content', 'bounce@example.com', ['to@example.com'], headers={'From': 'from@example.com'})
  121. message = email.message()
  122. self.assertEqual(message['From'], 'from@example.com')
  123. message = email.message()
  124. self.assertEqual(message['From'], 'from@example.com')
  125. def test_unicode_address_header(self):
  126. """
  127. Regression for #11144 - When a to/from/cc header contains unicode,
  128. make sure the email addresses are parsed correctly (especially with
  129. regards to commas)
  130. """
  131. email = EmailMessage('Subject', 'Content', 'from@example.com', ['"Firstname Sürname" <to@example.com>', 'other@example.com'])
  132. self.assertEqual(email.message()['To'], '=?utf-8?q?Firstname_S=C3=BCrname?= <to@example.com>, other@example.com')
  133. email = EmailMessage('Subject', 'Content', 'from@example.com', ['"Sürname, Firstname" <to@example.com>', 'other@example.com'])
  134. self.assertEqual(email.message()['To'], '=?utf-8?q?S=C3=BCrname=2C_Firstname?= <to@example.com>, other@example.com')
  135. def test_unicode_headers(self):
  136. email = EmailMessage("Gżegżółka", "Content", "from@example.com", ["to@example.com"],
  137. headers={"Sender": '"Firstname Sürname" <sender@example.com>',
  138. "Comments": 'My Sürname is non-ASCII'})
  139. message = email.message()
  140. self.assertEqual(message['Subject'], '=?utf-8?b?R8W8ZWfFvMOzxYJrYQ==?=')
  141. self.assertEqual(message['Sender'], '=?utf-8?q?Firstname_S=C3=BCrname?= <sender@example.com>')
  142. self.assertEqual(message['Comments'], '=?utf-8?q?My_S=C3=BCrname_is_non-ASCII?=')
  143. def test_safe_mime_multipart(self):
  144. """
  145. Make sure headers can be set with a different encoding than utf-8 in
  146. SafeMIMEMultipart as well
  147. """
  148. headers = {"Date": "Fri, 09 Nov 2001 01:08:47 -0000", "Message-ID": "foo"}
  149. subject, from_email, to = 'hello', 'from@example.com', '"Sürname, Firstname" <to@example.com>'
  150. text_content = 'This is an important message.'
  151. html_content = '<p>This is an <strong>important</strong> message.</p>'
  152. msg = EmailMultiAlternatives('Message from Firstname Sürname', text_content, from_email, [to], headers=headers)
  153. msg.attach_alternative(html_content, "text/html")
  154. msg.encoding = 'iso-8859-1'
  155. self.assertEqual(msg.message()['To'], '=?iso-8859-1?q?S=FCrname=2C_Firstname?= <to@example.com>')
  156. self.assertEqual(msg.message()['Subject'], '=?iso-8859-1?q?Message_from_Firstname_S=FCrname?=')
  157. def test_encoding(self):
  158. """
  159. Regression for #12791 - Encode body correctly with other encodings
  160. than utf-8
  161. """
  162. email = EmailMessage('Subject', 'Firstname Sürname is a great guy.', 'from@example.com', ['other@example.com'])
  163. email.encoding = 'iso-8859-1'
  164. message = email.message()
  165. self.assertTrue(message.as_string().startswith('Content-Type: text/plain; charset="iso-8859-1"\nMIME-Version: 1.0\nContent-Transfer-Encoding: quoted-printable\nSubject: Subject\nFrom: from@example.com\nTo: other@example.com'))
  166. self.assertEqual(message.get_payload(), 'Firstname S=FCrname is a great guy.')
  167. # Make sure MIME attachments also works correctly with other encodings than utf-8
  168. text_content = 'Firstname Sürname is a great guy.'
  169. html_content = '<p>Firstname Sürname is a <strong>great</strong> guy.</p>'
  170. msg = EmailMultiAlternatives('Subject', text_content, 'from@example.com', ['to@example.com'])
  171. msg.encoding = 'iso-8859-1'
  172. msg.attach_alternative(html_content, "text/html")
  173. self.assertEqual(msg.message().get_payload(0).as_string(), 'Content-Type: text/plain; charset="iso-8859-1"\nMIME-Version: 1.0\nContent-Transfer-Encoding: quoted-printable\n\nFirstname S=FCrname is a great guy.')
  174. self.assertEqual(msg.message().get_payload(1).as_string(), 'Content-Type: text/html; charset="iso-8859-1"\nMIME-Version: 1.0\nContent-Transfer-Encoding: quoted-printable\n\n<p>Firstname S=FCrname is a <strong>great</strong> guy.</p>')
  175. def test_attachments(self):
  176. """Regression test for #9367"""
  177. headers = {"Date": "Fri, 09 Nov 2001 01:08:47 -0000", "Message-ID": "foo"}
  178. subject, from_email, to = 'hello', 'from@example.com', 'to@example.com'
  179. text_content = 'This is an important message.'
  180. html_content = '<p>This is an <strong>important</strong> message.</p>'
  181. msg = EmailMultiAlternatives(subject, text_content, from_email, [to], headers=headers)
  182. msg.attach_alternative(html_content, "text/html")
  183. msg.attach("an attachment.pdf", b"%PDF-1.4.%...", mimetype="application/pdf")
  184. msg_str = msg.message().as_string()
  185. message = email.message_from_string(msg_str)
  186. self.assertTrue(message.is_multipart())
  187. self.assertEqual(message.get_content_type(), 'multipart/mixed')
  188. self.assertEqual(message.get_default_type(), 'text/plain')
  189. payload = message.get_payload()
  190. self.assertEqual(payload[0].get_content_type(), 'multipart/alternative')
  191. self.assertEqual(payload[1].get_content_type(), 'application/pdf')
  192. def test_non_ascii_attachment_filename(self):
  193. """Regression test for #14964"""
  194. headers = {"Date": "Fri, 09 Nov 2001 01:08:47 -0000", "Message-ID": "foo"}
  195. subject, from_email, to = 'hello', 'from@example.com', 'to@example.com'
  196. content = 'This is the message.'
  197. msg = EmailMessage(subject, content, from_email, [to], headers=headers)
  198. # Unicode in file name
  199. msg.attach("une pièce jointe.pdf", b"%PDF-1.4.%...", mimetype="application/pdf")
  200. msg_str = msg.message().as_string()
  201. message = email.message_from_string(msg_str)
  202. payload = message.get_payload()
  203. self.assertEqual(payload[1].get_filename(), 'une pièce jointe.pdf')
  204. def test_dummy_backend(self):
  205. """
  206. Make sure that dummy backends returns correct number of sent messages
  207. """
  208. connection = dummy.EmailBackend()
  209. email = EmailMessage('Subject', 'Content', 'bounce@example.com', ['to@example.com'], headers={'From': 'from@example.com'})
  210. self.assertEqual(connection.send_messages([email, email, email]), 3)
  211. def test_arbitrary_keyword(self):
  212. """
  213. Make sure that get_connection() accepts arbitrary keyword that might be
  214. used with custom backends.
  215. """
  216. c = mail.get_connection(fail_silently=True, foo='bar')
  217. self.assertTrue(c.fail_silently)
  218. def test_custom_backend(self):
  219. """Test custom backend defined in this suite."""
  220. conn = mail.get_connection('mail.custombackend.EmailBackend')
  221. self.assertTrue(hasattr(conn, 'test_outbox'))
  222. email = EmailMessage('Subject', 'Content', 'bounce@example.com', ['to@example.com'], headers={'From': 'from@example.com'})
  223. conn.send_messages([email])
  224. self.assertEqual(len(conn.test_outbox), 1)
  225. def test_backend_arg(self):
  226. """Test backend argument of mail.get_connection()"""
  227. self.assertIsInstance(mail.get_connection('django.core.mail.backends.smtp.EmailBackend'), smtp.EmailBackend)
  228. self.assertIsInstance(mail.get_connection('django.core.mail.backends.locmem.EmailBackend'), locmem.EmailBackend)
  229. self.assertIsInstance(mail.get_connection('django.core.mail.backends.dummy.EmailBackend'), dummy.EmailBackend)
  230. self.assertIsInstance(mail.get_connection('django.core.mail.backends.console.EmailBackend'), console.EmailBackend)
  231. tmp_dir = tempfile.mkdtemp()
  232. try:
  233. self.assertIsInstance(mail.get_connection('django.core.mail.backends.filebased.EmailBackend', file_path=tmp_dir), filebased.EmailBackend)
  234. finally:
  235. shutil.rmtree(tmp_dir)
  236. self.assertIsInstance(mail.get_connection(), locmem.EmailBackend)
  237. @override_settings(
  238. EMAIL_BACKEND='django.core.mail.backends.locmem.EmailBackend',
  239. ADMINS=[('nobody', 'nobody@example.com')],
  240. MANAGERS=[('nobody', 'nobody@example.com')])
  241. def test_connection_arg(self):
  242. """Test connection argument to send_mail(), et. al."""
  243. mail.outbox = []
  244. # Send using non-default connection
  245. connection = mail.get_connection('mail.custombackend.EmailBackend')
  246. send_mail('Subject', 'Content', 'from@example.com', ['to@example.com'], connection=connection)
  247. self.assertEqual(mail.outbox, [])
  248. self.assertEqual(len(connection.test_outbox), 1)
  249. self.assertEqual(connection.test_outbox[0].subject, 'Subject')
  250. connection = mail.get_connection('mail.custombackend.EmailBackend')
  251. send_mass_mail([
  252. ('Subject1', 'Content1', 'from1@example.com', ['to1@example.com']),
  253. ('Subject2', 'Content2', 'from2@example.com', ['to2@example.com']),
  254. ], connection=connection)
  255. self.assertEqual(mail.outbox, [])
  256. self.assertEqual(len(connection.test_outbox), 2)
  257. self.assertEqual(connection.test_outbox[0].subject, 'Subject1')
  258. self.assertEqual(connection.test_outbox[1].subject, 'Subject2')
  259. connection = mail.get_connection('mail.custombackend.EmailBackend')
  260. mail_admins('Admin message', 'Content', connection=connection)
  261. self.assertEqual(mail.outbox, [])
  262. self.assertEqual(len(connection.test_outbox), 1)
  263. self.assertEqual(connection.test_outbox[0].subject, '[Django] Admin message')
  264. connection = mail.get_connection('mail.custombackend.EmailBackend')
  265. mail_managers('Manager message', 'Content', connection=connection)
  266. self.assertEqual(mail.outbox, [])
  267. self.assertEqual(len(connection.test_outbox), 1)
  268. self.assertEqual(connection.test_outbox[0].subject, '[Django] Manager message')
  269. def test_dont_mangle_from_in_body(self):
  270. # Regression for #13433 - Make sure that EmailMessage doesn't mangle
  271. # 'From ' in message body.
  272. email = EmailMessage('Subject', 'From the future', 'bounce@example.com', ['to@example.com'], headers={'From': 'from@example.com'})
  273. self.assertFalse('>From the future' in email.message().as_string())
  274. def test_dont_base64_encode(self):
  275. # Ticket #3472
  276. # Shouldn't use Base64 encoding at all
  277. msg = EmailMessage('Subject', 'UTF-8 encoded body', 'bounce@example.com', ['to@example.com'], headers={'From': 'from@example.com'})
  278. self.assertFalse('Content-Transfer-Encoding: base64' in msg.message().as_string())
  279. # Ticket #11212
  280. # Shouldn't use quoted printable, should detect it can represent content with 7 bit data
  281. msg = EmailMessage('Subject', 'Body with only ASCII characters.', 'bounce@example.com', ['to@example.com'], headers={'From': 'from@example.com'})
  282. s = msg.message().as_string()
  283. self.assertFalse('Content-Transfer-Encoding: quoted-printable' in s)
  284. self.assertTrue('Content-Transfer-Encoding: 7bit' in s)
  285. # Shouldn't use quoted printable, should detect it can represent content with 8 bit data
  286. msg = EmailMessage('Subject', 'Body with latin characters: àáä.', 'bounce@example.com', ['to@example.com'], headers={'From': 'from@example.com'})
  287. s = msg.message().as_string()
  288. self.assertFalse(str('Content-Transfer-Encoding: quoted-printable') in s)
  289. self.assertTrue(str('Content-Transfer-Encoding: 8bit') in s)
  290. msg = EmailMessage('Subject', 'Body with non latin characters: А Б В Г Д Е Ж Ѕ З И І К Л М Н О П.', 'bounce@example.com', ['to@example.com'], headers={'From': 'from@example.com'})
  291. s = msg.message().as_string()
  292. self.assertFalse(str('Content-Transfer-Encoding: quoted-printable') in s)
  293. self.assertTrue(str('Content-Transfer-Encoding: 8bit') in s)
  294. class BaseEmailBackendTests(object):
  295. email_backend = None
  296. def setUp(self):
  297. self.settings_override = override_settings(EMAIL_BACKEND=self.email_backend)
  298. self.settings_override.enable()
  299. def tearDown(self):
  300. self.settings_override.disable()
  301. def assertStartsWith(self, first, second):
  302. if not first.startswith(second):
  303. self.longMessage = True
  304. self.assertEqual(first[:len(second)], second, "First string doesn't start with the second.")
  305. def get_mailbox_content(self):
  306. raise NotImplementedError
  307. def flush_mailbox(self):
  308. raise NotImplementedError
  309. def get_the_message(self):
  310. mailbox = self.get_mailbox_content()
  311. self.assertEqual(len(mailbox), 1,
  312. "Expected exactly one message, got %d.\n%r" % (len(mailbox), [
  313. m.as_string() for m in mailbox]))
  314. return mailbox[0]
  315. def test_send(self):
  316. email = EmailMessage('Subject', 'Content', 'from@example.com', ['to@example.com'])
  317. num_sent = mail.get_connection().send_messages([email])
  318. self.assertEqual(num_sent, 1)
  319. message = self.get_the_message()
  320. self.assertEqual(message["subject"], "Subject")
  321. self.assertEqual(message.get_payload(), "Content")
  322. self.assertEqual(message["from"], "from@example.com")
  323. self.assertEqual(message.get_all("to"), ["to@example.com"])
  324. def test_send_unicode(self):
  325. email = EmailMessage('Chère maman', 'Je t\'aime très fort', 'from@example.com', ['to@example.com'])
  326. num_sent = mail.get_connection().send_messages([email])
  327. self.assertEqual(num_sent, 1)
  328. message = self.get_the_message()
  329. self.assertEqual(message["subject"], '=?utf-8?q?Ch=C3=A8re_maman?=')
  330. self.assertEqual(force_text(message.get_payload()), 'Je t\'aime très fort')
  331. def test_send_many(self):
  332. email1 = EmailMessage('Subject', 'Content1', 'from@example.com', ['to@example.com'])
  333. email2 = EmailMessage('Subject', 'Content2', 'from@example.com', ['to@example.com'])
  334. num_sent = mail.get_connection().send_messages([email1, email2])
  335. self.assertEqual(num_sent, 2)
  336. messages = self.get_mailbox_content()
  337. self.assertEqual(len(messages), 2)
  338. self.assertEqual(messages[0].get_payload(), "Content1")
  339. self.assertEqual(messages[1].get_payload(), "Content2")
  340. def test_send_verbose_name(self):
  341. email = EmailMessage("Subject", "Content", '"Firstname Sürname" <from@example.com>',
  342. ["to@example.com"])
  343. email.send()
  344. message = self.get_the_message()
  345. self.assertEqual(message["subject"], "Subject")
  346. self.assertEqual(message.get_payload(), "Content")
  347. self.assertEqual(message["from"], "=?utf-8?q?Firstname_S=C3=BCrname?= <from@example.com>")
  348. def test_plaintext_send_mail(self):
  349. """
  350. Test send_mail without the html_message
  351. regression test for adding html_message parameter to send_mail()
  352. """
  353. send_mail('Subject', 'Content', 'sender@example.com', ['nobody@example.com'])
  354. message = self.get_the_message()
  355. self.assertEqual(message.get('subject'), 'Subject')
  356. self.assertEqual(message.get_all('to'), ['nobody@example.com'])
  357. self.assertFalse(message.is_multipart())
  358. self.assertEqual(message.get_payload(), 'Content')
  359. self.assertEqual(message.get_content_type(), 'text/plain')
  360. def test_html_send_mail(self):
  361. """Test html_message argument to send_mail"""
  362. send_mail('Subject', 'Content', 'sender@example.com', ['nobody@example.com'], html_message='HTML Content')
  363. message = self.get_the_message()
  364. self.assertEqual(message.get('subject'), 'Subject')
  365. self.assertEqual(message.get_all('to'), ['nobody@example.com'])
  366. self.assertTrue(message.is_multipart())
  367. self.assertEqual(len(message.get_payload()), 2)
  368. self.assertEqual(message.get_payload(0).get_payload(), 'Content')
  369. self.assertEqual(message.get_payload(0).get_content_type(), 'text/plain')
  370. self.assertEqual(message.get_payload(1).get_payload(), 'HTML Content')
  371. self.assertEqual(message.get_payload(1).get_content_type(), 'text/html')
  372. @override_settings(MANAGERS=[('nobody', 'nobody@example.com')])
  373. def test_html_mail_managers(self):
  374. """Test html_message argument to mail_managers"""
  375. mail_managers('Subject', 'Content', html_message='HTML Content')
  376. message = self.get_the_message()
  377. self.assertEqual(message.get('subject'), '[Django] Subject')
  378. self.assertEqual(message.get_all('to'), ['nobody@example.com'])
  379. self.assertTrue(message.is_multipart())
  380. self.assertEqual(len(message.get_payload()), 2)
  381. self.assertEqual(message.get_payload(0).get_payload(), 'Content')
  382. self.assertEqual(message.get_payload(0).get_content_type(), 'text/plain')
  383. self.assertEqual(message.get_payload(1).get_payload(), 'HTML Content')
  384. self.assertEqual(message.get_payload(1).get_content_type(), 'text/html')
  385. @override_settings(ADMINS=[('nobody', 'nobody@example.com')])
  386. def test_html_mail_admins(self):
  387. """Test html_message argument to mail_admins """
  388. mail_admins('Subject', 'Content', html_message='HTML Content')
  389. message = self.get_the_message()
  390. self.assertEqual(message.get('subject'), '[Django] Subject')
  391. self.assertEqual(message.get_all('to'), ['nobody@example.com'])
  392. self.assertTrue(message.is_multipart())
  393. self.assertEqual(len(message.get_payload()), 2)
  394. self.assertEqual(message.get_payload(0).get_payload(), 'Content')
  395. self.assertEqual(message.get_payload(0).get_content_type(), 'text/plain')
  396. self.assertEqual(message.get_payload(1).get_payload(), 'HTML Content')
  397. self.assertEqual(message.get_payload(1).get_content_type(), 'text/html')
  398. @override_settings(
  399. ADMINS=[('nobody', 'nobody+admin@example.com')],
  400. MANAGERS=[('nobody', 'nobody+manager@example.com')])
  401. def test_manager_and_admin_mail_prefix(self):
  402. """
  403. String prefix + lazy translated subject = bad output
  404. Regression for #13494
  405. """
  406. mail_managers(ugettext_lazy('Subject'), 'Content')
  407. message = self.get_the_message()
  408. self.assertEqual(message.get('subject'), '[Django] Subject')
  409. self.flush_mailbox()
  410. mail_admins(ugettext_lazy('Subject'), 'Content')
  411. message = self.get_the_message()
  412. self.assertEqual(message.get('subject'), '[Django] Subject')
  413. @override_settings(ADMINS=(), MANAGERS=())
  414. def test_empty_admins(self):
  415. """
  416. Test that mail_admins/mail_managers doesn't connect to the mail server
  417. if there are no recipients (#9383)
  418. """
  419. mail_admins('hi', 'there')
  420. self.assertEqual(self.get_mailbox_content(), [])
  421. mail_managers('hi', 'there')
  422. self.assertEqual(self.get_mailbox_content(), [])
  423. def test_message_cc_header(self):
  424. """
  425. Regression test for #7722
  426. """
  427. email = EmailMessage('Subject', 'Content', 'from@example.com', ['to@example.com'], cc=['cc@example.com'])
  428. mail.get_connection().send_messages([email])
  429. message = self.get_the_message()
  430. self.assertStartsWith(message.as_string(), 'Content-Type: text/plain; charset="utf-8"\nMIME-Version: 1.0\nContent-Transfer-Encoding: 7bit\nSubject: Subject\nFrom: from@example.com\nTo: to@example.com\nCc: cc@example.com\nDate: ')
  431. def test_idn_send(self):
  432. """
  433. Regression test for #14301
  434. """
  435. self.assertTrue(send_mail('Subject', 'Content', 'from@öäü.com', ['to@öäü.com']))
  436. message = self.get_the_message()
  437. self.assertEqual(message.get('subject'), 'Subject')
  438. self.assertEqual(message.get('from'), 'from@xn--4ca9at.com')
  439. self.assertEqual(message.get('to'), 'to@xn--4ca9at.com')
  440. self.flush_mailbox()
  441. m = EmailMessage('Subject', 'Content', 'from@öäü.com',
  442. ['to@öäü.com'], cc=['cc@öäü.com'])
  443. m.send()
  444. message = self.get_the_message()
  445. self.assertEqual(message.get('subject'), 'Subject')
  446. self.assertEqual(message.get('from'), 'from@xn--4ca9at.com')
  447. self.assertEqual(message.get('to'), 'to@xn--4ca9at.com')
  448. self.assertEqual(message.get('cc'), 'cc@xn--4ca9at.com')
  449. def test_recipient_without_domain(self):
  450. """
  451. Regression test for #15042
  452. """
  453. self.assertTrue(send_mail("Subject", "Content", "tester", ["django"]))
  454. message = self.get_the_message()
  455. self.assertEqual(message.get('subject'), 'Subject')
  456. self.assertEqual(message.get('from'), "tester")
  457. self.assertEqual(message.get('to'), "django")
  458. def test_close_connection(self):
  459. """
  460. Test that connection can be closed (even when not explicitely opened)
  461. """
  462. conn = mail.get_connection(username='', password='')
  463. try:
  464. conn.close()
  465. except Exception as e:
  466. self.fail("close() unexpectedly raised an exception: %s" % e)
  467. class LocmemBackendTests(BaseEmailBackendTests, TestCase):
  468. email_backend = 'django.core.mail.backends.locmem.EmailBackend'
  469. def get_mailbox_content(self):
  470. return [m.message() for m in mail.outbox]
  471. def flush_mailbox(self):
  472. mail.outbox = []
  473. def tearDown(self):
  474. super(LocmemBackendTests, self).tearDown()
  475. mail.outbox = []
  476. def test_locmem_shared_messages(self):
  477. """
  478. Make sure that the locmen backend populates the outbox.
  479. """
  480. connection = locmem.EmailBackend()
  481. connection2 = locmem.EmailBackend()
  482. email = EmailMessage('Subject', 'Content', 'bounce@example.com', ['to@example.com'], headers={'From': 'from@example.com'})
  483. connection.send_messages([email])
  484. connection2.send_messages([email])
  485. self.assertEqual(len(mail.outbox), 2)
  486. def test_validate_multiline_headers(self):
  487. # Ticket #18861 - Validate emails when using the locmem backend
  488. with self.assertRaises(BadHeaderError):
  489. send_mail('Subject\nMultiline', 'Content', 'from@example.com', ['to@example.com'])
  490. class FileBackendTests(BaseEmailBackendTests, TestCase):
  491. email_backend = 'django.core.mail.backends.filebased.EmailBackend'
  492. def setUp(self):
  493. super(FileBackendTests, self).setUp()
  494. self.tmp_dir = tempfile.mkdtemp()
  495. self.addCleanup(shutil.rmtree, self.tmp_dir)
  496. self._settings_override = override_settings(EMAIL_FILE_PATH=self.tmp_dir)
  497. self._settings_override.enable()
  498. def tearDown(self):
  499. self._settings_override.disable()
  500. super(FileBackendTests, self).tearDown()
  501. def flush_mailbox(self):
  502. for filename in os.listdir(self.tmp_dir):
  503. os.unlink(os.path.join(self.tmp_dir, filename))
  504. def get_mailbox_content(self):
  505. messages = []
  506. for filename in os.listdir(self.tmp_dir):
  507. with open(os.path.join(self.tmp_dir, filename), 'r') as fp:
  508. session = force_text(fp.read()).split('\n' + ('-' * 79) + '\n')
  509. messages.extend(email.message_from_string(force_str(m)) for m in session if m)
  510. return messages
  511. def test_file_sessions(self):
  512. """Make sure opening a connection creates a new file"""
  513. msg = EmailMessage('Subject', 'Content', 'bounce@example.com', ['to@example.com'], headers={'From': 'from@example.com'})
  514. connection = mail.get_connection()
  515. connection.send_messages([msg])
  516. self.assertEqual(len(os.listdir(self.tmp_dir)), 1)
  517. with open(os.path.join(self.tmp_dir, os.listdir(self.tmp_dir)[0])) as fp:
  518. message = email.message_from_file(fp)
  519. self.assertEqual(message.get_content_type(), 'text/plain')
  520. self.assertEqual(message.get('subject'), 'Subject')
  521. self.assertEqual(message.get('from'), 'from@example.com')
  522. self.assertEqual(message.get('to'), 'to@example.com')
  523. connection2 = mail.get_connection()
  524. connection2.send_messages([msg])
  525. self.assertEqual(len(os.listdir(self.tmp_dir)), 2)
  526. connection.send_messages([msg])
  527. self.assertEqual(len(os.listdir(self.tmp_dir)), 2)
  528. msg.connection = mail.get_connection()
  529. self.assertTrue(connection.open())
  530. msg.send()
  531. self.assertEqual(len(os.listdir(self.tmp_dir)), 3)
  532. msg.send()
  533. self.assertEqual(len(os.listdir(self.tmp_dir)), 3)
  534. connection.close()
  535. class ConsoleBackendTests(BaseEmailBackendTests, TestCase):
  536. email_backend = 'django.core.mail.backends.console.EmailBackend'
  537. def setUp(self):
  538. super(ConsoleBackendTests, self).setUp()
  539. self.__stdout = sys.stdout
  540. self.stream = sys.stdout = StringIO()
  541. def tearDown(self):
  542. del self.stream
  543. sys.stdout = self.__stdout
  544. del self.__stdout
  545. super(ConsoleBackendTests, self).tearDown()
  546. def flush_mailbox(self):
  547. self.stream = sys.stdout = StringIO()
  548. def get_mailbox_content(self):
  549. messages = force_text(self.stream.getvalue()).split('\n' + ('-' * 79) + '\n')
  550. return [email.message_from_string(force_str(m)) for m in messages if m]
  551. def test_console_stream_kwarg(self):
  552. """
  553. Test that the console backend can be pointed at an arbitrary stream.
  554. """
  555. s = StringIO()
  556. connection = mail.get_connection('django.core.mail.backends.console.EmailBackend', stream=s)
  557. send_mail('Subject', 'Content', 'from@example.com', ['to@example.com'], connection=connection)
  558. self.assertTrue(s.getvalue().startswith('Content-Type: text/plain; charset="utf-8"\nMIME-Version: 1.0\nContent-Transfer-Encoding: 7bit\nSubject: Subject\nFrom: from@example.com\nTo: to@example.com\nDate: '))
  559. class FakeSMTPChannel(smtpd.SMTPChannel):
  560. def collect_incoming_data(self, data):
  561. try:
  562. super(FakeSMTPChannel, self).collect_incoming_data(data)
  563. except UnicodeDecodeError:
  564. # ignore decode error in SSL/TLS connection tests as we only care
  565. # whether the connection attempt was made
  566. pass
  567. class FakeSMTPServer(smtpd.SMTPServer, threading.Thread):
  568. """
  569. Asyncore SMTP server wrapped into a thread. Based on DummyFTPServer from:
  570. http://svn.python.org/view/python/branches/py3k/Lib/test/test_ftplib.py?revision=86061&view=markup
  571. """
  572. channel_class = FakeSMTPChannel
  573. def __init__(self, *args, **kwargs):
  574. threading.Thread.__init__(self)
  575. smtpd.SMTPServer.__init__(self, *args, **kwargs)
  576. self._sink = []
  577. self.active = False
  578. self.active_lock = threading.Lock()
  579. self.sink_lock = threading.Lock()
  580. def process_message(self, peer, mailfrom, rcpttos, data):
  581. m = email.message_from_string(data)
  582. if PY3:
  583. maddr = email.utils.parseaddr(m.get('from'))[1]
  584. else:
  585. maddr = email.Utils.parseaddr(m.get('from'))[1]
  586. if mailfrom != maddr:
  587. return "553 '%s' != '%s'" % (mailfrom, maddr)
  588. with self.sink_lock:
  589. self._sink.append(m)
  590. def get_sink(self):
  591. with self.sink_lock:
  592. return self._sink[:]
  593. def flush_sink(self):
  594. with self.sink_lock:
  595. self._sink[:] = []
  596. def start(self):
  597. assert not self.active
  598. self.__flag = threading.Event()
  599. threading.Thread.start(self)
  600. self.__flag.wait()
  601. def run(self):
  602. self.active = True
  603. self.__flag.set()
  604. while self.active and asyncore.socket_map:
  605. with self.active_lock:
  606. asyncore.loop(timeout=0.1, count=1)
  607. asyncore.close_all()
  608. def stop(self):
  609. if self.active:
  610. self.active = False
  611. self.join()
  612. class SMTPBackendTests(BaseEmailBackendTests, TestCase):
  613. email_backend = 'django.core.mail.backends.smtp.EmailBackend'
  614. @classmethod
  615. def setUpClass(cls):
  616. cls.server = FakeSMTPServer(('127.0.0.1', 0), None)
  617. cls._settings_override = override_settings(
  618. EMAIL_HOST="127.0.0.1",
  619. EMAIL_PORT=cls.server.socket.getsockname()[1])
  620. cls._settings_override.enable()
  621. cls.server.start()
  622. @classmethod
  623. def tearDownClass(cls):
  624. cls._settings_override.disable()
  625. cls.server.stop()
  626. def setUp(self):
  627. super(SMTPBackendTests, self).setUp()
  628. self.server.flush_sink()
  629. def tearDown(self):
  630. self.server.flush_sink()
  631. super(SMTPBackendTests, self).tearDown()
  632. def flush_mailbox(self):
  633. self.server.flush_sink()
  634. def get_mailbox_content(self):
  635. return self.server.get_sink()
  636. @override_settings(EMAIL_HOST_USER="not empty username",
  637. EMAIL_HOST_PASSWORD="not empty password")
  638. def test_email_authentication_use_settings(self):
  639. backend = smtp.EmailBackend()
  640. self.assertEqual(backend.username, 'not empty username')
  641. self.assertEqual(backend.password, 'not empty password')
  642. @override_settings(EMAIL_HOST_USER="not empty username",
  643. EMAIL_HOST_PASSWORD="not empty password")
  644. def test_email_authentication_override_settings(self):
  645. backend = smtp.EmailBackend(username='username', password='password')
  646. self.assertEqual(backend.username, 'username')
  647. self.assertEqual(backend.password, 'password')
  648. @override_settings(EMAIL_HOST_USER="not empty username",
  649. EMAIL_HOST_PASSWORD="not empty password")
  650. def test_email_disabled_authentication(self):
  651. backend = smtp.EmailBackend(username='', password='')
  652. self.assertEqual(backend.username, '')
  653. self.assertEqual(backend.password, '')
  654. def test_server_stopped(self):
  655. """
  656. Test that closing the backend while the SMTP server is stopped doesn't
  657. raise an exception.
  658. """
  659. backend = smtp.EmailBackend(username='', password='')
  660. backend.open()
  661. self.server.stop()
  662. try:
  663. backend.close()
  664. except Exception as e:
  665. self.fail("close() unexpectedly raised an exception: %s" % e)
  666. @override_settings(EMAIL_USE_TLS=True)
  667. def test_email_tls_use_settings(self):
  668. backend = smtp.EmailBackend()
  669. self.assertTrue(backend.use_tls)
  670. @override_settings(EMAIL_USE_TLS=True)
  671. def test_email_tls_override_settings(self):
  672. backend = smtp.EmailBackend(use_tls=False)
  673. self.assertFalse(backend.use_tls)
  674. def test_email_tls_default_disabled(self):
  675. backend = smtp.EmailBackend()
  676. self.assertFalse(backend.use_tls)
  677. @override_settings(EMAIL_USE_SSL=True)
  678. def test_email_ssl_use_settings(self):
  679. backend = smtp.EmailBackend()
  680. self.assertTrue(backend.use_ssl)
  681. @override_settings(EMAIL_USE_SSL=True)
  682. def test_email_ssl_override_settings(self):
  683. backend = smtp.EmailBackend(use_ssl=False)
  684. self.assertFalse(backend.use_ssl)
  685. def test_email_ssl_default_disabled(self):
  686. backend = smtp.EmailBackend()
  687. self.assertFalse(backend.use_ssl)
  688. @override_settings(EMAIL_USE_TLS=True)
  689. def test_email_tls_attempts_starttls(self):
  690. backend = smtp.EmailBackend()
  691. self.assertTrue(backend.use_tls)
  692. self.assertRaisesMessage(SMTPException,
  693. 'STARTTLS extension not supported by server.', backend.open)
  694. @override_settings(EMAIL_USE_SSL=True)
  695. def test_email_ssl_attempts_ssl_connection(self):
  696. backend = smtp.EmailBackend()
  697. self.assertTrue(backend.use_ssl)
  698. self.assertRaises(SSLError, backend.open)