############################################################################## # # Copyright (c) 2002 Zope Foundation and Contributors. # # This software is subject to the provisions of the Zope Public License, # Version 2.1 (ZPL). A copy of the ZPL should accompany this distribution. # THIS SOFTWARE IS PROVIDED "AS IS" AND ANY AND ALL EXPRESS OR IMPLIED # WARRANTIES ARE DISCLAIMED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED # WARRANTIES OF TITLE, MERCHANTABILITY, AGAINST INFRINGEMENT, AND FITNESS # FOR A PARTICULAR PURPOSE. # ############################################################################## """MailHost unit tests. """ import unittest from email import message_from_string from Products.MailHost.MailHost import MailHost from Products.MailHost.MailHost import MailHostError, _mungeHeaders class DummyMailHost(MailHost): meta_type = 'Dummy Mail Host' def __init__(self, id): self.id = id self.sent = '' def _send(self, mfrom, mto, messageText, immediate=False): self.sent = messageText self.immediate = immediate class FakeContent(object): def __init__(self, template_name, message): def template(self, context, REQUEST=None): return message setattr(self, template_name, template) @staticmethod def check_status(context, REQUEST=None): return 'Message Sent' class TestMailHost(unittest.TestCase): def _getTargetClass(self): return DummyMailHost def _makeOne(self, *args, **kw): return self._getTargetClass()(*args, **kw) def test_z3interfaces(self): from Products.MailHost.interfaces import IMailHost from zope.interface.verify import verifyClass verifyClass(IMailHost, self._getTargetClass()) def testAllHeaders(self): msg = """To: recipient@domain.com From: sender@domain.com Subject: This is the subject This is the message body.""" # No additional info resmsg, resto, resfrom = _mungeHeaders(msg) self.failUnless(resto == ['recipient@domain.com']) self.failUnless(resfrom == 'sender@domain.com') # Add duplicated info resmsg, resto, resfrom = _mungeHeaders(msg, 'recipient@domain.com', 'sender@domain.com', 'This is the subject') self.failUnlessEqual(resto, ['recipient@domain.com']) self.failUnlessEqual(resfrom, 'sender@domain.com') # Add extra info resmsg, resto, resfrom = _mungeHeaders(msg, 'recipient2@domain.com', 'sender2@domain.com', 'This is the real subject') self.failUnlessEqual(resto, ['recipient2@domain.com']) self.failUnlessEqual(resfrom, 'sender2@domain.com') def testMissingHeaders(self): msg = """X-Header: Dummy header This is the message body.""" # Doesn't specify to self.failUnlessRaises(MailHostError, _mungeHeaders, msg, mfrom='sender@domain.com') # Doesn't specify from self.failUnlessRaises(MailHostError, _mungeHeaders, msg, mto='recipient@domain.com') def testNoHeaders(self): msg = """This is the message body.""" # Doesn't specify to self.failUnlessRaises(MailHostError, _mungeHeaders, msg, mfrom='sender@domain.com') # Doesn't specify from self.failUnlessRaises(MailHostError, _mungeHeaders, msg, mto='recipient@domain.com') # Specify all resmsg, resto, resfrom = _mungeHeaders(msg, 'recipient2@domain.com', 'sender2@domain.com', 'This is the real subject') self.failUnlessEqual(resto, ['recipient2@domain.com']) self.failUnlessEqual(resfrom, 'sender2@domain.com') def testBCCHeader(self): msg = "From: me@example.com\nBcc: many@example.com\n\nMessage text" # Specify only the "Bcc" header. Useful for bulk emails. resmsg, resto, resfrom = _mungeHeaders(msg) self.failUnlessEqual(resto, ['many@example.com']) self.failUnlessEqual(resfrom, 'me@example.com') def test__getThreadKey_uses_fspath(self): mh1 = self._makeOne('mh1') mh1.smtp_queue_directory = '/abc' mh1.absolute_url = lambda self: 'http://example.com/mh1' mh2 = self._makeOne('mh2') mh2.smtp_queue_directory = '/abc' mh2.absolute_url = lambda self: 'http://example.com/mh2' self.assertEqual(mh1._getThreadKey(), mh2._getThreadKey()) def testAddressParser(self): msg = """\ To: "Name, Nick" , "Foo Bar" CC: "Web, Jack" From: sender@domain.com Subject: This is the subject This is the message body.""" # Test Address-Parser for To & CC given in messageText resmsg, resto, resfrom = _mungeHeaders(msg) self.failUnlessEqual(resto, ['"Name, Nick" ', 'Foo Bar ', '"Web, Jack" ']) self.failUnlessEqual(resfrom, 'sender@domain.com') # Test Address-Parser for a given mto-string resmsg, resto, resfrom = _mungeHeaders(msg, mto='"Public, Joe" , Foo Bar ') self.failUnlessEqual(resto, ['"Public, Joe" ', 'Foo Bar ']) self.failUnlessEqual(resfrom, 'sender@domain.com') def testSendMessageOnly(self): msg = """\ To: "Name, Nick" , "Foo Bar" From: sender@domain.com Subject: This is the subject Date: Sun, 27 Aug 2006 17:00:00 +0200 This is the message body.""" mailhost = self._makeOne('MailHost') mailhost.send(msg) self.assertEqual(mailhost.sent, msg) def testSendWithArguments(self): inmsg = """\ Date: Sun, 27 Aug 2006 17:00:00 +0200 This is the message body.""" outmsg = """\ Date: Sun, 27 Aug 2006 17:00:00 +0200 Subject: This is the subject To: "Name, Nick" , Foo Bar From: sender@domain.com This is the message body.""" mailhost = self._makeOne('MailHost') mailhost.send(messageText=inmsg, mto='"Name, Nick" , ' '"Foo Bar" ', mfrom='sender@domain.com', subject='This is the subject') self.assertEqual(mailhost.sent, outmsg) def testSendWithMtoList(self): inmsg = """\ Date: Sun, 27 Aug 2006 17:00:00 +0200 This is the message body.""" outmsg = """\ Date: Sun, 27 Aug 2006 17:00:00 +0200 Subject: This is the subject To: "Name, Nick" , Foo Bar From: sender@domain.com This is the message body.""" mailhost = self._makeOne('MailHost') mailhost.send(messageText=inmsg, mto=['"Name, Nick" ', '"Foo Bar" '], mfrom='sender@domain.com', subject='This is the subject') self.assertEqual(mailhost.sent, outmsg) def testSimpleSend(self): outmsg = """\ From: sender@domain.com To: "Name, Nick" , "Foo Bar" Subject: This is the subject This is the message body.""" mailhost = self._makeOne('MailHost') mailhost.simple_send(mto='"Name, Nick" , ' '"Foo Bar" ', mfrom='sender@domain.com', subject='This is the subject', body='This is the message body.') self.assertEqual(mailhost.sent, outmsg) self.assertEqual(mailhost.immediate, False) def testSendImmediate(self): outmsg = """\ From: sender@domain.com To: "Name, Nick" , "Foo Bar" Subject: This is the subject This is the message body.""" mailhost = self._makeOne('MailHost') mailhost.simple_send(mto='"Name, Nick" , ' '"Foo Bar" ', mfrom='sender@domain.com', subject='This is the subject', body='This is the message body.', immediate=True) self.assertEqual(mailhost.sent, outmsg) self.assertEqual(mailhost.immediate, True) def testSendBodyWithUrl(self): # The implementation of rfc822.Message reacts poorly to # message bodies containing ':' characters as in a url msg = "Here's a nice link: http://www.zope.org/" mailhost = self._makeOne('MailHost') mailhost.send(messageText=msg, mto='"Name, Nick" , ' '"Foo Bar" ', mfrom='sender@domain.com', subject='This is the subject') out = message_from_string(mailhost.sent) self.failUnlessEqual(out.get_payload(), msg) self.failUnlessEqual(out['To'], '"Name, Nick" , Foo Bar ') self.failUnlessEqual(out['From'], 'sender@domain.com') def testSendEncodedBody(self): # If a charset is specified the correct headers for content # encoding will be set if not already set. Additionally, if # there is a default transfer encoding for the charset, then # the content will be encoded and the transfer encoding header # will be set. msg = "Here's some encoded t\xc3\xa9xt." mailhost = self._makeOne('MailHost') mailhost.send(messageText=msg, mto='"Name, Nick" , ' '"Foo Bar" ', mfrom='sender@domain.com', subject='This is the subject', charset='utf-8') out = message_from_string(mailhost.sent) self.failUnlessEqual(out['To'], '"Name, Nick" , Foo Bar ') self.failUnlessEqual(out['From'], 'sender@domain.com') # utf-8 will default to Quoted Printable encoding self.failUnlessEqual(out['Content-Transfer-Encoding'], 'quoted-printable') self.failUnlessEqual(out['Content-Type'], 'text/plain; charset="utf-8"') self.failUnlessEqual(out.get_payload(), "Here's some encoded t=C3=A9xt.") def testEncodedHeaders(self): # Headers are encoded automatically, email headers are encoded # piece-wise to ensure the adresses remain ASCII mfrom = "Jos\xc3\xa9 Andr\xc3\xa9s " mto = "Ferran Adri\xc3\xa0 " subject = "\xc2\xbfEsferificaci\xc3\xb3n?" mailhost = self._makeOne('MailHost') mailhost.send(messageText='A message.', mto=mto, mfrom=mfrom, subject=subject, charset='utf-8') out = message_from_string(mailhost.sent) self.failUnlessEqual(out['To'], '=?utf-8?q?Ferran_Adri=C3=A0?= ') self.failUnlessEqual(out['From'], '=?utf-8?q?Jos=C3=A9_Andr=C3=A9s?= ') self.failUnlessEqual(out['Subject'], '=?utf-8?q?=C2=BFEsferificaci=C3=B3n=3F?=') # utf-8 will default to Quoted Printable encoding self.failUnlessEqual(out['Content-Transfer-Encoding'], 'quoted-printable') self.failUnlessEqual(out['Content-Type'], 'text/plain; charset="utf-8"') self.failUnlessEqual(out.get_payload(), "A message.") def testAlreadyEncodedMessage(self): # If the message already specifies encodings, it is # essentially not altered this is true even if charset or # msg_type is specified msg = """\ From: =?utf-8?q?Jos=C3=A9_Andr=C3=A9s?= To: =?utf-8?q?Ferran_Adri=C3=A0?= Subject: =?utf-8?q?=C2=BFEsferificaci=C3=B3n=3F?= Date: Sun, 27 Aug 2006 17:00:00 +0200 Content-Type: text/html; charset="utf-8" Content-Transfer-Encoding: base64 MIME-Version: 1.0 (Generated by testMailHost.py) wqFVbiB0cnVjbyA8c3Ryb25nPmZhbnTDoXN0aWNvPC9zdHJvbmc+IQ=3D=3D """ mailhost = self._makeOne('MailHost') mailhost.send(messageText=msg) self.failUnlessEqual(mailhost.sent, msg) mailhost.send(messageText=msg, msg_type='text/plain') # The msg_type is ignored if already set self.failUnlessEqual(mailhost.sent, msg) def testAlreadyEncodedMessageWithCharset(self): # If the message already specifies encodings, it is # essentially not altered this is true even if charset or # msg_type is specified msg = """\ From: =?utf-8?q?Jos=C3=A9_Andr=C3=A9s?= To: =?utf-8?q?Ferran_Adri=C3=A0?= Subject: =?utf-8?q?=C2=BFEsferificaci=C3=B3n=3F?= Date: Sun, 27 Aug 2006 17:00:00 +0200 Content-Type: text/html; charset="utf-8" Content-Transfer-Encoding: base64 MIME-Version: 1.0 (Generated by testMailHost.py) wqFVbiB0cnVjbyA8c3Ryb25nPmZhbnTDoXN0aWNvPC9zdHJvbmc+IQ=3D=3D """ mailhost = self._makeOne('MailHost') # Pass a different charset, which will apply to any explicitly # set headers mailhost.send(messageText=msg, subject='\xbfEsferificaci\xf3n?', charset='iso-8859-1', msg_type='text/plain') # The charset for the body should remain the same, but any # headers passed into the method will be encoded using the # specified charset out = message_from_string(mailhost.sent) self.failUnlessEqual(out['Content-Type'], 'text/html; charset="utf-8"') self.failUnlessEqual(out['Content-Transfer-Encoding'], 'base64') # Headers set by parameter will be set using charset parameter self.failUnlessEqual(out['Subject'], '=?iso-8859-1?q?=BFEsferificaci=F3n=3F?=') # original headers will be unaltered self.failUnlessEqual(out['From'], '=?utf-8?q?Jos=C3=A9_Andr=C3=A9s?= ') def testUnicodeMessage(self): # unicode messages and headers are decoded using the given charset msg = unicode("Here's some unencoded t\xc3\xa9xt.", 'utf-8') mfrom = unicode('Ferran Adri\xc3\xa0 ', 'utf-8') subject = unicode('\xc2\xa1Andr\xc3\xa9s!', 'utf-8') mailhost = self._makeOne('MailHost') mailhost.send(messageText=msg, mto='"Name, Nick" ', mfrom=mfrom, subject=subject, charset='utf-8', msg_type='text/html') out = message_from_string(mailhost.sent) self.failUnlessEqual(out['To'], '"Name, Nick" ') self.failUnlessEqual(out['From'], '=?utf-8?q?Ferran_Adri=C3=A0?= ') self.failUnlessEqual(out['Subject'], '=?utf-8?q?=C2=A1Andr=C3=A9s!?=') self.failUnlessEqual(out['Content-Transfer-Encoding'], 'quoted-printable') self.failUnlessEqual(out['Content-Type'], 'text/html; charset="utf-8"') self.failUnlessEqual(out.get_payload(), "Here's some unencoded t=C3=A9xt.") def testUnicodeNoEncodingErrors(self): # Unicode messages and headers raise errors if no charset is passed to # send msg = unicode("Here's some unencoded t\xc3\xa9xt.", 'utf-8') subject = unicode('\xc2\xa1Andr\xc3\xa9s!', 'utf-8') mailhost = self._makeOne('MailHost') self.assertRaises(UnicodeEncodeError, mailhost.send, msg, mto='"Name, Nick" ', mfrom='Foo Bar ', subject=subject) def testUnicodeDefaultEncoding(self): # However if we pass unicode that can be encoded to the # default encoding (generally 'us-ascii'), no error is raised. # We include a date in the messageText to make inspecting the # results more convenient. msg = u"""\ Date: Sun, 27 Aug 2006 17:00:00 +0200 Here's some unencoded text.""" subject = u'Andres!' mailhost = self._makeOne('MailHost') mailhost.send(msg, mto=u'"Name, Nick" ', mfrom=u'Foo Bar ', subject=subject) out = mailhost.sent # Ensure the results are not unicode self.failUnlessEqual(out, """\ Date: Sun, 27 Aug 2006 17:00:00 +0200 Subject: Andres! To: "Name, Nick" From: Foo Bar Here's some unencoded text.""") self.failUnlessEqual(type(out), str) def testSendMessageObject(self): # send will accept an email.Message.Message object directly msg = message_from_string("""\ From: =?utf-8?q?Jos=C3=A9_Andr=C3=A9s?= To: =?utf-8?q?Ferran_Adri=C3=A0?= Subject: =?utf-8?q?=C2=BFEsferificaci=C3=B3n=3F?= Date: Sun, 27 Aug 2006 17:00:00 +0200 Content-Type: text/html; charset="utf-8" Content-Transfer-Encoding: base64 MIME-Version: 1.1 wqFVbiB0cnVjbyA8c3Ryb25nPmZhbnTDoXN0aWNvPC9zdHJvbmc+IQ=3D=3D """) mailhost = self._makeOne('MailHost') mailhost.send(msg) out = message_from_string(mailhost.sent) self.failUnlessEqual(out.as_string(), msg.as_string()) # we can even alter a from and subject headers without affecting the # original object mailhost.send(msg, mfrom='Foo Bar ', subject='Changed!') out = message_from_string(mailhost.sent) # We need to make sure we didn't mutate the message we were passed self.failIfEqual(out.as_string(), msg.as_string()) self.failUnlessEqual(out['From'], 'Foo Bar ') self.failUnlessEqual(msg['From'], '=?utf-8?q?Jos=C3=A9_Andr=C3=A9s?= ') # The subject is encoded with the body encoding since no # explicit encoding was specified self.failUnlessEqual(out['Subject'], '=?utf-8?q?Changed!?=') self.failUnlessEqual(msg['Subject'], '=?utf-8?q?=C2=BFEsferificaci=C3=B3n=3F?=') def testExplicitUUEncoding(self): # We can request a payload encoding explicitly, though this # should probably be considered deprecated functionality. mailhost = self._makeOne('MailHost') # uuencoding mailhost.send('Date: Sun, 27 Aug 2006 17:00:00 +0200\n\nA Message', mfrom='sender@domain.com', mto='Foo Bar ', encode='uue') out = message_from_string(mailhost.sent) self.failUnlessEqual(mailhost.sent, """\ Date: Sun, 27 Aug 2006 17:00:00 +0200 Subject: [No Subject] To: Foo Bar From: sender@domain.com Content-Transfer-Encoding: uue Mime-Version: 1.0 begin 666 - )02!-97-S86=E end """) def testExplicitBase64Encoding(self): mailhost = self._makeOne('MailHost') mailhost.send('Date: Sun, 27 Aug 2006 17:00:00 +0200\n\nA Message', mfrom='sender@domain.com', mto='Foo Bar ', encode='base64') out = message_from_string(mailhost.sent) self.failUnlessEqual(mailhost.sent, """\ Date: Sun, 27 Aug 2006 17:00:00 +0200 Subject: [No Subject] To: Foo Bar From: sender@domain.com Content-Transfer-Encoding: base64 Mime-Version: 1.0 QSBNZXNzYWdl""") def testExplicit7bitEncoding(self): mailhost = self._makeOne('MailHost') mailhost.send('Date: Sun, 27 Aug 2006 17:00:00 +0200\n\nA Message', mfrom='sender@domain.com', mto='Foo Bar ', encode='7bit') out = message_from_string(mailhost.sent) self.failUnlessEqual(mailhost.sent, """\ Date: Sun, 27 Aug 2006 17:00:00 +0200 Subject: [No Subject] To: Foo Bar From: sender@domain.com Content-Transfer-Encoding: 7bit Mime-Version: 1.0 A Message""") def testExplicit8bitEncoding(self): mailhost = self._makeOne('MailHost') # We pass an encoded string with unspecified charset, it should be # encoded 8bit mailhost.send('Date: Sun, 27 Aug 2006 17:00:00 +0200\n\n' 'A M\xc3\xa9ssage', mfrom='sender@domain.com', mto='Foo Bar ', encode='8bit') out = message_from_string(mailhost.sent) self.failUnlessEqual(mailhost.sent, """\ Date: Sun, 27 Aug 2006 17:00:00 +0200 Subject: [No Subject] To: Foo Bar From: sender@domain.com Content-Transfer-Encoding: 8bit Mime-Version: 1.0 A M\xc3\xa9ssage""") def testSendTemplate(self): content = FakeContent('my_template', 'A Message') mailhost = self._makeOne('MailHost') result = mailhost.sendTemplate(content, 'my_template', mto='Foo Bar ', mfrom='sender@domain.com') self.failUnlessEqual(result, 'SEND OK') result = mailhost.sendTemplate(content, 'my_template', mto='Foo Bar ', mfrom='sender@domain.com', statusTemplate='wrong_name') self.failUnlessEqual(result, 'SEND OK') result = mailhost.sendTemplate(content, 'my_template', mto='Foo Bar ', mfrom='sender@domain.com', statusTemplate='check_status') self.failUnlessEqual(result, 'Message Sent') def testSendMultiPartAlternativeMessage(self): msg = ("""\ Content-Type: multipart/alternative; boundary="===============0490954888==" MIME-Version: 1.0 Date: Sun, 27 Aug 2006 17:00:00 +0200 Subject: My multipart email To: Foo Bar From: sender@domain.com --===============0490954888== Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: quoted-printable This is plain text. --===============0490954888== Content-Type: multipart/related; boundary="===============2078950065==" MIME-Version: 1.0 --===============2078950065== Content-Type: text/html; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: quoted-printable

