Benjamin Peterson | 90f5ba5 | 2010-03-11 22:53:45 +0000 | [diff] [blame] | 1 | #! /usr/bin/env python3 |
Barry Warsaw | 4c4bec8 | 1998-12-22 03:02:20 +0000 | [diff] [blame] | 2 | |
Barry Warsaw | a1ae884 | 2000-07-09 21:24:31 +0000 | [diff] [blame] | 3 | '''SMTP/ESMTP client class. |
Guido van Rossum | bbe323e | 1998-01-29 17:24:40 +0000 | [diff] [blame] | 4 | |
Guido van Rossum | f7fcf5e | 2001-09-14 16:08:44 +0000 | [diff] [blame] | 5 | This should follow RFC 821 (SMTP), RFC 1869 (ESMTP), RFC 2554 (SMTP |
| 6 | Authentication) and RFC 2487 (Secure SMTP over TLS). |
Guido van Rossum | bbe323e | 1998-01-29 17:24:40 +0000 | [diff] [blame] | 7 | |
Guido van Rossum | fcfb632 | 1998-08-04 15:29:54 +0000 | [diff] [blame] | 8 | Notes: |
| 9 | |
| 10 | Please remember, when doing ESMTP, that the names of the SMTP service |
Barry Warsaw | 4c4bec8 | 1998-12-22 03:02:20 +0000 | [diff] [blame] | 11 | extensions are NOT the same thing as the option keywords for the RCPT |
Guido van Rossum | fcfb632 | 1998-08-04 15:29:54 +0000 | [diff] [blame] | 12 | and MAIL commands! |
| 13 | |
Guido van Rossum | bbe323e | 1998-01-29 17:24:40 +0000 | [diff] [blame] | 14 | Example: |
| 15 | |
Barry Warsaw | a7d9bdf | 1998-12-22 03:24:27 +0000 | [diff] [blame] | 16 | >>> import smtplib |
| 17 | >>> s=smtplib.SMTP("localhost") |
Guido van Rossum | 7131f84 | 2007-02-09 20:13:25 +0000 | [diff] [blame] | 18 | >>> print(s.help()) |
Barry Warsaw | a7d9bdf | 1998-12-22 03:24:27 +0000 | [diff] [blame] | 19 | This is Sendmail version 8.8.4 |
| 20 | Topics: |
| 21 | HELO EHLO MAIL RCPT DATA |
| 22 | RSET NOOP QUIT HELP VRFY |
| 23 | EXPN VERB ETRN DSN |
| 24 | For more info use "HELP <topic>". |
| 25 | To report bugs in the implementation send email to |
| 26 | sendmail-bugs@sendmail.org. |
| 27 | For local information send email to Postmaster at your site. |
| 28 | End of HELP info |
| 29 | >>> s.putcmd("vrfy","someone@here") |
| 30 | >>> s.getreply() |
| 31 | (250, "Somebody OverHere <somebody@here.my.org>") |
| 32 | >>> s.quit() |
Barry Warsaw | a1ae884 | 2000-07-09 21:24:31 +0000 | [diff] [blame] | 33 | ''' |
Guido van Rossum | bbe323e | 1998-01-29 17:24:40 +0000 | [diff] [blame] | 34 | |
Guido van Rossum | 98d9fd3 | 2000-02-28 15:12:25 +0000 | [diff] [blame] | 35 | # Author: The Dragon De Monsyne <dragondm@integral.org> |
| 36 | # ESMTP support, test code and doc fixes added by |
| 37 | # Eric S. Raymond <esr@thyrsus.com> |
| 38 | # Better RFC 821 compliance (MAIL and RCPT, and CRLF in data) |
| 39 | # by Carey Evans <c.evans@clear.net.nz>, for picky mail servers. |
Guido van Rossum | ae01046 | 2001-09-11 15:57:46 +0000 | [diff] [blame] | 40 | # RFC 2554 (authentication) support by Gerhard Haering <gerhard@bigfoot.de>. |
Tim Peters | 495ad3c | 2001-01-15 01:36:40 +0000 | [diff] [blame] | 41 | # |
Guido van Rossum | 98d9fd3 | 2000-02-28 15:12:25 +0000 | [diff] [blame] | 42 | # This was modified from the Python 1.5 library HTTP lib. |
| 43 | |
Guido van Rossum | bbe323e | 1998-01-29 17:24:40 +0000 | [diff] [blame] | 44 | import socket |
R. David Murray | 7dff9e0 | 2010-11-08 17:15:13 +0000 | [diff] [blame] | 45 | import io |
Barry Warsaw | 0720177 | 1998-12-22 20:37:36 +0000 | [diff] [blame] | 46 | import re |
Thomas Wouters | b213704 | 2007-02-01 18:02:27 +0000 | [diff] [blame] | 47 | import email.utils |
R. David Murray | 7dff9e0 | 2010-11-08 17:15:13 +0000 | [diff] [blame] | 48 | import email.message |
| 49 | import email.generator |
Guido van Rossum | ae01046 | 2001-09-11 15:57:46 +0000 | [diff] [blame] | 50 | import base64 |
| 51 | import hmac |
R David Murray | ac4e5ab | 2011-07-02 21:03:19 -0400 | [diff] [blame] | 52 | import copy |
Barry Warsaw | 2cc1f6d | 2007-08-30 14:28:55 +0000 | [diff] [blame] | 53 | from email.base64mime import body_encode as encode_base64 |
Brett Cannon | e6f8a89 | 2004-07-10 23:14:30 +0000 | [diff] [blame] | 54 | from sys import stderr |
Guido van Rossum | bbe323e | 1998-01-29 17:24:40 +0000 | [diff] [blame] | 55 | |
Giampaolo Rodolà | bd258bd | 2011-02-22 15:56:20 +0000 | [diff] [blame] | 56 | __all__ = ["SMTPException", "SMTPServerDisconnected", "SMTPResponseException", |
| 57 | "SMTPSenderRefused", "SMTPRecipientsRefused", "SMTPDataError", |
| 58 | "SMTPConnectError", "SMTPHeloError", "SMTPAuthenticationError", |
| 59 | "quoteaddr", "quotedata", "SMTP"] |
Skip Montanaro | 0de6580 | 2001-02-15 22:15:14 +0000 | [diff] [blame] | 60 | |
Guido van Rossum | bbe323e | 1998-01-29 17:24:40 +0000 | [diff] [blame] | 61 | SMTP_PORT = 25 |
Thomas Wouters | 89f507f | 2006-12-13 04:49:30 +0000 | [diff] [blame] | 62 | SMTP_SSL_PORT = 465 |
Giampaolo Rodolà | bd258bd | 2011-02-22 15:56:20 +0000 | [diff] [blame] | 63 | CRLF = "\r\n" |
| 64 | bCRLF = b"\r\n" |
Guido van Rossum | bbe323e | 1998-01-29 17:24:40 +0000 | [diff] [blame] | 65 | |
Piers Lauder | 385a77a | 2002-07-27 00:38:30 +0000 | [diff] [blame] | 66 | OLDSTYLE_AUTH = re.compile(r"auth=(.*)", re.I) |
| 67 | |
Tim Peters | 495ad3c | 2001-01-15 01:36:40 +0000 | [diff] [blame] | 68 | # Exception classes used by this module. |
Guido van Rossum | 296e143 | 1999-04-07 15:03:39 +0000 | [diff] [blame] | 69 | class SMTPException(Exception): |
| 70 | """Base class for all exceptions raised by this module.""" |
| 71 | |
| 72 | class SMTPServerDisconnected(SMTPException): |
| 73 | """Not connected to any SMTP server. |
| 74 | |
| 75 | This exception is raised when the server unexpectedly disconnects, |
| 76 | or when an attempt is made to use the SMTP instance before |
| 77 | connecting it to a server. |
| 78 | """ |
| 79 | |
| 80 | class SMTPResponseException(SMTPException): |
| 81 | """Base class for all exceptions that include an SMTP error code. |
| 82 | |
| 83 | These exceptions are generated in some instances when the SMTP |
| 84 | server returns an error code. The error code is stored in the |
| 85 | `smtp_code' attribute of the error, and the `smtp_error' attribute |
| 86 | is set to the error message. |
| 87 | """ |
| 88 | |
| 89 | def __init__(self, code, msg): |
| 90 | self.smtp_code = code |
| 91 | self.smtp_error = msg |
| 92 | self.args = (code, msg) |
| 93 | |
| 94 | class SMTPSenderRefused(SMTPResponseException): |
| 95 | """Sender address refused. |
Guido van Rossum | ae01046 | 2001-09-11 15:57:46 +0000 | [diff] [blame] | 96 | |
Guido van Rossum | 296e143 | 1999-04-07 15:03:39 +0000 | [diff] [blame] | 97 | In addition to the attributes set by on all SMTPResponseException |
Barry Warsaw | d25c1b7 | 1999-11-28 17:11:06 +0000 | [diff] [blame] | 98 | exceptions, this sets `sender' to the string that the SMTP refused. |
Guido van Rossum | 296e143 | 1999-04-07 15:03:39 +0000 | [diff] [blame] | 99 | """ |
| 100 | |
| 101 | def __init__(self, code, msg, sender): |
| 102 | self.smtp_code = code |
| 103 | self.smtp_error = msg |
| 104 | self.sender = sender |
| 105 | self.args = (code, msg, sender) |
| 106 | |
Guido van Rossum | 20c9228 | 1999-04-21 16:52:20 +0000 | [diff] [blame] | 107 | class SMTPRecipientsRefused(SMTPException): |
Barry Warsaw | d25c1b7 | 1999-11-28 17:11:06 +0000 | [diff] [blame] | 108 | """All recipient addresses refused. |
Guido van Rossum | ae01046 | 2001-09-11 15:57:46 +0000 | [diff] [blame] | 109 | |
Thomas Wouters | 7e47402 | 2000-07-16 12:04:32 +0000 | [diff] [blame] | 110 | The errors for each recipient are accessible through the attribute |
Tim Peters | 495ad3c | 2001-01-15 01:36:40 +0000 | [diff] [blame] | 111 | 'recipients', which is a dictionary of exactly the same sort as |
| 112 | SMTP.sendmail() returns. |
Guido van Rossum | 296e143 | 1999-04-07 15:03:39 +0000 | [diff] [blame] | 113 | """ |
| 114 | |
| 115 | def __init__(self, recipients): |
| 116 | self.recipients = recipients |
Giampaolo Rodolà | bd258bd | 2011-02-22 15:56:20 +0000 | [diff] [blame] | 117 | self.args = (recipients,) |
Guido van Rossum | 296e143 | 1999-04-07 15:03:39 +0000 | [diff] [blame] | 118 | |
| 119 | |
Guido van Rossum | 296e143 | 1999-04-07 15:03:39 +0000 | [diff] [blame] | 120 | class SMTPDataError(SMTPResponseException): |
| 121 | """The SMTP server didn't accept the data.""" |
| 122 | |
| 123 | class SMTPConnectError(SMTPResponseException): |
Barry Warsaw | d25c1b7 | 1999-11-28 17:11:06 +0000 | [diff] [blame] | 124 | """Error during connection establishment.""" |
Guido van Rossum | 296e143 | 1999-04-07 15:03:39 +0000 | [diff] [blame] | 125 | |
| 126 | class SMTPHeloError(SMTPResponseException): |
Barry Warsaw | d25c1b7 | 1999-11-28 17:11:06 +0000 | [diff] [blame] | 127 | """The server refused our HELO reply.""" |
Guido van Rossum | bbe323e | 1998-01-29 17:24:40 +0000 | [diff] [blame] | 128 | |
Guido van Rossum | ae01046 | 2001-09-11 15:57:46 +0000 | [diff] [blame] | 129 | class SMTPAuthenticationError(SMTPResponseException): |
| 130 | """Authentication error. |
| 131 | |
| 132 | Most probably the server didn't accept the username/password |
| 133 | combination provided. |
| 134 | """ |
Peter Schneider-Kamp | 7bc82bb | 2000-08-10 14:02:23 +0000 | [diff] [blame] | 135 | |
R David Murray | 4c14bba | 2011-07-18 21:59:53 -0400 | [diff] [blame] | 136 | def quoteaddr(addrstring): |
Guido van Rossum | 69a79bc | 1998-07-13 15:18:49 +0000 | [diff] [blame] | 137 | """Quote a subset of the email addresses defined by RFC 821. |
| 138 | |
Georg Brandl | 9f0f960 | 2008-06-12 22:23:59 +0000 | [diff] [blame] | 139 | Should be able to handle anything email.utils.parseaddr can handle. |
Barry Warsaw | a7d9bdf | 1998-12-22 03:24:27 +0000 | [diff] [blame] | 140 | """ |
R David Murray | 4c14bba | 2011-07-18 21:59:53 -0400 | [diff] [blame] | 141 | displayname, addr = email.utils.parseaddr(addrstring) |
| 142 | if (displayname, addr) == ('', ''): |
| 143 | # parseaddr couldn't parse it, use it as is and hope for the best. |
| 144 | if addrstring.strip().startswith('<'): |
| 145 | return addrstring |
| 146 | return "<%s>" % addrstring |
| 147 | return "<%s>" % addr |
Guido van Rossum | 69a79bc | 1998-07-13 15:18:49 +0000 | [diff] [blame] | 148 | |
R David Murray | 4634676 | 2011-07-18 21:38:54 -0400 | [diff] [blame] | 149 | def _addr_only(addrstring): |
| 150 | displayname, addr = email.utils.parseaddr(addrstring) |
| 151 | if (displayname, addr) == ('', ''): |
| 152 | # parseaddr couldn't parse it, so use it as is. |
| 153 | return addrstring |
| 154 | return addr |
| 155 | |
R. David Murray | 7dff9e0 | 2010-11-08 17:15:13 +0000 | [diff] [blame] | 156 | # Legacy method kept for backward compatibility. |
Guido van Rossum | 69a79bc | 1998-07-13 15:18:49 +0000 | [diff] [blame] | 157 | def quotedata(data): |
| 158 | """Quote data for email. |
| 159 | |
Barry Warsaw | d25c1b7 | 1999-11-28 17:11:06 +0000 | [diff] [blame] | 160 | Double leading '.', and change Unix newline '\\n', or Mac '\\r' into |
Barry Warsaw | a7d9bdf | 1998-12-22 03:24:27 +0000 | [diff] [blame] | 161 | Internet CRLF end-of-line. |
| 162 | """ |
Guido van Rossum | 69a79bc | 1998-07-13 15:18:49 +0000 | [diff] [blame] | 163 | return re.sub(r'(?m)^\.', '..', |
Guido van Rossum | fcfb632 | 1998-08-04 15:29:54 +0000 | [diff] [blame] | 164 | re.sub(r'(?:\r\n|\n|\r(?!\n))', CRLF, data)) |
Guido van Rossum | 69a79bc | 1998-07-13 15:18:49 +0000 | [diff] [blame] | 165 | |
R. David Murray | 7dff9e0 | 2010-11-08 17:15:13 +0000 | [diff] [blame] | 166 | def _quote_periods(bindata): |
R David Murray | 0f663d0 | 2011-06-09 15:05:57 -0400 | [diff] [blame] | 167 | return re.sub(br'(?m)^\.', b'..', bindata) |
R. David Murray | 7dff9e0 | 2010-11-08 17:15:13 +0000 | [diff] [blame] | 168 | |
| 169 | def _fix_eols(data): |
| 170 | return re.sub(r'(?:\r\n|\n|\r(?!\n))', CRLF, data) |
| 171 | |
Thomas Wouters | 47b49bf | 2007-08-30 22:15:33 +0000 | [diff] [blame] | 172 | try: |
| 173 | import ssl |
| 174 | except ImportError: |
| 175 | _have_ssl = False |
| 176 | else: |
Thomas Wouters | 47b49bf | 2007-08-30 22:15:33 +0000 | [diff] [blame] | 177 | _have_ssl = True |
| 178 | |
Peter Schneider-Kamp | 7bc82bb | 2000-08-10 14:02:23 +0000 | [diff] [blame] | 179 | |
Guido van Rossum | bbe323e | 1998-01-29 17:24:40 +0000 | [diff] [blame] | 180 | class SMTP: |
Guido van Rossum | fcfb632 | 1998-08-04 15:29:54 +0000 | [diff] [blame] | 181 | """This class manages a connection to an SMTP or ESMTP server. |
| 182 | SMTP Objects: |
Tim Peters | 495ad3c | 2001-01-15 01:36:40 +0000 | [diff] [blame] | 183 | SMTP objects have the following attributes: |
| 184 | helo_resp |
| 185 | This is the message given by the server in response to the |
Guido van Rossum | fcfb632 | 1998-08-04 15:29:54 +0000 | [diff] [blame] | 186 | most recent HELO command. |
Tim Peters | 495ad3c | 2001-01-15 01:36:40 +0000 | [diff] [blame] | 187 | |
Guido van Rossum | fcfb632 | 1998-08-04 15:29:54 +0000 | [diff] [blame] | 188 | ehlo_resp |
Tim Peters | 495ad3c | 2001-01-15 01:36:40 +0000 | [diff] [blame] | 189 | This is the message given by the server in response to the |
Guido van Rossum | fcfb632 | 1998-08-04 15:29:54 +0000 | [diff] [blame] | 190 | most recent EHLO command. This is usually multiline. |
| 191 | |
Tim Peters | 495ad3c | 2001-01-15 01:36:40 +0000 | [diff] [blame] | 192 | does_esmtp |
Guido van Rossum | fcfb632 | 1998-08-04 15:29:54 +0000 | [diff] [blame] | 193 | This is a True value _after you do an EHLO command_, if the |
| 194 | server supports ESMTP. |
| 195 | |
Tim Peters | 495ad3c | 2001-01-15 01:36:40 +0000 | [diff] [blame] | 196 | esmtp_features |
Guido van Rossum | fcfb632 | 1998-08-04 15:29:54 +0000 | [diff] [blame] | 197 | This is a dictionary, which, if the server supports ESMTP, |
Barry Warsaw | d25c1b7 | 1999-11-28 17:11:06 +0000 | [diff] [blame] | 198 | will _after you do an EHLO command_, contain the names of the |
| 199 | SMTP service extensions this server supports, and their |
Guido van Rossum | fcfb632 | 1998-08-04 15:29:54 +0000 | [diff] [blame] | 200 | parameters (if any). |
Barry Warsaw | d25c1b7 | 1999-11-28 17:11:06 +0000 | [diff] [blame] | 201 | |
Tim Peters | 495ad3c | 2001-01-15 01:36:40 +0000 | [diff] [blame] | 202 | Note, all extension names are mapped to lower case in the |
| 203 | dictionary. |
Guido van Rossum | fcfb632 | 1998-08-04 15:29:54 +0000 | [diff] [blame] | 204 | |
Barry Warsaw | d25c1b7 | 1999-11-28 17:11:06 +0000 | [diff] [blame] | 205 | See each method's docstrings for details. In general, there is a |
| 206 | method of the same name to perform each SMTP command. There is also a |
| 207 | method called 'sendmail' that will do an entire mail transaction. |
| 208 | """ |
Guido van Rossum | 95e6f70 | 1998-06-25 02:15:50 +0000 | [diff] [blame] | 209 | debuglevel = 0 |
| 210 | file = None |
| 211 | helo_resp = None |
Guido van Rossum | d8faa36 | 2007-04-27 19:54:29 +0000 | [diff] [blame] | 212 | ehlo_msg = "ehlo" |
Guido van Rossum | 95e6f70 | 1998-06-25 02:15:50 +0000 | [diff] [blame] | 213 | ehlo_resp = None |
Guido van Rossum | fcfb632 | 1998-08-04 15:29:54 +0000 | [diff] [blame] | 214 | does_esmtp = 0 |
Antoine Pitrou | c1d5206 | 2011-05-07 19:39:37 +0200 | [diff] [blame] | 215 | default_port = SMTP_PORT |
Guido van Rossum | 95e6f70 | 1998-06-25 02:15:50 +0000 | [diff] [blame] | 216 | |
Georg Brandl | f78e02b | 2008-06-10 17:40:04 +0000 | [diff] [blame] | 217 | def __init__(self, host='', port=0, local_hostname=None, |
Senthil Kumaran | 3d23fd6 | 2011-07-30 10:56:50 +0800 | [diff] [blame] | 218 | timeout=socket._GLOBAL_DEFAULT_TIMEOUT, |
| 219 | source_address=None): |
Guido van Rossum | bbe323e | 1998-01-29 17:24:40 +0000 | [diff] [blame] | 220 | """Initialize a new instance. |
| 221 | |
Barry Warsaw | a7d9bdf | 1998-12-22 03:24:27 +0000 | [diff] [blame] | 222 | If specified, `host' is the name of the remote host to which to |
| 223 | connect. If specified, `port' specifies the port to which to connect. |
Barry Warsaw | d25c1b7 | 1999-11-28 17:11:06 +0000 | [diff] [blame] | 224 | By default, smtplib.SMTP_PORT is used. An SMTPConnectError is raised |
Neil Schemenauer | 6730f26 | 2002-03-24 15:30:40 +0000 | [diff] [blame] | 225 | if the specified `host' doesn't respond correctly. If specified, |
Tim Peters | 863ac44 | 2002-04-16 01:38:40 +0000 | [diff] [blame] | 226 | `local_hostname` is used as the FQDN of the local host. By default, |
Senthil Kumaran | 3d23fd6 | 2011-07-30 10:56:50 +0800 | [diff] [blame] | 227 | the local hostname is found using socket.getfqdn(). The |
| 228 | `source_address` parameter takes a 2-tuple (host, port) for the socket |
| 229 | to bind to as its source address before connecting. If the host is '' |
| 230 | and port is 0, the OS default behavior will be used. |
Guido van Rossum | bbe323e | 1998-01-29 17:24:40 +0000 | [diff] [blame] | 231 | |
| 232 | """ |
Guido van Rossum | d8faa36 | 2007-04-27 19:54:29 +0000 | [diff] [blame] | 233 | self.timeout = timeout |
Guido van Rossum | fcfb632 | 1998-08-04 15:29:54 +0000 | [diff] [blame] | 234 | self.esmtp_features = {} |
Senthil Kumaran | 3d23fd6 | 2011-07-30 10:56:50 +0800 | [diff] [blame] | 235 | self.source_address = source_address |
| 236 | |
Guido van Rossum | 296e143 | 1999-04-07 15:03:39 +0000 | [diff] [blame] | 237 | if host: |
| 238 | (code, msg) = self.connect(host, port) |
| 239 | if code != 220: |
| 240 | raise SMTPConnectError(code, msg) |
Raymond Hettinger | f13eb55 | 2002-06-02 00:40:05 +0000 | [diff] [blame] | 241 | if local_hostname is not None: |
Barry Warsaw | 13e34f7 | 2002-03-26 20:27:35 +0000 | [diff] [blame] | 242 | self.local_hostname = local_hostname |
Neil Schemenauer | 6730f26 | 2002-03-24 15:30:40 +0000 | [diff] [blame] | 243 | else: |
Barry Warsaw | 13e34f7 | 2002-03-26 20:27:35 +0000 | [diff] [blame] | 244 | # RFC 2821 says we should use the fqdn in the EHLO/HELO verb, and |
| 245 | # if that can't be calculated, that we should use a domain literal |
| 246 | # instead (essentially an encoded IP address like [A.B.C.D]). |
| 247 | fqdn = socket.getfqdn() |
| 248 | if '.' in fqdn: |
| 249 | self.local_hostname = fqdn |
| 250 | else: |
| 251 | # We can't find an fqdn hostname, so use a domain literal |
Thomas Wouters | 49fd7fa | 2006-04-21 10:40:58 +0000 | [diff] [blame] | 252 | addr = '127.0.0.1' |
| 253 | try: |
| 254 | addr = socket.gethostbyname(socket.gethostname()) |
| 255 | except socket.gaierror: |
| 256 | pass |
Barry Warsaw | 13e34f7 | 2002-03-26 20:27:35 +0000 | [diff] [blame] | 257 | self.local_hostname = '[%s]' % addr |
Tim Peters | 495ad3c | 2001-01-15 01:36:40 +0000 | [diff] [blame] | 258 | |
Barry Warsaw | 1f5c958 | 2011-03-15 15:04:44 -0400 | [diff] [blame] | 259 | def __enter__(self): |
| 260 | return self |
| 261 | |
| 262 | def __exit__(self, *args): |
| 263 | try: |
| 264 | code, message = self.docmd("QUIT") |
| 265 | if code != 221: |
| 266 | raise SMTPResponseException(code, message) |
| 267 | except SMTPServerDisconnected: |
| 268 | pass |
| 269 | finally: |
| 270 | self.close() |
| 271 | |
Guido van Rossum | bbe323e | 1998-01-29 17:24:40 +0000 | [diff] [blame] | 272 | def set_debuglevel(self, debuglevel): |
| 273 | """Set the debug output level. |
| 274 | |
Barry Warsaw | a7d9bdf | 1998-12-22 03:24:27 +0000 | [diff] [blame] | 275 | A non-false value results in debug messages for connection and for all |
| 276 | messages sent to and received from the server. |
Guido van Rossum | bbe323e | 1998-01-29 17:24:40 +0000 | [diff] [blame] | 277 | |
| 278 | """ |
| 279 | self.debuglevel = debuglevel |
| 280 | |
Barry Warsaw | c918171 | 2008-03-19 14:25:51 +0000 | [diff] [blame] | 281 | def _get_socket(self, host, port, timeout): |
Thomas Wouters | 89f507f | 2006-12-13 04:49:30 +0000 | [diff] [blame] | 282 | # This makes it simpler for SMTP_SSL to use the SMTP connect code |
| 283 | # and just alter the socket connection bit. |
Giampaolo Rodolà | bd258bd | 2011-02-22 15:56:20 +0000 | [diff] [blame] | 284 | if self.debuglevel > 0: |
Senthil Kumaran | b351a48 | 2011-07-31 09:14:17 +0800 | [diff] [blame] | 285 | print('connect: to', (host, port), self.source_address, |
| 286 | file=stderr) |
Senthil Kumaran | 3d23fd6 | 2011-07-30 10:56:50 +0800 | [diff] [blame] | 287 | return socket.create_connection((host, port), timeout, |
| 288 | self.source_address) |
Thomas Wouters | 89f507f | 2006-12-13 04:49:30 +0000 | [diff] [blame] | 289 | |
Senthil Kumaran | 3d23fd6 | 2011-07-30 10:56:50 +0800 | [diff] [blame] | 290 | def connect(self, host='localhost', port=0, source_address=None): |
Guido van Rossum | bbe323e | 1998-01-29 17:24:40 +0000 | [diff] [blame] | 291 | """Connect to a host on a given port. |
Guido van Rossum | 95e6f70 | 1998-06-25 02:15:50 +0000 | [diff] [blame] | 292 | |
Barry Warsaw | 4c4bec8 | 1998-12-22 03:02:20 +0000 | [diff] [blame] | 293 | If the hostname ends with a colon (`:') followed by a number, and |
| 294 | there is no port specified, that suffix will be stripped off and the |
| 295 | number interpreted as the port number to use. |
Guido van Rossum | 95e6f70 | 1998-06-25 02:15:50 +0000 | [diff] [blame] | 296 | |
Barry Warsaw | a7d9bdf | 1998-12-22 03:24:27 +0000 | [diff] [blame] | 297 | Note: This method is automatically invoked by __init__, if a host is |
| 298 | specified during instantiation. |
Guido van Rossum | bbe323e | 1998-01-29 17:24:40 +0000 | [diff] [blame] | 299 | |
| 300 | """ |
Senthil Kumaran | b351a48 | 2011-07-31 09:14:17 +0800 | [diff] [blame] | 301 | |
| 302 | if source_address: |
| 303 | self.source_address = source_address |
| 304 | |
Martin v. Löwis | 4eb5940 | 2001-07-26 13:37:33 +0000 | [diff] [blame] | 305 | if not port and (host.find(':') == host.rfind(':')): |
Martin v. Löwis | a43c2f8 | 2001-07-24 20:34:08 +0000 | [diff] [blame] | 306 | i = host.rfind(':') |
Guido van Rossum | bbe323e | 1998-01-29 17:24:40 +0000 | [diff] [blame] | 307 | if i >= 0: |
Giampaolo Rodolà | bd258bd | 2011-02-22 15:56:20 +0000 | [diff] [blame] | 308 | host, port = host[:i], host[i + 1:] |
| 309 | try: |
| 310 | port = int(port) |
Eric S. Raymond | 8d87603 | 2001-02-09 10:14:53 +0000 | [diff] [blame] | 311 | except ValueError: |
Guido van Rossum | d8faa36 | 2007-04-27 19:54:29 +0000 | [diff] [blame] | 312 | raise socket.error("nonnumeric port") |
Giampaolo Rodolà | bd258bd | 2011-02-22 15:56:20 +0000 | [diff] [blame] | 313 | if not port: |
| 314 | port = self.default_port |
| 315 | if self.debuglevel > 0: |
| 316 | print('connect:', (host, port), file=stderr) |
Guido van Rossum | d8faa36 | 2007-04-27 19:54:29 +0000 | [diff] [blame] | 317 | self.sock = self._get_socket(host, port, self.timeout) |
Antoine Pitrou | f068ab8 | 2011-06-06 19:17:09 +0200 | [diff] [blame] | 318 | self.file = None |
Martin v. Löwis | a43c2f8 | 2001-07-24 20:34:08 +0000 | [diff] [blame] | 319 | (code, msg) = self.getreply() |
Giampaolo Rodolà | bd258bd | 2011-02-22 15:56:20 +0000 | [diff] [blame] | 320 | if self.debuglevel > 0: |
| 321 | print("connect:", msg, file=stderr) |
Martin v. Löwis | a43c2f8 | 2001-07-24 20:34:08 +0000 | [diff] [blame] | 322 | return (code, msg) |
Tim Peters | 495ad3c | 2001-01-15 01:36:40 +0000 | [diff] [blame] | 323 | |
Guido van Rossum | 8a392d7 | 2007-11-21 22:09:45 +0000 | [diff] [blame] | 324 | def send(self, s): |
| 325 | """Send `s' to the server.""" |
Giampaolo Rodolà | bd258bd | 2011-02-22 15:56:20 +0000 | [diff] [blame] | 326 | if self.debuglevel > 0: |
| 327 | print('send:', repr(s), file=stderr) |
Christian Heimes | 90c3d9b | 2008-02-23 13:18:03 +0000 | [diff] [blame] | 328 | if hasattr(self, 'sock') and self.sock: |
Guido van Rossum | 8a392d7 | 2007-11-21 22:09:45 +0000 | [diff] [blame] | 329 | if isinstance(s, str): |
| 330 | s = s.encode("ascii") |
Guido van Rossum | 2880f6e | 1998-08-10 20:07:00 +0000 | [diff] [blame] | 331 | try: |
Guido van Rossum | 8a392d7 | 2007-11-21 22:09:45 +0000 | [diff] [blame] | 332 | self.sock.sendall(s) |
Guido van Rossum | 2880f6e | 1998-08-10 20:07:00 +0000 | [diff] [blame] | 333 | except socket.error: |
Barry Warsaw | 7675097 | 2001-12-14 20:34:20 +0000 | [diff] [blame] | 334 | self.close() |
Guido van Rossum | 40233ea | 1999-01-15 03:23:55 +0000 | [diff] [blame] | 335 | raise SMTPServerDisconnected('Server not connected') |
Guido van Rossum | fc40a83 | 1998-01-29 17:26:45 +0000 | [diff] [blame] | 336 | else: |
Guido van Rossum | 40233ea | 1999-01-15 03:23:55 +0000 | [diff] [blame] | 337 | raise SMTPServerDisconnected('please run connect() first') |
Tim Peters | 495ad3c | 2001-01-15 01:36:40 +0000 | [diff] [blame] | 338 | |
Guido van Rossum | bbe323e | 1998-01-29 17:24:40 +0000 | [diff] [blame] | 339 | def putcmd(self, cmd, args=""): |
Barry Warsaw | a7d9bdf | 1998-12-22 03:24:27 +0000 | [diff] [blame] | 340 | """Send a command to the server.""" |
Guido van Rossum | db23d3d | 1999-06-09 15:13:10 +0000 | [diff] [blame] | 341 | if args == "": |
| 342 | str = '%s%s' % (cmd, CRLF) |
| 343 | else: |
| 344 | str = '%s %s%s' % (cmd, args, CRLF) |
Guido van Rossum | bbe323e | 1998-01-29 17:24:40 +0000 | [diff] [blame] | 345 | self.send(str) |
Tim Peters | 495ad3c | 2001-01-15 01:36:40 +0000 | [diff] [blame] | 346 | |
Guido van Rossum | fcfb632 | 1998-08-04 15:29:54 +0000 | [diff] [blame] | 347 | def getreply(self): |
Guido van Rossum | bbe323e | 1998-01-29 17:24:40 +0000 | [diff] [blame] | 348 | """Get a reply from the server. |
Tim Peters | 495ad3c | 2001-01-15 01:36:40 +0000 | [diff] [blame] | 349 | |
Guido van Rossum | bbe323e | 1998-01-29 17:24:40 +0000 | [diff] [blame] | 350 | Returns a tuple consisting of: |
Barry Warsaw | a7d9bdf | 1998-12-22 03:24:27 +0000 | [diff] [blame] | 351 | |
| 352 | - server response code (e.g. '250', or such, if all goes well) |
| 353 | Note: returns -1 if it can't read response code. |
| 354 | |
| 355 | - server response string corresponding to response code (multiline |
| 356 | responses are converted to a single, multiline string). |
Guido van Rossum | f123f84 | 1999-03-29 20:33:21 +0000 | [diff] [blame] | 357 | |
| 358 | Raises SMTPServerDisconnected if end-of-file is reached. |
Guido van Rossum | bbe323e | 1998-01-29 17:24:40 +0000 | [diff] [blame] | 359 | """ |
Giampaolo Rodolà | bd258bd | 2011-02-22 15:56:20 +0000 | [diff] [blame] | 360 | resp = [] |
Guido van Rossum | 296e143 | 1999-04-07 15:03:39 +0000 | [diff] [blame] | 361 | if self.file is None: |
| 362 | self.file = self.sock.makefile('rb') |
Guido van Rossum | 45e2fbc | 1998-03-26 21:13:24 +0000 | [diff] [blame] | 363 | while 1: |
Benjamin Peterson | e1cdfd7 | 2009-01-18 21:02:37 +0000 | [diff] [blame] | 364 | try: |
| 365 | line = self.file.readline() |
| 366 | except socket.error: |
| 367 | line = '' |
Guido van Rossum | 806c246 | 2007-08-06 23:33:07 +0000 | [diff] [blame] | 368 | if not line: |
Guido van Rossum | 296e143 | 1999-04-07 15:03:39 +0000 | [diff] [blame] | 369 | self.close() |
| 370 | raise SMTPServerDisconnected("Connection unexpectedly closed") |
Giampaolo Rodolà | bd258bd | 2011-02-22 15:56:20 +0000 | [diff] [blame] | 371 | if self.debuglevel > 0: |
| 372 | print('reply:', repr(line), file=stderr) |
Guido van Rossum | 806c246 | 2007-08-06 23:33:07 +0000 | [diff] [blame] | 373 | resp.append(line[4:].strip(b' \t\r\n')) |
Giampaolo Rodolà | bd258bd | 2011-02-22 15:56:20 +0000 | [diff] [blame] | 374 | code = line[:3] |
Guido van Rossum | 296e143 | 1999-04-07 15:03:39 +0000 | [diff] [blame] | 375 | # Check that the error code is syntactically correct. |
| 376 | # Don't attempt to read a continuation line if it is broken. |
| 377 | try: |
Eric S. Raymond | c013f30 | 2001-02-09 05:40:38 +0000 | [diff] [blame] | 378 | errcode = int(code) |
Guido van Rossum | 296e143 | 1999-04-07 15:03:39 +0000 | [diff] [blame] | 379 | except ValueError: |
| 380 | errcode = -1 |
| 381 | break |
Guido van Rossum | f123f84 | 1999-03-29 20:33:21 +0000 | [diff] [blame] | 382 | # Check if multiline response. |
Guido van Rossum | 806c246 | 2007-08-06 23:33:07 +0000 | [diff] [blame] | 383 | if line[3:4] != b"-": |
Guido van Rossum | bbe323e | 1998-01-29 17:24:40 +0000 | [diff] [blame] | 384 | break |
Guido van Rossum | bbe323e | 1998-01-29 17:24:40 +0000 | [diff] [blame] | 385 | |
Guido van Rossum | c43e79f | 2007-06-18 18:26:36 +0000 | [diff] [blame] | 386 | errmsg = b"\n".join(resp) |
Tim Peters | 495ad3c | 2001-01-15 01:36:40 +0000 | [diff] [blame] | 387 | if self.debuglevel > 0: |
Senthil Kumaran | b351a48 | 2011-07-31 09:14:17 +0800 | [diff] [blame] | 388 | print('reply: retcode (%s); Msg: %s' % (errcode, errmsg), |
| 389 | file=stderr) |
Guido van Rossum | bbe323e | 1998-01-29 17:24:40 +0000 | [diff] [blame] | 390 | return errcode, errmsg |
Tim Peters | 495ad3c | 2001-01-15 01:36:40 +0000 | [diff] [blame] | 391 | |
Guido van Rossum | bbe323e | 1998-01-29 17:24:40 +0000 | [diff] [blame] | 392 | def docmd(self, cmd, args=""): |
Barry Warsaw | a7d9bdf | 1998-12-22 03:24:27 +0000 | [diff] [blame] | 393 | """Send a command, and return its response code.""" |
Giampaolo Rodolà | bd258bd | 2011-02-22 15:56:20 +0000 | [diff] [blame] | 394 | self.putcmd(cmd, args) |
Guido van Rossum | 296e143 | 1999-04-07 15:03:39 +0000 | [diff] [blame] | 395 | return self.getreply() |
Guido van Rossum | bbe323e | 1998-01-29 17:24:40 +0000 | [diff] [blame] | 396 | |
Barry Warsaw | a7d9bdf | 1998-12-22 03:24:27 +0000 | [diff] [blame] | 397 | # std smtp commands |
Guido van Rossum | bbe323e | 1998-01-29 17:24:40 +0000 | [diff] [blame] | 398 | def helo(self, name=''): |
Barry Warsaw | a7d9bdf | 1998-12-22 03:24:27 +0000 | [diff] [blame] | 399 | """SMTP 'helo' command. |
| 400 | Hostname to send for this command defaults to the FQDN of the local |
| 401 | host. |
| 402 | """ |
Neil Schemenauer | 6730f26 | 2002-03-24 15:30:40 +0000 | [diff] [blame] | 403 | self.putcmd("helo", name or self.local_hostname) |
Giampaolo Rodolà | bd258bd | 2011-02-22 15:56:20 +0000 | [diff] [blame] | 404 | (code, msg) = self.getreply() |
| 405 | self.helo_resp = msg |
| 406 | return (code, msg) |
Guido van Rossum | bbe323e | 1998-01-29 17:24:40 +0000 | [diff] [blame] | 407 | |
Guido van Rossum | 95e6f70 | 1998-06-25 02:15:50 +0000 | [diff] [blame] | 408 | def ehlo(self, name=''): |
Barry Warsaw | a7d9bdf | 1998-12-22 03:24:27 +0000 | [diff] [blame] | 409 | """ SMTP 'ehlo' command. |
| 410 | Hostname to send for this command defaults to the FQDN of the local |
| 411 | host. |
| 412 | """ |
Guido van Rossum | f7fcf5e | 2001-09-14 16:08:44 +0000 | [diff] [blame] | 413 | self.esmtp_features = {} |
Guido van Rossum | d8faa36 | 2007-04-27 19:54:29 +0000 | [diff] [blame] | 414 | self.putcmd(self.ehlo_msg, name or self.local_hostname) |
Giampaolo Rodolà | bd258bd | 2011-02-22 15:56:20 +0000 | [diff] [blame] | 415 | (code, msg) = self.getreply() |
Tim Peters | 495ad3c | 2001-01-15 01:36:40 +0000 | [diff] [blame] | 416 | # According to RFC1869 some (badly written) |
| 417 | # MTA's will disconnect on an ehlo. Toss an exception if |
Guido van Rossum | fcfb632 | 1998-08-04 15:29:54 +0000 | [diff] [blame] | 418 | # that happens -ddm |
| 419 | if code == -1 and len(msg) == 0: |
Barry Warsaw | 7675097 | 2001-12-14 20:34:20 +0000 | [diff] [blame] | 420 | self.close() |
Guido van Rossum | 40233ea | 1999-01-15 03:23:55 +0000 | [diff] [blame] | 421 | raise SMTPServerDisconnected("Server not connected") |
Giampaolo Rodolà | bd258bd | 2011-02-22 15:56:20 +0000 | [diff] [blame] | 422 | self.ehlo_resp = msg |
Fred Drake | 8152d32 | 2000-12-12 23:20:45 +0000 | [diff] [blame] | 423 | if code != 250: |
Giampaolo Rodolà | bd258bd | 2011-02-22 15:56:20 +0000 | [diff] [blame] | 424 | return (code, msg) |
| 425 | self.does_esmtp = 1 |
Thomas Wouters | 7e47402 | 2000-07-16 12:04:32 +0000 | [diff] [blame] | 426 | #parse the ehlo response -ddm |
Guido van Rossum | 04110fb | 2007-08-24 16:32:05 +0000 | [diff] [blame] | 427 | assert isinstance(self.ehlo_resp, bytes), repr(self.ehlo_resp) |
Giampaolo Rodolà | bd258bd | 2011-02-22 15:56:20 +0000 | [diff] [blame] | 428 | resp = self.ehlo_resp.decode("latin-1").split('\n') |
Guido van Rossum | fcfb632 | 1998-08-04 15:29:54 +0000 | [diff] [blame] | 429 | del resp[0] |
Guido van Rossum | 2880f6e | 1998-08-10 20:07:00 +0000 | [diff] [blame] | 430 | for each in resp: |
Piers Lauder | 385a77a | 2002-07-27 00:38:30 +0000 | [diff] [blame] | 431 | # To be able to communicate with as many SMTP servers as possible, |
| 432 | # we have to take the old-style auth advertisement into account, |
| 433 | # because: |
| 434 | # 1) Else our SMTP feature parser gets confused. |
| 435 | # 2) There are some servers that only advertise the auth methods we |
| 436 | # support using the old style. |
| 437 | auth_match = OLDSTYLE_AUTH.match(each) |
| 438 | if auth_match: |
| 439 | # This doesn't remove duplicates, but that's no problem |
| 440 | self.esmtp_features["auth"] = self.esmtp_features.get("auth", "") \ |
| 441 | + " " + auth_match.groups(0)[0] |
| 442 | continue |
| 443 | |
Barry Warsaw | be22ae6 | 2002-04-15 20:03:30 +0000 | [diff] [blame] | 444 | # RFC 1869 requires a space between ehlo keyword and parameters. |
| 445 | # It's actually stricter, in that only spaces are allowed between |
| 446 | # parameters, but were not going to check for that here. Note |
| 447 | # that the space isn't present if there are no parameters. |
Giampaolo Rodolà | bd258bd | 2011-02-22 15:56:20 +0000 | [diff] [blame] | 448 | m = re.match(r'(?P<feature>[A-Za-z0-9][A-Za-z0-9\-]*) ?', each) |
Guido van Rossum | fcfb632 | 1998-08-04 15:29:54 +0000 | [diff] [blame] | 449 | if m: |
Giampaolo Rodolà | bd258bd | 2011-02-22 15:56:20 +0000 | [diff] [blame] | 450 | feature = m.group("feature").lower() |
| 451 | params = m.string[m.end("feature"):].strip() |
Piers Lauder | 385a77a | 2002-07-27 00:38:30 +0000 | [diff] [blame] | 452 | if feature == "auth": |
| 453 | self.esmtp_features[feature] = self.esmtp_features.get(feature, "") \ |
| 454 | + " " + params |
| 455 | else: |
Giampaolo Rodolà | bd258bd | 2011-02-22 15:56:20 +0000 | [diff] [blame] | 456 | self.esmtp_features[feature] = params |
| 457 | return (code, msg) |
Guido van Rossum | 95e6f70 | 1998-06-25 02:15:50 +0000 | [diff] [blame] | 458 | |
Guido van Rossum | fcfb632 | 1998-08-04 15:29:54 +0000 | [diff] [blame] | 459 | def has_extn(self, opt): |
| 460 | """Does the server support a given SMTP service extension?""" |
Raymond Hettinger | 54f0222 | 2002-06-01 14:18:47 +0000 | [diff] [blame] | 461 | return opt.lower() in self.esmtp_features |
Guido van Rossum | 95e6f70 | 1998-06-25 02:15:50 +0000 | [diff] [blame] | 462 | |
Guido van Rossum | 18586f4 | 1998-04-03 17:03:13 +0000 | [diff] [blame] | 463 | def help(self, args=''): |
Barry Warsaw | a7d9bdf | 1998-12-22 03:24:27 +0000 | [diff] [blame] | 464 | """SMTP 'help' command. |
| 465 | Returns help text from server.""" |
Guido van Rossum | 18586f4 | 1998-04-03 17:03:13 +0000 | [diff] [blame] | 466 | self.putcmd("help", args) |
Kurt B. Kaiser | 58bd190 | 2005-06-26 18:27:36 +0000 | [diff] [blame] | 467 | return self.getreply()[1] |
Guido van Rossum | bbe323e | 1998-01-29 17:24:40 +0000 | [diff] [blame] | 468 | |
| 469 | def rset(self): |
Barry Warsaw | a7d9bdf | 1998-12-22 03:24:27 +0000 | [diff] [blame] | 470 | """SMTP 'rset' command -- resets session.""" |
Guido van Rossum | 296e143 | 1999-04-07 15:03:39 +0000 | [diff] [blame] | 471 | return self.docmd("rset") |
Guido van Rossum | bbe323e | 1998-01-29 17:24:40 +0000 | [diff] [blame] | 472 | |
| 473 | def noop(self): |
Barry Warsaw | a7d9bdf | 1998-12-22 03:24:27 +0000 | [diff] [blame] | 474 | """SMTP 'noop' command -- doesn't do anything :>""" |
Guido van Rossum | 296e143 | 1999-04-07 15:03:39 +0000 | [diff] [blame] | 475 | return self.docmd("noop") |
Guido van Rossum | bbe323e | 1998-01-29 17:24:40 +0000 | [diff] [blame] | 476 | |
Giampaolo Rodolà | bd258bd | 2011-02-22 15:56:20 +0000 | [diff] [blame] | 477 | def mail(self, sender, options=[]): |
Barry Warsaw | a7d9bdf | 1998-12-22 03:24:27 +0000 | [diff] [blame] | 478 | """SMTP 'mail' command -- begins mail xfer session.""" |
Guido van Rossum | fcfb632 | 1998-08-04 15:29:54 +0000 | [diff] [blame] | 479 | optionlist = '' |
| 480 | if options and self.does_esmtp: |
Eric S. Raymond | c013f30 | 2001-02-09 05:40:38 +0000 | [diff] [blame] | 481 | optionlist = ' ' + ' '.join(options) |
Giampaolo Rodolà | bd258bd | 2011-02-22 15:56:20 +0000 | [diff] [blame] | 482 | self.putcmd("mail", "FROM:%s%s" % (quoteaddr(sender), optionlist)) |
Guido van Rossum | 45e2fbc | 1998-03-26 21:13:24 +0000 | [diff] [blame] | 483 | return self.getreply() |
Guido van Rossum | bbe323e | 1998-01-29 17:24:40 +0000 | [diff] [blame] | 484 | |
Giampaolo Rodolà | bd258bd | 2011-02-22 15:56:20 +0000 | [diff] [blame] | 485 | def rcpt(self, recip, options=[]): |
Barry Warsaw | a7d9bdf | 1998-12-22 03:24:27 +0000 | [diff] [blame] | 486 | """SMTP 'rcpt' command -- indicates 1 recipient for this mail.""" |
Guido van Rossum | fcfb632 | 1998-08-04 15:29:54 +0000 | [diff] [blame] | 487 | optionlist = '' |
| 488 | if options and self.does_esmtp: |
Eric S. Raymond | c013f30 | 2001-02-09 05:40:38 +0000 | [diff] [blame] | 489 | optionlist = ' ' + ' '.join(options) |
Giampaolo Rodolà | bd258bd | 2011-02-22 15:56:20 +0000 | [diff] [blame] | 490 | self.putcmd("rcpt", "TO:%s%s" % (quoteaddr(recip), optionlist)) |
Guido van Rossum | 45e2fbc | 1998-03-26 21:13:24 +0000 | [diff] [blame] | 491 | return self.getreply() |
Guido van Rossum | bbe323e | 1998-01-29 17:24:40 +0000 | [diff] [blame] | 492 | |
Giampaolo Rodolà | bd258bd | 2011-02-22 15:56:20 +0000 | [diff] [blame] | 493 | def data(self, msg): |
Tim Peters | 495ad3c | 2001-01-15 01:36:40 +0000 | [diff] [blame] | 494 | """SMTP 'DATA' command -- sends message data to server. |
Guido van Rossum | 296e143 | 1999-04-07 15:03:39 +0000 | [diff] [blame] | 495 | |
Barry Warsaw | 4c4bec8 | 1998-12-22 03:02:20 +0000 | [diff] [blame] | 496 | Automatically quotes lines beginning with a period per rfc821. |
Guido van Rossum | 296e143 | 1999-04-07 15:03:39 +0000 | [diff] [blame] | 497 | Raises SMTPDataError if there is an unexpected reply to the |
| 498 | DATA command; the return value from this method is the final |
R. David Murray | 7dff9e0 | 2010-11-08 17:15:13 +0000 | [diff] [blame] | 499 | response code received when the all data is sent. If msg |
| 500 | is a string, lone '\r' and '\n' characters are converted to |
| 501 | '\r\n' characters. If msg is bytes, it is transmitted as is. |
Barry Warsaw | 4c4bec8 | 1998-12-22 03:02:20 +0000 | [diff] [blame] | 502 | """ |
Guido van Rossum | 45e2fbc | 1998-03-26 21:13:24 +0000 | [diff] [blame] | 503 | self.putcmd("data") |
Giampaolo Rodolà | bd258bd | 2011-02-22 15:56:20 +0000 | [diff] [blame] | 504 | (code, repl) = self.getreply() |
| 505 | if self.debuglevel > 0: |
| 506 | print("data:", (code, repl), file=stderr) |
Fred Drake | 8152d32 | 2000-12-12 23:20:45 +0000 | [diff] [blame] | 507 | if code != 354: |
Giampaolo Rodolà | bd258bd | 2011-02-22 15:56:20 +0000 | [diff] [blame] | 508 | raise SMTPDataError(code, repl) |
Guido van Rossum | 45e2fbc | 1998-03-26 21:13:24 +0000 | [diff] [blame] | 509 | else: |
R. David Murray | 7dff9e0 | 2010-11-08 17:15:13 +0000 | [diff] [blame] | 510 | if isinstance(msg, str): |
| 511 | msg = _fix_eols(msg).encode('ascii') |
| 512 | q = _quote_periods(msg) |
| 513 | if q[-2:] != bCRLF: |
| 514 | q = q + bCRLF |
| 515 | q = q + b"." + bCRLF |
Guido van Rossum | 20c9228 | 1999-04-21 16:52:20 +0000 | [diff] [blame] | 516 | self.send(q) |
Giampaolo Rodolà | bd258bd | 2011-02-22 15:56:20 +0000 | [diff] [blame] | 517 | (code, msg) = self.getreply() |
| 518 | if self.debuglevel > 0: |
| 519 | print("data:", (code, msg), file=stderr) |
| 520 | return (code, msg) |
Guido van Rossum | bbe323e | 1998-01-29 17:24:40 +0000 | [diff] [blame] | 521 | |
Guido van Rossum | fcfb632 | 1998-08-04 15:29:54 +0000 | [diff] [blame] | 522 | def verify(self, address): |
Barry Warsaw | a7d9bdf | 1998-12-22 03:24:27 +0000 | [diff] [blame] | 523 | """SMTP 'verify' command -- checks for address validity.""" |
R David Murray | 4634676 | 2011-07-18 21:38:54 -0400 | [diff] [blame] | 524 | self.putcmd("vrfy", _addr_only(address)) |
Guido van Rossum | fcfb632 | 1998-08-04 15:29:54 +0000 | [diff] [blame] | 525 | return self.getreply() |
Barry Warsaw | 4c4bec8 | 1998-12-22 03:02:20 +0000 | [diff] [blame] | 526 | # a.k.a. |
Giampaolo Rodolà | bd258bd | 2011-02-22 15:56:20 +0000 | [diff] [blame] | 527 | vrfy = verify |
Guido van Rossum | fcfb632 | 1998-08-04 15:29:54 +0000 | [diff] [blame] | 528 | |
| 529 | def expn(self, address): |
Christian Heimes | 90c3d9b | 2008-02-23 13:18:03 +0000 | [diff] [blame] | 530 | """SMTP 'expn' command -- expands a mailing list.""" |
R David Murray | 4634676 | 2011-07-18 21:38:54 -0400 | [diff] [blame] | 531 | self.putcmd("expn", _addr_only(address)) |
Guido van Rossum | fcfb632 | 1998-08-04 15:29:54 +0000 | [diff] [blame] | 532 | return self.getreply() |
| 533 | |
Barry Warsaw | 4c4bec8 | 1998-12-22 03:02:20 +0000 | [diff] [blame] | 534 | # some useful methods |
Guido van Rossum | ae01046 | 2001-09-11 15:57:46 +0000 | [diff] [blame] | 535 | |
Christian Heimes | 679db4a | 2008-01-18 09:56:22 +0000 | [diff] [blame] | 536 | def ehlo_or_helo_if_needed(self): |
| 537 | """Call self.ehlo() and/or self.helo() if needed. |
| 538 | |
| 539 | If there has been no previous EHLO or HELO command this session, this |
| 540 | method tries ESMTP EHLO first. |
| 541 | |
| 542 | This method may raise the following exceptions: |
| 543 | |
| 544 | SMTPHeloError The server didn't reply properly to |
| 545 | the helo greeting. |
| 546 | """ |
| 547 | if self.helo_resp is None and self.ehlo_resp is None: |
| 548 | if not (200 <= self.ehlo()[0] <= 299): |
| 549 | (code, resp) = self.helo() |
| 550 | if not (200 <= code <= 299): |
| 551 | raise SMTPHeloError(code, resp) |
| 552 | |
Guido van Rossum | ae01046 | 2001-09-11 15:57:46 +0000 | [diff] [blame] | 553 | def login(self, user, password): |
| 554 | """Log in on an SMTP server that requires authentication. |
| 555 | |
| 556 | The arguments are: |
| 557 | - user: The user name to authenticate with. |
| 558 | - password: The password for the authentication. |
| 559 | |
| 560 | If there has been no previous EHLO or HELO command this session, this |
| 561 | method tries ESMTP EHLO first. |
| 562 | |
| 563 | This method will return normally if the authentication was successful. |
| 564 | |
| 565 | This method may raise the following exceptions: |
| 566 | |
| 567 | SMTPHeloError The server didn't reply properly to |
| 568 | the helo greeting. |
| 569 | SMTPAuthenticationError The server didn't accept the username/ |
| 570 | password combination. |
Fred Drake | 2f8f4d3 | 2001-10-13 18:35:32 +0000 | [diff] [blame] | 571 | SMTPException No suitable authentication method was |
Guido van Rossum | ae01046 | 2001-09-11 15:57:46 +0000 | [diff] [blame] | 572 | found. |
| 573 | """ |
| 574 | |
| 575 | def encode_cram_md5(challenge, user, password): |
Georg Brandl | 706824f | 2009-06-04 09:42:55 +0000 | [diff] [blame] | 576 | challenge = base64.decodebytes(challenge) |
R. David Murray | fb12391 | 2009-05-28 18:19:00 +0000 | [diff] [blame] | 577 | response = user + " " + hmac.HMAC(password.encode('ascii'), |
| 578 | challenge).hexdigest() |
| 579 | return encode_base64(response.encode('ascii'), eol='') |
Guido van Rossum | ae01046 | 2001-09-11 15:57:46 +0000 | [diff] [blame] | 580 | |
| 581 | def encode_plain(user, password): |
R. David Murray | caa27b7 | 2009-05-23 18:49:56 +0000 | [diff] [blame] | 582 | s = "\0%s\0%s" % (user, password) |
| 583 | return encode_base64(s.encode('ascii'), eol='') |
Tim Peters | 469cdad | 2002-08-08 20:19:19 +0000 | [diff] [blame] | 584 | |
Guido van Rossum | ae01046 | 2001-09-11 15:57:46 +0000 | [diff] [blame] | 585 | AUTH_PLAIN = "PLAIN" |
| 586 | AUTH_CRAM_MD5 = "CRAM-MD5" |
Piers Lauder | 385a77a | 2002-07-27 00:38:30 +0000 | [diff] [blame] | 587 | AUTH_LOGIN = "LOGIN" |
Guido van Rossum | ae01046 | 2001-09-11 15:57:46 +0000 | [diff] [blame] | 588 | |
Christian Heimes | 679db4a | 2008-01-18 09:56:22 +0000 | [diff] [blame] | 589 | self.ehlo_or_helo_if_needed() |
Guido van Rossum | ae01046 | 2001-09-11 15:57:46 +0000 | [diff] [blame] | 590 | |
| 591 | if not self.has_extn("auth"): |
| 592 | raise SMTPException("SMTP AUTH extension not supported by server.") |
| 593 | |
Gerhard Häring | 1c5471f | 2010-08-05 14:08:44 +0000 | [diff] [blame] | 594 | # Authentication methods the server claims to support |
| 595 | advertised_authlist = self.esmtp_features["auth"].split() |
Guido van Rossum | ae01046 | 2001-09-11 15:57:46 +0000 | [diff] [blame] | 596 | |
| 597 | # List of authentication methods we support: from preferred to |
| 598 | # less preferred methods. Except for the purpose of testing the weaker |
| 599 | # ones, we prefer stronger methods like CRAM-MD5: |
Piers Lauder | 385a77a | 2002-07-27 00:38:30 +0000 | [diff] [blame] | 600 | preferred_auths = [AUTH_CRAM_MD5, AUTH_PLAIN, AUTH_LOGIN] |
Guido van Rossum | ae01046 | 2001-09-11 15:57:46 +0000 | [diff] [blame] | 601 | |
Gerhard Häring | 1c5471f | 2010-08-05 14:08:44 +0000 | [diff] [blame] | 602 | # We try the authentication methods the server advertises, but only the |
| 603 | # ones *we* support. And in our preferred order. |
| 604 | authlist = [auth for auth in preferred_auths if auth in advertised_authlist] |
| 605 | if not authlist: |
Fred Drake | 2f8f4d3 | 2001-10-13 18:35:32 +0000 | [diff] [blame] | 606 | raise SMTPException("No suitable authentication method found.") |
Gerhard Häring | 1c5471f | 2010-08-05 14:08:44 +0000 | [diff] [blame] | 607 | |
| 608 | # Some servers advertise authentication methods they don't really |
| 609 | # support, so if authentication fails, we continue until we've tried |
| 610 | # all methods. |
| 611 | for authmethod in authlist: |
| 612 | if authmethod == AUTH_CRAM_MD5: |
| 613 | (code, resp) = self.docmd("AUTH", AUTH_CRAM_MD5) |
| 614 | if code == 334: |
| 615 | (code, resp) = self.docmd(encode_cram_md5(resp, user, password)) |
| 616 | elif authmethod == AUTH_PLAIN: |
| 617 | (code, resp) = self.docmd("AUTH", |
| 618 | AUTH_PLAIN + " " + encode_plain(user, password)) |
| 619 | elif authmethod == AUTH_LOGIN: |
| 620 | (code, resp) = self.docmd("AUTH", |
| 621 | "%s %s" % (AUTH_LOGIN, encode_base64(user.encode('ascii'), eol=''))) |
| 622 | if code == 334: |
| 623 | (code, resp) = self.docmd(encode_base64(password.encode('ascii'), eol='')) |
| 624 | |
Guido van Rossum | ae01046 | 2001-09-11 15:57:46 +0000 | [diff] [blame] | 625 | # 235 == 'Authentication successful' |
| 626 | # 503 == 'Error: already authenticated' |
Gerhard Häring | 1c5471f | 2010-08-05 14:08:44 +0000 | [diff] [blame] | 627 | if code in (235, 503): |
| 628 | return (code, resp) |
| 629 | |
| 630 | # We could not login sucessfully. Return result of last attempt. |
| 631 | raise SMTPAuthenticationError(code, resp) |
Guido van Rossum | ae01046 | 2001-09-11 15:57:46 +0000 | [diff] [blame] | 632 | |
Antoine Pitrou | e065020 | 2011-05-18 18:03:09 +0200 | [diff] [blame] | 633 | def starttls(self, keyfile=None, certfile=None, context=None): |
Guido van Rossum | f7fcf5e | 2001-09-14 16:08:44 +0000 | [diff] [blame] | 634 | """Puts the connection to the SMTP server into TLS mode. |
Tim Peters | b64bec3 | 2001-09-18 02:26:39 +0000 | [diff] [blame] | 635 | |
Christian Heimes | 679db4a | 2008-01-18 09:56:22 +0000 | [diff] [blame] | 636 | If there has been no previous EHLO or HELO command this session, this |
| 637 | method tries ESMTP EHLO first. |
| 638 | |
Guido van Rossum | f7fcf5e | 2001-09-14 16:08:44 +0000 | [diff] [blame] | 639 | If the server supports TLS, this will encrypt the rest of the SMTP |
| 640 | session. If you provide the keyfile and certfile parameters, |
| 641 | the identity of the SMTP server and client can be checked. This, |
| 642 | however, depends on whether the socket module really checks the |
| 643 | certificates. |
Christian Heimes | 679db4a | 2008-01-18 09:56:22 +0000 | [diff] [blame] | 644 | |
| 645 | This method may raise the following exceptions: |
| 646 | |
| 647 | SMTPHeloError The server didn't reply properly to |
| 648 | the helo greeting. |
Guido van Rossum | f7fcf5e | 2001-09-14 16:08:44 +0000 | [diff] [blame] | 649 | """ |
Christian Heimes | 679db4a | 2008-01-18 09:56:22 +0000 | [diff] [blame] | 650 | self.ehlo_or_helo_if_needed() |
| 651 | if not self.has_extn("starttls"): |
| 652 | raise SMTPException("STARTTLS extension not supported by server.") |
Tim Peters | b64bec3 | 2001-09-18 02:26:39 +0000 | [diff] [blame] | 653 | (resp, reply) = self.docmd("STARTTLS") |
Guido van Rossum | f7fcf5e | 2001-09-14 16:08:44 +0000 | [diff] [blame] | 654 | if resp == 220: |
Thomas Wouters | 47b49bf | 2007-08-30 22:15:33 +0000 | [diff] [blame] | 655 | if not _have_ssl: |
| 656 | raise RuntimeError("No SSL support included in this Python") |
Antoine Pitrou | e065020 | 2011-05-18 18:03:09 +0200 | [diff] [blame] | 657 | if context is not None and keyfile is not None: |
| 658 | raise ValueError("context and keyfile arguments are mutually " |
| 659 | "exclusive") |
| 660 | if context is not None and certfile is not None: |
| 661 | raise ValueError("context and certfile arguments are mutually " |
| 662 | "exclusive") |
| 663 | if context is not None: |
| 664 | self.sock = context.wrap_socket(self.sock) |
| 665 | else: |
| 666 | self.sock = ssl.wrap_socket(self.sock, keyfile, certfile) |
Antoine Pitrou | f068ab8 | 2011-06-06 19:17:09 +0200 | [diff] [blame] | 667 | self.file = None |
Christian Heimes | 679db4a | 2008-01-18 09:56:22 +0000 | [diff] [blame] | 668 | # RFC 3207: |
| 669 | # The client MUST discard any knowledge obtained from |
| 670 | # the server, such as the list of SMTP service extensions, |
| 671 | # which was not obtained from the TLS negotiation itself. |
| 672 | self.helo_resp = None |
| 673 | self.ehlo_resp = None |
| 674 | self.esmtp_features = {} |
| 675 | self.does_esmtp = 0 |
Guido van Rossum | f7fcf5e | 2001-09-14 16:08:44 +0000 | [diff] [blame] | 676 | return (resp, reply) |
Tim Peters | b64bec3 | 2001-09-18 02:26:39 +0000 | [diff] [blame] | 677 | |
Jeremy Hylton | 31bb8ce | 1998-08-13 19:57:46 +0000 | [diff] [blame] | 678 | def sendmail(self, from_addr, to_addrs, msg, mail_options=[], |
Tim Peters | 495ad3c | 2001-01-15 01:36:40 +0000 | [diff] [blame] | 679 | rcpt_options=[]): |
| 680 | """This command performs an entire mail transaction. |
Guido van Rossum | bbe323e | 1998-01-29 17:24:40 +0000 | [diff] [blame] | 681 | |
Tim Peters | 495ad3c | 2001-01-15 01:36:40 +0000 | [diff] [blame] | 682 | The arguments are: |
Barry Warsaw | 4c4bec8 | 1998-12-22 03:02:20 +0000 | [diff] [blame] | 683 | - from_addr : The address sending this mail. |
| 684 | - to_addrs : A list of addresses to send this mail to. A bare |
| 685 | string will be treated as a list with 1 address. |
Tim Peters | 495ad3c | 2001-01-15 01:36:40 +0000 | [diff] [blame] | 686 | - msg : The message to send. |
Barry Warsaw | 4c4bec8 | 1998-12-22 03:02:20 +0000 | [diff] [blame] | 687 | - mail_options : List of ESMTP options (such as 8bitmime) for the |
| 688 | mail command. |
| 689 | - rcpt_options : List of ESMTP options (such as DSN commands) for |
| 690 | all the rcpt commands. |
| 691 | |
R. David Murray | 7dff9e0 | 2010-11-08 17:15:13 +0000 | [diff] [blame] | 692 | msg may be a string containing characters in the ASCII range, or a byte |
| 693 | string. A string is encoded to bytes using the ascii codec, and lone |
R David Murray | ac4e5ab | 2011-07-02 21:03:19 -0400 | [diff] [blame] | 694 | \\r and \\n characters are converted to \\r\\n characters. |
R. David Murray | 7dff9e0 | 2010-11-08 17:15:13 +0000 | [diff] [blame] | 695 | |
Barry Warsaw | 4c4bec8 | 1998-12-22 03:02:20 +0000 | [diff] [blame] | 696 | If there has been no previous EHLO or HELO command this session, this |
| 697 | method tries ESMTP EHLO first. If the server does ESMTP, message size |
| 698 | and each of the specified options will be passed to it. If EHLO |
| 699 | fails, HELO will be tried and ESMTP options suppressed. |
| 700 | |
| 701 | This method will return normally if the mail is accepted for at least |
Barry Warsaw | d25c1b7 | 1999-11-28 17:11:06 +0000 | [diff] [blame] | 702 | one recipient. It returns a dictionary, with one entry for each |
| 703 | recipient that was refused. Each entry contains a tuple of the SMTP |
| 704 | error code and the accompanying error message sent by the server. |
Guido van Rossum | 296e143 | 1999-04-07 15:03:39 +0000 | [diff] [blame] | 705 | |
| 706 | This method may raise the following exceptions: |
| 707 | |
| 708 | SMTPHeloError The server didn't reply properly to |
Tim Peters | 495ad3c | 2001-01-15 01:36:40 +0000 | [diff] [blame] | 709 | the helo greeting. |
Barry Warsaw | d25c1b7 | 1999-11-28 17:11:06 +0000 | [diff] [blame] | 710 | SMTPRecipientsRefused The server rejected ALL recipients |
Guido van Rossum | 296e143 | 1999-04-07 15:03:39 +0000 | [diff] [blame] | 711 | (no mail was sent). |
| 712 | SMTPSenderRefused The server didn't accept the from_addr. |
| 713 | SMTPDataError The server replied with an unexpected |
| 714 | error code (other than a refusal of |
| 715 | a recipient). |
| 716 | |
| 717 | Note: the connection will be open even after an exception is raised. |
Guido van Rossum | bbe323e | 1998-01-29 17:24:40 +0000 | [diff] [blame] | 718 | |
Guido van Rossum | 95e6f70 | 1998-06-25 02:15:50 +0000 | [diff] [blame] | 719 | Example: |
Tim Peters | 495ad3c | 2001-01-15 01:36:40 +0000 | [diff] [blame] | 720 | |
Guido van Rossum | bbe323e | 1998-01-29 17:24:40 +0000 | [diff] [blame] | 721 | >>> import smtplib |
| 722 | >>> s=smtplib.SMTP("localhost") |
Guido van Rossum | fc40a83 | 1998-01-29 17:26:45 +0000 | [diff] [blame] | 723 | >>> tolist=["one@one.org","two@two.org","three@three.org","four@four.org"] |
Martin v. Löwis | 301b1cd | 2002-07-28 16:52:01 +0000 | [diff] [blame] | 724 | >>> msg = '''\\ |
Guido van Rossum | bbe323e | 1998-01-29 17:24:40 +0000 | [diff] [blame] | 725 | ... From: Me@my.org |
| 726 | ... Subject: testin'... |
| 727 | ... |
| 728 | ... This is a test ''' |
| 729 | >>> s.sendmail("me@my.org",tolist,msg) |
| 730 | { "three@three.org" : ( 550 ,"User unknown" ) } |
| 731 | >>> s.quit() |
Tim Peters | 495ad3c | 2001-01-15 01:36:40 +0000 | [diff] [blame] | 732 | |
Barry Warsaw | 4c4bec8 | 1998-12-22 03:02:20 +0000 | [diff] [blame] | 733 | In the above example, the message was accepted for delivery to three |
| 734 | of the four addresses, and one was rejected, with the error code |
Barry Warsaw | d25c1b7 | 1999-11-28 17:11:06 +0000 | [diff] [blame] | 735 | 550. If all addresses are accepted, then the method will return an |
Barry Warsaw | 4c4bec8 | 1998-12-22 03:02:20 +0000 | [diff] [blame] | 736 | empty dictionary. |
| 737 | |
| 738 | """ |
Christian Heimes | 679db4a | 2008-01-18 09:56:22 +0000 | [diff] [blame] | 739 | self.ehlo_or_helo_if_needed() |
Guido van Rossum | 95e6f70 | 1998-06-25 02:15:50 +0000 | [diff] [blame] | 740 | esmtp_opts = [] |
R. David Murray | 7dff9e0 | 2010-11-08 17:15:13 +0000 | [diff] [blame] | 741 | if isinstance(msg, str): |
| 742 | msg = _fix_eols(msg).encode('ascii') |
Guido van Rossum | fcfb632 | 1998-08-04 15:29:54 +0000 | [diff] [blame] | 743 | if self.does_esmtp: |
| 744 | # Hmmm? what's this? -ddm |
| 745 | # self.esmtp_features['7bit']="" |
| 746 | if self.has_extn('size'): |
Walter Dörwald | 70a6b49 | 2004-02-12 17:35:32 +0000 | [diff] [blame] | 747 | esmtp_opts.append("size=%d" % len(msg)) |
Guido van Rossum | fcfb632 | 1998-08-04 15:29:54 +0000 | [diff] [blame] | 748 | for option in mail_options: |
Guido van Rossum | 95e6f70 | 1998-06-25 02:15:50 +0000 | [diff] [blame] | 749 | esmtp_opts.append(option) |
Giampaolo Rodolà | bd258bd | 2011-02-22 15:56:20 +0000 | [diff] [blame] | 750 | (code, resp) = self.mail(from_addr, esmtp_opts) |
Fred Drake | 8152d32 | 2000-12-12 23:20:45 +0000 | [diff] [blame] | 751 | if code != 250: |
Guido van Rossum | 45e2fbc | 1998-03-26 21:13:24 +0000 | [diff] [blame] | 752 | self.rset() |
Guido van Rossum | 296e143 | 1999-04-07 15:03:39 +0000 | [diff] [blame] | 753 | raise SMTPSenderRefused(code, resp, from_addr) |
Giampaolo Rodolà | bd258bd | 2011-02-22 15:56:20 +0000 | [diff] [blame] | 754 | senderrs = {} |
Guido van Rossum | 3172c5d | 2007-10-16 18:12:55 +0000 | [diff] [blame] | 755 | if isinstance(to_addrs, str): |
Jeremy Hylton | 31bb8ce | 1998-08-13 19:57:46 +0000 | [diff] [blame] | 756 | to_addrs = [to_addrs] |
Guido van Rossum | bbe323e | 1998-01-29 17:24:40 +0000 | [diff] [blame] | 757 | for each in to_addrs: |
Giampaolo Rodolà | bd258bd | 2011-02-22 15:56:20 +0000 | [diff] [blame] | 758 | (code, resp) = self.rcpt(each, rcpt_options) |
Fred Drake | 8152d32 | 2000-12-12 23:20:45 +0000 | [diff] [blame] | 759 | if (code != 250) and (code != 251): |
Giampaolo Rodolà | bd258bd | 2011-02-22 15:56:20 +0000 | [diff] [blame] | 760 | senderrs[each] = (code, resp) |
| 761 | if len(senderrs) == len(to_addrs): |
Guido van Rossum | 95e6f70 | 1998-06-25 02:15:50 +0000 | [diff] [blame] | 762 | # the server refused all our recipients |
Guido van Rossum | bbe323e | 1998-01-29 17:24:40 +0000 | [diff] [blame] | 763 | self.rset() |
Guido van Rossum | 296e143 | 1999-04-07 15:03:39 +0000 | [diff] [blame] | 764 | raise SMTPRecipientsRefused(senderrs) |
Giampaolo Rodolà | bd258bd | 2011-02-22 15:56:20 +0000 | [diff] [blame] | 765 | (code, resp) = self.data(msg) |
Fred Drake | 8152d32 | 2000-12-12 23:20:45 +0000 | [diff] [blame] | 766 | if code != 250: |
Guido van Rossum | bbe323e | 1998-01-29 17:24:40 +0000 | [diff] [blame] | 767 | self.rset() |
Guido van Rossum | 296e143 | 1999-04-07 15:03:39 +0000 | [diff] [blame] | 768 | raise SMTPDataError(code, resp) |
Guido van Rossum | bbe323e | 1998-01-29 17:24:40 +0000 | [diff] [blame] | 769 | #if we got here then somebody got our mail |
Tim Peters | 495ad3c | 2001-01-15 01:36:40 +0000 | [diff] [blame] | 770 | return senderrs |
Guido van Rossum | bbe323e | 1998-01-29 17:24:40 +0000 | [diff] [blame] | 771 | |
R. David Murray | 7dff9e0 | 2010-11-08 17:15:13 +0000 | [diff] [blame] | 772 | def send_message(self, msg, from_addr=None, to_addrs=None, |
| 773 | mail_options=[], rcpt_options={}): |
| 774 | """Converts message to a bytestring and passes it to sendmail. |
| 775 | |
| 776 | The arguments are as for sendmail, except that msg is an |
R David Murray | ac4e5ab | 2011-07-02 21:03:19 -0400 | [diff] [blame] | 777 | email.message.Message object. If from_addr is None or to_addrs is |
| 778 | None, these arguments are taken from the headers of the Message as |
| 779 | described in RFC 2822 (a ValueError is raised if there is more than |
| 780 | one set of 'Resent-' headers). Regardless of the values of from_addr and |
| 781 | to_addr, any Bcc field (or Resent-Bcc field, when the Message is a |
| 782 | resent) of the Message object won't be transmitted. The Message |
| 783 | object is then serialized using email.generator.BytesGenerator and |
| 784 | sendmail is called to transmit the message. |
| 785 | |
R. David Murray | 7dff9e0 | 2010-11-08 17:15:13 +0000 | [diff] [blame] | 786 | """ |
R David Murray | ac4e5ab | 2011-07-02 21:03:19 -0400 | [diff] [blame] | 787 | # 'Resent-Date' is a mandatory field if the Message is resent (RFC 2822 |
| 788 | # Section 3.6.6). In such a case, we use the 'Resent-*' fields. However, |
| 789 | # if there is more than one 'Resent-' block there's no way to |
| 790 | # unambiguously determine which one is the most recent in all cases, |
| 791 | # so rather than guess we raise a ValueError in that case. |
| 792 | # |
| 793 | # TODO implement heuristics to guess the correct Resent-* block with an |
| 794 | # option allowing the user to enable the heuristics. (It should be |
| 795 | # possible to guess correctly almost all of the time.) |
Senthil Kumaran | b351a48 | 2011-07-31 09:14:17 +0800 | [diff] [blame] | 796 | |
| 797 | resent = msg.get_all('Resent-Date') |
R David Murray | ac4e5ab | 2011-07-02 21:03:19 -0400 | [diff] [blame] | 798 | if resent is None: |
| 799 | header_prefix = '' |
| 800 | elif len(resent) == 1: |
| 801 | header_prefix = 'Resent-' |
| 802 | else: |
| 803 | raise ValueError("message has more than one 'Resent-' header block") |
R. David Murray | 7dff9e0 | 2010-11-08 17:15:13 +0000 | [diff] [blame] | 804 | if from_addr is None: |
R David Murray | ac4e5ab | 2011-07-02 21:03:19 -0400 | [diff] [blame] | 805 | # Prefer the sender field per RFC 2822:3.6.2. |
Senthil Kumaran | b351a48 | 2011-07-31 09:14:17 +0800 | [diff] [blame] | 806 | from_addr = (msg[header_prefix + 'Sender'] |
| 807 | if (header_prefix + 'Sender') in msg |
| 808 | else msg[header_prefix + 'From']) |
R. David Murray | 7dff9e0 | 2010-11-08 17:15:13 +0000 | [diff] [blame] | 809 | if to_addrs is None: |
Senthil Kumaran | b351a48 | 2011-07-31 09:14:17 +0800 | [diff] [blame] | 810 | addr_fields = [f for f in (msg[header_prefix + 'To'], |
| 811 | msg[header_prefix + 'Bcc'], |
| 812 | msg[header_prefix + 'Cc']) if f is not None] |
R. David Murray | 7dff9e0 | 2010-11-08 17:15:13 +0000 | [diff] [blame] | 813 | to_addrs = [a[1] for a in email.utils.getaddresses(addr_fields)] |
R David Murray | ac4e5ab | 2011-07-02 21:03:19 -0400 | [diff] [blame] | 814 | # Make a local copy so we can delete the bcc headers. |
| 815 | msg_copy = copy.copy(msg) |
| 816 | del msg_copy['Bcc'] |
| 817 | del msg_copy['Resent-Bcc'] |
R. David Murray | 7dff9e0 | 2010-11-08 17:15:13 +0000 | [diff] [blame] | 818 | with io.BytesIO() as bytesmsg: |
| 819 | g = email.generator.BytesGenerator(bytesmsg) |
R David Murray | ac4e5ab | 2011-07-02 21:03:19 -0400 | [diff] [blame] | 820 | g.flatten(msg_copy, linesep='\r\n') |
R. David Murray | 7dff9e0 | 2010-11-08 17:15:13 +0000 | [diff] [blame] | 821 | flatmsg = bytesmsg.getvalue() |
| 822 | return self.sendmail(from_addr, to_addrs, flatmsg, mail_options, |
| 823 | rcpt_options) |
| 824 | |
Guido van Rossum | bbe323e | 1998-01-29 17:24:40 +0000 | [diff] [blame] | 825 | def close(self): |
| 826 | """Close the connection to the SMTP server.""" |
| 827 | if self.file: |
| 828 | self.file.close() |
| 829 | self.file = None |
| 830 | if self.sock: |
| 831 | self.sock.close() |
| 832 | self.sock = None |
| 833 | |
Guido van Rossum | bbe323e | 1998-01-29 17:24:40 +0000 | [diff] [blame] | 834 | def quit(self): |
Guido van Rossum | 95e6f70 | 1998-06-25 02:15:50 +0000 | [diff] [blame] | 835 | """Terminate the SMTP session.""" |
Christian Heimes | ba4af49 | 2008-03-28 00:55:15 +0000 | [diff] [blame] | 836 | res = self.docmd("quit") |
Guido van Rossum | 45e2fbc | 1998-03-26 21:13:24 +0000 | [diff] [blame] | 837 | self.close() |
Christian Heimes | ba4af49 | 2008-03-28 00:55:15 +0000 | [diff] [blame] | 838 | return res |
Guido van Rossum | 95e6f70 | 1998-06-25 02:15:50 +0000 | [diff] [blame] | 839 | |
Thomas Wouters | 47b49bf | 2007-08-30 22:15:33 +0000 | [diff] [blame] | 840 | if _have_ssl: |
Thomas Wouters | 89f507f | 2006-12-13 04:49:30 +0000 | [diff] [blame] | 841 | |
Thomas Wouters | 47b49bf | 2007-08-30 22:15:33 +0000 | [diff] [blame] | 842 | class SMTP_SSL(SMTP): |
| 843 | """ This is a subclass derived from SMTP that connects over an SSL encrypted |
| 844 | socket (to use this class you need a socket module that was compiled with SSL |
| 845 | support). If host is not specified, '' (the local host) is used. If port is |
Senthil Kumaran | 3d23fd6 | 2011-07-30 10:56:50 +0800 | [diff] [blame] | 846 | omitted, the standard SMTP-over-SSL port (465) is used. The optional |
| 847 | source_address takes a two-tuple (host,port) for socket to bind to. keyfile and certfile |
Thomas Wouters | 47b49bf | 2007-08-30 22:15:33 +0000 | [diff] [blame] | 848 | are also optional - they can contain a PEM formatted private key and |
Antoine Pitrou | e065020 | 2011-05-18 18:03:09 +0200 | [diff] [blame] | 849 | certificate chain file for the SSL connection. context also optional, can contain |
| 850 | a SSLContext, and is an alternative to keyfile and certfile; If it is specified both |
| 851 | keyfile and certfile must be None. |
Thomas Wouters | 47b49bf | 2007-08-30 22:15:33 +0000 | [diff] [blame] | 852 | """ |
Antoine Pitrou | c1d5206 | 2011-05-07 19:39:37 +0200 | [diff] [blame] | 853 | |
| 854 | default_port = SMTP_SSL_PORT |
| 855 | |
Thomas Wouters | 47b49bf | 2007-08-30 22:15:33 +0000 | [diff] [blame] | 856 | def __init__(self, host='', port=0, local_hostname=None, |
Georg Brandl | f78e02b | 2008-06-10 17:40:04 +0000 | [diff] [blame] | 857 | keyfile=None, certfile=None, |
Senthil Kumaran | 3d23fd6 | 2011-07-30 10:56:50 +0800 | [diff] [blame] | 858 | timeout=socket._GLOBAL_DEFAULT_TIMEOUT, |
| 859 | source_address=None, context=None): |
Antoine Pitrou | e065020 | 2011-05-18 18:03:09 +0200 | [diff] [blame] | 860 | if context is not None and keyfile is not None: |
| 861 | raise ValueError("context and keyfile arguments are mutually " |
| 862 | "exclusive") |
| 863 | if context is not None and certfile is not None: |
| 864 | raise ValueError("context and certfile arguments are mutually " |
| 865 | "exclusive") |
Thomas Wouters | 47b49bf | 2007-08-30 22:15:33 +0000 | [diff] [blame] | 866 | self.keyfile = keyfile |
| 867 | self.certfile = certfile |
Antoine Pitrou | e065020 | 2011-05-18 18:03:09 +0200 | [diff] [blame] | 868 | self.context = context |
Senthil Kumaran | 3d23fd6 | 2011-07-30 10:56:50 +0800 | [diff] [blame] | 869 | SMTP.__init__(self, host, port, local_hostname, timeout, |
| 870 | source_address) |
Thomas Wouters | 47b49bf | 2007-08-30 22:15:33 +0000 | [diff] [blame] | 871 | |
| 872 | def _get_socket(self, host, port, timeout): |
Giampaolo Rodolà | bd258bd | 2011-02-22 15:56:20 +0000 | [diff] [blame] | 873 | if self.debuglevel > 0: |
| 874 | print('connect:', (host, port), file=stderr) |
Senthil Kumaran | 3d23fd6 | 2011-07-30 10:56:50 +0800 | [diff] [blame] | 875 | new_socket = socket.create_connection((host, port), timeout, |
| 876 | self.source_address) |
Antoine Pitrou | e065020 | 2011-05-18 18:03:09 +0200 | [diff] [blame] | 877 | if self.context is not None: |
| 878 | new_socket = self.context.wrap_socket(new_socket) |
| 879 | else: |
| 880 | new_socket = ssl.wrap_socket(new_socket, self.keyfile, self.certfile) |
R. David Murray | 87e2074 | 2009-05-23 01:30:26 +0000 | [diff] [blame] | 881 | return new_socket |
Thomas Wouters | 47b49bf | 2007-08-30 22:15:33 +0000 | [diff] [blame] | 882 | |
| 883 | __all__.append("SMTP_SSL") |
Barry Warsaw | 4c4bec8 | 1998-12-22 03:02:20 +0000 | [diff] [blame] | 884 | |
Guido van Rossum | d8faa36 | 2007-04-27 19:54:29 +0000 | [diff] [blame] | 885 | # |
| 886 | # LMTP extension |
| 887 | # |
| 888 | LMTP_PORT = 2003 |
| 889 | |
| 890 | class LMTP(SMTP): |
| 891 | """LMTP - Local Mail Transfer Protocol |
| 892 | |
| 893 | The LMTP protocol, which is very similar to ESMTP, is heavily based |
| 894 | on the standard SMTP client. It's common to use Unix sockets for LMTP, |
| 895 | so our connect() method must support that as well as a regular |
| 896 | host:port server. To specify a Unix socket, you must use an absolute |
| 897 | path as the host, starting with a '/'. |
| 898 | |
| 899 | Authentication is supported, using the regular SMTP mechanism. When |
| 900 | using a Unix socket, LMTP generally don't support or require any |
| 901 | authentication, but your mileage might vary.""" |
| 902 | |
| 903 | ehlo_msg = "lhlo" |
| 904 | |
Senthil Kumaran | 3d23fd6 | 2011-07-30 10:56:50 +0800 | [diff] [blame] | 905 | def __init__(self, host='', port=LMTP_PORT, local_hostname=None, |
| 906 | source_address=None): |
Guido van Rossum | d8faa36 | 2007-04-27 19:54:29 +0000 | [diff] [blame] | 907 | """Initialize a new instance.""" |
Senthil Kumaran | b351a48 | 2011-07-31 09:14:17 +0800 | [diff] [blame] | 908 | SMTP.__init__(self, host, port, local_hostname=local_hostname, |
| 909 | source_address=source_address) |
Guido van Rossum | d8faa36 | 2007-04-27 19:54:29 +0000 | [diff] [blame] | 910 | |
Senthil Kumaran | 3d23fd6 | 2011-07-30 10:56:50 +0800 | [diff] [blame] | 911 | def connect(self, host='localhost', port=0, source_address=None): |
Guido van Rossum | d8faa36 | 2007-04-27 19:54:29 +0000 | [diff] [blame] | 912 | """Connect to the LMTP daemon, on either a Unix or a TCP socket.""" |
| 913 | if host[0] != '/': |
Senthil Kumaran | b351a48 | 2011-07-31 09:14:17 +0800 | [diff] [blame] | 914 | return SMTP.connect(self, host, port, source_address=source_address) |
Guido van Rossum | d8faa36 | 2007-04-27 19:54:29 +0000 | [diff] [blame] | 915 | |
| 916 | # Handle Unix-domain sockets. |
| 917 | try: |
| 918 | self.sock = socket.socket(socket.AF_UNIX, socket.SOCK_STREAM) |
Antoine Pitrou | f068ab8 | 2011-06-06 19:17:09 +0200 | [diff] [blame] | 919 | self.file = None |
Guido van Rossum | d8faa36 | 2007-04-27 19:54:29 +0000 | [diff] [blame] | 920 | self.sock.connect(host) |
| 921 | except socket.error as msg: |
Giampaolo Rodolà | bd258bd | 2011-02-22 15:56:20 +0000 | [diff] [blame] | 922 | if self.debuglevel > 0: |
| 923 | print('connect fail:', host, file=stderr) |
Guido van Rossum | d8faa36 | 2007-04-27 19:54:29 +0000 | [diff] [blame] | 924 | if self.sock: |
| 925 | self.sock.close() |
| 926 | self.sock = None |
| 927 | raise socket.error(msg) |
| 928 | (code, msg) = self.getreply() |
Giampaolo Rodolà | bd258bd | 2011-02-22 15:56:20 +0000 | [diff] [blame] | 929 | if self.debuglevel > 0: |
| 930 | print('connect:', msg, file=stderr) |
Guido van Rossum | d8faa36 | 2007-04-27 19:54:29 +0000 | [diff] [blame] | 931 | return (code, msg) |
| 932 | |
| 933 | |
Guido van Rossum | 95e6f70 | 1998-06-25 02:15:50 +0000 | [diff] [blame] | 934 | # Test the sendmail method, which tests most of the others. |
| 935 | # Note: This always sends to localhost. |
| 936 | if __name__ == '__main__': |
Andrew M. Kuchling | 6be424f | 2001-08-13 14:41:39 +0000 | [diff] [blame] | 937 | import sys |
Guido van Rossum | 95e6f70 | 1998-06-25 02:15:50 +0000 | [diff] [blame] | 938 | |
| 939 | def prompt(prompt): |
| 940 | sys.stdout.write(prompt + ": ") |
Eric S. Raymond | c013f30 | 2001-02-09 05:40:38 +0000 | [diff] [blame] | 941 | return sys.stdin.readline().strip() |
Guido van Rossum | 95e6f70 | 1998-06-25 02:15:50 +0000 | [diff] [blame] | 942 | |
| 943 | fromaddr = prompt("From") |
Giampaolo Rodolà | bd258bd | 2011-02-22 15:56:20 +0000 | [diff] [blame] | 944 | toaddrs = prompt("To").split(',') |
Guido van Rossum | be19ed7 | 2007-02-09 05:37:30 +0000 | [diff] [blame] | 945 | print("Enter message, end with ^D:") |
Guido van Rossum | 95e6f70 | 1998-06-25 02:15:50 +0000 | [diff] [blame] | 946 | msg = '' |
| 947 | while 1: |
| 948 | line = sys.stdin.readline() |
| 949 | if not line: |
| 950 | break |
| 951 | msg = msg + line |
Guido van Rossum | be19ed7 | 2007-02-09 05:37:30 +0000 | [diff] [blame] | 952 | print("Message length is %d" % len(msg)) |
Guido van Rossum | 95e6f70 | 1998-06-25 02:15:50 +0000 | [diff] [blame] | 953 | |
| 954 | server = SMTP('localhost') |
| 955 | server.set_debuglevel(1) |
| 956 | server.sendmail(fromaddr, toaddrs, msg) |
| 957 | server.quit() |