Barry Warsaw | 4c4bec8 | 1998-12-22 03:02:20 +0000 | [diff] [blame] | 1 | #! /usr/bin/env python |
| 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") |
| 18 | >>> print s.help() |
| 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 |
Barry Warsaw | 0720177 | 1998-12-22 20:37:36 +0000 | [diff] [blame] | 45 | import re |
Johannes Gijsbers | 9a98364 | 2005-01-08 14:12:27 +0000 | [diff] [blame] | 46 | import email.Utils |
Guido van Rossum | ae01046 | 2001-09-11 15:57:46 +0000 | [diff] [blame] | 47 | import base64 |
| 48 | import hmac |
Piers Lauder | 385a77a | 2002-07-27 00:38:30 +0000 | [diff] [blame] | 49 | from email.base64MIME import encode as encode_base64 |
Brett Cannon | e6f8a89 | 2004-07-10 23:14:30 +0000 | [diff] [blame] | 50 | from sys import stderr |
Guido van Rossum | bbe323e | 1998-01-29 17:24:40 +0000 | [diff] [blame] | 51 | |
Skip Montanaro | 0de6580 | 2001-02-15 22:15:14 +0000 | [diff] [blame] | 52 | __all__ = ["SMTPException","SMTPServerDisconnected","SMTPResponseException", |
| 53 | "SMTPSenderRefused","SMTPRecipientsRefused","SMTPDataError", |
Guido van Rossum | ae01046 | 2001-09-11 15:57:46 +0000 | [diff] [blame] | 54 | "SMTPConnectError","SMTPHeloError","SMTPAuthenticationError", |
| 55 | "quoteaddr","quotedata","SMTP"] |
Skip Montanaro | 0de6580 | 2001-02-15 22:15:14 +0000 | [diff] [blame] | 56 | |
Guido van Rossum | bbe323e | 1998-01-29 17:24:40 +0000 | [diff] [blame] | 57 | SMTP_PORT = 25 |
| 58 | CRLF="\r\n" |
| 59 | |
Piers Lauder | 385a77a | 2002-07-27 00:38:30 +0000 | [diff] [blame] | 60 | OLDSTYLE_AUTH = re.compile(r"auth=(.*)", re.I) |
| 61 | |
Tim Peters | 495ad3c | 2001-01-15 01:36:40 +0000 | [diff] [blame] | 62 | # Exception classes used by this module. |
Guido van Rossum | 296e143 | 1999-04-07 15:03:39 +0000 | [diff] [blame] | 63 | class SMTPException(Exception): |
| 64 | """Base class for all exceptions raised by this module.""" |
| 65 | |
| 66 | class SMTPServerDisconnected(SMTPException): |
| 67 | """Not connected to any SMTP server. |
| 68 | |
| 69 | This exception is raised when the server unexpectedly disconnects, |
| 70 | or when an attempt is made to use the SMTP instance before |
| 71 | connecting it to a server. |
| 72 | """ |
| 73 | |
| 74 | class SMTPResponseException(SMTPException): |
| 75 | """Base class for all exceptions that include an SMTP error code. |
| 76 | |
| 77 | These exceptions are generated in some instances when the SMTP |
| 78 | server returns an error code. The error code is stored in the |
| 79 | `smtp_code' attribute of the error, and the `smtp_error' attribute |
| 80 | is set to the error message. |
| 81 | """ |
| 82 | |
| 83 | def __init__(self, code, msg): |
| 84 | self.smtp_code = code |
| 85 | self.smtp_error = msg |
| 86 | self.args = (code, msg) |
| 87 | |
| 88 | class SMTPSenderRefused(SMTPResponseException): |
| 89 | """Sender address refused. |
Guido van Rossum | ae01046 | 2001-09-11 15:57:46 +0000 | [diff] [blame] | 90 | |
Guido van Rossum | 296e143 | 1999-04-07 15:03:39 +0000 | [diff] [blame] | 91 | In addition to the attributes set by on all SMTPResponseException |
Barry Warsaw | d25c1b7 | 1999-11-28 17:11:06 +0000 | [diff] [blame] | 92 | exceptions, this sets `sender' to the string that the SMTP refused. |
Guido van Rossum | 296e143 | 1999-04-07 15:03:39 +0000 | [diff] [blame] | 93 | """ |
| 94 | |
| 95 | def __init__(self, code, msg, sender): |
| 96 | self.smtp_code = code |
| 97 | self.smtp_error = msg |
| 98 | self.sender = sender |
| 99 | self.args = (code, msg, sender) |
| 100 | |
Guido van Rossum | 20c9228 | 1999-04-21 16:52:20 +0000 | [diff] [blame] | 101 | class SMTPRecipientsRefused(SMTPException): |
Barry Warsaw | d25c1b7 | 1999-11-28 17:11:06 +0000 | [diff] [blame] | 102 | """All recipient addresses refused. |
Guido van Rossum | ae01046 | 2001-09-11 15:57:46 +0000 | [diff] [blame] | 103 | |
Thomas Wouters | 7e47402 | 2000-07-16 12:04:32 +0000 | [diff] [blame] | 104 | The errors for each recipient are accessible through the attribute |
Tim Peters | 495ad3c | 2001-01-15 01:36:40 +0000 | [diff] [blame] | 105 | 'recipients', which is a dictionary of exactly the same sort as |
| 106 | SMTP.sendmail() returns. |
Guido van Rossum | 296e143 | 1999-04-07 15:03:39 +0000 | [diff] [blame] | 107 | """ |
| 108 | |
| 109 | def __init__(self, recipients): |
| 110 | self.recipients = recipients |
| 111 | self.args = ( recipients,) |
| 112 | |
| 113 | |
Guido van Rossum | 296e143 | 1999-04-07 15:03:39 +0000 | [diff] [blame] | 114 | class SMTPDataError(SMTPResponseException): |
| 115 | """The SMTP server didn't accept the data.""" |
| 116 | |
| 117 | class SMTPConnectError(SMTPResponseException): |
Barry Warsaw | d25c1b7 | 1999-11-28 17:11:06 +0000 | [diff] [blame] | 118 | """Error during connection establishment.""" |
Guido van Rossum | 296e143 | 1999-04-07 15:03:39 +0000 | [diff] [blame] | 119 | |
| 120 | class SMTPHeloError(SMTPResponseException): |
Barry Warsaw | d25c1b7 | 1999-11-28 17:11:06 +0000 | [diff] [blame] | 121 | """The server refused our HELO reply.""" |
Guido van Rossum | bbe323e | 1998-01-29 17:24:40 +0000 | [diff] [blame] | 122 | |
Guido van Rossum | ae01046 | 2001-09-11 15:57:46 +0000 | [diff] [blame] | 123 | class SMTPAuthenticationError(SMTPResponseException): |
| 124 | """Authentication error. |
| 125 | |
| 126 | Most probably the server didn't accept the username/password |
| 127 | combination provided. |
| 128 | """ |
Peter Schneider-Kamp | 7bc82bb | 2000-08-10 14:02:23 +0000 | [diff] [blame] | 129 | |
Guido van Rossum | f7fcf5e | 2001-09-14 16:08:44 +0000 | [diff] [blame] | 130 | class SSLFakeSocket: |
| 131 | """A fake socket object that really wraps a SSLObject. |
Tim Peters | b64bec3 | 2001-09-18 02:26:39 +0000 | [diff] [blame] | 132 | |
Guido van Rossum | f7fcf5e | 2001-09-14 16:08:44 +0000 | [diff] [blame] | 133 | It only supports what is needed in smtplib. |
| 134 | """ |
| 135 | def __init__(self, realsock, sslobj): |
| 136 | self.realsock = realsock |
| 137 | self.sslobj = sslobj |
| 138 | |
| 139 | def send(self, str): |
| 140 | self.sslobj.write(str) |
| 141 | return len(str) |
| 142 | |
Martin v. Löwis | 9ea6c19 | 2002-06-02 12:33:22 +0000 | [diff] [blame] | 143 | sendall = send |
| 144 | |
Guido van Rossum | f7fcf5e | 2001-09-14 16:08:44 +0000 | [diff] [blame] | 145 | def close(self): |
| 146 | self.realsock.close() |
| 147 | |
| 148 | class SSLFakeFile: |
| 149 | """A fake file like object that really wraps a SSLObject. |
Tim Peters | b64bec3 | 2001-09-18 02:26:39 +0000 | [diff] [blame] | 150 | |
Guido van Rossum | f7fcf5e | 2001-09-14 16:08:44 +0000 | [diff] [blame] | 151 | It only supports what is needed in smtplib. |
| 152 | """ |
| 153 | def __init__( self, sslobj): |
| 154 | self.sslobj = sslobj |
| 155 | |
| 156 | def readline(self): |
| 157 | str = "" |
| 158 | chr = None |
| 159 | while chr != "\n": |
| 160 | chr = self.sslobj.read(1) |
| 161 | str += chr |
| 162 | return str |
| 163 | |
| 164 | def close(self): |
| 165 | pass |
| 166 | |
Guido van Rossum | 69a79bc | 1998-07-13 15:18:49 +0000 | [diff] [blame] | 167 | def quoteaddr(addr): |
| 168 | """Quote a subset of the email addresses defined by RFC 821. |
| 169 | |
Barry Warsaw | a7d9bdf | 1998-12-22 03:24:27 +0000 | [diff] [blame] | 170 | Should be able to handle anything rfc822.parseaddr can handle. |
| 171 | """ |
Raymond Hettinger | 342456d | 2002-09-05 01:14:07 +0000 | [diff] [blame] | 172 | m = (None, None) |
Guido van Rossum | 69a79bc | 1998-07-13 15:18:49 +0000 | [diff] [blame] | 173 | try: |
Johannes Gijsbers | 9a98364 | 2005-01-08 14:12:27 +0000 | [diff] [blame] | 174 | m = email.Utils.parseaddr(addr)[1] |
Guido van Rossum | fcfb632 | 1998-08-04 15:29:54 +0000 | [diff] [blame] | 175 | except AttributeError: |
| 176 | pass |
Raymond Hettinger | 342456d | 2002-09-05 01:14:07 +0000 | [diff] [blame] | 177 | if m == (None, None): # Indicates parse failure or AttributeError |
Guido van Rossum | fcfb632 | 1998-08-04 15:29:54 +0000 | [diff] [blame] | 178 | #something weird here.. punt -ddm |
Raymond Hettinger | 342456d | 2002-09-05 01:14:07 +0000 | [diff] [blame] | 179 | return "<%s>" % addr |
Guido van Rossum | fcfb632 | 1998-08-04 15:29:54 +0000 | [diff] [blame] | 180 | else: |
| 181 | return "<%s>" % m |
Guido van Rossum | 69a79bc | 1998-07-13 15:18:49 +0000 | [diff] [blame] | 182 | |
| 183 | def quotedata(data): |
| 184 | """Quote data for email. |
| 185 | |
Barry Warsaw | d25c1b7 | 1999-11-28 17:11:06 +0000 | [diff] [blame] | 186 | Double leading '.', and change Unix newline '\\n', or Mac '\\r' into |
Barry Warsaw | a7d9bdf | 1998-12-22 03:24:27 +0000 | [diff] [blame] | 187 | Internet CRLF end-of-line. |
| 188 | """ |
Guido van Rossum | 69a79bc | 1998-07-13 15:18:49 +0000 | [diff] [blame] | 189 | return re.sub(r'(?m)^\.', '..', |
Guido van Rossum | fcfb632 | 1998-08-04 15:29:54 +0000 | [diff] [blame] | 190 | re.sub(r'(?:\r\n|\n|\r(?!\n))', CRLF, data)) |
Guido van Rossum | 69a79bc | 1998-07-13 15:18:49 +0000 | [diff] [blame] | 191 | |
Peter Schneider-Kamp | 7bc82bb | 2000-08-10 14:02:23 +0000 | [diff] [blame] | 192 | |
Guido van Rossum | bbe323e | 1998-01-29 17:24:40 +0000 | [diff] [blame] | 193 | class SMTP: |
Guido van Rossum | fcfb632 | 1998-08-04 15:29:54 +0000 | [diff] [blame] | 194 | """This class manages a connection to an SMTP or ESMTP server. |
| 195 | SMTP Objects: |
Tim Peters | 495ad3c | 2001-01-15 01:36:40 +0000 | [diff] [blame] | 196 | SMTP objects have the following attributes: |
| 197 | helo_resp |
| 198 | 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] | 199 | most recent HELO command. |
Tim Peters | 495ad3c | 2001-01-15 01:36:40 +0000 | [diff] [blame] | 200 | |
Guido van Rossum | fcfb632 | 1998-08-04 15:29:54 +0000 | [diff] [blame] | 201 | ehlo_resp |
Tim Peters | 495ad3c | 2001-01-15 01:36:40 +0000 | [diff] [blame] | 202 | 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] | 203 | most recent EHLO command. This is usually multiline. |
| 204 | |
Tim Peters | 495ad3c | 2001-01-15 01:36:40 +0000 | [diff] [blame] | 205 | does_esmtp |
Guido van Rossum | fcfb632 | 1998-08-04 15:29:54 +0000 | [diff] [blame] | 206 | This is a True value _after you do an EHLO command_, if the |
| 207 | server supports ESMTP. |
| 208 | |
Tim Peters | 495ad3c | 2001-01-15 01:36:40 +0000 | [diff] [blame] | 209 | esmtp_features |
Guido van Rossum | fcfb632 | 1998-08-04 15:29:54 +0000 | [diff] [blame] | 210 | This is a dictionary, which, if the server supports ESMTP, |
Barry Warsaw | d25c1b7 | 1999-11-28 17:11:06 +0000 | [diff] [blame] | 211 | will _after you do an EHLO command_, contain the names of the |
| 212 | SMTP service extensions this server supports, and their |
Guido van Rossum | fcfb632 | 1998-08-04 15:29:54 +0000 | [diff] [blame] | 213 | parameters (if any). |
Barry Warsaw | d25c1b7 | 1999-11-28 17:11:06 +0000 | [diff] [blame] | 214 | |
Tim Peters | 495ad3c | 2001-01-15 01:36:40 +0000 | [diff] [blame] | 215 | Note, all extension names are mapped to lower case in the |
| 216 | dictionary. |
Guido van Rossum | fcfb632 | 1998-08-04 15:29:54 +0000 | [diff] [blame] | 217 | |
Barry Warsaw | d25c1b7 | 1999-11-28 17:11:06 +0000 | [diff] [blame] | 218 | See each method's docstrings for details. In general, there is a |
| 219 | method of the same name to perform each SMTP command. There is also a |
| 220 | method called 'sendmail' that will do an entire mail transaction. |
| 221 | """ |
Guido van Rossum | 95e6f70 | 1998-06-25 02:15:50 +0000 | [diff] [blame] | 222 | debuglevel = 0 |
| 223 | file = None |
| 224 | helo_resp = None |
| 225 | ehlo_resp = None |
Guido van Rossum | fcfb632 | 1998-08-04 15:29:54 +0000 | [diff] [blame] | 226 | does_esmtp = 0 |
Guido van Rossum | 95e6f70 | 1998-06-25 02:15:50 +0000 | [diff] [blame] | 227 | |
Neil Schemenauer | 6730f26 | 2002-03-24 15:30:40 +0000 | [diff] [blame] | 228 | def __init__(self, host = '', port = 0, local_hostname = None): |
Guido van Rossum | bbe323e | 1998-01-29 17:24:40 +0000 | [diff] [blame] | 229 | """Initialize a new instance. |
| 230 | |
Barry Warsaw | a7d9bdf | 1998-12-22 03:24:27 +0000 | [diff] [blame] | 231 | If specified, `host' is the name of the remote host to which to |
| 232 | connect. If specified, `port' specifies the port to which to connect. |
Barry Warsaw | d25c1b7 | 1999-11-28 17:11:06 +0000 | [diff] [blame] | 233 | By default, smtplib.SMTP_PORT is used. An SMTPConnectError is raised |
Neil Schemenauer | 6730f26 | 2002-03-24 15:30:40 +0000 | [diff] [blame] | 234 | if the specified `host' doesn't respond correctly. If specified, |
Tim Peters | 863ac44 | 2002-04-16 01:38:40 +0000 | [diff] [blame] | 235 | `local_hostname` is used as the FQDN of the local host. By default, |
| 236 | the local hostname is found using socket.getfqdn(). |
Guido van Rossum | bbe323e | 1998-01-29 17:24:40 +0000 | [diff] [blame] | 237 | |
| 238 | """ |
Guido van Rossum | fcfb632 | 1998-08-04 15:29:54 +0000 | [diff] [blame] | 239 | self.esmtp_features = {} |
Guido van Rossum | 296e143 | 1999-04-07 15:03:39 +0000 | [diff] [blame] | 240 | if host: |
| 241 | (code, msg) = self.connect(host, port) |
| 242 | if code != 220: |
| 243 | raise SMTPConnectError(code, msg) |
Raymond Hettinger | f13eb55 | 2002-06-02 00:40:05 +0000 | [diff] [blame] | 244 | if local_hostname is not None: |
Barry Warsaw | 13e34f7 | 2002-03-26 20:27:35 +0000 | [diff] [blame] | 245 | self.local_hostname = local_hostname |
Neil Schemenauer | 6730f26 | 2002-03-24 15:30:40 +0000 | [diff] [blame] | 246 | else: |
Barry Warsaw | 13e34f7 | 2002-03-26 20:27:35 +0000 | [diff] [blame] | 247 | # RFC 2821 says we should use the fqdn in the EHLO/HELO verb, and |
| 248 | # if that can't be calculated, that we should use a domain literal |
| 249 | # instead (essentially an encoded IP address like [A.B.C.D]). |
| 250 | fqdn = socket.getfqdn() |
| 251 | if '.' in fqdn: |
| 252 | self.local_hostname = fqdn |
| 253 | else: |
| 254 | # We can't find an fqdn hostname, so use a domain literal |
| 255 | addr = socket.gethostbyname(socket.gethostname()) |
| 256 | self.local_hostname = '[%s]' % addr |
Tim Peters | 495ad3c | 2001-01-15 01:36:40 +0000 | [diff] [blame] | 257 | |
Guido van Rossum | bbe323e | 1998-01-29 17:24:40 +0000 | [diff] [blame] | 258 | def set_debuglevel(self, debuglevel): |
| 259 | """Set the debug output level. |
| 260 | |
Barry Warsaw | a7d9bdf | 1998-12-22 03:24:27 +0000 | [diff] [blame] | 261 | A non-false value results in debug messages for connection and for all |
| 262 | messages sent to and received from the server. |
Guido van Rossum | bbe323e | 1998-01-29 17:24:40 +0000 | [diff] [blame] | 263 | |
| 264 | """ |
| 265 | self.debuglevel = debuglevel |
| 266 | |
| 267 | def connect(self, host='localhost', port = 0): |
| 268 | """Connect to a host on a given port. |
Guido van Rossum | 95e6f70 | 1998-06-25 02:15:50 +0000 | [diff] [blame] | 269 | |
Barry Warsaw | 4c4bec8 | 1998-12-22 03:02:20 +0000 | [diff] [blame] | 270 | If the hostname ends with a colon (`:') followed by a number, and |
| 271 | there is no port specified, that suffix will be stripped off and the |
| 272 | number interpreted as the port number to use. |
Guido van Rossum | 95e6f70 | 1998-06-25 02:15:50 +0000 | [diff] [blame] | 273 | |
Barry Warsaw | a7d9bdf | 1998-12-22 03:24:27 +0000 | [diff] [blame] | 274 | Note: This method is automatically invoked by __init__, if a host is |
| 275 | specified during instantiation. |
Guido van Rossum | bbe323e | 1998-01-29 17:24:40 +0000 | [diff] [blame] | 276 | |
| 277 | """ |
Martin v. Löwis | 4eb5940 | 2001-07-26 13:37:33 +0000 | [diff] [blame] | 278 | if not port and (host.find(':') == host.rfind(':')): |
Martin v. Löwis | a43c2f8 | 2001-07-24 20:34:08 +0000 | [diff] [blame] | 279 | i = host.rfind(':') |
Guido van Rossum | bbe323e | 1998-01-29 17:24:40 +0000 | [diff] [blame] | 280 | if i >= 0: |
| 281 | host, port = host[:i], host[i+1:] |
Eric S. Raymond | c013f30 | 2001-02-09 05:40:38 +0000 | [diff] [blame] | 282 | try: port = int(port) |
Eric S. Raymond | 8d87603 | 2001-02-09 10:14:53 +0000 | [diff] [blame] | 283 | except ValueError: |
Guido van Rossum | bbe323e | 1998-01-29 17:24:40 +0000 | [diff] [blame] | 284 | raise socket.error, "nonnumeric port" |
| 285 | if not port: port = SMTP_PORT |
Brett Cannon | e6f8a89 | 2004-07-10 23:14:30 +0000 | [diff] [blame] | 286 | if self.debuglevel > 0: print>>stderr, 'connect:', (host, port) |
Martin v. Löwis | 2ad2569 | 2001-07-31 08:40:21 +0000 | [diff] [blame] | 287 | msg = "getaddrinfo returns an empty list" |
Martin v. Löwis | 322c0d1 | 2001-10-07 08:53:32 +0000 | [diff] [blame] | 288 | self.sock = None |
Martin v. Löwis | 4eb5940 | 2001-07-26 13:37:33 +0000 | [diff] [blame] | 289 | for res in socket.getaddrinfo(host, port, 0, socket.SOCK_STREAM): |
| 290 | af, socktype, proto, canonname, sa = res |
| 291 | try: |
| 292 | self.sock = socket.socket(af, socktype, proto) |
Johannes Gijsbers | 5954623 | 2005-01-16 13:04:30 +0000 | [diff] [blame^] | 293 | if self.debuglevel > 0: print>>stderr, 'connect:', sa |
Martin v. Löwis | 4eb5940 | 2001-07-26 13:37:33 +0000 | [diff] [blame] | 294 | self.sock.connect(sa) |
| 295 | except socket.error, msg: |
Johannes Gijsbers | 5954623 | 2005-01-16 13:04:30 +0000 | [diff] [blame^] | 296 | if self.debuglevel > 0: print>>stderr, 'connect fail:', msg |
Martin v. Löwis | 322c0d1 | 2001-10-07 08:53:32 +0000 | [diff] [blame] | 297 | if self.sock: |
| 298 | self.sock.close() |
Martin v. Löwis | 4eb5940 | 2001-07-26 13:37:33 +0000 | [diff] [blame] | 299 | self.sock = None |
| 300 | continue |
| 301 | break |
| 302 | if not self.sock: |
| 303 | raise socket.error, msg |
Martin v. Löwis | a43c2f8 | 2001-07-24 20:34:08 +0000 | [diff] [blame] | 304 | (code, msg) = self.getreply() |
Brett Cannon | e6f8a89 | 2004-07-10 23:14:30 +0000 | [diff] [blame] | 305 | if self.debuglevel > 0: print>>stderr, "connect:", msg |
Martin v. Löwis | a43c2f8 | 2001-07-24 20:34:08 +0000 | [diff] [blame] | 306 | return (code, msg) |
Tim Peters | 495ad3c | 2001-01-15 01:36:40 +0000 | [diff] [blame] | 307 | |
Guido van Rossum | bbe323e | 1998-01-29 17:24:40 +0000 | [diff] [blame] | 308 | def send(self, str): |
| 309 | """Send `str' to the server.""" |
Brett Cannon | e6f8a89 | 2004-07-10 23:14:30 +0000 | [diff] [blame] | 310 | if self.debuglevel > 0: print>>stderr, 'send:', repr(str) |
Guido van Rossum | 45e2fbc | 1998-03-26 21:13:24 +0000 | [diff] [blame] | 311 | if self.sock: |
Guido van Rossum | 2880f6e | 1998-08-10 20:07:00 +0000 | [diff] [blame] | 312 | try: |
Martin v. Löwis | e12454f | 2002-02-16 23:06:19 +0000 | [diff] [blame] | 313 | self.sock.sendall(str) |
Guido van Rossum | 2880f6e | 1998-08-10 20:07:00 +0000 | [diff] [blame] | 314 | except socket.error: |
Barry Warsaw | 7675097 | 2001-12-14 20:34:20 +0000 | [diff] [blame] | 315 | self.close() |
Guido van Rossum | 40233ea | 1999-01-15 03:23:55 +0000 | [diff] [blame] | 316 | raise SMTPServerDisconnected('Server not connected') |
Guido van Rossum | fc40a83 | 1998-01-29 17:26:45 +0000 | [diff] [blame] | 317 | else: |
Guido van Rossum | 40233ea | 1999-01-15 03:23:55 +0000 | [diff] [blame] | 318 | raise SMTPServerDisconnected('please run connect() first') |
Tim Peters | 495ad3c | 2001-01-15 01:36:40 +0000 | [diff] [blame] | 319 | |
Guido van Rossum | bbe323e | 1998-01-29 17:24:40 +0000 | [diff] [blame] | 320 | def putcmd(self, cmd, args=""): |
Barry Warsaw | a7d9bdf | 1998-12-22 03:24:27 +0000 | [diff] [blame] | 321 | """Send a command to the server.""" |
Guido van Rossum | db23d3d | 1999-06-09 15:13:10 +0000 | [diff] [blame] | 322 | if args == "": |
| 323 | str = '%s%s' % (cmd, CRLF) |
| 324 | else: |
| 325 | str = '%s %s%s' % (cmd, args, CRLF) |
Guido van Rossum | bbe323e | 1998-01-29 17:24:40 +0000 | [diff] [blame] | 326 | self.send(str) |
Tim Peters | 495ad3c | 2001-01-15 01:36:40 +0000 | [diff] [blame] | 327 | |
Guido van Rossum | fcfb632 | 1998-08-04 15:29:54 +0000 | [diff] [blame] | 328 | def getreply(self): |
Guido van Rossum | bbe323e | 1998-01-29 17:24:40 +0000 | [diff] [blame] | 329 | """Get a reply from the server. |
Tim Peters | 495ad3c | 2001-01-15 01:36:40 +0000 | [diff] [blame] | 330 | |
Guido van Rossum | bbe323e | 1998-01-29 17:24:40 +0000 | [diff] [blame] | 331 | Returns a tuple consisting of: |
Barry Warsaw | a7d9bdf | 1998-12-22 03:24:27 +0000 | [diff] [blame] | 332 | |
| 333 | - server response code (e.g. '250', or such, if all goes well) |
| 334 | Note: returns -1 if it can't read response code. |
| 335 | |
| 336 | - server response string corresponding to response code (multiline |
| 337 | responses are converted to a single, multiline string). |
Guido van Rossum | f123f84 | 1999-03-29 20:33:21 +0000 | [diff] [blame] | 338 | |
| 339 | Raises SMTPServerDisconnected if end-of-file is reached. |
Guido van Rossum | bbe323e | 1998-01-29 17:24:40 +0000 | [diff] [blame] | 340 | """ |
| 341 | resp=[] |
Guido van Rossum | 296e143 | 1999-04-07 15:03:39 +0000 | [diff] [blame] | 342 | if self.file is None: |
| 343 | self.file = self.sock.makefile('rb') |
Guido van Rossum | 45e2fbc | 1998-03-26 21:13:24 +0000 | [diff] [blame] | 344 | while 1: |
Guido van Rossum | bbe323e | 1998-01-29 17:24:40 +0000 | [diff] [blame] | 345 | line = self.file.readline() |
Guido van Rossum | 296e143 | 1999-04-07 15:03:39 +0000 | [diff] [blame] | 346 | if line == '': |
| 347 | self.close() |
| 348 | raise SMTPServerDisconnected("Connection unexpectedly closed") |
Brett Cannon | e6f8a89 | 2004-07-10 23:14:30 +0000 | [diff] [blame] | 349 | if self.debuglevel > 0: print>>stderr, 'reply:', repr(line) |
Eric S. Raymond | c013f30 | 2001-02-09 05:40:38 +0000 | [diff] [blame] | 350 | resp.append(line[4:].strip()) |
Guido van Rossum | 45e2fbc | 1998-03-26 21:13:24 +0000 | [diff] [blame] | 351 | code=line[:3] |
Guido van Rossum | 296e143 | 1999-04-07 15:03:39 +0000 | [diff] [blame] | 352 | # Check that the error code is syntactically correct. |
| 353 | # Don't attempt to read a continuation line if it is broken. |
| 354 | try: |
Eric S. Raymond | c013f30 | 2001-02-09 05:40:38 +0000 | [diff] [blame] | 355 | errcode = int(code) |
Guido van Rossum | 296e143 | 1999-04-07 15:03:39 +0000 | [diff] [blame] | 356 | except ValueError: |
| 357 | errcode = -1 |
| 358 | break |
Guido van Rossum | f123f84 | 1999-03-29 20:33:21 +0000 | [diff] [blame] | 359 | # Check if multiline response. |
Guido van Rossum | 45e2fbc | 1998-03-26 21:13:24 +0000 | [diff] [blame] | 360 | if line[3:4]!="-": |
Guido van Rossum | bbe323e | 1998-01-29 17:24:40 +0000 | [diff] [blame] | 361 | break |
Guido van Rossum | bbe323e | 1998-01-29 17:24:40 +0000 | [diff] [blame] | 362 | |
Eric S. Raymond | c013f30 | 2001-02-09 05:40:38 +0000 | [diff] [blame] | 363 | errmsg = "\n".join(resp) |
Tim Peters | 495ad3c | 2001-01-15 01:36:40 +0000 | [diff] [blame] | 364 | if self.debuglevel > 0: |
Brett Cannon | e6f8a89 | 2004-07-10 23:14:30 +0000 | [diff] [blame] | 365 | print>>stderr, 'reply: retcode (%s); Msg: %s' % (errcode,errmsg) |
Guido van Rossum | bbe323e | 1998-01-29 17:24:40 +0000 | [diff] [blame] | 366 | return errcode, errmsg |
Tim Peters | 495ad3c | 2001-01-15 01:36:40 +0000 | [diff] [blame] | 367 | |
Guido van Rossum | bbe323e | 1998-01-29 17:24:40 +0000 | [diff] [blame] | 368 | def docmd(self, cmd, args=""): |
Barry Warsaw | a7d9bdf | 1998-12-22 03:24:27 +0000 | [diff] [blame] | 369 | """Send a command, and return its response code.""" |
Guido van Rossum | 45e2fbc | 1998-03-26 21:13:24 +0000 | [diff] [blame] | 370 | self.putcmd(cmd,args) |
Guido van Rossum | 296e143 | 1999-04-07 15:03:39 +0000 | [diff] [blame] | 371 | return self.getreply() |
Guido van Rossum | bbe323e | 1998-01-29 17:24:40 +0000 | [diff] [blame] | 372 | |
Barry Warsaw | a7d9bdf | 1998-12-22 03:24:27 +0000 | [diff] [blame] | 373 | # std smtp commands |
Guido van Rossum | bbe323e | 1998-01-29 17:24:40 +0000 | [diff] [blame] | 374 | def helo(self, name=''): |
Barry Warsaw | a7d9bdf | 1998-12-22 03:24:27 +0000 | [diff] [blame] | 375 | """SMTP 'helo' command. |
| 376 | Hostname to send for this command defaults to the FQDN of the local |
| 377 | host. |
| 378 | """ |
Neil Schemenauer | 6730f26 | 2002-03-24 15:30:40 +0000 | [diff] [blame] | 379 | self.putcmd("helo", name or self.local_hostname) |
Guido van Rossum | 45e2fbc | 1998-03-26 21:13:24 +0000 | [diff] [blame] | 380 | (code,msg)=self.getreply() |
| 381 | self.helo_resp=msg |
Guido van Rossum | 296e143 | 1999-04-07 15:03:39 +0000 | [diff] [blame] | 382 | return (code,msg) |
Guido van Rossum | bbe323e | 1998-01-29 17:24:40 +0000 | [diff] [blame] | 383 | |
Guido van Rossum | 95e6f70 | 1998-06-25 02:15:50 +0000 | [diff] [blame] | 384 | def ehlo(self, name=''): |
Barry Warsaw | a7d9bdf | 1998-12-22 03:24:27 +0000 | [diff] [blame] | 385 | """ SMTP 'ehlo' command. |
| 386 | Hostname to send for this command defaults to the FQDN of the local |
| 387 | host. |
| 388 | """ |
Guido van Rossum | f7fcf5e | 2001-09-14 16:08:44 +0000 | [diff] [blame] | 389 | self.esmtp_features = {} |
Neil Schemenauer | 6730f26 | 2002-03-24 15:30:40 +0000 | [diff] [blame] | 390 | self.putcmd("ehlo", name or self.local_hostname) |
Guido van Rossum | fcfb632 | 1998-08-04 15:29:54 +0000 | [diff] [blame] | 391 | (code,msg)=self.getreply() |
Tim Peters | 495ad3c | 2001-01-15 01:36:40 +0000 | [diff] [blame] | 392 | # According to RFC1869 some (badly written) |
| 393 | # MTA's will disconnect on an ehlo. Toss an exception if |
Guido van Rossum | fcfb632 | 1998-08-04 15:29:54 +0000 | [diff] [blame] | 394 | # that happens -ddm |
| 395 | if code == -1 and len(msg) == 0: |
Barry Warsaw | 7675097 | 2001-12-14 20:34:20 +0000 | [diff] [blame] | 396 | self.close() |
Guido van Rossum | 40233ea | 1999-01-15 03:23:55 +0000 | [diff] [blame] | 397 | raise SMTPServerDisconnected("Server not connected") |
Guido van Rossum | 95e6f70 | 1998-06-25 02:15:50 +0000 | [diff] [blame] | 398 | self.ehlo_resp=msg |
Fred Drake | 8152d32 | 2000-12-12 23:20:45 +0000 | [diff] [blame] | 399 | if code != 250: |
Guido van Rossum | 296e143 | 1999-04-07 15:03:39 +0000 | [diff] [blame] | 400 | return (code,msg) |
Guido van Rossum | fcfb632 | 1998-08-04 15:29:54 +0000 | [diff] [blame] | 401 | self.does_esmtp=1 |
Thomas Wouters | 7e47402 | 2000-07-16 12:04:32 +0000 | [diff] [blame] | 402 | #parse the ehlo response -ddm |
Eric S. Raymond | c013f30 | 2001-02-09 05:40:38 +0000 | [diff] [blame] | 403 | resp=self.ehlo_resp.split('\n') |
Guido van Rossum | fcfb632 | 1998-08-04 15:29:54 +0000 | [diff] [blame] | 404 | del resp[0] |
Guido van Rossum | 2880f6e | 1998-08-10 20:07:00 +0000 | [diff] [blame] | 405 | for each in resp: |
Piers Lauder | 385a77a | 2002-07-27 00:38:30 +0000 | [diff] [blame] | 406 | # To be able to communicate with as many SMTP servers as possible, |
| 407 | # we have to take the old-style auth advertisement into account, |
| 408 | # because: |
| 409 | # 1) Else our SMTP feature parser gets confused. |
| 410 | # 2) There are some servers that only advertise the auth methods we |
| 411 | # support using the old style. |
| 412 | auth_match = OLDSTYLE_AUTH.match(each) |
| 413 | if auth_match: |
| 414 | # This doesn't remove duplicates, but that's no problem |
| 415 | self.esmtp_features["auth"] = self.esmtp_features.get("auth", "") \ |
| 416 | + " " + auth_match.groups(0)[0] |
| 417 | continue |
| 418 | |
Barry Warsaw | be22ae6 | 2002-04-15 20:03:30 +0000 | [diff] [blame] | 419 | # RFC 1869 requires a space between ehlo keyword and parameters. |
| 420 | # It's actually stricter, in that only spaces are allowed between |
| 421 | # parameters, but were not going to check for that here. Note |
| 422 | # that the space isn't present if there are no parameters. |
| 423 | 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] | 424 | if m: |
Eric S. Raymond | c013f30 | 2001-02-09 05:40:38 +0000 | [diff] [blame] | 425 | feature=m.group("feature").lower() |
| 426 | params=m.string[m.end("feature"):].strip() |
Piers Lauder | 385a77a | 2002-07-27 00:38:30 +0000 | [diff] [blame] | 427 | if feature == "auth": |
| 428 | self.esmtp_features[feature] = self.esmtp_features.get(feature, "") \ |
| 429 | + " " + params |
| 430 | else: |
| 431 | self.esmtp_features[feature]=params |
Guido van Rossum | 296e143 | 1999-04-07 15:03:39 +0000 | [diff] [blame] | 432 | return (code,msg) |
Guido van Rossum | 95e6f70 | 1998-06-25 02:15:50 +0000 | [diff] [blame] | 433 | |
Guido van Rossum | fcfb632 | 1998-08-04 15:29:54 +0000 | [diff] [blame] | 434 | def has_extn(self, opt): |
| 435 | """Does the server support a given SMTP service extension?""" |
Raymond Hettinger | 54f0222 | 2002-06-01 14:18:47 +0000 | [diff] [blame] | 436 | return opt.lower() in self.esmtp_features |
Guido van Rossum | 95e6f70 | 1998-06-25 02:15:50 +0000 | [diff] [blame] | 437 | |
Guido van Rossum | 18586f4 | 1998-04-03 17:03:13 +0000 | [diff] [blame] | 438 | def help(self, args=''): |
Barry Warsaw | a7d9bdf | 1998-12-22 03:24:27 +0000 | [diff] [blame] | 439 | """SMTP 'help' command. |
| 440 | Returns help text from server.""" |
Guido van Rossum | 18586f4 | 1998-04-03 17:03:13 +0000 | [diff] [blame] | 441 | self.putcmd("help", args) |
Guido van Rossum | 296e143 | 1999-04-07 15:03:39 +0000 | [diff] [blame] | 442 | return self.getreply() |
Guido van Rossum | bbe323e | 1998-01-29 17:24:40 +0000 | [diff] [blame] | 443 | |
| 444 | def rset(self): |
Barry Warsaw | a7d9bdf | 1998-12-22 03:24:27 +0000 | [diff] [blame] | 445 | """SMTP 'rset' command -- resets session.""" |
Guido van Rossum | 296e143 | 1999-04-07 15:03:39 +0000 | [diff] [blame] | 446 | return self.docmd("rset") |
Guido van Rossum | bbe323e | 1998-01-29 17:24:40 +0000 | [diff] [blame] | 447 | |
| 448 | def noop(self): |
Barry Warsaw | a7d9bdf | 1998-12-22 03:24:27 +0000 | [diff] [blame] | 449 | """SMTP 'noop' command -- doesn't do anything :>""" |
Guido van Rossum | 296e143 | 1999-04-07 15:03:39 +0000 | [diff] [blame] | 450 | return self.docmd("noop") |
Guido van Rossum | bbe323e | 1998-01-29 17:24:40 +0000 | [diff] [blame] | 451 | |
Guido van Rossum | 95e6f70 | 1998-06-25 02:15:50 +0000 | [diff] [blame] | 452 | def mail(self,sender,options=[]): |
Barry Warsaw | a7d9bdf | 1998-12-22 03:24:27 +0000 | [diff] [blame] | 453 | """SMTP 'mail' command -- begins mail xfer session.""" |
Guido van Rossum | fcfb632 | 1998-08-04 15:29:54 +0000 | [diff] [blame] | 454 | optionlist = '' |
| 455 | if options and self.does_esmtp: |
Eric S. Raymond | c013f30 | 2001-02-09 05:40:38 +0000 | [diff] [blame] | 456 | optionlist = ' ' + ' '.join(options) |
Guido van Rossum | db23d3d | 1999-06-09 15:13:10 +0000 | [diff] [blame] | 457 | self.putcmd("mail", "FROM:%s%s" % (quoteaddr(sender) ,optionlist)) |
Guido van Rossum | 45e2fbc | 1998-03-26 21:13:24 +0000 | [diff] [blame] | 458 | return self.getreply() |
Guido van Rossum | bbe323e | 1998-01-29 17:24:40 +0000 | [diff] [blame] | 459 | |
Guido van Rossum | fcfb632 | 1998-08-04 15:29:54 +0000 | [diff] [blame] | 460 | def rcpt(self,recip,options=[]): |
Barry Warsaw | a7d9bdf | 1998-12-22 03:24:27 +0000 | [diff] [blame] | 461 | """SMTP 'rcpt' command -- indicates 1 recipient for this mail.""" |
Guido van Rossum | fcfb632 | 1998-08-04 15:29:54 +0000 | [diff] [blame] | 462 | optionlist = '' |
| 463 | if options and self.does_esmtp: |
Eric S. Raymond | c013f30 | 2001-02-09 05:40:38 +0000 | [diff] [blame] | 464 | optionlist = ' ' + ' '.join(options) |
Guido van Rossum | 348fd06 | 1999-01-14 04:18:46 +0000 | [diff] [blame] | 465 | self.putcmd("rcpt","TO:%s%s" % (quoteaddr(recip),optionlist)) |
Guido van Rossum | 45e2fbc | 1998-03-26 21:13:24 +0000 | [diff] [blame] | 466 | return self.getreply() |
Guido van Rossum | bbe323e | 1998-01-29 17:24:40 +0000 | [diff] [blame] | 467 | |
| 468 | def data(self,msg): |
Tim Peters | 495ad3c | 2001-01-15 01:36:40 +0000 | [diff] [blame] | 469 | """SMTP 'DATA' command -- sends message data to server. |
Guido van Rossum | 296e143 | 1999-04-07 15:03:39 +0000 | [diff] [blame] | 470 | |
Barry Warsaw | 4c4bec8 | 1998-12-22 03:02:20 +0000 | [diff] [blame] | 471 | Automatically quotes lines beginning with a period per rfc821. |
Guido van Rossum | 296e143 | 1999-04-07 15:03:39 +0000 | [diff] [blame] | 472 | Raises SMTPDataError if there is an unexpected reply to the |
| 473 | DATA command; the return value from this method is the final |
| 474 | response code received when the all data is sent. |
Barry Warsaw | 4c4bec8 | 1998-12-22 03:02:20 +0000 | [diff] [blame] | 475 | """ |
Guido van Rossum | 45e2fbc | 1998-03-26 21:13:24 +0000 | [diff] [blame] | 476 | self.putcmd("data") |
| 477 | (code,repl)=self.getreply() |
Brett Cannon | e6f8a89 | 2004-07-10 23:14:30 +0000 | [diff] [blame] | 478 | if self.debuglevel >0 : print>>stderr, "data:", (code,repl) |
Fred Drake | 8152d32 | 2000-12-12 23:20:45 +0000 | [diff] [blame] | 479 | if code != 354: |
Guido van Rossum | 296e143 | 1999-04-07 15:03:39 +0000 | [diff] [blame] | 480 | raise SMTPDataError(code,repl) |
Guido van Rossum | 45e2fbc | 1998-03-26 21:13:24 +0000 | [diff] [blame] | 481 | else: |
Guido van Rossum | 20c9228 | 1999-04-21 16:52:20 +0000 | [diff] [blame] | 482 | q = quotedata(msg) |
| 483 | if q[-2:] != CRLF: |
| 484 | q = q + CRLF |
| 485 | q = q + "." + CRLF |
| 486 | self.send(q) |
Guido van Rossum | 45e2fbc | 1998-03-26 21:13:24 +0000 | [diff] [blame] | 487 | (code,msg)=self.getreply() |
Brett Cannon | e6f8a89 | 2004-07-10 23:14:30 +0000 | [diff] [blame] | 488 | if self.debuglevel >0 : print>>stderr, "data:", (code,msg) |
Guido van Rossum | 296e143 | 1999-04-07 15:03:39 +0000 | [diff] [blame] | 489 | return (code,msg) |
Guido van Rossum | bbe323e | 1998-01-29 17:24:40 +0000 | [diff] [blame] | 490 | |
Guido van Rossum | fcfb632 | 1998-08-04 15:29:54 +0000 | [diff] [blame] | 491 | def verify(self, address): |
Barry Warsaw | a7d9bdf | 1998-12-22 03:24:27 +0000 | [diff] [blame] | 492 | """SMTP 'verify' command -- checks for address validity.""" |
Guido van Rossum | fcfb632 | 1998-08-04 15:29:54 +0000 | [diff] [blame] | 493 | self.putcmd("vrfy", quoteaddr(address)) |
| 494 | return self.getreply() |
Barry Warsaw | 4c4bec8 | 1998-12-22 03:02:20 +0000 | [diff] [blame] | 495 | # a.k.a. |
| 496 | vrfy=verify |
Guido van Rossum | fcfb632 | 1998-08-04 15:29:54 +0000 | [diff] [blame] | 497 | |
| 498 | def expn(self, address): |
Barry Warsaw | a7d9bdf | 1998-12-22 03:24:27 +0000 | [diff] [blame] | 499 | """SMTP 'verify' command -- checks for address validity.""" |
Guido van Rossum | fcfb632 | 1998-08-04 15:29:54 +0000 | [diff] [blame] | 500 | self.putcmd("expn", quoteaddr(address)) |
| 501 | return self.getreply() |
| 502 | |
Barry Warsaw | 4c4bec8 | 1998-12-22 03:02:20 +0000 | [diff] [blame] | 503 | # some useful methods |
Guido van Rossum | ae01046 | 2001-09-11 15:57:46 +0000 | [diff] [blame] | 504 | |
| 505 | def login(self, user, password): |
| 506 | """Log in on an SMTP server that requires authentication. |
| 507 | |
| 508 | The arguments are: |
| 509 | - user: The user name to authenticate with. |
| 510 | - password: The password for the authentication. |
| 511 | |
| 512 | If there has been no previous EHLO or HELO command this session, this |
| 513 | method tries ESMTP EHLO first. |
| 514 | |
| 515 | This method will return normally if the authentication was successful. |
| 516 | |
| 517 | This method may raise the following exceptions: |
| 518 | |
| 519 | SMTPHeloError The server didn't reply properly to |
| 520 | the helo greeting. |
| 521 | SMTPAuthenticationError The server didn't accept the username/ |
| 522 | password combination. |
Fred Drake | 2f8f4d3 | 2001-10-13 18:35:32 +0000 | [diff] [blame] | 523 | SMTPException No suitable authentication method was |
Guido van Rossum | ae01046 | 2001-09-11 15:57:46 +0000 | [diff] [blame] | 524 | found. |
| 525 | """ |
| 526 | |
| 527 | def encode_cram_md5(challenge, user, password): |
| 528 | challenge = base64.decodestring(challenge) |
| 529 | response = user + " " + hmac.HMAC(password, challenge).hexdigest() |
Piers Lauder | 385a77a | 2002-07-27 00:38:30 +0000 | [diff] [blame] | 530 | return encode_base64(response, eol="") |
Guido van Rossum | ae01046 | 2001-09-11 15:57:46 +0000 | [diff] [blame] | 531 | |
| 532 | def encode_plain(user, password): |
Johannes Gijsbers | 25946dd | 2004-12-06 21:25:26 +0000 | [diff] [blame] | 533 | return encode_base64("\0%s\0%s" % (user, password), eol="") |
Tim Peters | 469cdad | 2002-08-08 20:19:19 +0000 | [diff] [blame] | 534 | |
Guido van Rossum | ae01046 | 2001-09-11 15:57:46 +0000 | [diff] [blame] | 535 | |
| 536 | AUTH_PLAIN = "PLAIN" |
| 537 | AUTH_CRAM_MD5 = "CRAM-MD5" |
Piers Lauder | 385a77a | 2002-07-27 00:38:30 +0000 | [diff] [blame] | 538 | AUTH_LOGIN = "LOGIN" |
Guido van Rossum | ae01046 | 2001-09-11 15:57:46 +0000 | [diff] [blame] | 539 | |
| 540 | if self.helo_resp is None and self.ehlo_resp is None: |
| 541 | if not (200 <= self.ehlo()[0] <= 299): |
| 542 | (code, resp) = self.helo() |
| 543 | if not (200 <= code <= 299): |
| 544 | raise SMTPHeloError(code, resp) |
| 545 | |
| 546 | if not self.has_extn("auth"): |
| 547 | raise SMTPException("SMTP AUTH extension not supported by server.") |
| 548 | |
| 549 | # Authentication methods the server supports: |
| 550 | authlist = self.esmtp_features["auth"].split() |
| 551 | |
| 552 | # List of authentication methods we support: from preferred to |
| 553 | # less preferred methods. Except for the purpose of testing the weaker |
| 554 | # ones, we prefer stronger methods like CRAM-MD5: |
Piers Lauder | 385a77a | 2002-07-27 00:38:30 +0000 | [diff] [blame] | 555 | preferred_auths = [AUTH_CRAM_MD5, AUTH_PLAIN, AUTH_LOGIN] |
Guido van Rossum | ae01046 | 2001-09-11 15:57:46 +0000 | [diff] [blame] | 556 | |
| 557 | # Determine the authentication method we'll use |
| 558 | authmethod = None |
| 559 | for method in preferred_auths: |
| 560 | if method in authlist: |
| 561 | authmethod = method |
| 562 | break |
Tim Peters | b64bec3 | 2001-09-18 02:26:39 +0000 | [diff] [blame] | 563 | |
Guido van Rossum | ae01046 | 2001-09-11 15:57:46 +0000 | [diff] [blame] | 564 | if authmethod == AUTH_CRAM_MD5: |
| 565 | (code, resp) = self.docmd("AUTH", AUTH_CRAM_MD5) |
| 566 | if code == 503: |
| 567 | # 503 == 'Error: already authenticated' |
| 568 | return (code, resp) |
| 569 | (code, resp) = self.docmd(encode_cram_md5(resp, user, password)) |
| 570 | elif authmethod == AUTH_PLAIN: |
Tim Peters | b64bec3 | 2001-09-18 02:26:39 +0000 | [diff] [blame] | 571 | (code, resp) = self.docmd("AUTH", |
Guido van Rossum | ae01046 | 2001-09-11 15:57:46 +0000 | [diff] [blame] | 572 | AUTH_PLAIN + " " + encode_plain(user, password)) |
Piers Lauder | 385a77a | 2002-07-27 00:38:30 +0000 | [diff] [blame] | 573 | elif authmethod == AUTH_LOGIN: |
| 574 | (code, resp) = self.docmd("AUTH", |
| 575 | "%s %s" % (AUTH_LOGIN, encode_base64(user, eol=""))) |
| 576 | if code != 334: |
| 577 | raise SMTPAuthenticationError(code, resp) |
Martin v. Löwis | 49c05d3 | 2002-10-06 17:55:08 +0000 | [diff] [blame] | 578 | (code, resp) = self.docmd(encode_base64(password, eol="")) |
Raymond Hettinger | 7fdfc2d | 2002-05-31 17:49:10 +0000 | [diff] [blame] | 579 | elif authmethod is None: |
Fred Drake | 2f8f4d3 | 2001-10-13 18:35:32 +0000 | [diff] [blame] | 580 | raise SMTPException("No suitable authentication method found.") |
Guido van Rossum | ae01046 | 2001-09-11 15:57:46 +0000 | [diff] [blame] | 581 | if code not in [235, 503]: |
| 582 | # 235 == 'Authentication successful' |
| 583 | # 503 == 'Error: already authenticated' |
| 584 | raise SMTPAuthenticationError(code, resp) |
| 585 | return (code, resp) |
| 586 | |
Guido van Rossum | f7fcf5e | 2001-09-14 16:08:44 +0000 | [diff] [blame] | 587 | def starttls(self, keyfile = None, certfile = None): |
| 588 | """Puts the connection to the SMTP server into TLS mode. |
Tim Peters | b64bec3 | 2001-09-18 02:26:39 +0000 | [diff] [blame] | 589 | |
Guido van Rossum | f7fcf5e | 2001-09-14 16:08:44 +0000 | [diff] [blame] | 590 | If the server supports TLS, this will encrypt the rest of the SMTP |
| 591 | session. If you provide the keyfile and certfile parameters, |
| 592 | the identity of the SMTP server and client can be checked. This, |
| 593 | however, depends on whether the socket module really checks the |
| 594 | certificates. |
| 595 | """ |
Tim Peters | b64bec3 | 2001-09-18 02:26:39 +0000 | [diff] [blame] | 596 | (resp, reply) = self.docmd("STARTTLS") |
Guido van Rossum | f7fcf5e | 2001-09-14 16:08:44 +0000 | [diff] [blame] | 597 | if resp == 220: |
| 598 | sslobj = socket.ssl(self.sock, keyfile, certfile) |
| 599 | self.sock = SSLFakeSocket(self.sock, sslobj) |
| 600 | self.file = SSLFakeFile(sslobj) |
| 601 | return (resp, reply) |
Tim Peters | b64bec3 | 2001-09-18 02:26:39 +0000 | [diff] [blame] | 602 | |
Jeremy Hylton | 31bb8ce | 1998-08-13 19:57:46 +0000 | [diff] [blame] | 603 | def sendmail(self, from_addr, to_addrs, msg, mail_options=[], |
Tim Peters | 495ad3c | 2001-01-15 01:36:40 +0000 | [diff] [blame] | 604 | rcpt_options=[]): |
| 605 | """This command performs an entire mail transaction. |
Guido van Rossum | bbe323e | 1998-01-29 17:24:40 +0000 | [diff] [blame] | 606 | |
Tim Peters | 495ad3c | 2001-01-15 01:36:40 +0000 | [diff] [blame] | 607 | The arguments are: |
Barry Warsaw | 4c4bec8 | 1998-12-22 03:02:20 +0000 | [diff] [blame] | 608 | - from_addr : The address sending this mail. |
| 609 | - to_addrs : A list of addresses to send this mail to. A bare |
| 610 | string will be treated as a list with 1 address. |
Tim Peters | 495ad3c | 2001-01-15 01:36:40 +0000 | [diff] [blame] | 611 | - msg : The message to send. |
Barry Warsaw | 4c4bec8 | 1998-12-22 03:02:20 +0000 | [diff] [blame] | 612 | - mail_options : List of ESMTP options (such as 8bitmime) for the |
| 613 | mail command. |
| 614 | - rcpt_options : List of ESMTP options (such as DSN commands) for |
| 615 | all the rcpt commands. |
| 616 | |
| 617 | If there has been no previous EHLO or HELO command this session, this |
| 618 | method tries ESMTP EHLO first. If the server does ESMTP, message size |
| 619 | and each of the specified options will be passed to it. If EHLO |
| 620 | fails, HELO will be tried and ESMTP options suppressed. |
| 621 | |
| 622 | 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] | 623 | one recipient. It returns a dictionary, with one entry for each |
| 624 | recipient that was refused. Each entry contains a tuple of the SMTP |
| 625 | error code and the accompanying error message sent by the server. |
Guido van Rossum | 296e143 | 1999-04-07 15:03:39 +0000 | [diff] [blame] | 626 | |
| 627 | This method may raise the following exceptions: |
| 628 | |
| 629 | SMTPHeloError The server didn't reply properly to |
Tim Peters | 495ad3c | 2001-01-15 01:36:40 +0000 | [diff] [blame] | 630 | the helo greeting. |
Barry Warsaw | d25c1b7 | 1999-11-28 17:11:06 +0000 | [diff] [blame] | 631 | SMTPRecipientsRefused The server rejected ALL recipients |
Guido van Rossum | 296e143 | 1999-04-07 15:03:39 +0000 | [diff] [blame] | 632 | (no mail was sent). |
| 633 | SMTPSenderRefused The server didn't accept the from_addr. |
| 634 | SMTPDataError The server replied with an unexpected |
| 635 | error code (other than a refusal of |
| 636 | a recipient). |
| 637 | |
| 638 | 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] | 639 | |
Guido van Rossum | 95e6f70 | 1998-06-25 02:15:50 +0000 | [diff] [blame] | 640 | Example: |
Tim Peters | 495ad3c | 2001-01-15 01:36:40 +0000 | [diff] [blame] | 641 | |
Guido van Rossum | bbe323e | 1998-01-29 17:24:40 +0000 | [diff] [blame] | 642 | >>> import smtplib |
| 643 | >>> s=smtplib.SMTP("localhost") |
Guido van Rossum | fc40a83 | 1998-01-29 17:26:45 +0000 | [diff] [blame] | 644 | >>> 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] | 645 | >>> msg = '''\\ |
Guido van Rossum | bbe323e | 1998-01-29 17:24:40 +0000 | [diff] [blame] | 646 | ... From: Me@my.org |
| 647 | ... Subject: testin'... |
| 648 | ... |
| 649 | ... This is a test ''' |
| 650 | >>> s.sendmail("me@my.org",tolist,msg) |
| 651 | { "three@three.org" : ( 550 ,"User unknown" ) } |
| 652 | >>> s.quit() |
Tim Peters | 495ad3c | 2001-01-15 01:36:40 +0000 | [diff] [blame] | 653 | |
Barry Warsaw | 4c4bec8 | 1998-12-22 03:02:20 +0000 | [diff] [blame] | 654 | In the above example, the message was accepted for delivery to three |
| 655 | of the four addresses, and one was rejected, with the error code |
Barry Warsaw | d25c1b7 | 1999-11-28 17:11:06 +0000 | [diff] [blame] | 656 | 550. If all addresses are accepted, then the method will return an |
Barry Warsaw | 4c4bec8 | 1998-12-22 03:02:20 +0000 | [diff] [blame] | 657 | empty dictionary. |
| 658 | |
| 659 | """ |
Guido van Rossum | 296e143 | 1999-04-07 15:03:39 +0000 | [diff] [blame] | 660 | if self.helo_resp is None and self.ehlo_resp is None: |
| 661 | if not (200 <= self.ehlo()[0] <= 299): |
| 662 | (code,resp) = self.helo() |
| 663 | if not (200 <= code <= 299): |
| 664 | raise SMTPHeloError(code, resp) |
Guido van Rossum | 95e6f70 | 1998-06-25 02:15:50 +0000 | [diff] [blame] | 665 | esmtp_opts = [] |
Guido van Rossum | fcfb632 | 1998-08-04 15:29:54 +0000 | [diff] [blame] | 666 | if self.does_esmtp: |
| 667 | # Hmmm? what's this? -ddm |
| 668 | # self.esmtp_features['7bit']="" |
| 669 | if self.has_extn('size'): |
Walter Dörwald | 70a6b49 | 2004-02-12 17:35:32 +0000 | [diff] [blame] | 670 | esmtp_opts.append("size=%d" % len(msg)) |
Guido van Rossum | fcfb632 | 1998-08-04 15:29:54 +0000 | [diff] [blame] | 671 | for option in mail_options: |
Guido van Rossum | 95e6f70 | 1998-06-25 02:15:50 +0000 | [diff] [blame] | 672 | esmtp_opts.append(option) |
Guido van Rossum | fcfb632 | 1998-08-04 15:29:54 +0000 | [diff] [blame] | 673 | |
Guido van Rossum | 95e6f70 | 1998-06-25 02:15:50 +0000 | [diff] [blame] | 674 | (code,resp) = self.mail(from_addr, esmtp_opts) |
Fred Drake | 8152d32 | 2000-12-12 23:20:45 +0000 | [diff] [blame] | 675 | if code != 250: |
Guido van Rossum | 45e2fbc | 1998-03-26 21:13:24 +0000 | [diff] [blame] | 676 | self.rset() |
Guido van Rossum | 296e143 | 1999-04-07 15:03:39 +0000 | [diff] [blame] | 677 | raise SMTPSenderRefused(code, resp, from_addr) |
Guido van Rossum | 45e2fbc | 1998-03-26 21:13:24 +0000 | [diff] [blame] | 678 | senderrs={} |
Walter Dörwald | 65230a2 | 2002-06-03 15:58:32 +0000 | [diff] [blame] | 679 | if isinstance(to_addrs, basestring): |
Jeremy Hylton | 31bb8ce | 1998-08-13 19:57:46 +0000 | [diff] [blame] | 680 | to_addrs = [to_addrs] |
Guido van Rossum | bbe323e | 1998-01-29 17:24:40 +0000 | [diff] [blame] | 681 | for each in to_addrs: |
Guido van Rossum | fcfb632 | 1998-08-04 15:29:54 +0000 | [diff] [blame] | 682 | (code,resp)=self.rcpt(each, rcpt_options) |
Fred Drake | 8152d32 | 2000-12-12 23:20:45 +0000 | [diff] [blame] | 683 | if (code != 250) and (code != 251): |
Guido van Rossum | fc40a83 | 1998-01-29 17:26:45 +0000 | [diff] [blame] | 684 | senderrs[each]=(code,resp) |
Guido van Rossum | bbe323e | 1998-01-29 17:24:40 +0000 | [diff] [blame] | 685 | if len(senderrs)==len(to_addrs): |
Guido van Rossum | 95e6f70 | 1998-06-25 02:15:50 +0000 | [diff] [blame] | 686 | # the server refused all our recipients |
Guido van Rossum | bbe323e | 1998-01-29 17:24:40 +0000 | [diff] [blame] | 687 | self.rset() |
Guido van Rossum | 296e143 | 1999-04-07 15:03:39 +0000 | [diff] [blame] | 688 | raise SMTPRecipientsRefused(senderrs) |
Fred Drake | 8152d32 | 2000-12-12 23:20:45 +0000 | [diff] [blame] | 689 | (code,resp) = self.data(msg) |
| 690 | if code != 250: |
Guido van Rossum | bbe323e | 1998-01-29 17:24:40 +0000 | [diff] [blame] | 691 | self.rset() |
Guido van Rossum | 296e143 | 1999-04-07 15:03:39 +0000 | [diff] [blame] | 692 | raise SMTPDataError(code, resp) |
Guido van Rossum | bbe323e | 1998-01-29 17:24:40 +0000 | [diff] [blame] | 693 | #if we got here then somebody got our mail |
Tim Peters | 495ad3c | 2001-01-15 01:36:40 +0000 | [diff] [blame] | 694 | return senderrs |
Guido van Rossum | bbe323e | 1998-01-29 17:24:40 +0000 | [diff] [blame] | 695 | |
| 696 | |
| 697 | def close(self): |
| 698 | """Close the connection to the SMTP server.""" |
| 699 | if self.file: |
| 700 | self.file.close() |
| 701 | self.file = None |
| 702 | if self.sock: |
| 703 | self.sock.close() |
| 704 | self.sock = None |
| 705 | |
| 706 | |
| 707 | def quit(self): |
Guido van Rossum | 95e6f70 | 1998-06-25 02:15:50 +0000 | [diff] [blame] | 708 | """Terminate the SMTP session.""" |
Guido van Rossum | 45e2fbc | 1998-03-26 21:13:24 +0000 | [diff] [blame] | 709 | self.docmd("quit") |
| 710 | self.close() |
Guido van Rossum | 95e6f70 | 1998-06-25 02:15:50 +0000 | [diff] [blame] | 711 | |
Barry Warsaw | 4c4bec8 | 1998-12-22 03:02:20 +0000 | [diff] [blame] | 712 | |
Guido van Rossum | 95e6f70 | 1998-06-25 02:15:50 +0000 | [diff] [blame] | 713 | # Test the sendmail method, which tests most of the others. |
| 714 | # Note: This always sends to localhost. |
| 715 | if __name__ == '__main__': |
Andrew M. Kuchling | 6be424f | 2001-08-13 14:41:39 +0000 | [diff] [blame] | 716 | import sys |
Guido van Rossum | 95e6f70 | 1998-06-25 02:15:50 +0000 | [diff] [blame] | 717 | |
| 718 | def prompt(prompt): |
| 719 | sys.stdout.write(prompt + ": ") |
Eric S. Raymond | c013f30 | 2001-02-09 05:40:38 +0000 | [diff] [blame] | 720 | return sys.stdin.readline().strip() |
Guido van Rossum | 95e6f70 | 1998-06-25 02:15:50 +0000 | [diff] [blame] | 721 | |
| 722 | fromaddr = prompt("From") |
Eric S. Raymond | 38151ed | 2001-02-09 07:40:17 +0000 | [diff] [blame] | 723 | toaddrs = prompt("To").split(',') |
Guido van Rossum | 95e6f70 | 1998-06-25 02:15:50 +0000 | [diff] [blame] | 724 | print "Enter message, end with ^D:" |
| 725 | msg = '' |
| 726 | while 1: |
| 727 | line = sys.stdin.readline() |
| 728 | if not line: |
| 729 | break |
| 730 | msg = msg + line |
Walter Dörwald | 70a6b49 | 2004-02-12 17:35:32 +0000 | [diff] [blame] | 731 | print "Message length is %d" % len(msg) |
Guido van Rossum | 95e6f70 | 1998-06-25 02:15:50 +0000 | [diff] [blame] | 732 | |
| 733 | server = SMTP('localhost') |
| 734 | server.set_debuglevel(1) |
| 735 | server.sendmail(fromaddr, toaddrs, msg) |
| 736 | server.quit() |