This is html.

--===============2078950065==-- --===============0490954888==-- """) mailhost = self._makeOne('MailHost') # Specifying a charset for the header may have unwanted side # effects in the case of multipart mails. # (TypeError: expected string or buffer) mailhost.send(msg, charset='utf-8') # There is a one newline difference in the output between # zope.sendmail versions. self.assertEqual(mailhost.sent[:677], msg[:677]) self.assertTrue(mailhost.sent.endswith('==0490954888==--\n')) def testSendMultiPartMixedMessage(self): msg = ("""\ Content-Type: multipart/mixed; boundary="XOIedfhf+7KOe/yw" Content-Disposition: inline MIME-Version: 1.0 Date: Sun, 27 Aug 2006 17:00:00 +0200 Subject: My multipart email To: Foo Bar From: sender@domain.com --XOIedfhf+7KOe/yw Content-Type: text/plain; charset=us-ascii Content-Disposition: inline This is a test with as attachment OFS/www/new.gif. --XOIedfhf+7KOe/yw Content-Type: image/gif Content-Disposition: attachment; filename="new.gif" Content-Transfer-Encoding: base64 R0lGODlhCwAQAPcAAP8A/wAAAFBQUICAgMDAwP8AAIAAQAAAoABAgIAAgEAAQP//AP//gACA gECAgP///wAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAACH5BAEAAAAALAAAAAALABAAAAg7AAEIFKhgoEGC CwoeRKhwoYKEBhVIfLgg4UQAFCtqbJixYkOEHg9SHDmQJEmMEBkS/IiR5cKXMGPKDAgAOw== --XOIedfhf+7KOe/yw Content-Type: text/plain; charset=iso-8859-1 Content-Disposition: attachment; filename="test.txt" Content-Transfer-Encoding: quoted-printable D=EDt =EFs =E9=E9n test --XOIedfhf+7KOe/yw-- """) mailhost = self._makeOne('MailHost') # Specifying a charset for the header may have unwanted side # effects in the case of multipart mails. # (TypeError: expected string or buffer) mailhost.send(msg, charset='utf-8') self.assertEqual(mailhost.sent, msg) def test_suite(): suite = unittest.TestSuite() suite.addTest(unittest.makeSuite(TestMailHost)) return suite