blob: 1af127f0675bc61236af8f6ccb26acece877efaf [file] [log] [blame]
Barry Warsaw4c4bec81998-12-22 03:02:20 +00001#! /usr/bin/env python
2
Barry Warsawa1ae8842000-07-09 21:24:31 +00003'''SMTP/ESMTP client class.
Guido van Rossumbbe323e1998-01-29 17:24:40 +00004
Guido van Rossumf7fcf5e2001-09-14 16:08:44 +00005This should follow RFC 821 (SMTP), RFC 1869 (ESMTP), RFC 2554 (SMTP
6Authentication) and RFC 2487 (Secure SMTP over TLS).
Guido van Rossumbbe323e1998-01-29 17:24:40 +00007
Guido van Rossumfcfb6321998-08-04 15:29:54 +00008Notes:
9
10Please remember, when doing ESMTP, that the names of the SMTP service
Barry Warsaw4c4bec81998-12-22 03:02:20 +000011extensions are NOT the same thing as the option keywords for the RCPT
Guido van Rossumfcfb6321998-08-04 15:29:54 +000012and MAIL commands!
13
Guido van Rossumbbe323e1998-01-29 17:24:40 +000014Example:
15
Barry Warsawa7d9bdf1998-12-22 03:24:27 +000016 >>> 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 Warsawa1ae8842000-07-09 21:24:31 +000033'''
Guido van Rossumbbe323e1998-01-29 17:24:40 +000034
Guido van Rossum98d9fd32000-02-28 15:12:25 +000035# 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 Rossumae010462001-09-11 15:57:46 +000040# RFC 2554 (authentication) support by Gerhard Haering <gerhard@bigfoot.de>.
Tim Peters495ad3c2001-01-15 01:36:40 +000041#
Guido van Rossum98d9fd32000-02-28 15:12:25 +000042# This was modified from the Python 1.5 library HTTP lib.
43
Guido van Rossumbbe323e1998-01-29 17:24:40 +000044import socket
Barry Warsaw07201771998-12-22 20:37:36 +000045import re
Guido van Rossumfcfb6321998-08-04 15:29:54 +000046import rfc822
Guido van Rossumae010462001-09-11 15:57:46 +000047import base64
48import hmac
Piers Lauder385a77a2002-07-27 00:38:30 +000049from email.base64MIME import encode as encode_base64
Guido van Rossumbbe323e1998-01-29 17:24:40 +000050
Skip Montanaro0de65802001-02-15 22:15:14 +000051__all__ = ["SMTPException","SMTPServerDisconnected","SMTPResponseException",
52 "SMTPSenderRefused","SMTPRecipientsRefused","SMTPDataError",
Guido van Rossumae010462001-09-11 15:57:46 +000053 "SMTPConnectError","SMTPHeloError","SMTPAuthenticationError",
54 "quoteaddr","quotedata","SMTP"]
Skip Montanaro0de65802001-02-15 22:15:14 +000055
Guido van Rossumbbe323e1998-01-29 17:24:40 +000056SMTP_PORT = 25
57CRLF="\r\n"
58
Piers Lauder385a77a2002-07-27 00:38:30 +000059OLDSTYLE_AUTH = re.compile(r"auth=(.*)", re.I)
60
Tim Peters495ad3c2001-01-15 01:36:40 +000061# Exception classes used by this module.
Guido van Rossum296e1431999-04-07 15:03:39 +000062class SMTPException(Exception):
63 """Base class for all exceptions raised by this module."""
64
65class SMTPServerDisconnected(SMTPException):
66 """Not connected to any SMTP server.
67
68 This exception is raised when the server unexpectedly disconnects,
69 or when an attempt is made to use the SMTP instance before
70 connecting it to a server.
71 """
72
73class SMTPResponseException(SMTPException):
74 """Base class for all exceptions that include an SMTP error code.
75
76 These exceptions are generated in some instances when the SMTP
77 server returns an error code. The error code is stored in the
78 `smtp_code' attribute of the error, and the `smtp_error' attribute
79 is set to the error message.
80 """
81
82 def __init__(self, code, msg):
83 self.smtp_code = code
84 self.smtp_error = msg
85 self.args = (code, msg)
86
87class SMTPSenderRefused(SMTPResponseException):
88 """Sender address refused.
Guido van Rossumae010462001-09-11 15:57:46 +000089
Guido van Rossum296e1431999-04-07 15:03:39 +000090 In addition to the attributes set by on all SMTPResponseException
Barry Warsawd25c1b71999-11-28 17:11:06 +000091 exceptions, this sets `sender' to the string that the SMTP refused.
Guido van Rossum296e1431999-04-07 15:03:39 +000092 """
93
94 def __init__(self, code, msg, sender):
95 self.smtp_code = code
96 self.smtp_error = msg
97 self.sender = sender
98 self.args = (code, msg, sender)
99
Guido van Rossum20c92281999-04-21 16:52:20 +0000100class SMTPRecipientsRefused(SMTPException):
Barry Warsawd25c1b71999-11-28 17:11:06 +0000101 """All recipient addresses refused.
Guido van Rossumae010462001-09-11 15:57:46 +0000102
Thomas Wouters7e474022000-07-16 12:04:32 +0000103 The errors for each recipient are accessible through the attribute
Tim Peters495ad3c2001-01-15 01:36:40 +0000104 'recipients', which is a dictionary of exactly the same sort as
105 SMTP.sendmail() returns.
Guido van Rossum296e1431999-04-07 15:03:39 +0000106 """
107
108 def __init__(self, recipients):
109 self.recipients = recipients
110 self.args = ( recipients,)
111
112
Guido van Rossum296e1431999-04-07 15:03:39 +0000113class SMTPDataError(SMTPResponseException):
114 """The SMTP server didn't accept the data."""
115
116class SMTPConnectError(SMTPResponseException):
Barry Warsawd25c1b71999-11-28 17:11:06 +0000117 """Error during connection establishment."""
Guido van Rossum296e1431999-04-07 15:03:39 +0000118
119class SMTPHeloError(SMTPResponseException):
Barry Warsawd25c1b71999-11-28 17:11:06 +0000120 """The server refused our HELO reply."""
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000121
Guido van Rossumae010462001-09-11 15:57:46 +0000122class SMTPAuthenticationError(SMTPResponseException):
123 """Authentication error.
124
125 Most probably the server didn't accept the username/password
126 combination provided.
127 """
Peter Schneider-Kamp7bc82bb2000-08-10 14:02:23 +0000128
Guido van Rossumf7fcf5e2001-09-14 16:08:44 +0000129class SSLFakeSocket:
130 """A fake socket object that really wraps a SSLObject.
Tim Petersb64bec32001-09-18 02:26:39 +0000131
Guido van Rossumf7fcf5e2001-09-14 16:08:44 +0000132 It only supports what is needed in smtplib.
133 """
134 def __init__(self, realsock, sslobj):
135 self.realsock = realsock
136 self.sslobj = sslobj
137
138 def send(self, str):
139 self.sslobj.write(str)
140 return len(str)
141
Martin v. Löwis9ea6c192002-06-02 12:33:22 +0000142 sendall = send
143
Guido van Rossumf7fcf5e2001-09-14 16:08:44 +0000144 def close(self):
145 self.realsock.close()
146
147class SSLFakeFile:
148 """A fake file like object that really wraps a SSLObject.
Tim Petersb64bec32001-09-18 02:26:39 +0000149
Guido van Rossumf7fcf5e2001-09-14 16:08:44 +0000150 It only supports what is needed in smtplib.
151 """
152 def __init__( self, sslobj):
153 self.sslobj = sslobj
154
155 def readline(self):
156 str = ""
157 chr = None
158 while chr != "\n":
159 chr = self.sslobj.read(1)
160 str += chr
161 return str
162
163 def close(self):
164 pass
165
Guido van Rossum69a79bc1998-07-13 15:18:49 +0000166def quoteaddr(addr):
167 """Quote a subset of the email addresses defined by RFC 821.
168
Barry Warsawa7d9bdf1998-12-22 03:24:27 +0000169 Should be able to handle anything rfc822.parseaddr can handle.
170 """
Raymond Hettinger342456d2002-09-05 01:14:07 +0000171 m = (None, None)
Guido van Rossum69a79bc1998-07-13 15:18:49 +0000172 try:
Guido van Rossumfcfb6321998-08-04 15:29:54 +0000173 m=rfc822.parseaddr(addr)[1]
174 except AttributeError:
175 pass
Raymond Hettinger342456d2002-09-05 01:14:07 +0000176 if m == (None, None): # Indicates parse failure or AttributeError
Guido van Rossumfcfb6321998-08-04 15:29:54 +0000177 #something weird here.. punt -ddm
Raymond Hettinger342456d2002-09-05 01:14:07 +0000178 return "<%s>" % addr
Guido van Rossumfcfb6321998-08-04 15:29:54 +0000179 else:
180 return "<%s>" % m
Guido van Rossum69a79bc1998-07-13 15:18:49 +0000181
182def quotedata(data):
183 """Quote data for email.
184
Barry Warsawd25c1b71999-11-28 17:11:06 +0000185 Double leading '.', and change Unix newline '\\n', or Mac '\\r' into
Barry Warsawa7d9bdf1998-12-22 03:24:27 +0000186 Internet CRLF end-of-line.
187 """
Guido van Rossum69a79bc1998-07-13 15:18:49 +0000188 return re.sub(r'(?m)^\.', '..',
Guido van Rossumfcfb6321998-08-04 15:29:54 +0000189 re.sub(r'(?:\r\n|\n|\r(?!\n))', CRLF, data))
Guido van Rossum69a79bc1998-07-13 15:18:49 +0000190
Peter Schneider-Kamp7bc82bb2000-08-10 14:02:23 +0000191
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000192class SMTP:
Guido van Rossumfcfb6321998-08-04 15:29:54 +0000193 """This class manages a connection to an SMTP or ESMTP server.
194 SMTP Objects:
Tim Peters495ad3c2001-01-15 01:36:40 +0000195 SMTP objects have the following attributes:
196 helo_resp
197 This is the message given by the server in response to the
Guido van Rossumfcfb6321998-08-04 15:29:54 +0000198 most recent HELO command.
Tim Peters495ad3c2001-01-15 01:36:40 +0000199
Guido van Rossumfcfb6321998-08-04 15:29:54 +0000200 ehlo_resp
Tim Peters495ad3c2001-01-15 01:36:40 +0000201 This is the message given by the server in response to the
Guido van Rossumfcfb6321998-08-04 15:29:54 +0000202 most recent EHLO command. This is usually multiline.
203
Tim Peters495ad3c2001-01-15 01:36:40 +0000204 does_esmtp
Guido van Rossumfcfb6321998-08-04 15:29:54 +0000205 This is a True value _after you do an EHLO command_, if the
206 server supports ESMTP.
207
Tim Peters495ad3c2001-01-15 01:36:40 +0000208 esmtp_features
Guido van Rossumfcfb6321998-08-04 15:29:54 +0000209 This is a dictionary, which, if the server supports ESMTP,
Barry Warsawd25c1b71999-11-28 17:11:06 +0000210 will _after you do an EHLO command_, contain the names of the
211 SMTP service extensions this server supports, and their
Guido van Rossumfcfb6321998-08-04 15:29:54 +0000212 parameters (if any).
Barry Warsawd25c1b71999-11-28 17:11:06 +0000213
Tim Peters495ad3c2001-01-15 01:36:40 +0000214 Note, all extension names are mapped to lower case in the
215 dictionary.
Guido van Rossumfcfb6321998-08-04 15:29:54 +0000216
Barry Warsawd25c1b71999-11-28 17:11:06 +0000217 See each method's docstrings for details. In general, there is a
218 method of the same name to perform each SMTP command. There is also a
219 method called 'sendmail' that will do an entire mail transaction.
220 """
Guido van Rossum95e6f701998-06-25 02:15:50 +0000221 debuglevel = 0
222 file = None
223 helo_resp = None
224 ehlo_resp = None
Guido van Rossumfcfb6321998-08-04 15:29:54 +0000225 does_esmtp = 0
Guido van Rossum95e6f701998-06-25 02:15:50 +0000226
Neil Schemenauer6730f262002-03-24 15:30:40 +0000227 def __init__(self, host = '', port = 0, local_hostname = None):
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000228 """Initialize a new instance.
229
Barry Warsawa7d9bdf1998-12-22 03:24:27 +0000230 If specified, `host' is the name of the remote host to which to
231 connect. If specified, `port' specifies the port to which to connect.
Barry Warsawd25c1b71999-11-28 17:11:06 +0000232 By default, smtplib.SMTP_PORT is used. An SMTPConnectError is raised
Neil Schemenauer6730f262002-03-24 15:30:40 +0000233 if the specified `host' doesn't respond correctly. If specified,
Tim Peters863ac442002-04-16 01:38:40 +0000234 `local_hostname` is used as the FQDN of the local host. By default,
235 the local hostname is found using socket.getfqdn().
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000236
237 """
Guido van Rossumfcfb6321998-08-04 15:29:54 +0000238 self.esmtp_features = {}
Guido van Rossum296e1431999-04-07 15:03:39 +0000239 if host:
240 (code, msg) = self.connect(host, port)
241 if code != 220:
242 raise SMTPConnectError(code, msg)
Raymond Hettingerf13eb552002-06-02 00:40:05 +0000243 if local_hostname is not None:
Barry Warsaw13e34f72002-03-26 20:27:35 +0000244 self.local_hostname = local_hostname
Neil Schemenauer6730f262002-03-24 15:30:40 +0000245 else:
Barry Warsaw13e34f72002-03-26 20:27:35 +0000246 # RFC 2821 says we should use the fqdn in the EHLO/HELO verb, and
247 # if that can't be calculated, that we should use a domain literal
248 # instead (essentially an encoded IP address like [A.B.C.D]).
249 fqdn = socket.getfqdn()
250 if '.' in fqdn:
251 self.local_hostname = fqdn
252 else:
253 # We can't find an fqdn hostname, so use a domain literal
254 addr = socket.gethostbyname(socket.gethostname())
255 self.local_hostname = '[%s]' % addr
Tim Peters495ad3c2001-01-15 01:36:40 +0000256
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000257 def set_debuglevel(self, debuglevel):
258 """Set the debug output level.
259
Barry Warsawa7d9bdf1998-12-22 03:24:27 +0000260 A non-false value results in debug messages for connection and for all
261 messages sent to and received from the server.
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000262
263 """
264 self.debuglevel = debuglevel
265
266 def connect(self, host='localhost', port = 0):
267 """Connect to a host on a given port.
Guido van Rossum95e6f701998-06-25 02:15:50 +0000268
Barry Warsaw4c4bec81998-12-22 03:02:20 +0000269 If the hostname ends with a colon (`:') followed by a number, and
270 there is no port specified, that suffix will be stripped off and the
271 number interpreted as the port number to use.
Guido van Rossum95e6f701998-06-25 02:15:50 +0000272
Barry Warsawa7d9bdf1998-12-22 03:24:27 +0000273 Note: This method is automatically invoked by __init__, if a host is
274 specified during instantiation.
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000275
276 """
Martin v. Löwis4eb59402001-07-26 13:37:33 +0000277 if not port and (host.find(':') == host.rfind(':')):
Martin v. Löwisa43c2f82001-07-24 20:34:08 +0000278 i = host.rfind(':')
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000279 if i >= 0:
280 host, port = host[:i], host[i+1:]
Eric S. Raymondc013f302001-02-09 05:40:38 +0000281 try: port = int(port)
Eric S. Raymond8d876032001-02-09 10:14:53 +0000282 except ValueError:
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000283 raise socket.error, "nonnumeric port"
284 if not port: port = SMTP_PORT
Martin v. Löwis4eb59402001-07-26 13:37:33 +0000285 if self.debuglevel > 0: print 'connect:', (host, port)
Martin v. Löwis2ad25692001-07-31 08:40:21 +0000286 msg = "getaddrinfo returns an empty list"
Martin v. Löwis322c0d12001-10-07 08:53:32 +0000287 self.sock = None
Martin v. Löwis4eb59402001-07-26 13:37:33 +0000288 for res in socket.getaddrinfo(host, port, 0, socket.SOCK_STREAM):
289 af, socktype, proto, canonname, sa = res
290 try:
291 self.sock = socket.socket(af, socktype, proto)
292 if self.debuglevel > 0: print 'connect:', (host, port)
293 self.sock.connect(sa)
294 except socket.error, msg:
295 if self.debuglevel > 0: print 'connect fail:', (host, port)
Martin v. Löwis322c0d12001-10-07 08:53:32 +0000296 if self.sock:
297 self.sock.close()
Martin v. Löwis4eb59402001-07-26 13:37:33 +0000298 self.sock = None
299 continue
300 break
301 if not self.sock:
302 raise socket.error, msg
Martin v. Löwisa43c2f82001-07-24 20:34:08 +0000303 (code, msg) = self.getreply()
304 if self.debuglevel > 0: print "connect:", msg
305 return (code, msg)
Tim Peters495ad3c2001-01-15 01:36:40 +0000306
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000307 def send(self, str):
308 """Send `str' to the server."""
309 if self.debuglevel > 0: print 'send:', `str`
Guido van Rossum45e2fbc1998-03-26 21:13:24 +0000310 if self.sock:
Guido van Rossum2880f6e1998-08-10 20:07:00 +0000311 try:
Martin v. Löwise12454f2002-02-16 23:06:19 +0000312 self.sock.sendall(str)
Guido van Rossum2880f6e1998-08-10 20:07:00 +0000313 except socket.error:
Barry Warsaw76750972001-12-14 20:34:20 +0000314 self.close()
Guido van Rossum40233ea1999-01-15 03:23:55 +0000315 raise SMTPServerDisconnected('Server not connected')
Guido van Rossumfc40a831998-01-29 17:26:45 +0000316 else:
Guido van Rossum40233ea1999-01-15 03:23:55 +0000317 raise SMTPServerDisconnected('please run connect() first')
Tim Peters495ad3c2001-01-15 01:36:40 +0000318
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000319 def putcmd(self, cmd, args=""):
Barry Warsawa7d9bdf1998-12-22 03:24:27 +0000320 """Send a command to the server."""
Guido van Rossumdb23d3d1999-06-09 15:13:10 +0000321 if args == "":
322 str = '%s%s' % (cmd, CRLF)
323 else:
324 str = '%s %s%s' % (cmd, args, CRLF)
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000325 self.send(str)
Tim Peters495ad3c2001-01-15 01:36:40 +0000326
Guido van Rossumfcfb6321998-08-04 15:29:54 +0000327 def getreply(self):
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000328 """Get a reply from the server.
Tim Peters495ad3c2001-01-15 01:36:40 +0000329
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000330 Returns a tuple consisting of:
Barry Warsawa7d9bdf1998-12-22 03:24:27 +0000331
332 - server response code (e.g. '250', or such, if all goes well)
333 Note: returns -1 if it can't read response code.
334
335 - server response string corresponding to response code (multiline
336 responses are converted to a single, multiline string).
Guido van Rossumf123f841999-03-29 20:33:21 +0000337
338 Raises SMTPServerDisconnected if end-of-file is reached.
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000339 """
340 resp=[]
Guido van Rossum296e1431999-04-07 15:03:39 +0000341 if self.file is None:
342 self.file = self.sock.makefile('rb')
Guido van Rossum45e2fbc1998-03-26 21:13:24 +0000343 while 1:
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000344 line = self.file.readline()
Guido van Rossum296e1431999-04-07 15:03:39 +0000345 if line == '':
346 self.close()
347 raise SMTPServerDisconnected("Connection unexpectedly closed")
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000348 if self.debuglevel > 0: print 'reply:', `line`
Eric S. Raymondc013f302001-02-09 05:40:38 +0000349 resp.append(line[4:].strip())
Guido van Rossum45e2fbc1998-03-26 21:13:24 +0000350 code=line[:3]
Guido van Rossum296e1431999-04-07 15:03:39 +0000351 # Check that the error code is syntactically correct.
352 # Don't attempt to read a continuation line if it is broken.
353 try:
Eric S. Raymondc013f302001-02-09 05:40:38 +0000354 errcode = int(code)
Guido van Rossum296e1431999-04-07 15:03:39 +0000355 except ValueError:
356 errcode = -1
357 break
Guido van Rossumf123f841999-03-29 20:33:21 +0000358 # Check if multiline response.
Guido van Rossum45e2fbc1998-03-26 21:13:24 +0000359 if line[3:4]!="-":
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000360 break
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000361
Eric S. Raymondc013f302001-02-09 05:40:38 +0000362 errmsg = "\n".join(resp)
Tim Peters495ad3c2001-01-15 01:36:40 +0000363 if self.debuglevel > 0:
Guido van Rossumfc40a831998-01-29 17:26:45 +0000364 print 'reply: retcode (%s); Msg: %s' % (errcode,errmsg)
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000365 return errcode, errmsg
Tim Peters495ad3c2001-01-15 01:36:40 +0000366
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000367 def docmd(self, cmd, args=""):
Barry Warsawa7d9bdf1998-12-22 03:24:27 +0000368 """Send a command, and return its response code."""
Guido van Rossum45e2fbc1998-03-26 21:13:24 +0000369 self.putcmd(cmd,args)
Guido van Rossum296e1431999-04-07 15:03:39 +0000370 return self.getreply()
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000371
Barry Warsawa7d9bdf1998-12-22 03:24:27 +0000372 # std smtp commands
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000373 def helo(self, name=''):
Barry Warsawa7d9bdf1998-12-22 03:24:27 +0000374 """SMTP 'helo' command.
375 Hostname to send for this command defaults to the FQDN of the local
376 host.
377 """
Neil Schemenauer6730f262002-03-24 15:30:40 +0000378 self.putcmd("helo", name or self.local_hostname)
Guido van Rossum45e2fbc1998-03-26 21:13:24 +0000379 (code,msg)=self.getreply()
380 self.helo_resp=msg
Guido van Rossum296e1431999-04-07 15:03:39 +0000381 return (code,msg)
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000382
Guido van Rossum95e6f701998-06-25 02:15:50 +0000383 def ehlo(self, name=''):
Barry Warsawa7d9bdf1998-12-22 03:24:27 +0000384 """ SMTP 'ehlo' command.
385 Hostname to send for this command defaults to the FQDN of the local
386 host.
387 """
Guido van Rossumf7fcf5e2001-09-14 16:08:44 +0000388 self.esmtp_features = {}
Neil Schemenauer6730f262002-03-24 15:30:40 +0000389 self.putcmd("ehlo", name or self.local_hostname)
Guido van Rossumfcfb6321998-08-04 15:29:54 +0000390 (code,msg)=self.getreply()
Tim Peters495ad3c2001-01-15 01:36:40 +0000391 # According to RFC1869 some (badly written)
392 # MTA's will disconnect on an ehlo. Toss an exception if
Guido van Rossumfcfb6321998-08-04 15:29:54 +0000393 # that happens -ddm
394 if code == -1 and len(msg) == 0:
Barry Warsaw76750972001-12-14 20:34:20 +0000395 self.close()
Guido van Rossum40233ea1999-01-15 03:23:55 +0000396 raise SMTPServerDisconnected("Server not connected")
Guido van Rossum95e6f701998-06-25 02:15:50 +0000397 self.ehlo_resp=msg
Fred Drake8152d322000-12-12 23:20:45 +0000398 if code != 250:
Guido van Rossum296e1431999-04-07 15:03:39 +0000399 return (code,msg)
Guido van Rossumfcfb6321998-08-04 15:29:54 +0000400 self.does_esmtp=1
Thomas Wouters7e474022000-07-16 12:04:32 +0000401 #parse the ehlo response -ddm
Eric S. Raymondc013f302001-02-09 05:40:38 +0000402 resp=self.ehlo_resp.split('\n')
Guido van Rossumfcfb6321998-08-04 15:29:54 +0000403 del resp[0]
Guido van Rossum2880f6e1998-08-10 20:07:00 +0000404 for each in resp:
Piers Lauder385a77a2002-07-27 00:38:30 +0000405 # To be able to communicate with as many SMTP servers as possible,
406 # we have to take the old-style auth advertisement into account,
407 # because:
408 # 1) Else our SMTP feature parser gets confused.
409 # 2) There are some servers that only advertise the auth methods we
410 # support using the old style.
411 auth_match = OLDSTYLE_AUTH.match(each)
412 if auth_match:
413 # This doesn't remove duplicates, but that's no problem
414 self.esmtp_features["auth"] = self.esmtp_features.get("auth", "") \
415 + " " + auth_match.groups(0)[0]
416 continue
417
Barry Warsawbe22ae62002-04-15 20:03:30 +0000418 # RFC 1869 requires a space between ehlo keyword and parameters.
419 # It's actually stricter, in that only spaces are allowed between
420 # parameters, but were not going to check for that here. Note
421 # that the space isn't present if there are no parameters.
422 m=re.match(r'(?P<feature>[A-Za-z0-9][A-Za-z0-9\-]*) ?',each)
Guido van Rossumfcfb6321998-08-04 15:29:54 +0000423 if m:
Eric S. Raymondc013f302001-02-09 05:40:38 +0000424 feature=m.group("feature").lower()
425 params=m.string[m.end("feature"):].strip()
Piers Lauder385a77a2002-07-27 00:38:30 +0000426 if feature == "auth":
427 self.esmtp_features[feature] = self.esmtp_features.get(feature, "") \
428 + " " + params
429 else:
430 self.esmtp_features[feature]=params
Guido van Rossum296e1431999-04-07 15:03:39 +0000431 return (code,msg)
Guido van Rossum95e6f701998-06-25 02:15:50 +0000432
Guido van Rossumfcfb6321998-08-04 15:29:54 +0000433 def has_extn(self, opt):
434 """Does the server support a given SMTP service extension?"""
Raymond Hettinger54f02222002-06-01 14:18:47 +0000435 return opt.lower() in self.esmtp_features
Guido van Rossum95e6f701998-06-25 02:15:50 +0000436
Guido van Rossum18586f41998-04-03 17:03:13 +0000437 def help(self, args=''):
Barry Warsawa7d9bdf1998-12-22 03:24:27 +0000438 """SMTP 'help' command.
439 Returns help text from server."""
Guido van Rossum18586f41998-04-03 17:03:13 +0000440 self.putcmd("help", args)
Guido van Rossum296e1431999-04-07 15:03:39 +0000441 return self.getreply()
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000442
443 def rset(self):
Barry Warsawa7d9bdf1998-12-22 03:24:27 +0000444 """SMTP 'rset' command -- resets session."""
Guido van Rossum296e1431999-04-07 15:03:39 +0000445 return self.docmd("rset")
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000446
447 def noop(self):
Barry Warsawa7d9bdf1998-12-22 03:24:27 +0000448 """SMTP 'noop' command -- doesn't do anything :>"""
Guido van Rossum296e1431999-04-07 15:03:39 +0000449 return self.docmd("noop")
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000450
Guido van Rossum95e6f701998-06-25 02:15:50 +0000451 def mail(self,sender,options=[]):
Barry Warsawa7d9bdf1998-12-22 03:24:27 +0000452 """SMTP 'mail' command -- begins mail xfer session."""
Guido van Rossumfcfb6321998-08-04 15:29:54 +0000453 optionlist = ''
454 if options and self.does_esmtp:
Eric S. Raymondc013f302001-02-09 05:40:38 +0000455 optionlist = ' ' + ' '.join(options)
Guido van Rossumdb23d3d1999-06-09 15:13:10 +0000456 self.putcmd("mail", "FROM:%s%s" % (quoteaddr(sender) ,optionlist))
Guido van Rossum45e2fbc1998-03-26 21:13:24 +0000457 return self.getreply()
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000458
Guido van Rossumfcfb6321998-08-04 15:29:54 +0000459 def rcpt(self,recip,options=[]):
Barry Warsawa7d9bdf1998-12-22 03:24:27 +0000460 """SMTP 'rcpt' command -- indicates 1 recipient for this mail."""
Guido van Rossumfcfb6321998-08-04 15:29:54 +0000461 optionlist = ''
462 if options and self.does_esmtp:
Eric S. Raymondc013f302001-02-09 05:40:38 +0000463 optionlist = ' ' + ' '.join(options)
Guido van Rossum348fd061999-01-14 04:18:46 +0000464 self.putcmd("rcpt","TO:%s%s" % (quoteaddr(recip),optionlist))
Guido van Rossum45e2fbc1998-03-26 21:13:24 +0000465 return self.getreply()
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000466
467 def data(self,msg):
Tim Peters495ad3c2001-01-15 01:36:40 +0000468 """SMTP 'DATA' command -- sends message data to server.
Guido van Rossum296e1431999-04-07 15:03:39 +0000469
Barry Warsaw4c4bec81998-12-22 03:02:20 +0000470 Automatically quotes lines beginning with a period per rfc821.
Guido van Rossum296e1431999-04-07 15:03:39 +0000471 Raises SMTPDataError if there is an unexpected reply to the
472 DATA command; the return value from this method is the final
473 response code received when the all data is sent.
Barry Warsaw4c4bec81998-12-22 03:02:20 +0000474 """
Guido van Rossum45e2fbc1998-03-26 21:13:24 +0000475 self.putcmd("data")
476 (code,repl)=self.getreply()
477 if self.debuglevel >0 : print "data:", (code,repl)
Fred Drake8152d322000-12-12 23:20:45 +0000478 if code != 354:
Guido van Rossum296e1431999-04-07 15:03:39 +0000479 raise SMTPDataError(code,repl)
Guido van Rossum45e2fbc1998-03-26 21:13:24 +0000480 else:
Guido van Rossum20c92281999-04-21 16:52:20 +0000481 q = quotedata(msg)
482 if q[-2:] != CRLF:
483 q = q + CRLF
484 q = q + "." + CRLF
485 self.send(q)
Guido van Rossum45e2fbc1998-03-26 21:13:24 +0000486 (code,msg)=self.getreply()
487 if self.debuglevel >0 : print "data:", (code,msg)
Guido van Rossum296e1431999-04-07 15:03:39 +0000488 return (code,msg)
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000489
Guido van Rossumfcfb6321998-08-04 15:29:54 +0000490 def verify(self, address):
Barry Warsawa7d9bdf1998-12-22 03:24:27 +0000491 """SMTP 'verify' command -- checks for address validity."""
Guido van Rossumfcfb6321998-08-04 15:29:54 +0000492 self.putcmd("vrfy", quoteaddr(address))
493 return self.getreply()
Barry Warsaw4c4bec81998-12-22 03:02:20 +0000494 # a.k.a.
495 vrfy=verify
Guido van Rossumfcfb6321998-08-04 15:29:54 +0000496
497 def expn(self, address):
Barry Warsawa7d9bdf1998-12-22 03:24:27 +0000498 """SMTP 'verify' command -- checks for address validity."""
Guido van Rossumfcfb6321998-08-04 15:29:54 +0000499 self.putcmd("expn", quoteaddr(address))
500 return self.getreply()
501
Barry Warsaw4c4bec81998-12-22 03:02:20 +0000502 # some useful methods
Guido van Rossumae010462001-09-11 15:57:46 +0000503
504 def login(self, user, password):
505 """Log in on an SMTP server that requires authentication.
506
507 The arguments are:
508 - user: The user name to authenticate with.
509 - password: The password for the authentication.
510
511 If there has been no previous EHLO or HELO command this session, this
512 method tries ESMTP EHLO first.
513
514 This method will return normally if the authentication was successful.
515
516 This method may raise the following exceptions:
517
518 SMTPHeloError The server didn't reply properly to
519 the helo greeting.
520 SMTPAuthenticationError The server didn't accept the username/
521 password combination.
Fred Drake2f8f4d32001-10-13 18:35:32 +0000522 SMTPException No suitable authentication method was
Guido van Rossumae010462001-09-11 15:57:46 +0000523 found.
524 """
525
526 def encode_cram_md5(challenge, user, password):
527 challenge = base64.decodestring(challenge)
528 response = user + " " + hmac.HMAC(password, challenge).hexdigest()
Piers Lauder385a77a2002-07-27 00:38:30 +0000529 return encode_base64(response, eol="")
Guido van Rossumae010462001-09-11 15:57:46 +0000530
531 def encode_plain(user, password):
Piers Lauder385a77a2002-07-27 00:38:30 +0000532 return encode_base64("%s\0%s\0%s" % (user, user, password), eol="")
Tim Peters469cdad2002-08-08 20:19:19 +0000533
Guido van Rossumae010462001-09-11 15:57:46 +0000534
535 AUTH_PLAIN = "PLAIN"
536 AUTH_CRAM_MD5 = "CRAM-MD5"
Piers Lauder385a77a2002-07-27 00:38:30 +0000537 AUTH_LOGIN = "LOGIN"
Guido van Rossumae010462001-09-11 15:57:46 +0000538
539 if self.helo_resp is None and self.ehlo_resp is None:
540 if not (200 <= self.ehlo()[0] <= 299):
541 (code, resp) = self.helo()
542 if not (200 <= code <= 299):
543 raise SMTPHeloError(code, resp)
544
545 if not self.has_extn("auth"):
546 raise SMTPException("SMTP AUTH extension not supported by server.")
547
548 # Authentication methods the server supports:
549 authlist = self.esmtp_features["auth"].split()
550
551 # List of authentication methods we support: from preferred to
552 # less preferred methods. Except for the purpose of testing the weaker
553 # ones, we prefer stronger methods like CRAM-MD5:
Piers Lauder385a77a2002-07-27 00:38:30 +0000554 preferred_auths = [AUTH_CRAM_MD5, AUTH_PLAIN, AUTH_LOGIN]
Guido van Rossumae010462001-09-11 15:57:46 +0000555
556 # Determine the authentication method we'll use
557 authmethod = None
558 for method in preferred_auths:
559 if method in authlist:
560 authmethod = method
561 break
Tim Petersb64bec32001-09-18 02:26:39 +0000562
Guido van Rossumae010462001-09-11 15:57:46 +0000563 if authmethod == AUTH_CRAM_MD5:
564 (code, resp) = self.docmd("AUTH", AUTH_CRAM_MD5)
565 if code == 503:
566 # 503 == 'Error: already authenticated'
567 return (code, resp)
568 (code, resp) = self.docmd(encode_cram_md5(resp, user, password))
569 elif authmethod == AUTH_PLAIN:
Tim Petersb64bec32001-09-18 02:26:39 +0000570 (code, resp) = self.docmd("AUTH",
Guido van Rossumae010462001-09-11 15:57:46 +0000571 AUTH_PLAIN + " " + encode_plain(user, password))
Piers Lauder385a77a2002-07-27 00:38:30 +0000572 elif authmethod == AUTH_LOGIN:
573 (code, resp) = self.docmd("AUTH",
574 "%s %s" % (AUTH_LOGIN, encode_base64(user, eol="")))
575 if code != 334:
576 raise SMTPAuthenticationError(code, resp)
Martin v. Löwis49c05d32002-10-06 17:55:08 +0000577 (code, resp) = self.docmd(encode_base64(password, eol=""))
Raymond Hettinger7fdfc2d2002-05-31 17:49:10 +0000578 elif authmethod is None:
Fred Drake2f8f4d32001-10-13 18:35:32 +0000579 raise SMTPException("No suitable authentication method found.")
Guido van Rossumae010462001-09-11 15:57:46 +0000580 if code not in [235, 503]:
581 # 235 == 'Authentication successful'
582 # 503 == 'Error: already authenticated'
583 raise SMTPAuthenticationError(code, resp)
584 return (code, resp)
585
Guido van Rossumf7fcf5e2001-09-14 16:08:44 +0000586 def starttls(self, keyfile = None, certfile = None):
587 """Puts the connection to the SMTP server into TLS mode.
Tim Petersb64bec32001-09-18 02:26:39 +0000588
Guido van Rossumf7fcf5e2001-09-14 16:08:44 +0000589 If the server supports TLS, this will encrypt the rest of the SMTP
590 session. If you provide the keyfile and certfile parameters,
591 the identity of the SMTP server and client can be checked. This,
592 however, depends on whether the socket module really checks the
593 certificates.
594 """
Tim Petersb64bec32001-09-18 02:26:39 +0000595 (resp, reply) = self.docmd("STARTTLS")
Guido van Rossumf7fcf5e2001-09-14 16:08:44 +0000596 if resp == 220:
597 sslobj = socket.ssl(self.sock, keyfile, certfile)
598 self.sock = SSLFakeSocket(self.sock, sslobj)
599 self.file = SSLFakeFile(sslobj)
600 return (resp, reply)
Tim Petersb64bec32001-09-18 02:26:39 +0000601
Jeremy Hylton31bb8ce1998-08-13 19:57:46 +0000602 def sendmail(self, from_addr, to_addrs, msg, mail_options=[],
Tim Peters495ad3c2001-01-15 01:36:40 +0000603 rcpt_options=[]):
604 """This command performs an entire mail transaction.
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000605
Tim Peters495ad3c2001-01-15 01:36:40 +0000606 The arguments are:
Barry Warsaw4c4bec81998-12-22 03:02:20 +0000607 - from_addr : The address sending this mail.
608 - to_addrs : A list of addresses to send this mail to. A bare
609 string will be treated as a list with 1 address.
Tim Peters495ad3c2001-01-15 01:36:40 +0000610 - msg : The message to send.
Barry Warsaw4c4bec81998-12-22 03:02:20 +0000611 - mail_options : List of ESMTP options (such as 8bitmime) for the
612 mail command.
613 - rcpt_options : List of ESMTP options (such as DSN commands) for
614 all the rcpt commands.
615
616 If there has been no previous EHLO or HELO command this session, this
617 method tries ESMTP EHLO first. If the server does ESMTP, message size
618 and each of the specified options will be passed to it. If EHLO
619 fails, HELO will be tried and ESMTP options suppressed.
620
621 This method will return normally if the mail is accepted for at least
Barry Warsawd25c1b71999-11-28 17:11:06 +0000622 one recipient. It returns a dictionary, with one entry for each
623 recipient that was refused. Each entry contains a tuple of the SMTP
624 error code and the accompanying error message sent by the server.
Guido van Rossum296e1431999-04-07 15:03:39 +0000625
626 This method may raise the following exceptions:
627
628 SMTPHeloError The server didn't reply properly to
Tim Peters495ad3c2001-01-15 01:36:40 +0000629 the helo greeting.
Barry Warsawd25c1b71999-11-28 17:11:06 +0000630 SMTPRecipientsRefused The server rejected ALL recipients
Guido van Rossum296e1431999-04-07 15:03:39 +0000631 (no mail was sent).
632 SMTPSenderRefused The server didn't accept the from_addr.
633 SMTPDataError The server replied with an unexpected
634 error code (other than a refusal of
635 a recipient).
636
637 Note: the connection will be open even after an exception is raised.
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000638
Guido van Rossum95e6f701998-06-25 02:15:50 +0000639 Example:
Tim Peters495ad3c2001-01-15 01:36:40 +0000640
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000641 >>> import smtplib
642 >>> s=smtplib.SMTP("localhost")
Guido van Rossumfc40a831998-01-29 17:26:45 +0000643 >>> tolist=["one@one.org","two@two.org","three@three.org","four@four.org"]
Martin v. Löwis301b1cd2002-07-28 16:52:01 +0000644 >>> msg = '''\\
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000645 ... From: Me@my.org
646 ... Subject: testin'...
647 ...
648 ... This is a test '''
649 >>> s.sendmail("me@my.org",tolist,msg)
650 { "three@three.org" : ( 550 ,"User unknown" ) }
651 >>> s.quit()
Tim Peters495ad3c2001-01-15 01:36:40 +0000652
Barry Warsaw4c4bec81998-12-22 03:02:20 +0000653 In the above example, the message was accepted for delivery to three
654 of the four addresses, and one was rejected, with the error code
Barry Warsawd25c1b71999-11-28 17:11:06 +0000655 550. If all addresses are accepted, then the method will return an
Barry Warsaw4c4bec81998-12-22 03:02:20 +0000656 empty dictionary.
657
658 """
Guido van Rossum296e1431999-04-07 15:03:39 +0000659 if self.helo_resp is None and self.ehlo_resp is None:
660 if not (200 <= self.ehlo()[0] <= 299):
661 (code,resp) = self.helo()
662 if not (200 <= code <= 299):
663 raise SMTPHeloError(code, resp)
Guido van Rossum95e6f701998-06-25 02:15:50 +0000664 esmtp_opts = []
Guido van Rossumfcfb6321998-08-04 15:29:54 +0000665 if self.does_esmtp:
666 # Hmmm? what's this? -ddm
667 # self.esmtp_features['7bit']=""
668 if self.has_extn('size'):
669 esmtp_opts.append("size=" + `len(msg)`)
670 for option in mail_options:
Guido van Rossum95e6f701998-06-25 02:15:50 +0000671 esmtp_opts.append(option)
Guido van Rossumfcfb6321998-08-04 15:29:54 +0000672
Guido van Rossum95e6f701998-06-25 02:15:50 +0000673 (code,resp) = self.mail(from_addr, esmtp_opts)
Fred Drake8152d322000-12-12 23:20:45 +0000674 if code != 250:
Guido van Rossum45e2fbc1998-03-26 21:13:24 +0000675 self.rset()
Guido van Rossum296e1431999-04-07 15:03:39 +0000676 raise SMTPSenderRefused(code, resp, from_addr)
Guido van Rossum45e2fbc1998-03-26 21:13:24 +0000677 senderrs={}
Walter Dörwald65230a22002-06-03 15:58:32 +0000678 if isinstance(to_addrs, basestring):
Jeremy Hylton31bb8ce1998-08-13 19:57:46 +0000679 to_addrs = [to_addrs]
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000680 for each in to_addrs:
Guido van Rossumfcfb6321998-08-04 15:29:54 +0000681 (code,resp)=self.rcpt(each, rcpt_options)
Fred Drake8152d322000-12-12 23:20:45 +0000682 if (code != 250) and (code != 251):
Guido van Rossumfc40a831998-01-29 17:26:45 +0000683 senderrs[each]=(code,resp)
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000684 if len(senderrs)==len(to_addrs):
Guido van Rossum95e6f701998-06-25 02:15:50 +0000685 # the server refused all our recipients
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000686 self.rset()
Guido van Rossum296e1431999-04-07 15:03:39 +0000687 raise SMTPRecipientsRefused(senderrs)
Fred Drake8152d322000-12-12 23:20:45 +0000688 (code,resp) = self.data(msg)
689 if code != 250:
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000690 self.rset()
Guido van Rossum296e1431999-04-07 15:03:39 +0000691 raise SMTPDataError(code, resp)
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000692 #if we got here then somebody got our mail
Tim Peters495ad3c2001-01-15 01:36:40 +0000693 return senderrs
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000694
695
696 def close(self):
697 """Close the connection to the SMTP server."""
698 if self.file:
699 self.file.close()
700 self.file = None
701 if self.sock:
702 self.sock.close()
703 self.sock = None
704
705
706 def quit(self):
Guido van Rossum95e6f701998-06-25 02:15:50 +0000707 """Terminate the SMTP session."""
Guido van Rossum45e2fbc1998-03-26 21:13:24 +0000708 self.docmd("quit")
709 self.close()
Guido van Rossum95e6f701998-06-25 02:15:50 +0000710
Barry Warsaw4c4bec81998-12-22 03:02:20 +0000711
Guido van Rossum95e6f701998-06-25 02:15:50 +0000712# Test the sendmail method, which tests most of the others.
713# Note: This always sends to localhost.
714if __name__ == '__main__':
Andrew M. Kuchling6be424f2001-08-13 14:41:39 +0000715 import sys
Guido van Rossum95e6f701998-06-25 02:15:50 +0000716
717 def prompt(prompt):
718 sys.stdout.write(prompt + ": ")
Eric S. Raymondc013f302001-02-09 05:40:38 +0000719 return sys.stdin.readline().strip()
Guido van Rossum95e6f701998-06-25 02:15:50 +0000720
721 fromaddr = prompt("From")
Eric S. Raymond38151ed2001-02-09 07:40:17 +0000722 toaddrs = prompt("To").split(',')
Guido van Rossum95e6f701998-06-25 02:15:50 +0000723 print "Enter message, end with ^D:"
724 msg = ''
725 while 1:
726 line = sys.stdin.readline()
727 if not line:
728 break
729 msg = msg + line
730 print "Message length is " + `len(msg)`
731
732 server = SMTP('localhost')
733 server.set_debuglevel(1)
734 server.sendmail(fromaddr, toaddrs, msg)
735 server.quit()