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 |
Georg Brandl | 5a096e1 | 2007-01-22 19:40:21 +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 |
Georg Brandl | 5a096e1 | 2007-01-22 19:40:21 +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 | |
Giampaolo Rodolà | 5c12ec6 | 2011-02-24 20:43:11 +0000 | [diff] [blame] | 52 | __all__ = ["SMTPException", "SMTPServerDisconnected", "SMTPResponseException", |
| 53 | "SMTPSenderRefused", "SMTPRecipientsRefused", "SMTPDataError", |
| 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 |
Martin v. Löwis | ee82c0e | 2006-10-27 07:13:28 +0000 | [diff] [blame] | 58 | SMTP_SSL_PORT = 465 |
Giampaolo Rodolà | 5c12ec6 | 2011-02-24 20:43:11 +0000 | [diff] [blame] | 59 | CRLF = "\r\n" |
Benjamin Peterson | dabfc56 | 2014-12-05 20:05:18 -0500 | [diff] [blame] | 60 | _MAXLINE = 8192 # more than 8 times larger than RFC 821, 4.5.3 |
Guido van Rossum | bbe323e | 1998-01-29 17:24:40 +0000 | [diff] [blame] | 61 | |
Piers Lauder | 385a77a | 2002-07-27 00:38:30 +0000 | [diff] [blame] | 62 | OLDSTYLE_AUTH = re.compile(r"auth=(.*)", re.I) |
| 63 | |
Giampaolo Rodolà | 5c12ec6 | 2011-02-24 20:43:11 +0000 | [diff] [blame] | 64 | |
Tim Peters | 495ad3c | 2001-01-15 01:36:40 +0000 | [diff] [blame] | 65 | # Exception classes used by this module. |
Guido van Rossum | 296e143 | 1999-04-07 15:03:39 +0000 | [diff] [blame] | 66 | class SMTPException(Exception): |
| 67 | """Base class for all exceptions raised by this module.""" |
| 68 | |
| 69 | class SMTPServerDisconnected(SMTPException): |
| 70 | """Not connected to any SMTP server. |
| 71 | |
| 72 | This exception is raised when the server unexpectedly disconnects, |
| 73 | or when an attempt is made to use the SMTP instance before |
| 74 | connecting it to a server. |
| 75 | """ |
| 76 | |
| 77 | class SMTPResponseException(SMTPException): |
| 78 | """Base class for all exceptions that include an SMTP error code. |
| 79 | |
| 80 | These exceptions are generated in some instances when the SMTP |
| 81 | server returns an error code. The error code is stored in the |
| 82 | `smtp_code' attribute of the error, and the `smtp_error' attribute |
| 83 | is set to the error message. |
| 84 | """ |
| 85 | |
| 86 | def __init__(self, code, msg): |
| 87 | self.smtp_code = code |
| 88 | self.smtp_error = msg |
| 89 | self.args = (code, msg) |
| 90 | |
| 91 | class SMTPSenderRefused(SMTPResponseException): |
| 92 | """Sender address refused. |
Guido van Rossum | ae01046 | 2001-09-11 15:57:46 +0000 | [diff] [blame] | 93 | |
Guido van Rossum | 296e143 | 1999-04-07 15:03:39 +0000 | [diff] [blame] | 94 | In addition to the attributes set by on all SMTPResponseException |
Barry Warsaw | d25c1b7 | 1999-11-28 17:11:06 +0000 | [diff] [blame] | 95 | exceptions, this sets `sender' to the string that the SMTP refused. |
Guido van Rossum | 296e143 | 1999-04-07 15:03:39 +0000 | [diff] [blame] | 96 | """ |
| 97 | |
| 98 | def __init__(self, code, msg, sender): |
| 99 | self.smtp_code = code |
| 100 | self.smtp_error = msg |
| 101 | self.sender = sender |
| 102 | self.args = (code, msg, sender) |
| 103 | |
Guido van Rossum | 20c9228 | 1999-04-21 16:52:20 +0000 | [diff] [blame] | 104 | class SMTPRecipientsRefused(SMTPException): |
Barry Warsaw | d25c1b7 | 1999-11-28 17:11:06 +0000 | [diff] [blame] | 105 | """All recipient addresses refused. |
Guido van Rossum | ae01046 | 2001-09-11 15:57:46 +0000 | [diff] [blame] | 106 | |
Thomas Wouters | 7e47402 | 2000-07-16 12:04:32 +0000 | [diff] [blame] | 107 | The errors for each recipient are accessible through the attribute |
Tim Peters | 495ad3c | 2001-01-15 01:36:40 +0000 | [diff] [blame] | 108 | 'recipients', which is a dictionary of exactly the same sort as |
| 109 | SMTP.sendmail() returns. |
Guido van Rossum | 296e143 | 1999-04-07 15:03:39 +0000 | [diff] [blame] | 110 | """ |
| 111 | |
| 112 | def __init__(self, recipients): |
| 113 | self.recipients = recipients |
Giampaolo Rodolà | 5c12ec6 | 2011-02-24 20:43:11 +0000 | [diff] [blame] | 114 | self.args = (recipients,) |
Guido van Rossum | 296e143 | 1999-04-07 15:03:39 +0000 | [diff] [blame] | 115 | |
| 116 | |
Guido van Rossum | 296e143 | 1999-04-07 15:03:39 +0000 | [diff] [blame] | 117 | class SMTPDataError(SMTPResponseException): |
| 118 | """The SMTP server didn't accept the data.""" |
| 119 | |
| 120 | class SMTPConnectError(SMTPResponseException): |
Barry Warsaw | d25c1b7 | 1999-11-28 17:11:06 +0000 | [diff] [blame] | 121 | """Error during connection establishment.""" |
Guido van Rossum | 296e143 | 1999-04-07 15:03:39 +0000 | [diff] [blame] | 122 | |
| 123 | class SMTPHeloError(SMTPResponseException): |
Barry Warsaw | d25c1b7 | 1999-11-28 17:11:06 +0000 | [diff] [blame] | 124 | """The server refused our HELO reply.""" |
Guido van Rossum | bbe323e | 1998-01-29 17:24:40 +0000 | [diff] [blame] | 125 | |
Guido van Rossum | ae01046 | 2001-09-11 15:57:46 +0000 | [diff] [blame] | 126 | class SMTPAuthenticationError(SMTPResponseException): |
| 127 | """Authentication error. |
| 128 | |
| 129 | Most probably the server didn't accept the username/password |
| 130 | combination provided. |
| 131 | """ |
Peter Schneider-Kamp | 7bc82bb | 2000-08-10 14:02:23 +0000 | [diff] [blame] | 132 | |
Giampaolo Rodolà | 5c12ec6 | 2011-02-24 20:43:11 +0000 | [diff] [blame] | 133 | |
Guido van Rossum | 69a79bc | 1998-07-13 15:18:49 +0000 | [diff] [blame] | 134 | def quoteaddr(addr): |
| 135 | """Quote a subset of the email addresses defined by RFC 821. |
| 136 | |
Barry Warsaw | a7d9bdf | 1998-12-22 03:24:27 +0000 | [diff] [blame] | 137 | Should be able to handle anything rfc822.parseaddr can handle. |
| 138 | """ |
Raymond Hettinger | 342456d | 2002-09-05 01:14:07 +0000 | [diff] [blame] | 139 | m = (None, None) |
Guido van Rossum | 69a79bc | 1998-07-13 15:18:49 +0000 | [diff] [blame] | 140 | try: |
Georg Brandl | 5a096e1 | 2007-01-22 19:40:21 +0000 | [diff] [blame] | 141 | m = email.utils.parseaddr(addr)[1] |
Guido van Rossum | fcfb632 | 1998-08-04 15:29:54 +0000 | [diff] [blame] | 142 | except AttributeError: |
| 143 | pass |
Giampaolo Rodolà | 5c12ec6 | 2011-02-24 20:43:11 +0000 | [diff] [blame] | 144 | if m == (None, None): # Indicates parse failure or AttributeError |
Georg Brandl | bd3bc4d | 2006-02-17 09:52:53 +0000 | [diff] [blame] | 145 | # something weird here.. punt -ddm |
Raymond Hettinger | 342456d | 2002-09-05 01:14:07 +0000 | [diff] [blame] | 146 | return "<%s>" % addr |
Georg Brandl | bd3bc4d | 2006-02-17 09:52:53 +0000 | [diff] [blame] | 147 | elif m is None: |
| 148 | # the sender wants an empty return address |
| 149 | return "<>" |
Guido van Rossum | fcfb632 | 1998-08-04 15:29:54 +0000 | [diff] [blame] | 150 | else: |
| 151 | return "<%s>" % m |
Guido van Rossum | 69a79bc | 1998-07-13 15:18:49 +0000 | [diff] [blame] | 152 | |
R David Murray | 9522595 | 2011-07-18 21:34:04 -0400 | [diff] [blame] | 153 | def _addr_only(addrstring): |
| 154 | displayname, addr = email.utils.parseaddr(addrstring) |
| 155 | if (displayname, addr) == ('', ''): |
| 156 | # parseaddr couldn't parse it, so use it as is. |
| 157 | return addrstring |
| 158 | return addr |
| 159 | |
Guido van Rossum | 69a79bc | 1998-07-13 15:18:49 +0000 | [diff] [blame] | 160 | def quotedata(data): |
| 161 | """Quote data for email. |
| 162 | |
Barry Warsaw | d25c1b7 | 1999-11-28 17:11:06 +0000 | [diff] [blame] | 163 | Double leading '.', and change Unix newline '\\n', or Mac '\\r' into |
Barry Warsaw | a7d9bdf | 1998-12-22 03:24:27 +0000 | [diff] [blame] | 164 | Internet CRLF end-of-line. |
| 165 | """ |
Guido van Rossum | 69a79bc | 1998-07-13 15:18:49 +0000 | [diff] [blame] | 166 | return re.sub(r'(?m)^\.', '..', |
Guido van Rossum | fcfb632 | 1998-08-04 15:29:54 +0000 | [diff] [blame] | 167 | re.sub(r'(?:\r\n|\n|\r(?!\n))', CRLF, data)) |
Guido van Rossum | 69a79bc | 1998-07-13 15:18:49 +0000 | [diff] [blame] | 168 | |
Peter Schneider-Kamp | 7bc82bb | 2000-08-10 14:02:23 +0000 | [diff] [blame] | 169 | |
Bill Janssen | 426ea0a | 2007-08-29 22:35:05 +0000 | [diff] [blame] | 170 | try: |
| 171 | import ssl |
| 172 | except ImportError: |
| 173 | _have_ssl = False |
| 174 | else: |
Bill Janssen | 426ea0a | 2007-08-29 22:35:05 +0000 | [diff] [blame] | 175 | class SSLFakeFile: |
| 176 | """A fake file like object that really wraps a SSLObject. |
| 177 | |
| 178 | It only supports what is needed in smtplib. |
| 179 | """ |
| 180 | def __init__(self, sslobj): |
| 181 | self.sslobj = sslobj |
| 182 | |
Benjamin Peterson | dabfc56 | 2014-12-05 20:05:18 -0500 | [diff] [blame] | 183 | def readline(self, size=-1): |
| 184 | if size < 0: |
| 185 | size = None |
Bill Janssen | 426ea0a | 2007-08-29 22:35:05 +0000 | [diff] [blame] | 186 | str = "" |
| 187 | chr = None |
| 188 | while chr != "\n": |
Benjamin Peterson | dabfc56 | 2014-12-05 20:05:18 -0500 | [diff] [blame] | 189 | if size is not None and len(str) >= size: |
| 190 | break |
Bill Janssen | 426ea0a | 2007-08-29 22:35:05 +0000 | [diff] [blame] | 191 | chr = self.sslobj.read(1) |
Giampaolo Rodolà | 5c12ec6 | 2011-02-24 20:43:11 +0000 | [diff] [blame] | 192 | if not chr: |
| 193 | break |
Bill Janssen | 426ea0a | 2007-08-29 22:35:05 +0000 | [diff] [blame] | 194 | str += chr |
| 195 | return str |
| 196 | |
| 197 | def close(self): |
| 198 | pass |
| 199 | |
| 200 | _have_ssl = True |
| 201 | |
Guido van Rossum | bbe323e | 1998-01-29 17:24:40 +0000 | [diff] [blame] | 202 | class SMTP: |
Guido van Rossum | fcfb632 | 1998-08-04 15:29:54 +0000 | [diff] [blame] | 203 | """This class manages a connection to an SMTP or ESMTP server. |
| 204 | SMTP Objects: |
Tim Peters | 495ad3c | 2001-01-15 01:36:40 +0000 | [diff] [blame] | 205 | SMTP objects have the following attributes: |
| 206 | helo_resp |
| 207 | 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] | 208 | most recent HELO command. |
Tim Peters | 495ad3c | 2001-01-15 01:36:40 +0000 | [diff] [blame] | 209 | |
Guido van Rossum | fcfb632 | 1998-08-04 15:29:54 +0000 | [diff] [blame] | 210 | ehlo_resp |
Tim Peters | 495ad3c | 2001-01-15 01:36:40 +0000 | [diff] [blame] | 211 | 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] | 212 | most recent EHLO command. This is usually multiline. |
| 213 | |
Tim Peters | 495ad3c | 2001-01-15 01:36:40 +0000 | [diff] [blame] | 214 | does_esmtp |
Guido van Rossum | fcfb632 | 1998-08-04 15:29:54 +0000 | [diff] [blame] | 215 | This is a True value _after you do an EHLO command_, if the |
| 216 | server supports ESMTP. |
| 217 | |
Tim Peters | 495ad3c | 2001-01-15 01:36:40 +0000 | [diff] [blame] | 218 | esmtp_features |
Guido van Rossum | fcfb632 | 1998-08-04 15:29:54 +0000 | [diff] [blame] | 219 | This is a dictionary, which, if the server supports ESMTP, |
Barry Warsaw | d25c1b7 | 1999-11-28 17:11:06 +0000 | [diff] [blame] | 220 | will _after you do an EHLO command_, contain the names of the |
| 221 | SMTP service extensions this server supports, and their |
Guido van Rossum | fcfb632 | 1998-08-04 15:29:54 +0000 | [diff] [blame] | 222 | parameters (if any). |
Barry Warsaw | d25c1b7 | 1999-11-28 17:11:06 +0000 | [diff] [blame] | 223 | |
Tim Peters | 495ad3c | 2001-01-15 01:36:40 +0000 | [diff] [blame] | 224 | Note, all extension names are mapped to lower case in the |
| 225 | dictionary. |
Guido van Rossum | fcfb632 | 1998-08-04 15:29:54 +0000 | [diff] [blame] | 226 | |
Barry Warsaw | d25c1b7 | 1999-11-28 17:11:06 +0000 | [diff] [blame] | 227 | See each method's docstrings for details. In general, there is a |
| 228 | method of the same name to perform each SMTP command. There is also a |
| 229 | method called 'sendmail' that will do an entire mail transaction. |
| 230 | """ |
Guido van Rossum | 95e6f70 | 1998-06-25 02:15:50 +0000 | [diff] [blame] | 231 | debuglevel = 0 |
| 232 | file = None |
| 233 | helo_resp = None |
Martin v. Löwis | 1190a38 | 2007-03-09 15:35:55 +0000 | [diff] [blame] | 234 | ehlo_msg = "ehlo" |
Guido van Rossum | 95e6f70 | 1998-06-25 02:15:50 +0000 | [diff] [blame] | 235 | ehlo_resp = None |
Guido van Rossum | fcfb632 | 1998-08-04 15:29:54 +0000 | [diff] [blame] | 236 | does_esmtp = 0 |
Antoine Pitrou | 21ce8f0 | 2011-05-07 19:59:33 +0200 | [diff] [blame] | 237 | default_port = SMTP_PORT |
Guido van Rossum | 95e6f70 | 1998-06-25 02:15:50 +0000 | [diff] [blame] | 238 | |
Facundo Batista | 4f1b1ed | 2008-05-29 16:39:26 +0000 | [diff] [blame] | 239 | def __init__(self, host='', port=0, local_hostname=None, |
| 240 | timeout=socket._GLOBAL_DEFAULT_TIMEOUT): |
Guido van Rossum | bbe323e | 1998-01-29 17:24:40 +0000 | [diff] [blame] | 241 | """Initialize a new instance. |
| 242 | |
Barry Warsaw | a7d9bdf | 1998-12-22 03:24:27 +0000 | [diff] [blame] | 243 | If specified, `host' is the name of the remote host to which to |
| 244 | connect. If specified, `port' specifies the port to which to connect. |
R David Murray | 2fc97e6 | 2013-04-13 14:37:22 -0400 | [diff] [blame] | 245 | By default, smtplib.SMTP_PORT is used. If a host is specified the |
R David Murray | 9575222 | 2013-06-23 16:10:37 -0400 | [diff] [blame] | 246 | connect method is called, and if it returns anything other than a |
| 247 | success code an SMTPConnectError is raised. If specified, |
R David Murray | 7f01d55 | 2013-06-23 16:02:34 -0400 | [diff] [blame] | 248 | `local_hostname` is used as the FQDN of the local host for the |
R David Murray | 9575222 | 2013-06-23 16:10:37 -0400 | [diff] [blame] | 249 | HELO/EHLO command. Otherwise, the local hostname is found using |
| 250 | socket.getfqdn(). |
Guido van Rossum | bbe323e | 1998-01-29 17:24:40 +0000 | [diff] [blame] | 251 | |
| 252 | """ |
Facundo Batista | 366d626 | 2007-03-28 18:25:54 +0000 | [diff] [blame] | 253 | self.timeout = timeout |
Guido van Rossum | fcfb632 | 1998-08-04 15:29:54 +0000 | [diff] [blame] | 254 | self.esmtp_features = {} |
Guido van Rossum | 296e143 | 1999-04-07 15:03:39 +0000 | [diff] [blame] | 255 | if host: |
| 256 | (code, msg) = self.connect(host, port) |
| 257 | if code != 220: |
Stéphane Wirtel | 779e7c9 | 2017-05-24 20:24:27 +0200 | [diff] [blame^] | 258 | self.close() |
Guido van Rossum | 296e143 | 1999-04-07 15:03:39 +0000 | [diff] [blame] | 259 | raise SMTPConnectError(code, msg) |
Raymond Hettinger | f13eb55 | 2002-06-02 00:40:05 +0000 | [diff] [blame] | 260 | if local_hostname is not None: |
Barry Warsaw | 13e34f7 | 2002-03-26 20:27:35 +0000 | [diff] [blame] | 261 | self.local_hostname = local_hostname |
Neil Schemenauer | 6730f26 | 2002-03-24 15:30:40 +0000 | [diff] [blame] | 262 | else: |
Barry Warsaw | 13e34f7 | 2002-03-26 20:27:35 +0000 | [diff] [blame] | 263 | # RFC 2821 says we should use the fqdn in the EHLO/HELO verb, and |
| 264 | # if that can't be calculated, that we should use a domain literal |
| 265 | # instead (essentially an encoded IP address like [A.B.C.D]). |
| 266 | fqdn = socket.getfqdn() |
| 267 | if '.' in fqdn: |
| 268 | self.local_hostname = fqdn |
| 269 | else: |
| 270 | # We can't find an fqdn hostname, so use a domain literal |
Georg Brandl | dcdfd22 | 2006-03-31 19:34:13 +0000 | [diff] [blame] | 271 | addr = '127.0.0.1' |
| 272 | try: |
| 273 | addr = socket.gethostbyname(socket.gethostname()) |
| 274 | except socket.gaierror: |
| 275 | pass |
Barry Warsaw | 13e34f7 | 2002-03-26 20:27:35 +0000 | [diff] [blame] | 276 | self.local_hostname = '[%s]' % addr |
Tim Peters | 495ad3c | 2001-01-15 01:36:40 +0000 | [diff] [blame] | 277 | |
Guido van Rossum | bbe323e | 1998-01-29 17:24:40 +0000 | [diff] [blame] | 278 | def set_debuglevel(self, debuglevel): |
| 279 | """Set the debug output level. |
| 280 | |
Barry Warsaw | a7d9bdf | 1998-12-22 03:24:27 +0000 | [diff] [blame] | 281 | A non-false value results in debug messages for connection and for all |
| 282 | messages sent to and received from the server. |
Guido van Rossum | bbe323e | 1998-01-29 17:24:40 +0000 | [diff] [blame] | 283 | |
| 284 | """ |
| 285 | self.debuglevel = debuglevel |
| 286 | |
R David Murray | c993a19 | 2013-04-02 12:15:07 -0400 | [diff] [blame] | 287 | def _get_socket(self, host, port, timeout): |
Martin v. Löwis | ee82c0e | 2006-10-27 07:13:28 +0000 | [diff] [blame] | 288 | # This makes it simpler for SMTP_SSL to use the SMTP connect code |
| 289 | # and just alter the socket connection bit. |
Giampaolo Rodolà | 5c12ec6 | 2011-02-24 20:43:11 +0000 | [diff] [blame] | 290 | if self.debuglevel > 0: |
| 291 | print>>stderr, 'connect:', (host, port) |
R David Murray | c993a19 | 2013-04-02 12:15:07 -0400 | [diff] [blame] | 292 | return socket.create_connection((host, port), timeout) |
Martin v. Löwis | ee82c0e | 2006-10-27 07:13:28 +0000 | [diff] [blame] | 293 | |
Giampaolo Rodolà | 5c12ec6 | 2011-02-24 20:43:11 +0000 | [diff] [blame] | 294 | def connect(self, host='localhost', port=0): |
Guido van Rossum | bbe323e | 1998-01-29 17:24:40 +0000 | [diff] [blame] | 295 | """Connect to a host on a given port. |
Guido van Rossum | 95e6f70 | 1998-06-25 02:15:50 +0000 | [diff] [blame] | 296 | |
Barry Warsaw | 4c4bec8 | 1998-12-22 03:02:20 +0000 | [diff] [blame] | 297 | If the hostname ends with a colon (`:') followed by a number, and |
| 298 | there is no port specified, that suffix will be stripped off and the |
| 299 | number interpreted as the port number to use. |
Guido van Rossum | 95e6f70 | 1998-06-25 02:15:50 +0000 | [diff] [blame] | 300 | |
Barry Warsaw | a7d9bdf | 1998-12-22 03:24:27 +0000 | [diff] [blame] | 301 | Note: This method is automatically invoked by __init__, if a host is |
| 302 | specified during instantiation. |
Guido van Rossum | bbe323e | 1998-01-29 17:24:40 +0000 | [diff] [blame] | 303 | |
| 304 | """ |
Martin v. Löwis | 4eb5940 | 2001-07-26 13:37:33 +0000 | [diff] [blame] | 305 | if not port and (host.find(':') == host.rfind(':')): |
Martin v. Löwis | a43c2f8 | 2001-07-24 20:34:08 +0000 | [diff] [blame] | 306 | i = host.rfind(':') |
Guido van Rossum | bbe323e | 1998-01-29 17:24:40 +0000 | [diff] [blame] | 307 | if i >= 0: |
Giampaolo Rodolà | 5c12ec6 | 2011-02-24 20:43:11 +0000 | [diff] [blame] | 308 | host, port = host[:i], host[i + 1:] |
| 309 | try: |
| 310 | port = int(port) |
Eric S. Raymond | 8d87603 | 2001-02-09 10:14:53 +0000 | [diff] [blame] | 311 | except ValueError: |
Guido van Rossum | bbe323e | 1998-01-29 17:24:40 +0000 | [diff] [blame] | 312 | raise socket.error, "nonnumeric port" |
Giampaolo Rodolà | 5c12ec6 | 2011-02-24 20:43:11 +0000 | [diff] [blame] | 313 | if not port: |
| 314 | port = self.default_port |
| 315 | if self.debuglevel > 0: |
| 316 | print>>stderr, 'connect:', (host, port) |
Facundo Batista | 366d626 | 2007-03-28 18:25:54 +0000 | [diff] [blame] | 317 | self.sock = self._get_socket(host, port, self.timeout) |
Martin v. Löwis | a43c2f8 | 2001-07-24 20:34:08 +0000 | [diff] [blame] | 318 | (code, msg) = self.getreply() |
Giampaolo Rodolà | 5c12ec6 | 2011-02-24 20:43:11 +0000 | [diff] [blame] | 319 | if self.debuglevel > 0: |
| 320 | print>>stderr, "connect:", msg |
Martin v. Löwis | a43c2f8 | 2001-07-24 20:34:08 +0000 | [diff] [blame] | 321 | return (code, msg) |
Tim Peters | 495ad3c | 2001-01-15 01:36:40 +0000 | [diff] [blame] | 322 | |
Guido van Rossum | bbe323e | 1998-01-29 17:24:40 +0000 | [diff] [blame] | 323 | def send(self, str): |
| 324 | """Send `str' to the server.""" |
Giampaolo Rodolà | 5c12ec6 | 2011-02-24 20:43:11 +0000 | [diff] [blame] | 325 | if self.debuglevel > 0: |
| 326 | print>>stderr, 'send:', repr(str) |
Facundo Batista | 1660933 | 2008-02-23 12:27:17 +0000 | [diff] [blame] | 327 | if hasattr(self, 'sock') and self.sock: |
Guido van Rossum | 2880f6e | 1998-08-10 20:07:00 +0000 | [diff] [blame] | 328 | try: |
Martin v. Löwis | e12454f | 2002-02-16 23:06:19 +0000 | [diff] [blame] | 329 | self.sock.sendall(str) |
Guido van Rossum | 2880f6e | 1998-08-10 20:07:00 +0000 | [diff] [blame] | 330 | except socket.error: |
Barry Warsaw | 7675097 | 2001-12-14 20:34:20 +0000 | [diff] [blame] | 331 | self.close() |
Guido van Rossum | 40233ea | 1999-01-15 03:23:55 +0000 | [diff] [blame] | 332 | raise SMTPServerDisconnected('Server not connected') |
Guido van Rossum | fc40a83 | 1998-01-29 17:26:45 +0000 | [diff] [blame] | 333 | else: |
Guido van Rossum | 40233ea | 1999-01-15 03:23:55 +0000 | [diff] [blame] | 334 | raise SMTPServerDisconnected('please run connect() first') |
Tim Peters | 495ad3c | 2001-01-15 01:36:40 +0000 | [diff] [blame] | 335 | |
Guido van Rossum | bbe323e | 1998-01-29 17:24:40 +0000 | [diff] [blame] | 336 | def putcmd(self, cmd, args=""): |
Barry Warsaw | a7d9bdf | 1998-12-22 03:24:27 +0000 | [diff] [blame] | 337 | """Send a command to the server.""" |
Guido van Rossum | db23d3d | 1999-06-09 15:13:10 +0000 | [diff] [blame] | 338 | if args == "": |
| 339 | str = '%s%s' % (cmd, CRLF) |
| 340 | else: |
| 341 | str = '%s %s%s' % (cmd, args, CRLF) |
Guido van Rossum | bbe323e | 1998-01-29 17:24:40 +0000 | [diff] [blame] | 342 | self.send(str) |
Tim Peters | 495ad3c | 2001-01-15 01:36:40 +0000 | [diff] [blame] | 343 | |
Guido van Rossum | fcfb632 | 1998-08-04 15:29:54 +0000 | [diff] [blame] | 344 | def getreply(self): |
Guido van Rossum | bbe323e | 1998-01-29 17:24:40 +0000 | [diff] [blame] | 345 | """Get a reply from the server. |
Tim Peters | 495ad3c | 2001-01-15 01:36:40 +0000 | [diff] [blame] | 346 | |
Guido van Rossum | bbe323e | 1998-01-29 17:24:40 +0000 | [diff] [blame] | 347 | Returns a tuple consisting of: |
Barry Warsaw | a7d9bdf | 1998-12-22 03:24:27 +0000 | [diff] [blame] | 348 | |
| 349 | - server response code (e.g. '250', or such, if all goes well) |
| 350 | Note: returns -1 if it can't read response code. |
| 351 | |
| 352 | - server response string corresponding to response code (multiline |
| 353 | responses are converted to a single, multiline string). |
Guido van Rossum | f123f84 | 1999-03-29 20:33:21 +0000 | [diff] [blame] | 354 | |
| 355 | Raises SMTPServerDisconnected if end-of-file is reached. |
Guido van Rossum | bbe323e | 1998-01-29 17:24:40 +0000 | [diff] [blame] | 356 | """ |
Giampaolo Rodolà | 5c12ec6 | 2011-02-24 20:43:11 +0000 | [diff] [blame] | 357 | resp = [] |
Guido van Rossum | 296e143 | 1999-04-07 15:03:39 +0000 | [diff] [blame] | 358 | if self.file is None: |
| 359 | self.file = self.sock.makefile('rb') |
Guido van Rossum | 45e2fbc | 1998-03-26 21:13:24 +0000 | [diff] [blame] | 360 | while 1: |
Kristján Valur Jónsson | 51a035e | 2009-01-15 17:20:21 +0000 | [diff] [blame] | 361 | try: |
Benjamin Peterson | dabfc56 | 2014-12-05 20:05:18 -0500 | [diff] [blame] | 362 | line = self.file.readline(_MAXLINE + 1) |
Antoine Pitrou | 0ad7358 | 2011-08-28 01:18:31 +0200 | [diff] [blame] | 363 | except socket.error as e: |
| 364 | self.close() |
| 365 | raise SMTPServerDisconnected("Connection unexpectedly closed: " |
| 366 | + str(e)) |
Guido van Rossum | 296e143 | 1999-04-07 15:03:39 +0000 | [diff] [blame] | 367 | if line == '': |
| 368 | self.close() |
| 369 | raise SMTPServerDisconnected("Connection unexpectedly closed") |
Giampaolo Rodolà | 5c12ec6 | 2011-02-24 20:43:11 +0000 | [diff] [blame] | 370 | if self.debuglevel > 0: |
| 371 | print>>stderr, 'reply:', repr(line) |
Benjamin Peterson | dabfc56 | 2014-12-05 20:05:18 -0500 | [diff] [blame] | 372 | if len(line) > _MAXLINE: |
| 373 | raise SMTPResponseException(500, "Line too long.") |
Eric S. Raymond | c013f30 | 2001-02-09 05:40:38 +0000 | [diff] [blame] | 374 | resp.append(line[4:].strip()) |
Giampaolo Rodolà | 5c12ec6 | 2011-02-24 20:43:11 +0000 | [diff] [blame] | 375 | code = line[:3] |
Guido van Rossum | 296e143 | 1999-04-07 15:03:39 +0000 | [diff] [blame] | 376 | # Check that the error code is syntactically correct. |
| 377 | # Don't attempt to read a continuation line if it is broken. |
| 378 | try: |
Eric S. Raymond | c013f30 | 2001-02-09 05:40:38 +0000 | [diff] [blame] | 379 | errcode = int(code) |
Guido van Rossum | 296e143 | 1999-04-07 15:03:39 +0000 | [diff] [blame] | 380 | except ValueError: |
| 381 | errcode = -1 |
| 382 | break |
Guido van Rossum | f123f84 | 1999-03-29 20:33:21 +0000 | [diff] [blame] | 383 | # Check if multiline response. |
Giampaolo Rodolà | 5c12ec6 | 2011-02-24 20:43:11 +0000 | [diff] [blame] | 384 | if line[3:4] != "-": |
Guido van Rossum | bbe323e | 1998-01-29 17:24:40 +0000 | [diff] [blame] | 385 | break |
Guido van Rossum | bbe323e | 1998-01-29 17:24:40 +0000 | [diff] [blame] | 386 | |
Eric S. Raymond | c013f30 | 2001-02-09 05:40:38 +0000 | [diff] [blame] | 387 | errmsg = "\n".join(resp) |
Tim Peters | 495ad3c | 2001-01-15 01:36:40 +0000 | [diff] [blame] | 388 | if self.debuglevel > 0: |
Giampaolo Rodolà | 5c12ec6 | 2011-02-24 20:43:11 +0000 | [diff] [blame] | 389 | print>>stderr, 'reply: retcode (%s); Msg: %s' % (errcode, errmsg) |
Guido van Rossum | bbe323e | 1998-01-29 17:24:40 +0000 | [diff] [blame] | 390 | return errcode, errmsg |
Tim Peters | 495ad3c | 2001-01-15 01:36:40 +0000 | [diff] [blame] | 391 | |
Guido van Rossum | bbe323e | 1998-01-29 17:24:40 +0000 | [diff] [blame] | 392 | def docmd(self, cmd, args=""): |
Barry Warsaw | a7d9bdf | 1998-12-22 03:24:27 +0000 | [diff] [blame] | 393 | """Send a command, and return its response code.""" |
Giampaolo Rodolà | 5c12ec6 | 2011-02-24 20:43:11 +0000 | [diff] [blame] | 394 | self.putcmd(cmd, args) |
Guido van Rossum | 296e143 | 1999-04-07 15:03:39 +0000 | [diff] [blame] | 395 | return self.getreply() |
Guido van Rossum | bbe323e | 1998-01-29 17:24:40 +0000 | [diff] [blame] | 396 | |
Barry Warsaw | a7d9bdf | 1998-12-22 03:24:27 +0000 | [diff] [blame] | 397 | # std smtp commands |
Guido van Rossum | bbe323e | 1998-01-29 17:24:40 +0000 | [diff] [blame] | 398 | def helo(self, name=''): |
Barry Warsaw | a7d9bdf | 1998-12-22 03:24:27 +0000 | [diff] [blame] | 399 | """SMTP 'helo' command. |
| 400 | Hostname to send for this command defaults to the FQDN of the local |
| 401 | host. |
| 402 | """ |
Neil Schemenauer | 6730f26 | 2002-03-24 15:30:40 +0000 | [diff] [blame] | 403 | self.putcmd("helo", name or self.local_hostname) |
Giampaolo Rodolà | 5c12ec6 | 2011-02-24 20:43:11 +0000 | [diff] [blame] | 404 | (code, msg) = self.getreply() |
| 405 | self.helo_resp = msg |
| 406 | return (code, msg) |
Guido van Rossum | bbe323e | 1998-01-29 17:24:40 +0000 | [diff] [blame] | 407 | |
Guido van Rossum | 95e6f70 | 1998-06-25 02:15:50 +0000 | [diff] [blame] | 408 | def ehlo(self, name=''): |
Barry Warsaw | a7d9bdf | 1998-12-22 03:24:27 +0000 | [diff] [blame] | 409 | """ SMTP 'ehlo' command. |
| 410 | Hostname to send for this command defaults to the FQDN of the local |
| 411 | host. |
| 412 | """ |
Guido van Rossum | f7fcf5e | 2001-09-14 16:08:44 +0000 | [diff] [blame] | 413 | self.esmtp_features = {} |
Martin v. Löwis | 1190a38 | 2007-03-09 15:35:55 +0000 | [diff] [blame] | 414 | self.putcmd(self.ehlo_msg, name or self.local_hostname) |
Giampaolo Rodolà | 5c12ec6 | 2011-02-24 20:43:11 +0000 | [diff] [blame] | 415 | (code, msg) = self.getreply() |
Tim Peters | 495ad3c | 2001-01-15 01:36:40 +0000 | [diff] [blame] | 416 | # According to RFC1869 some (badly written) |
| 417 | # MTA's will disconnect on an ehlo. Toss an exception if |
Guido van Rossum | fcfb632 | 1998-08-04 15:29:54 +0000 | [diff] [blame] | 418 | # that happens -ddm |
| 419 | if code == -1 and len(msg) == 0: |
Barry Warsaw | 7675097 | 2001-12-14 20:34:20 +0000 | [diff] [blame] | 420 | self.close() |
Guido van Rossum | 40233ea | 1999-01-15 03:23:55 +0000 | [diff] [blame] | 421 | raise SMTPServerDisconnected("Server not connected") |
Giampaolo Rodolà | 5c12ec6 | 2011-02-24 20:43:11 +0000 | [diff] [blame] | 422 | self.ehlo_resp = msg |
Fred Drake | 8152d32 | 2000-12-12 23:20:45 +0000 | [diff] [blame] | 423 | if code != 250: |
Giampaolo Rodolà | 5c12ec6 | 2011-02-24 20:43:11 +0000 | [diff] [blame] | 424 | return (code, msg) |
| 425 | self.does_esmtp = 1 |
Thomas Wouters | 7e47402 | 2000-07-16 12:04:32 +0000 | [diff] [blame] | 426 | #parse the ehlo response -ddm |
Giampaolo Rodolà | 5c12ec6 | 2011-02-24 20:43:11 +0000 | [diff] [blame] | 427 | resp = self.ehlo_resp.split('\n') |
Guido van Rossum | fcfb632 | 1998-08-04 15:29:54 +0000 | [diff] [blame] | 428 | del resp[0] |
Guido van Rossum | 2880f6e | 1998-08-10 20:07:00 +0000 | [diff] [blame] | 429 | for each in resp: |
Piers Lauder | 385a77a | 2002-07-27 00:38:30 +0000 | [diff] [blame] | 430 | # To be able to communicate with as many SMTP servers as possible, |
| 431 | # we have to take the old-style auth advertisement into account, |
| 432 | # because: |
| 433 | # 1) Else our SMTP feature parser gets confused. |
| 434 | # 2) There are some servers that only advertise the auth methods we |
| 435 | # support using the old style. |
| 436 | auth_match = OLDSTYLE_AUTH.match(each) |
| 437 | if auth_match: |
| 438 | # This doesn't remove duplicates, but that's no problem |
| 439 | self.esmtp_features["auth"] = self.esmtp_features.get("auth", "") \ |
| 440 | + " " + auth_match.groups(0)[0] |
| 441 | continue |
| 442 | |
Barry Warsaw | be22ae6 | 2002-04-15 20:03:30 +0000 | [diff] [blame] | 443 | # RFC 1869 requires a space between ehlo keyword and parameters. |
| 444 | # It's actually stricter, in that only spaces are allowed between |
| 445 | # parameters, but were not going to check for that here. Note |
| 446 | # that the space isn't present if there are no parameters. |
Giampaolo Rodolà | 5c12ec6 | 2011-02-24 20:43:11 +0000 | [diff] [blame] | 447 | 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] | 448 | if m: |
Giampaolo Rodolà | 5c12ec6 | 2011-02-24 20:43:11 +0000 | [diff] [blame] | 449 | feature = m.group("feature").lower() |
| 450 | params = m.string[m.end("feature"):].strip() |
Piers Lauder | 385a77a | 2002-07-27 00:38:30 +0000 | [diff] [blame] | 451 | if feature == "auth": |
| 452 | self.esmtp_features[feature] = self.esmtp_features.get(feature, "") \ |
| 453 | + " " + params |
| 454 | else: |
Giampaolo Rodolà | 5c12ec6 | 2011-02-24 20:43:11 +0000 | [diff] [blame] | 455 | self.esmtp_features[feature] = params |
| 456 | return (code, msg) |
Guido van Rossum | 95e6f70 | 1998-06-25 02:15:50 +0000 | [diff] [blame] | 457 | |
Guido van Rossum | fcfb632 | 1998-08-04 15:29:54 +0000 | [diff] [blame] | 458 | def has_extn(self, opt): |
| 459 | """Does the server support a given SMTP service extension?""" |
Raymond Hettinger | 54f0222 | 2002-06-01 14:18:47 +0000 | [diff] [blame] | 460 | return opt.lower() in self.esmtp_features |
Guido van Rossum | 95e6f70 | 1998-06-25 02:15:50 +0000 | [diff] [blame] | 461 | |
Guido van Rossum | 18586f4 | 1998-04-03 17:03:13 +0000 | [diff] [blame] | 462 | def help(self, args=''): |
Barry Warsaw | a7d9bdf | 1998-12-22 03:24:27 +0000 | [diff] [blame] | 463 | """SMTP 'help' command. |
| 464 | Returns help text from server.""" |
Guido van Rossum | 18586f4 | 1998-04-03 17:03:13 +0000 | [diff] [blame] | 465 | self.putcmd("help", args) |
Kurt B. Kaiser | 58bd190 | 2005-06-26 18:27:36 +0000 | [diff] [blame] | 466 | return self.getreply()[1] |
Guido van Rossum | bbe323e | 1998-01-29 17:24:40 +0000 | [diff] [blame] | 467 | |
| 468 | def rset(self): |
Barry Warsaw | a7d9bdf | 1998-12-22 03:24:27 +0000 | [diff] [blame] | 469 | """SMTP 'rset' command -- resets session.""" |
Guido van Rossum | 296e143 | 1999-04-07 15:03:39 +0000 | [diff] [blame] | 470 | return self.docmd("rset") |
Guido van Rossum | bbe323e | 1998-01-29 17:24:40 +0000 | [diff] [blame] | 471 | |
| 472 | def noop(self): |
Barry Warsaw | a7d9bdf | 1998-12-22 03:24:27 +0000 | [diff] [blame] | 473 | """SMTP 'noop' command -- doesn't do anything :>""" |
Guido van Rossum | 296e143 | 1999-04-07 15:03:39 +0000 | [diff] [blame] | 474 | return self.docmd("noop") |
Guido van Rossum | bbe323e | 1998-01-29 17:24:40 +0000 | [diff] [blame] | 475 | |
Giampaolo Rodolà | 5c12ec6 | 2011-02-24 20:43:11 +0000 | [diff] [blame] | 476 | def mail(self, sender, options=[]): |
Barry Warsaw | a7d9bdf | 1998-12-22 03:24:27 +0000 | [diff] [blame] | 477 | """SMTP 'mail' command -- begins mail xfer session.""" |
Guido van Rossum | fcfb632 | 1998-08-04 15:29:54 +0000 | [diff] [blame] | 478 | optionlist = '' |
| 479 | if options and self.does_esmtp: |
Eric S. Raymond | c013f30 | 2001-02-09 05:40:38 +0000 | [diff] [blame] | 480 | optionlist = ' ' + ' '.join(options) |
Giampaolo Rodolà | 5c12ec6 | 2011-02-24 20:43:11 +0000 | [diff] [blame] | 481 | self.putcmd("mail", "FROM:%s%s" % (quoteaddr(sender), optionlist)) |
Guido van Rossum | 45e2fbc | 1998-03-26 21:13:24 +0000 | [diff] [blame] | 482 | return self.getreply() |
Guido van Rossum | bbe323e | 1998-01-29 17:24:40 +0000 | [diff] [blame] | 483 | |
Giampaolo Rodolà | 5c12ec6 | 2011-02-24 20:43:11 +0000 | [diff] [blame] | 484 | def rcpt(self, recip, options=[]): |
Barry Warsaw | a7d9bdf | 1998-12-22 03:24:27 +0000 | [diff] [blame] | 485 | """SMTP 'rcpt' command -- indicates 1 recipient for this mail.""" |
Guido van Rossum | fcfb632 | 1998-08-04 15:29:54 +0000 | [diff] [blame] | 486 | optionlist = '' |
| 487 | if options and self.does_esmtp: |
Eric S. Raymond | c013f30 | 2001-02-09 05:40:38 +0000 | [diff] [blame] | 488 | optionlist = ' ' + ' '.join(options) |
Giampaolo Rodolà | 5c12ec6 | 2011-02-24 20:43:11 +0000 | [diff] [blame] | 489 | self.putcmd("rcpt", "TO:%s%s" % (quoteaddr(recip), optionlist)) |
Guido van Rossum | 45e2fbc | 1998-03-26 21:13:24 +0000 | [diff] [blame] | 490 | return self.getreply() |
Guido van Rossum | bbe323e | 1998-01-29 17:24:40 +0000 | [diff] [blame] | 491 | |
Giampaolo Rodolà | 5c12ec6 | 2011-02-24 20:43:11 +0000 | [diff] [blame] | 492 | def data(self, msg): |
Tim Peters | 495ad3c | 2001-01-15 01:36:40 +0000 | [diff] [blame] | 493 | """SMTP 'DATA' command -- sends message data to server. |
Guido van Rossum | 296e143 | 1999-04-07 15:03:39 +0000 | [diff] [blame] | 494 | |
Barry Warsaw | 4c4bec8 | 1998-12-22 03:02:20 +0000 | [diff] [blame] | 495 | Automatically quotes lines beginning with a period per rfc821. |
Guido van Rossum | 296e143 | 1999-04-07 15:03:39 +0000 | [diff] [blame] | 496 | Raises SMTPDataError if there is an unexpected reply to the |
| 497 | DATA command; the return value from this method is the final |
| 498 | response code received when the all data is sent. |
Barry Warsaw | 4c4bec8 | 1998-12-22 03:02:20 +0000 | [diff] [blame] | 499 | """ |
Guido van Rossum | 45e2fbc | 1998-03-26 21:13:24 +0000 | [diff] [blame] | 500 | self.putcmd("data") |
Giampaolo Rodolà | 5c12ec6 | 2011-02-24 20:43:11 +0000 | [diff] [blame] | 501 | (code, repl) = self.getreply() |
| 502 | if self.debuglevel > 0: |
| 503 | print>>stderr, "data:", (code, repl) |
Fred Drake | 8152d32 | 2000-12-12 23:20:45 +0000 | [diff] [blame] | 504 | if code != 354: |
Giampaolo Rodolà | 5c12ec6 | 2011-02-24 20:43:11 +0000 | [diff] [blame] | 505 | raise SMTPDataError(code, repl) |
Guido van Rossum | 45e2fbc | 1998-03-26 21:13:24 +0000 | [diff] [blame] | 506 | else: |
Guido van Rossum | 20c9228 | 1999-04-21 16:52:20 +0000 | [diff] [blame] | 507 | q = quotedata(msg) |
| 508 | if q[-2:] != CRLF: |
| 509 | q = q + CRLF |
| 510 | q = q + "." + CRLF |
| 511 | self.send(q) |
Giampaolo Rodolà | 5c12ec6 | 2011-02-24 20:43:11 +0000 | [diff] [blame] | 512 | (code, msg) = self.getreply() |
| 513 | if self.debuglevel > 0: |
| 514 | print>>stderr, "data:", (code, msg) |
| 515 | return (code, msg) |
Guido van Rossum | bbe323e | 1998-01-29 17:24:40 +0000 | [diff] [blame] | 516 | |
Guido van Rossum | fcfb632 | 1998-08-04 15:29:54 +0000 | [diff] [blame] | 517 | def verify(self, address): |
Barry Warsaw | a7d9bdf | 1998-12-22 03:24:27 +0000 | [diff] [blame] | 518 | """SMTP 'verify' command -- checks for address validity.""" |
R David Murray | 9522595 | 2011-07-18 21:34:04 -0400 | [diff] [blame] | 519 | self.putcmd("vrfy", _addr_only(address)) |
Guido van Rossum | fcfb632 | 1998-08-04 15:29:54 +0000 | [diff] [blame] | 520 | return self.getreply() |
Barry Warsaw | 4c4bec8 | 1998-12-22 03:02:20 +0000 | [diff] [blame] | 521 | # a.k.a. |
Giampaolo Rodolà | 5c12ec6 | 2011-02-24 20:43:11 +0000 | [diff] [blame] | 522 | vrfy = verify |
Guido van Rossum | fcfb632 | 1998-08-04 15:29:54 +0000 | [diff] [blame] | 523 | |
| 524 | def expn(self, address): |
Facundo Batista | 1660933 | 2008-02-23 12:27:17 +0000 | [diff] [blame] | 525 | """SMTP 'expn' command -- expands a mailing list.""" |
R David Murray | 9522595 | 2011-07-18 21:34:04 -0400 | [diff] [blame] | 526 | self.putcmd("expn", _addr_only(address)) |
Guido van Rossum | fcfb632 | 1998-08-04 15:29:54 +0000 | [diff] [blame] | 527 | return self.getreply() |
| 528 | |
Barry Warsaw | 4c4bec8 | 1998-12-22 03:02:20 +0000 | [diff] [blame] | 529 | # some useful methods |
Guido van Rossum | ae01046 | 2001-09-11 15:57:46 +0000 | [diff] [blame] | 530 | |
Gregory P. Smith | bde4ae4 | 2008-01-17 08:35:49 +0000 | [diff] [blame] | 531 | def ehlo_or_helo_if_needed(self): |
| 532 | """Call self.ehlo() and/or self.helo() if needed. |
| 533 | |
| 534 | If there has been no previous EHLO or HELO command this session, this |
| 535 | method tries ESMTP EHLO first. |
| 536 | |
| 537 | This method may raise the following exceptions: |
| 538 | |
| 539 | SMTPHeloError The server didn't reply properly to |
| 540 | the helo greeting. |
| 541 | """ |
| 542 | if self.helo_resp is None and self.ehlo_resp is None: |
| 543 | if not (200 <= self.ehlo()[0] <= 299): |
| 544 | (code, resp) = self.helo() |
| 545 | if not (200 <= code <= 299): |
| 546 | raise SMTPHeloError(code, resp) |
| 547 | |
Guido van Rossum | ae01046 | 2001-09-11 15:57:46 +0000 | [diff] [blame] | 548 | def login(self, user, password): |
| 549 | """Log in on an SMTP server that requires authentication. |
| 550 | |
| 551 | The arguments are: |
| 552 | - user: The user name to authenticate with. |
| 553 | - password: The password for the authentication. |
| 554 | |
| 555 | If there has been no previous EHLO or HELO command this session, this |
| 556 | method tries ESMTP EHLO first. |
| 557 | |
| 558 | This method will return normally if the authentication was successful. |
| 559 | |
| 560 | This method may raise the following exceptions: |
| 561 | |
| 562 | SMTPHeloError The server didn't reply properly to |
| 563 | the helo greeting. |
| 564 | SMTPAuthenticationError The server didn't accept the username/ |
| 565 | password combination. |
Fred Drake | 2f8f4d3 | 2001-10-13 18:35:32 +0000 | [diff] [blame] | 566 | SMTPException No suitable authentication method was |
Guido van Rossum | ae01046 | 2001-09-11 15:57:46 +0000 | [diff] [blame] | 567 | found. |
| 568 | """ |
| 569 | |
| 570 | def encode_cram_md5(challenge, user, password): |
| 571 | challenge = base64.decodestring(challenge) |
| 572 | response = user + " " + hmac.HMAC(password, challenge).hexdigest() |
Piers Lauder | 385a77a | 2002-07-27 00:38:30 +0000 | [diff] [blame] | 573 | return encode_base64(response, eol="") |
Guido van Rossum | ae01046 | 2001-09-11 15:57:46 +0000 | [diff] [blame] | 574 | |
| 575 | def encode_plain(user, password): |
Johannes Gijsbers | 25946dd | 2004-12-06 21:25:26 +0000 | [diff] [blame] | 576 | return encode_base64("\0%s\0%s" % (user, password), eol="") |
Tim Peters | 469cdad | 2002-08-08 20:19:19 +0000 | [diff] [blame] | 577 | |
Guido van Rossum | ae01046 | 2001-09-11 15:57:46 +0000 | [diff] [blame] | 578 | |
| 579 | AUTH_PLAIN = "PLAIN" |
| 580 | AUTH_CRAM_MD5 = "CRAM-MD5" |
Piers Lauder | 385a77a | 2002-07-27 00:38:30 +0000 | [diff] [blame] | 581 | AUTH_LOGIN = "LOGIN" |
Guido van Rossum | ae01046 | 2001-09-11 15:57:46 +0000 | [diff] [blame] | 582 | |
Gregory P. Smith | bde4ae4 | 2008-01-17 08:35:49 +0000 | [diff] [blame] | 583 | self.ehlo_or_helo_if_needed() |
Guido van Rossum | ae01046 | 2001-09-11 15:57:46 +0000 | [diff] [blame] | 584 | |
| 585 | if not self.has_extn("auth"): |
| 586 | raise SMTPException("SMTP AUTH extension not supported by server.") |
| 587 | |
| 588 | # Authentication methods the server supports: |
| 589 | authlist = self.esmtp_features["auth"].split() |
| 590 | |
| 591 | # List of authentication methods we support: from preferred to |
| 592 | # less preferred methods. Except for the purpose of testing the weaker |
| 593 | # ones, we prefer stronger methods like CRAM-MD5: |
Piers Lauder | 385a77a | 2002-07-27 00:38:30 +0000 | [diff] [blame] | 594 | preferred_auths = [AUTH_CRAM_MD5, AUTH_PLAIN, AUTH_LOGIN] |
Guido van Rossum | ae01046 | 2001-09-11 15:57:46 +0000 | [diff] [blame] | 595 | |
| 596 | # Determine the authentication method we'll use |
| 597 | authmethod = None |
| 598 | for method in preferred_auths: |
| 599 | if method in authlist: |
| 600 | authmethod = method |
| 601 | break |
Tim Peters | b64bec3 | 2001-09-18 02:26:39 +0000 | [diff] [blame] | 602 | |
Guido van Rossum | ae01046 | 2001-09-11 15:57:46 +0000 | [diff] [blame] | 603 | if authmethod == AUTH_CRAM_MD5: |
| 604 | (code, resp) = self.docmd("AUTH", AUTH_CRAM_MD5) |
| 605 | if code == 503: |
| 606 | # 503 == 'Error: already authenticated' |
| 607 | return (code, resp) |
| 608 | (code, resp) = self.docmd(encode_cram_md5(resp, user, password)) |
| 609 | elif authmethod == AUTH_PLAIN: |
Tim Peters | b64bec3 | 2001-09-18 02:26:39 +0000 | [diff] [blame] | 610 | (code, resp) = self.docmd("AUTH", |
Guido van Rossum | ae01046 | 2001-09-11 15:57:46 +0000 | [diff] [blame] | 611 | AUTH_PLAIN + " " + encode_plain(user, password)) |
Piers Lauder | 385a77a | 2002-07-27 00:38:30 +0000 | [diff] [blame] | 612 | elif authmethod == AUTH_LOGIN: |
| 613 | (code, resp) = self.docmd("AUTH", |
| 614 | "%s %s" % (AUTH_LOGIN, encode_base64(user, eol=""))) |
| 615 | if code != 334: |
| 616 | raise SMTPAuthenticationError(code, resp) |
Martin v. Löwis | 49c05d3 | 2002-10-06 17:55:08 +0000 | [diff] [blame] | 617 | (code, resp) = self.docmd(encode_base64(password, eol="")) |
Raymond Hettinger | 7fdfc2d | 2002-05-31 17:49:10 +0000 | [diff] [blame] | 618 | elif authmethod is None: |
Fred Drake | 2f8f4d3 | 2001-10-13 18:35:32 +0000 | [diff] [blame] | 619 | raise SMTPException("No suitable authentication method found.") |
Raymond Hettinger | dbecd93 | 2005-02-06 06:57:08 +0000 | [diff] [blame] | 620 | if code not in (235, 503): |
Guido van Rossum | ae01046 | 2001-09-11 15:57:46 +0000 | [diff] [blame] | 621 | # 235 == 'Authentication successful' |
| 622 | # 503 == 'Error: already authenticated' |
| 623 | raise SMTPAuthenticationError(code, resp) |
| 624 | return (code, resp) |
| 625 | |
Giampaolo Rodolà | 5c12ec6 | 2011-02-24 20:43:11 +0000 | [diff] [blame] | 626 | def starttls(self, keyfile=None, certfile=None): |
Guido van Rossum | f7fcf5e | 2001-09-14 16:08:44 +0000 | [diff] [blame] | 627 | """Puts the connection to the SMTP server into TLS mode. |
Tim Peters | b64bec3 | 2001-09-18 02:26:39 +0000 | [diff] [blame] | 628 | |
Gregory P. Smith | bde4ae4 | 2008-01-17 08:35:49 +0000 | [diff] [blame] | 629 | If there has been no previous EHLO or HELO command this session, this |
| 630 | method tries ESMTP EHLO first. |
| 631 | |
Guido van Rossum | f7fcf5e | 2001-09-14 16:08:44 +0000 | [diff] [blame] | 632 | If the server supports TLS, this will encrypt the rest of the SMTP |
| 633 | session. If you provide the keyfile and certfile parameters, |
| 634 | the identity of the SMTP server and client can be checked. This, |
| 635 | however, depends on whether the socket module really checks the |
| 636 | certificates. |
Gregory P. Smith | bde4ae4 | 2008-01-17 08:35:49 +0000 | [diff] [blame] | 637 | |
| 638 | This method may raise the following exceptions: |
| 639 | |
| 640 | SMTPHeloError The server didn't reply properly to |
| 641 | the helo greeting. |
Guido van Rossum | f7fcf5e | 2001-09-14 16:08:44 +0000 | [diff] [blame] | 642 | """ |
Gregory P. Smith | bde4ae4 | 2008-01-17 08:35:49 +0000 | [diff] [blame] | 643 | self.ehlo_or_helo_if_needed() |
| 644 | if not self.has_extn("starttls"): |
| 645 | raise SMTPException("STARTTLS extension not supported by server.") |
Tim Peters | b64bec3 | 2001-09-18 02:26:39 +0000 | [diff] [blame] | 646 | (resp, reply) = self.docmd("STARTTLS") |
Guido van Rossum | f7fcf5e | 2001-09-14 16:08:44 +0000 | [diff] [blame] | 647 | if resp == 220: |
Bill Janssen | 426ea0a | 2007-08-29 22:35:05 +0000 | [diff] [blame] | 648 | if not _have_ssl: |
| 649 | raise RuntimeError("No SSL support included in this Python") |
Bill Janssen | 98d19da | 2007-09-10 21:51:02 +0000 | [diff] [blame] | 650 | self.sock = ssl.wrap_socket(self.sock, keyfile, certfile) |
Bill Janssen | 426ea0a | 2007-08-29 22:35:05 +0000 | [diff] [blame] | 651 | self.file = SSLFakeFile(self.sock) |
Gregory P. Smith | 63bfc1d | 2008-01-17 07:43:20 +0000 | [diff] [blame] | 652 | # RFC 3207: |
| 653 | # The client MUST discard any knowledge obtained from |
| 654 | # the server, such as the list of SMTP service extensions, |
| 655 | # which was not obtained from the TLS negotiation itself. |
| 656 | self.helo_resp = None |
| 657 | self.ehlo_resp = None |
| 658 | self.esmtp_features = {} |
| 659 | self.does_esmtp = 0 |
Benjamin Peterson | 2e1b7fc | 2016-06-11 13:16:42 -0700 | [diff] [blame] | 660 | else: |
| 661 | # RFC 3207: |
| 662 | # 501 Syntax error (no parameters allowed) |
| 663 | # 454 TLS not available due to temporary reason |
| 664 | raise SMTPResponseException(resp, reply) |
Guido van Rossum | f7fcf5e | 2001-09-14 16:08:44 +0000 | [diff] [blame] | 665 | return (resp, reply) |
Tim Peters | b64bec3 | 2001-09-18 02:26:39 +0000 | [diff] [blame] | 666 | |
Jeremy Hylton | 31bb8ce | 1998-08-13 19:57:46 +0000 | [diff] [blame] | 667 | def sendmail(self, from_addr, to_addrs, msg, mail_options=[], |
Tim Peters | 495ad3c | 2001-01-15 01:36:40 +0000 | [diff] [blame] | 668 | rcpt_options=[]): |
| 669 | """This command performs an entire mail transaction. |
Guido van Rossum | bbe323e | 1998-01-29 17:24:40 +0000 | [diff] [blame] | 670 | |
Tim Peters | 495ad3c | 2001-01-15 01:36:40 +0000 | [diff] [blame] | 671 | The arguments are: |
Barry Warsaw | 4c4bec8 | 1998-12-22 03:02:20 +0000 | [diff] [blame] | 672 | - from_addr : The address sending this mail. |
| 673 | - to_addrs : A list of addresses to send this mail to. A bare |
| 674 | string will be treated as a list with 1 address. |
Tim Peters | 495ad3c | 2001-01-15 01:36:40 +0000 | [diff] [blame] | 675 | - msg : The message to send. |
Barry Warsaw | 4c4bec8 | 1998-12-22 03:02:20 +0000 | [diff] [blame] | 676 | - mail_options : List of ESMTP options (such as 8bitmime) for the |
| 677 | mail command. |
| 678 | - rcpt_options : List of ESMTP options (such as DSN commands) for |
| 679 | all the rcpt commands. |
| 680 | |
| 681 | If there has been no previous EHLO or HELO command this session, this |
| 682 | method tries ESMTP EHLO first. If the server does ESMTP, message size |
| 683 | and each of the specified options will be passed to it. If EHLO |
| 684 | fails, HELO will be tried and ESMTP options suppressed. |
| 685 | |
| 686 | 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] | 687 | one recipient. It returns a dictionary, with one entry for each |
| 688 | recipient that was refused. Each entry contains a tuple of the SMTP |
| 689 | error code and the accompanying error message sent by the server. |
Guido van Rossum | 296e143 | 1999-04-07 15:03:39 +0000 | [diff] [blame] | 690 | |
| 691 | This method may raise the following exceptions: |
| 692 | |
| 693 | SMTPHeloError The server didn't reply properly to |
Tim Peters | 495ad3c | 2001-01-15 01:36:40 +0000 | [diff] [blame] | 694 | the helo greeting. |
Barry Warsaw | d25c1b7 | 1999-11-28 17:11:06 +0000 | [diff] [blame] | 695 | SMTPRecipientsRefused The server rejected ALL recipients |
Guido van Rossum | 296e143 | 1999-04-07 15:03:39 +0000 | [diff] [blame] | 696 | (no mail was sent). |
| 697 | SMTPSenderRefused The server didn't accept the from_addr. |
| 698 | SMTPDataError The server replied with an unexpected |
| 699 | error code (other than a refusal of |
| 700 | a recipient). |
| 701 | |
| 702 | 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] | 703 | |
Guido van Rossum | 95e6f70 | 1998-06-25 02:15:50 +0000 | [diff] [blame] | 704 | Example: |
Tim Peters | 495ad3c | 2001-01-15 01:36:40 +0000 | [diff] [blame] | 705 | |
Guido van Rossum | bbe323e | 1998-01-29 17:24:40 +0000 | [diff] [blame] | 706 | >>> import smtplib |
| 707 | >>> s=smtplib.SMTP("localhost") |
Guido van Rossum | fc40a83 | 1998-01-29 17:26:45 +0000 | [diff] [blame] | 708 | >>> 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] | 709 | >>> msg = '''\\ |
Guido van Rossum | bbe323e | 1998-01-29 17:24:40 +0000 | [diff] [blame] | 710 | ... From: Me@my.org |
| 711 | ... Subject: testin'... |
| 712 | ... |
| 713 | ... This is a test ''' |
| 714 | >>> s.sendmail("me@my.org",tolist,msg) |
| 715 | { "three@three.org" : ( 550 ,"User unknown" ) } |
| 716 | >>> s.quit() |
Tim Peters | 495ad3c | 2001-01-15 01:36:40 +0000 | [diff] [blame] | 717 | |
Barry Warsaw | 4c4bec8 | 1998-12-22 03:02:20 +0000 | [diff] [blame] | 718 | In the above example, the message was accepted for delivery to three |
| 719 | of the four addresses, and one was rejected, with the error code |
Barry Warsaw | d25c1b7 | 1999-11-28 17:11:06 +0000 | [diff] [blame] | 720 | 550. If all addresses are accepted, then the method will return an |
Barry Warsaw | 4c4bec8 | 1998-12-22 03:02:20 +0000 | [diff] [blame] | 721 | empty dictionary. |
| 722 | |
| 723 | """ |
Gregory P. Smith | bde4ae4 | 2008-01-17 08:35:49 +0000 | [diff] [blame] | 724 | self.ehlo_or_helo_if_needed() |
Guido van Rossum | 95e6f70 | 1998-06-25 02:15:50 +0000 | [diff] [blame] | 725 | esmtp_opts = [] |
Guido van Rossum | fcfb632 | 1998-08-04 15:29:54 +0000 | [diff] [blame] | 726 | if self.does_esmtp: |
| 727 | # Hmmm? what's this? -ddm |
| 728 | # self.esmtp_features['7bit']="" |
| 729 | if self.has_extn('size'): |
Walter Dörwald | 70a6b49 | 2004-02-12 17:35:32 +0000 | [diff] [blame] | 730 | esmtp_opts.append("size=%d" % len(msg)) |
Guido van Rossum | fcfb632 | 1998-08-04 15:29:54 +0000 | [diff] [blame] | 731 | for option in mail_options: |
Guido van Rossum | 95e6f70 | 1998-06-25 02:15:50 +0000 | [diff] [blame] | 732 | esmtp_opts.append(option) |
Guido van Rossum | fcfb632 | 1998-08-04 15:29:54 +0000 | [diff] [blame] | 733 | |
Giampaolo Rodolà | 5c12ec6 | 2011-02-24 20:43:11 +0000 | [diff] [blame] | 734 | (code, resp) = self.mail(from_addr, esmtp_opts) |
Fred Drake | 8152d32 | 2000-12-12 23:20:45 +0000 | [diff] [blame] | 735 | if code != 250: |
Guido van Rossum | 45e2fbc | 1998-03-26 21:13:24 +0000 | [diff] [blame] | 736 | self.rset() |
Guido van Rossum | 296e143 | 1999-04-07 15:03:39 +0000 | [diff] [blame] | 737 | raise SMTPSenderRefused(code, resp, from_addr) |
Giampaolo Rodolà | 5c12ec6 | 2011-02-24 20:43:11 +0000 | [diff] [blame] | 738 | senderrs = {} |
Walter Dörwald | 65230a2 | 2002-06-03 15:58:32 +0000 | [diff] [blame] | 739 | if isinstance(to_addrs, basestring): |
Jeremy Hylton | 31bb8ce | 1998-08-13 19:57:46 +0000 | [diff] [blame] | 740 | to_addrs = [to_addrs] |
Guido van Rossum | bbe323e | 1998-01-29 17:24:40 +0000 | [diff] [blame] | 741 | for each in to_addrs: |
Giampaolo Rodolà | 5c12ec6 | 2011-02-24 20:43:11 +0000 | [diff] [blame] | 742 | (code, resp) = self.rcpt(each, rcpt_options) |
Fred Drake | 8152d32 | 2000-12-12 23:20:45 +0000 | [diff] [blame] | 743 | if (code != 250) and (code != 251): |
Giampaolo Rodolà | 5c12ec6 | 2011-02-24 20:43:11 +0000 | [diff] [blame] | 744 | senderrs[each] = (code, resp) |
| 745 | if len(senderrs) == len(to_addrs): |
Guido van Rossum | 95e6f70 | 1998-06-25 02:15:50 +0000 | [diff] [blame] | 746 | # the server refused all our recipients |
Guido van Rossum | bbe323e | 1998-01-29 17:24:40 +0000 | [diff] [blame] | 747 | self.rset() |
Guido van Rossum | 296e143 | 1999-04-07 15:03:39 +0000 | [diff] [blame] | 748 | raise SMTPRecipientsRefused(senderrs) |
Giampaolo Rodolà | 5c12ec6 | 2011-02-24 20:43:11 +0000 | [diff] [blame] | 749 | (code, resp) = self.data(msg) |
Fred Drake | 8152d32 | 2000-12-12 23:20:45 +0000 | [diff] [blame] | 750 | if code != 250: |
Guido van Rossum | bbe323e | 1998-01-29 17:24:40 +0000 | [diff] [blame] | 751 | self.rset() |
Guido van Rossum | 296e143 | 1999-04-07 15:03:39 +0000 | [diff] [blame] | 752 | raise SMTPDataError(code, resp) |
Guido van Rossum | bbe323e | 1998-01-29 17:24:40 +0000 | [diff] [blame] | 753 | #if we got here then somebody got our mail |
Tim Peters | 495ad3c | 2001-01-15 01:36:40 +0000 | [diff] [blame] | 754 | return senderrs |
Guido van Rossum | bbe323e | 1998-01-29 17:24:40 +0000 | [diff] [blame] | 755 | |
| 756 | |
| 757 | def close(self): |
| 758 | """Close the connection to the SMTP server.""" |
Serhiy Storchaka | 1aa2c0f | 2015-04-10 13:24:10 +0300 | [diff] [blame] | 759 | try: |
| 760 | file = self.file |
| 761 | self.file = None |
| 762 | if file: |
| 763 | file.close() |
| 764 | finally: |
| 765 | sock = self.sock |
| 766 | self.sock = None |
| 767 | if sock: |
| 768 | sock.close() |
Guido van Rossum | bbe323e | 1998-01-29 17:24:40 +0000 | [diff] [blame] | 769 | |
| 770 | |
| 771 | def quit(self): |
Guido van Rossum | 95e6f70 | 1998-06-25 02:15:50 +0000 | [diff] [blame] | 772 | """Terminate the SMTP session.""" |
Georg Brandl | deaf2ca | 2008-03-27 13:27:31 +0000 | [diff] [blame] | 773 | res = self.docmd("quit") |
R David Murray | 7234e03 | 2014-08-30 16:56:49 -0400 | [diff] [blame] | 774 | # A new EHLO is required after reconnecting with connect() |
| 775 | self.ehlo_resp = self.helo_resp = None |
| 776 | self.esmtp_features = {} |
| 777 | self.does_esmtp = False |
Guido van Rossum | 45e2fbc | 1998-03-26 21:13:24 +0000 | [diff] [blame] | 778 | self.close() |
Georg Brandl | deaf2ca | 2008-03-27 13:27:31 +0000 | [diff] [blame] | 779 | return res |
Guido van Rossum | 95e6f70 | 1998-06-25 02:15:50 +0000 | [diff] [blame] | 780 | |
Bill Janssen | 426ea0a | 2007-08-29 22:35:05 +0000 | [diff] [blame] | 781 | if _have_ssl: |
Martin v. Löwis | ee82c0e | 2006-10-27 07:13:28 +0000 | [diff] [blame] | 782 | |
Bill Janssen | 426ea0a | 2007-08-29 22:35:05 +0000 | [diff] [blame] | 783 | class SMTP_SSL(SMTP): |
R David Murray | 9575222 | 2013-06-23 16:10:37 -0400 | [diff] [blame] | 784 | """ This is a subclass derived from SMTP that connects over an SSL |
| 785 | encrypted socket (to use this class you need a socket module that was |
| 786 | compiled with SSL support). If host is not specified, '' (the local |
| 787 | host) is used. If port is omitted, the standard SMTP-over-SSL port |
| 788 | (465) is used. local_hostname has the same meaning as it does in the |
| 789 | SMTP class. keyfile and certfile are also optional - they can contain |
| 790 | a PEM formatted private key and certificate chain file for the SSL |
| 791 | connection. |
| 792 | |
Bill Janssen | 426ea0a | 2007-08-29 22:35:05 +0000 | [diff] [blame] | 793 | """ |
Antoine Pitrou | 21ce8f0 | 2011-05-07 19:59:33 +0200 | [diff] [blame] | 794 | |
| 795 | default_port = SMTP_SSL_PORT |
| 796 | |
Bill Janssen | 426ea0a | 2007-08-29 22:35:05 +0000 | [diff] [blame] | 797 | def __init__(self, host='', port=0, local_hostname=None, |
Facundo Batista | 4f1b1ed | 2008-05-29 16:39:26 +0000 | [diff] [blame] | 798 | keyfile=None, certfile=None, |
| 799 | timeout=socket._GLOBAL_DEFAULT_TIMEOUT): |
Bill Janssen | 426ea0a | 2007-08-29 22:35:05 +0000 | [diff] [blame] | 800 | self.keyfile = keyfile |
| 801 | self.certfile = certfile |
| 802 | SMTP.__init__(self, host, port, local_hostname, timeout) |
Bill Janssen | 426ea0a | 2007-08-29 22:35:05 +0000 | [diff] [blame] | 803 | |
| 804 | def _get_socket(self, host, port, timeout): |
Giampaolo Rodolà | 5c12ec6 | 2011-02-24 20:43:11 +0000 | [diff] [blame] | 805 | if self.debuglevel > 0: |
| 806 | print>>stderr, 'connect:', (host, port) |
R. David Murray | ad3058e | 2009-05-23 00:48:58 +0000 | [diff] [blame] | 807 | new_socket = socket.create_connection((host, port), timeout) |
| 808 | new_socket = ssl.wrap_socket(new_socket, self.keyfile, self.certfile) |
| 809 | self.file = SSLFakeFile(new_socket) |
| 810 | return new_socket |
Barry Warsaw | 4c4bec8 | 1998-12-22 03:02:20 +0000 | [diff] [blame] | 811 | |
Thomas Wouters | a6900e8 | 2007-08-30 21:54:39 +0000 | [diff] [blame] | 812 | __all__.append("SMTP_SSL") |
| 813 | |
Martin v. Löwis | 1190a38 | 2007-03-09 15:35:55 +0000 | [diff] [blame] | 814 | # |
| 815 | # LMTP extension |
| 816 | # |
| 817 | LMTP_PORT = 2003 |
| 818 | |
| 819 | class LMTP(SMTP): |
| 820 | """LMTP - Local Mail Transfer Protocol |
| 821 | |
| 822 | The LMTP protocol, which is very similar to ESMTP, is heavily based |
R David Murray | 9575222 | 2013-06-23 16:10:37 -0400 | [diff] [blame] | 823 | on the standard SMTP client. It's common to use Unix sockets for |
| 824 | LMTP, so our connect() method must support that as well as a regular |
| 825 | host:port server. local_hostname has the same meaning as it does in |
| 826 | the SMTP class. To specify a Unix socket, you must use an absolute |
Martin v. Löwis | 1190a38 | 2007-03-09 15:35:55 +0000 | [diff] [blame] | 827 | path as the host, starting with a '/'. |
| 828 | |
| 829 | Authentication is supported, using the regular SMTP mechanism. When |
| 830 | using a Unix socket, LMTP generally don't support or require any |
| 831 | authentication, but your mileage might vary.""" |
| 832 | |
| 833 | ehlo_msg = "lhlo" |
Tim Peters | ea5962f | 2007-03-12 18:07:52 +0000 | [diff] [blame] | 834 | |
Giampaolo Rodolà | 5c12ec6 | 2011-02-24 20:43:11 +0000 | [diff] [blame] | 835 | def __init__(self, host='', port=LMTP_PORT, local_hostname=None): |
Martin v. Löwis | 1190a38 | 2007-03-09 15:35:55 +0000 | [diff] [blame] | 836 | """Initialize a new instance.""" |
| 837 | SMTP.__init__(self, host, port, local_hostname) |
| 838 | |
Giampaolo Rodolà | 5c12ec6 | 2011-02-24 20:43:11 +0000 | [diff] [blame] | 839 | def connect(self, host='localhost', port=0): |
Martin v. Löwis | 1190a38 | 2007-03-09 15:35:55 +0000 | [diff] [blame] | 840 | """Connect to the LMTP daemon, on either a Unix or a TCP socket.""" |
Neal Norwitz | c8f6c23 | 2007-03-10 03:19:18 +0000 | [diff] [blame] | 841 | if host[0] != '/': |
Martin v. Löwis | 1190a38 | 2007-03-09 15:35:55 +0000 | [diff] [blame] | 842 | return SMTP.connect(self, host, port) |
| 843 | |
Neal Norwitz | c8f6c23 | 2007-03-10 03:19:18 +0000 | [diff] [blame] | 844 | # Handle Unix-domain sockets. |
| 845 | try: |
| 846 | self.sock = socket.socket(socket.AF_UNIX, socket.SOCK_STREAM) |
| 847 | self.sock.connect(host) |
Andrew Svetlov | ed3f6c6 | 2012-12-17 19:06:43 +0200 | [diff] [blame] | 848 | except socket.error: |
Giampaolo Rodolà | 5c12ec6 | 2011-02-24 20:43:11 +0000 | [diff] [blame] | 849 | if self.debuglevel > 0: |
| 850 | print>>stderr, 'connect fail:', host |
Neal Norwitz | c8f6c23 | 2007-03-10 03:19:18 +0000 | [diff] [blame] | 851 | if self.sock: |
| 852 | self.sock.close() |
| 853 | self.sock = None |
Andrew Svetlov | ed3f6c6 | 2012-12-17 19:06:43 +0200 | [diff] [blame] | 854 | raise |
Neal Norwitz | c8f6c23 | 2007-03-10 03:19:18 +0000 | [diff] [blame] | 855 | (code, msg) = self.getreply() |
Giampaolo Rodolà | 5c12ec6 | 2011-02-24 20:43:11 +0000 | [diff] [blame] | 856 | if self.debuglevel > 0: |
| 857 | print>>stderr, "connect:", msg |
Neal Norwitz | c8f6c23 | 2007-03-10 03:19:18 +0000 | [diff] [blame] | 858 | return (code, msg) |
| 859 | |
Martin v. Löwis | 1190a38 | 2007-03-09 15:35:55 +0000 | [diff] [blame] | 860 | |
Guido van Rossum | 95e6f70 | 1998-06-25 02:15:50 +0000 | [diff] [blame] | 861 | # Test the sendmail method, which tests most of the others. |
| 862 | # Note: This always sends to localhost. |
| 863 | if __name__ == '__main__': |
Andrew M. Kuchling | 6be424f | 2001-08-13 14:41:39 +0000 | [diff] [blame] | 864 | import sys |
Guido van Rossum | 95e6f70 | 1998-06-25 02:15:50 +0000 | [diff] [blame] | 865 | |
| 866 | def prompt(prompt): |
| 867 | sys.stdout.write(prompt + ": ") |
Eric S. Raymond | c013f30 | 2001-02-09 05:40:38 +0000 | [diff] [blame] | 868 | return sys.stdin.readline().strip() |
Guido van Rossum | 95e6f70 | 1998-06-25 02:15:50 +0000 | [diff] [blame] | 869 | |
| 870 | fromaddr = prompt("From") |
Giampaolo Rodolà | 5c12ec6 | 2011-02-24 20:43:11 +0000 | [diff] [blame] | 871 | toaddrs = prompt("To").split(',') |
Guido van Rossum | 95e6f70 | 1998-06-25 02:15:50 +0000 | [diff] [blame] | 872 | print "Enter message, end with ^D:" |
| 873 | msg = '' |
| 874 | while 1: |
| 875 | line = sys.stdin.readline() |
| 876 | if not line: |
| 877 | break |
| 878 | msg = msg + line |
Walter Dörwald | 70a6b49 | 2004-02-12 17:35:32 +0000 | [diff] [blame] | 879 | print "Message length is %d" % len(msg) |
Guido van Rossum | 95e6f70 | 1998-06-25 02:15:50 +0000 | [diff] [blame] | 880 | |
| 881 | server = SMTP('localhost') |
| 882 | server.set_debuglevel(1) |
| 883 | server.sendmail(fromaddr, toaddrs, msg) |
| 884 | server.quit() |