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