blob: 0695840df78f7da11b5b4fa7546149a67baab7d2 [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
Jeremy Hylton31bb8ce1998-08-13 19:57:46 +000047import types
Guido van Rossumae010462001-09-11 15:57:46 +000048import base64
49import hmac
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
Tim Peters495ad3c2001-01-15 01:36:40 +000059# Exception classes used by this module.
Guido van Rossum296e1431999-04-07 15:03:39 +000060class SMTPException(Exception):
61 """Base class for all exceptions raised by this module."""
62
63class SMTPServerDisconnected(SMTPException):
64 """Not connected to any SMTP server.
65
66 This exception is raised when the server unexpectedly disconnects,
67 or when an attempt is made to use the SMTP instance before
68 connecting it to a server.
69 """
70
71class SMTPResponseException(SMTPException):
72 """Base class for all exceptions that include an SMTP error code.
73
74 These exceptions are generated in some instances when the SMTP
75 server returns an error code. The error code is stored in the
76 `smtp_code' attribute of the error, and the `smtp_error' attribute
77 is set to the error message.
78 """
79
80 def __init__(self, code, msg):
81 self.smtp_code = code
82 self.smtp_error = msg
83 self.args = (code, msg)
84
85class SMTPSenderRefused(SMTPResponseException):
86 """Sender address refused.
Guido van Rossumae010462001-09-11 15:57:46 +000087
Guido van Rossum296e1431999-04-07 15:03:39 +000088 In addition to the attributes set by on all SMTPResponseException
Barry Warsawd25c1b71999-11-28 17:11:06 +000089 exceptions, this sets `sender' to the string that the SMTP refused.
Guido van Rossum296e1431999-04-07 15:03:39 +000090 """
91
92 def __init__(self, code, msg, sender):
93 self.smtp_code = code
94 self.smtp_error = msg
95 self.sender = sender
96 self.args = (code, msg, sender)
97
Guido van Rossum20c92281999-04-21 16:52:20 +000098class SMTPRecipientsRefused(SMTPException):
Barry Warsawd25c1b71999-11-28 17:11:06 +000099 """All recipient addresses refused.
Guido van Rossumae010462001-09-11 15:57:46 +0000100
Thomas Wouters7e474022000-07-16 12:04:32 +0000101 The errors for each recipient are accessible through the attribute
Tim Peters495ad3c2001-01-15 01:36:40 +0000102 'recipients', which is a dictionary of exactly the same sort as
103 SMTP.sendmail() returns.
Guido van Rossum296e1431999-04-07 15:03:39 +0000104 """
105
106 def __init__(self, recipients):
107 self.recipients = recipients
108 self.args = ( recipients,)
109
110
Guido van Rossum296e1431999-04-07 15:03:39 +0000111class SMTPDataError(SMTPResponseException):
112 """The SMTP server didn't accept the data."""
113
114class SMTPConnectError(SMTPResponseException):
Barry Warsawd25c1b71999-11-28 17:11:06 +0000115 """Error during connection establishment."""
Guido van Rossum296e1431999-04-07 15:03:39 +0000116
117class SMTPHeloError(SMTPResponseException):
Barry Warsawd25c1b71999-11-28 17:11:06 +0000118 """The server refused our HELO reply."""
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000119
Guido van Rossumae010462001-09-11 15:57:46 +0000120class SMTPAuthenticationError(SMTPResponseException):
121 """Authentication error.
122
123 Most probably the server didn't accept the username/password
124 combination provided.
125 """
Peter Schneider-Kamp7bc82bb2000-08-10 14:02:23 +0000126
Guido van Rossumf7fcf5e2001-09-14 16:08:44 +0000127class SSLFakeSocket:
128 """A fake socket object that really wraps a SSLObject.
Tim Petersb64bec32001-09-18 02:26:39 +0000129
Guido van Rossumf7fcf5e2001-09-14 16:08:44 +0000130 It only supports what is needed in smtplib.
131 """
132 def __init__(self, realsock, sslobj):
133 self.realsock = realsock
134 self.sslobj = sslobj
135
136 def send(self, str):
137 self.sslobj.write(str)
138 return len(str)
139
140 def close(self):
141 self.realsock.close()
142
143class SSLFakeFile:
144 """A fake file like object that really wraps a SSLObject.
Tim Petersb64bec32001-09-18 02:26:39 +0000145
Guido van Rossumf7fcf5e2001-09-14 16:08:44 +0000146 It only supports what is needed in smtplib.
147 """
148 def __init__( self, sslobj):
149 self.sslobj = sslobj
150
151 def readline(self):
152 str = ""
153 chr = None
154 while chr != "\n":
155 chr = self.sslobj.read(1)
156 str += chr
157 return str
158
159 def close(self):
160 pass
161
Guido van Rossum69a79bc1998-07-13 15:18:49 +0000162def quoteaddr(addr):
163 """Quote a subset of the email addresses defined by RFC 821.
164
Barry Warsawa7d9bdf1998-12-22 03:24:27 +0000165 Should be able to handle anything rfc822.parseaddr can handle.
166 """
Guido van Rossumfcfb6321998-08-04 15:29:54 +0000167 m=None
Guido van Rossum69a79bc1998-07-13 15:18:49 +0000168 try:
Guido van Rossumfcfb6321998-08-04 15:29:54 +0000169 m=rfc822.parseaddr(addr)[1]
170 except AttributeError:
171 pass
172 if not m:
173 #something weird here.. punt -ddm
174 return addr
175 else:
176 return "<%s>" % m
Guido van Rossum69a79bc1998-07-13 15:18:49 +0000177
178def quotedata(data):
179 """Quote data for email.
180
Barry Warsawd25c1b71999-11-28 17:11:06 +0000181 Double leading '.', and change Unix newline '\\n', or Mac '\\r' into
Barry Warsawa7d9bdf1998-12-22 03:24:27 +0000182 Internet CRLF end-of-line.
183 """
Guido van Rossum69a79bc1998-07-13 15:18:49 +0000184 return re.sub(r'(?m)^\.', '..',
Guido van Rossumfcfb6321998-08-04 15:29:54 +0000185 re.sub(r'(?:\r\n|\n|\r(?!\n))', CRLF, data))
Guido van Rossum69a79bc1998-07-13 15:18:49 +0000186
Peter Schneider-Kamp7bc82bb2000-08-10 14:02:23 +0000187
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000188class SMTP:
Guido van Rossumfcfb6321998-08-04 15:29:54 +0000189 """This class manages a connection to an SMTP or ESMTP server.
190 SMTP Objects:
Tim Peters495ad3c2001-01-15 01:36:40 +0000191 SMTP objects have the following attributes:
192 helo_resp
193 This is the message given by the server in response to the
Guido van Rossumfcfb6321998-08-04 15:29:54 +0000194 most recent HELO command.
Tim Peters495ad3c2001-01-15 01:36:40 +0000195
Guido van Rossumfcfb6321998-08-04 15:29:54 +0000196 ehlo_resp
Tim Peters495ad3c2001-01-15 01:36:40 +0000197 This is the message given by the server in response to the
Guido van Rossumfcfb6321998-08-04 15:29:54 +0000198 most recent EHLO command. This is usually multiline.
199
Tim Peters495ad3c2001-01-15 01:36:40 +0000200 does_esmtp
Guido van Rossumfcfb6321998-08-04 15:29:54 +0000201 This is a True value _after you do an EHLO command_, if the
202 server supports ESMTP.
203
Tim Peters495ad3c2001-01-15 01:36:40 +0000204 esmtp_features
Guido van Rossumfcfb6321998-08-04 15:29:54 +0000205 This is a dictionary, which, if the server supports ESMTP,
Barry Warsawd25c1b71999-11-28 17:11:06 +0000206 will _after you do an EHLO command_, contain the names of the
207 SMTP service extensions this server supports, and their
Guido van Rossumfcfb6321998-08-04 15:29:54 +0000208 parameters (if any).
Barry Warsawd25c1b71999-11-28 17:11:06 +0000209
Tim Peters495ad3c2001-01-15 01:36:40 +0000210 Note, all extension names are mapped to lower case in the
211 dictionary.
Guido van Rossumfcfb6321998-08-04 15:29:54 +0000212
Barry Warsawd25c1b71999-11-28 17:11:06 +0000213 See each method's docstrings for details. In general, there is a
214 method of the same name to perform each SMTP command. There is also a
215 method called 'sendmail' that will do an entire mail transaction.
216 """
Guido van Rossum95e6f701998-06-25 02:15:50 +0000217 debuglevel = 0
218 file = None
219 helo_resp = None
220 ehlo_resp = None
Guido van Rossumfcfb6321998-08-04 15:29:54 +0000221 does_esmtp = 0
Guido van Rossum95e6f701998-06-25 02:15:50 +0000222
Neil Schemenauer6730f262002-03-24 15:30:40 +0000223 def __init__(self, host = '', port = 0, local_hostname = None):
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000224 """Initialize a new instance.
225
Barry Warsawa7d9bdf1998-12-22 03:24:27 +0000226 If specified, `host' is the name of the remote host to which to
227 connect. If specified, `port' specifies the port to which to connect.
Barry Warsawd25c1b71999-11-28 17:11:06 +0000228 By default, smtplib.SMTP_PORT is used. An SMTPConnectError is raised
Neil Schemenauer6730f262002-03-24 15:30:40 +0000229 if the specified `host' doesn't respond correctly. If specified,
230 `local_hostname` is used as the FQDN of the local host. By default,
Barry Warsaw4b186af2002-03-25 04:00:38 +0000231 the local hostname is found using socket.getfqdn().
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000232
233 """
Guido van Rossumfcfb6321998-08-04 15:29:54 +0000234 self.esmtp_features = {}
Guido van Rossum296e1431999-04-07 15:03:39 +0000235 if host:
236 (code, msg) = self.connect(host, port)
237 if code != 220:
238 raise SMTPConnectError(code, msg)
Neil Schemenauer6730f262002-03-24 15:30:40 +0000239 if local_hostname:
240 self.local_hostname = local_hostname
241 else:
242 self.local_hostname = socket.getfqdn()
Tim Peters495ad3c2001-01-15 01:36:40 +0000243
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000244 def set_debuglevel(self, debuglevel):
245 """Set the debug output level.
246
Barry Warsawa7d9bdf1998-12-22 03:24:27 +0000247 A non-false value results in debug messages for connection and for all
248 messages sent to and received from the server.
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000249
250 """
251 self.debuglevel = debuglevel
252
253 def connect(self, host='localhost', port = 0):
254 """Connect to a host on a given port.
Guido van Rossum95e6f701998-06-25 02:15:50 +0000255
Barry Warsaw4c4bec81998-12-22 03:02:20 +0000256 If the hostname ends with a colon (`:') followed by a number, and
257 there is no port specified, that suffix will be stripped off and the
258 number interpreted as the port number to use.
Guido van Rossum95e6f701998-06-25 02:15:50 +0000259
Barry Warsawa7d9bdf1998-12-22 03:24:27 +0000260 Note: This method is automatically invoked by __init__, if a host is
261 specified during instantiation.
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000262
263 """
Martin v. Löwis4eb59402001-07-26 13:37:33 +0000264 if not port and (host.find(':') == host.rfind(':')):
Martin v. Löwisa43c2f82001-07-24 20:34:08 +0000265 i = host.rfind(':')
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000266 if i >= 0:
267 host, port = host[:i], host[i+1:]
Eric S. Raymondc013f302001-02-09 05:40:38 +0000268 try: port = int(port)
Eric S. Raymond8d876032001-02-09 10:14:53 +0000269 except ValueError:
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000270 raise socket.error, "nonnumeric port"
271 if not port: port = SMTP_PORT
Martin v. Löwis4eb59402001-07-26 13:37:33 +0000272 if self.debuglevel > 0: print 'connect:', (host, port)
Martin v. Löwis2ad25692001-07-31 08:40:21 +0000273 msg = "getaddrinfo returns an empty list"
Martin v. Löwis322c0d12001-10-07 08:53:32 +0000274 self.sock = None
Martin v. Löwis4eb59402001-07-26 13:37:33 +0000275 for res in socket.getaddrinfo(host, port, 0, socket.SOCK_STREAM):
276 af, socktype, proto, canonname, sa = res
277 try:
278 self.sock = socket.socket(af, socktype, proto)
279 if self.debuglevel > 0: print 'connect:', (host, port)
280 self.sock.connect(sa)
281 except socket.error, msg:
282 if self.debuglevel > 0: print 'connect fail:', (host, port)
Martin v. Löwis322c0d12001-10-07 08:53:32 +0000283 if self.sock:
284 self.sock.close()
Martin v. Löwis4eb59402001-07-26 13:37:33 +0000285 self.sock = None
286 continue
287 break
288 if not self.sock:
289 raise socket.error, msg
Martin v. Löwisa43c2f82001-07-24 20:34:08 +0000290 (code, msg) = self.getreply()
291 if self.debuglevel > 0: print "connect:", msg
292 return (code, msg)
Tim Peters495ad3c2001-01-15 01:36:40 +0000293
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000294 def send(self, str):
295 """Send `str' to the server."""
296 if self.debuglevel > 0: print 'send:', `str`
Guido van Rossum45e2fbc1998-03-26 21:13:24 +0000297 if self.sock:
Guido van Rossum2880f6e1998-08-10 20:07:00 +0000298 try:
Martin v. Löwise12454f2002-02-16 23:06:19 +0000299 self.sock.sendall(str)
Guido van Rossum2880f6e1998-08-10 20:07:00 +0000300 except socket.error:
Barry Warsaw76750972001-12-14 20:34:20 +0000301 self.close()
Guido van Rossum40233ea1999-01-15 03:23:55 +0000302 raise SMTPServerDisconnected('Server not connected')
Guido van Rossumfc40a831998-01-29 17:26:45 +0000303 else:
Guido van Rossum40233ea1999-01-15 03:23:55 +0000304 raise SMTPServerDisconnected('please run connect() first')
Tim Peters495ad3c2001-01-15 01:36:40 +0000305
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000306 def putcmd(self, cmd, args=""):
Barry Warsawa7d9bdf1998-12-22 03:24:27 +0000307 """Send a command to the server."""
Guido van Rossumdb23d3d1999-06-09 15:13:10 +0000308 if args == "":
309 str = '%s%s' % (cmd, CRLF)
310 else:
311 str = '%s %s%s' % (cmd, args, CRLF)
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000312 self.send(str)
Tim Peters495ad3c2001-01-15 01:36:40 +0000313
Guido van Rossumfcfb6321998-08-04 15:29:54 +0000314 def getreply(self):
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000315 """Get a reply from the server.
Tim Peters495ad3c2001-01-15 01:36:40 +0000316
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000317 Returns a tuple consisting of:
Barry Warsawa7d9bdf1998-12-22 03:24:27 +0000318
319 - server response code (e.g. '250', or such, if all goes well)
320 Note: returns -1 if it can't read response code.
321
322 - server response string corresponding to response code (multiline
323 responses are converted to a single, multiline string).
Guido van Rossumf123f841999-03-29 20:33:21 +0000324
325 Raises SMTPServerDisconnected if end-of-file is reached.
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000326 """
327 resp=[]
Guido van Rossum296e1431999-04-07 15:03:39 +0000328 if self.file is None:
329 self.file = self.sock.makefile('rb')
Guido van Rossum45e2fbc1998-03-26 21:13:24 +0000330 while 1:
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000331 line = self.file.readline()
Guido van Rossum296e1431999-04-07 15:03:39 +0000332 if line == '':
333 self.close()
334 raise SMTPServerDisconnected("Connection unexpectedly closed")
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000335 if self.debuglevel > 0: print 'reply:', `line`
Eric S. Raymondc013f302001-02-09 05:40:38 +0000336 resp.append(line[4:].strip())
Guido van Rossum45e2fbc1998-03-26 21:13:24 +0000337 code=line[:3]
Guido van Rossum296e1431999-04-07 15:03:39 +0000338 # Check that the error code is syntactically correct.
339 # Don't attempt to read a continuation line if it is broken.
340 try:
Eric S. Raymondc013f302001-02-09 05:40:38 +0000341 errcode = int(code)
Guido van Rossum296e1431999-04-07 15:03:39 +0000342 except ValueError:
343 errcode = -1
344 break
Guido van Rossumf123f841999-03-29 20:33:21 +0000345 # Check if multiline response.
Guido van Rossum45e2fbc1998-03-26 21:13:24 +0000346 if line[3:4]!="-":
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000347 break
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000348
Eric S. Raymondc013f302001-02-09 05:40:38 +0000349 errmsg = "\n".join(resp)
Tim Peters495ad3c2001-01-15 01:36:40 +0000350 if self.debuglevel > 0:
Guido van Rossumfc40a831998-01-29 17:26:45 +0000351 print 'reply: retcode (%s); Msg: %s' % (errcode,errmsg)
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000352 return errcode, errmsg
Tim Peters495ad3c2001-01-15 01:36:40 +0000353
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000354 def docmd(self, cmd, args=""):
Barry Warsawa7d9bdf1998-12-22 03:24:27 +0000355 """Send a command, and return its response code."""
Guido van Rossum45e2fbc1998-03-26 21:13:24 +0000356 self.putcmd(cmd,args)
Guido van Rossum296e1431999-04-07 15:03:39 +0000357 return self.getreply()
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000358
Barry Warsawa7d9bdf1998-12-22 03:24:27 +0000359 # std smtp commands
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000360 def helo(self, name=''):
Barry Warsawa7d9bdf1998-12-22 03:24:27 +0000361 """SMTP 'helo' command.
362 Hostname to send for this command defaults to the FQDN of the local
363 host.
364 """
Neil Schemenauer6730f262002-03-24 15:30:40 +0000365 self.putcmd("helo", name or self.local_hostname)
Guido van Rossum45e2fbc1998-03-26 21:13:24 +0000366 (code,msg)=self.getreply()
367 self.helo_resp=msg
Guido van Rossum296e1431999-04-07 15:03:39 +0000368 return (code,msg)
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000369
Guido van Rossum95e6f701998-06-25 02:15:50 +0000370 def ehlo(self, name=''):
Barry Warsawa7d9bdf1998-12-22 03:24:27 +0000371 """ SMTP 'ehlo' command.
372 Hostname to send for this command defaults to the FQDN of the local
373 host.
374 """
Guido van Rossumf7fcf5e2001-09-14 16:08:44 +0000375 self.esmtp_features = {}
Neil Schemenauer6730f262002-03-24 15:30:40 +0000376 self.putcmd("ehlo", name or self.local_hostname)
Guido van Rossumfcfb6321998-08-04 15:29:54 +0000377 (code,msg)=self.getreply()
Tim Peters495ad3c2001-01-15 01:36:40 +0000378 # According to RFC1869 some (badly written)
379 # MTA's will disconnect on an ehlo. Toss an exception if
Guido van Rossumfcfb6321998-08-04 15:29:54 +0000380 # that happens -ddm
381 if code == -1 and len(msg) == 0:
Barry Warsaw76750972001-12-14 20:34:20 +0000382 self.close()
Guido van Rossum40233ea1999-01-15 03:23:55 +0000383 raise SMTPServerDisconnected("Server not connected")
Guido van Rossum95e6f701998-06-25 02:15:50 +0000384 self.ehlo_resp=msg
Fred Drake8152d322000-12-12 23:20:45 +0000385 if code != 250:
Guido van Rossum296e1431999-04-07 15:03:39 +0000386 return (code,msg)
Guido van Rossumfcfb6321998-08-04 15:29:54 +0000387 self.does_esmtp=1
Thomas Wouters7e474022000-07-16 12:04:32 +0000388 #parse the ehlo response -ddm
Eric S. Raymondc013f302001-02-09 05:40:38 +0000389 resp=self.ehlo_resp.split('\n')
Guido van Rossumfcfb6321998-08-04 15:29:54 +0000390 del resp[0]
Guido van Rossum2880f6e1998-08-10 20:07:00 +0000391 for each in resp:
Guido van Rossumfcfb6321998-08-04 15:29:54 +0000392 m=re.match(r'(?P<feature>[A-Za-z0-9][A-Za-z0-9\-]*)',each)
393 if m:
Eric S. Raymondc013f302001-02-09 05:40:38 +0000394 feature=m.group("feature").lower()
395 params=m.string[m.end("feature"):].strip()
Guido van Rossumfcfb6321998-08-04 15:29:54 +0000396 self.esmtp_features[feature]=params
Guido van Rossum296e1431999-04-07 15:03:39 +0000397 return (code,msg)
Guido van Rossum95e6f701998-06-25 02:15:50 +0000398
Guido van Rossumfcfb6321998-08-04 15:29:54 +0000399 def has_extn(self, opt):
400 """Does the server support a given SMTP service extension?"""
Eric S. Raymondc013f302001-02-09 05:40:38 +0000401 return self.esmtp_features.has_key(opt.lower())
Guido van Rossum95e6f701998-06-25 02:15:50 +0000402
Guido van Rossum18586f41998-04-03 17:03:13 +0000403 def help(self, args=''):
Barry Warsawa7d9bdf1998-12-22 03:24:27 +0000404 """SMTP 'help' command.
405 Returns help text from server."""
Guido van Rossum18586f41998-04-03 17:03:13 +0000406 self.putcmd("help", args)
Guido van Rossum296e1431999-04-07 15:03:39 +0000407 return self.getreply()
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000408
409 def rset(self):
Barry Warsawa7d9bdf1998-12-22 03:24:27 +0000410 """SMTP 'rset' command -- resets session."""
Guido van Rossum296e1431999-04-07 15:03:39 +0000411 return self.docmd("rset")
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000412
413 def noop(self):
Barry Warsawa7d9bdf1998-12-22 03:24:27 +0000414 """SMTP 'noop' command -- doesn't do anything :>"""
Guido van Rossum296e1431999-04-07 15:03:39 +0000415 return self.docmd("noop")
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000416
Guido van Rossum95e6f701998-06-25 02:15:50 +0000417 def mail(self,sender,options=[]):
Barry Warsawa7d9bdf1998-12-22 03:24:27 +0000418 """SMTP 'mail' command -- begins mail xfer session."""
Guido van Rossumfcfb6321998-08-04 15:29:54 +0000419 optionlist = ''
420 if options and self.does_esmtp:
Eric S. Raymondc013f302001-02-09 05:40:38 +0000421 optionlist = ' ' + ' '.join(options)
Guido van Rossumdb23d3d1999-06-09 15:13:10 +0000422 self.putcmd("mail", "FROM:%s%s" % (quoteaddr(sender) ,optionlist))
Guido van Rossum45e2fbc1998-03-26 21:13:24 +0000423 return self.getreply()
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000424
Guido van Rossumfcfb6321998-08-04 15:29:54 +0000425 def rcpt(self,recip,options=[]):
Barry Warsawa7d9bdf1998-12-22 03:24:27 +0000426 """SMTP 'rcpt' command -- indicates 1 recipient for this mail."""
Guido van Rossumfcfb6321998-08-04 15:29:54 +0000427 optionlist = ''
428 if options and self.does_esmtp:
Eric S. Raymondc013f302001-02-09 05:40:38 +0000429 optionlist = ' ' + ' '.join(options)
Guido van Rossum348fd061999-01-14 04:18:46 +0000430 self.putcmd("rcpt","TO:%s%s" % (quoteaddr(recip),optionlist))
Guido van Rossum45e2fbc1998-03-26 21:13:24 +0000431 return self.getreply()
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000432
433 def data(self,msg):
Tim Peters495ad3c2001-01-15 01:36:40 +0000434 """SMTP 'DATA' command -- sends message data to server.
Guido van Rossum296e1431999-04-07 15:03:39 +0000435
Barry Warsaw4c4bec81998-12-22 03:02:20 +0000436 Automatically quotes lines beginning with a period per rfc821.
Guido van Rossum296e1431999-04-07 15:03:39 +0000437 Raises SMTPDataError if there is an unexpected reply to the
438 DATA command; the return value from this method is the final
439 response code received when the all data is sent.
Barry Warsaw4c4bec81998-12-22 03:02:20 +0000440 """
Guido van Rossum45e2fbc1998-03-26 21:13:24 +0000441 self.putcmd("data")
442 (code,repl)=self.getreply()
443 if self.debuglevel >0 : print "data:", (code,repl)
Fred Drake8152d322000-12-12 23:20:45 +0000444 if code != 354:
Guido van Rossum296e1431999-04-07 15:03:39 +0000445 raise SMTPDataError(code,repl)
Guido van Rossum45e2fbc1998-03-26 21:13:24 +0000446 else:
Guido van Rossum20c92281999-04-21 16:52:20 +0000447 q = quotedata(msg)
448 if q[-2:] != CRLF:
449 q = q + CRLF
450 q = q + "." + CRLF
451 self.send(q)
Guido van Rossum45e2fbc1998-03-26 21:13:24 +0000452 (code,msg)=self.getreply()
453 if self.debuglevel >0 : print "data:", (code,msg)
Guido van Rossum296e1431999-04-07 15:03:39 +0000454 return (code,msg)
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000455
Guido van Rossumfcfb6321998-08-04 15:29:54 +0000456 def verify(self, address):
Barry Warsawa7d9bdf1998-12-22 03:24:27 +0000457 """SMTP 'verify' command -- checks for address validity."""
Guido van Rossumfcfb6321998-08-04 15:29:54 +0000458 self.putcmd("vrfy", quoteaddr(address))
459 return self.getreply()
Barry Warsaw4c4bec81998-12-22 03:02:20 +0000460 # a.k.a.
461 vrfy=verify
Guido van Rossumfcfb6321998-08-04 15:29:54 +0000462
463 def expn(self, address):
Barry Warsawa7d9bdf1998-12-22 03:24:27 +0000464 """SMTP 'verify' command -- checks for address validity."""
Guido van Rossumfcfb6321998-08-04 15:29:54 +0000465 self.putcmd("expn", quoteaddr(address))
466 return self.getreply()
467
Barry Warsaw4c4bec81998-12-22 03:02:20 +0000468 # some useful methods
Guido van Rossumae010462001-09-11 15:57:46 +0000469
470 def login(self, user, password):
471 """Log in on an SMTP server that requires authentication.
472
473 The arguments are:
474 - user: The user name to authenticate with.
475 - password: The password for the authentication.
476
477 If there has been no previous EHLO or HELO command this session, this
478 method tries ESMTP EHLO first.
479
480 This method will return normally if the authentication was successful.
481
482 This method may raise the following exceptions:
483
484 SMTPHeloError The server didn't reply properly to
485 the helo greeting.
486 SMTPAuthenticationError The server didn't accept the username/
487 password combination.
Fred Drake2f8f4d32001-10-13 18:35:32 +0000488 SMTPException No suitable authentication method was
Guido van Rossumae010462001-09-11 15:57:46 +0000489 found.
490 """
491
492 def encode_cram_md5(challenge, user, password):
493 challenge = base64.decodestring(challenge)
494 response = user + " " + hmac.HMAC(password, challenge).hexdigest()
495 return base64.encodestring(response)[:-1]
496
497 def encode_plain(user, password):
498 return base64.encodestring("%s\0%s\0%s" %
499 (user, user, password))[:-1]
500
501 AUTH_PLAIN = "PLAIN"
502 AUTH_CRAM_MD5 = "CRAM-MD5"
503
504 if self.helo_resp is None and self.ehlo_resp is None:
505 if not (200 <= self.ehlo()[0] <= 299):
506 (code, resp) = self.helo()
507 if not (200 <= code <= 299):
508 raise SMTPHeloError(code, resp)
509
510 if not self.has_extn("auth"):
511 raise SMTPException("SMTP AUTH extension not supported by server.")
512
513 # Authentication methods the server supports:
514 authlist = self.esmtp_features["auth"].split()
515
516 # List of authentication methods we support: from preferred to
517 # less preferred methods. Except for the purpose of testing the weaker
518 # ones, we prefer stronger methods like CRAM-MD5:
519 preferred_auths = [AUTH_CRAM_MD5, AUTH_PLAIN]
520 #preferred_auths = [AUTH_PLAIN, AUTH_CRAM_MD5]
521
522 # Determine the authentication method we'll use
523 authmethod = None
524 for method in preferred_auths:
525 if method in authlist:
526 authmethod = method
527 break
528 if self.debuglevel > 0: print "AuthMethod:", authmethod
Tim Petersb64bec32001-09-18 02:26:39 +0000529
Guido van Rossumae010462001-09-11 15:57:46 +0000530 if authmethod == AUTH_CRAM_MD5:
531 (code, resp) = self.docmd("AUTH", AUTH_CRAM_MD5)
532 if code == 503:
533 # 503 == 'Error: already authenticated'
534 return (code, resp)
535 (code, resp) = self.docmd(encode_cram_md5(resp, user, password))
536 elif authmethod == AUTH_PLAIN:
Tim Petersb64bec32001-09-18 02:26:39 +0000537 (code, resp) = self.docmd("AUTH",
Guido van Rossumae010462001-09-11 15:57:46 +0000538 AUTH_PLAIN + " " + encode_plain(user, password))
539 elif authmethod == None:
Fred Drake2f8f4d32001-10-13 18:35:32 +0000540 raise SMTPException("No suitable authentication method found.")
Guido van Rossumae010462001-09-11 15:57:46 +0000541 if code not in [235, 503]:
542 # 235 == 'Authentication successful'
543 # 503 == 'Error: already authenticated'
544 raise SMTPAuthenticationError(code, resp)
545 return (code, resp)
546
Guido van Rossumf7fcf5e2001-09-14 16:08:44 +0000547 def starttls(self, keyfile = None, certfile = None):
548 """Puts the connection to the SMTP server into TLS mode.
Tim Petersb64bec32001-09-18 02:26:39 +0000549
Guido van Rossumf7fcf5e2001-09-14 16:08:44 +0000550 If the server supports TLS, this will encrypt the rest of the SMTP
551 session. If you provide the keyfile and certfile parameters,
552 the identity of the SMTP server and client can be checked. This,
553 however, depends on whether the socket module really checks the
554 certificates.
555 """
Tim Petersb64bec32001-09-18 02:26:39 +0000556 (resp, reply) = self.docmd("STARTTLS")
Guido van Rossumf7fcf5e2001-09-14 16:08:44 +0000557 if resp == 220:
558 sslobj = socket.ssl(self.sock, keyfile, certfile)
559 self.sock = SSLFakeSocket(self.sock, sslobj)
560 self.file = SSLFakeFile(sslobj)
561 return (resp, reply)
Tim Petersb64bec32001-09-18 02:26:39 +0000562
Jeremy Hylton31bb8ce1998-08-13 19:57:46 +0000563 def sendmail(self, from_addr, to_addrs, msg, mail_options=[],
Tim Peters495ad3c2001-01-15 01:36:40 +0000564 rcpt_options=[]):
565 """This command performs an entire mail transaction.
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000566
Tim Peters495ad3c2001-01-15 01:36:40 +0000567 The arguments are:
Barry Warsaw4c4bec81998-12-22 03:02:20 +0000568 - from_addr : The address sending this mail.
569 - to_addrs : A list of addresses to send this mail to. A bare
570 string will be treated as a list with 1 address.
Tim Peters495ad3c2001-01-15 01:36:40 +0000571 - msg : The message to send.
Barry Warsaw4c4bec81998-12-22 03:02:20 +0000572 - mail_options : List of ESMTP options (such as 8bitmime) for the
573 mail command.
574 - rcpt_options : List of ESMTP options (such as DSN commands) for
575 all the rcpt commands.
576
577 If there has been no previous EHLO or HELO command this session, this
578 method tries ESMTP EHLO first. If the server does ESMTP, message size
579 and each of the specified options will be passed to it. If EHLO
580 fails, HELO will be tried and ESMTP options suppressed.
581
582 This method will return normally if the mail is accepted for at least
Barry Warsawd25c1b71999-11-28 17:11:06 +0000583 one recipient. It returns a dictionary, with one entry for each
584 recipient that was refused. Each entry contains a tuple of the SMTP
585 error code and the accompanying error message sent by the server.
Guido van Rossum296e1431999-04-07 15:03:39 +0000586
587 This method may raise the following exceptions:
588
589 SMTPHeloError The server didn't reply properly to
Tim Peters495ad3c2001-01-15 01:36:40 +0000590 the helo greeting.
Barry Warsawd25c1b71999-11-28 17:11:06 +0000591 SMTPRecipientsRefused The server rejected ALL recipients
Guido van Rossum296e1431999-04-07 15:03:39 +0000592 (no mail was sent).
593 SMTPSenderRefused The server didn't accept the from_addr.
594 SMTPDataError The server replied with an unexpected
595 error code (other than a refusal of
596 a recipient).
597
598 Note: the connection will be open even after an exception is raised.
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000599
Guido van Rossum95e6f701998-06-25 02:15:50 +0000600 Example:
Tim Peters495ad3c2001-01-15 01:36:40 +0000601
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000602 >>> import smtplib
603 >>> s=smtplib.SMTP("localhost")
Guido van Rossumfc40a831998-01-29 17:26:45 +0000604 >>> tolist=["one@one.org","two@two.org","three@three.org","four@four.org"]
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000605 >>> msg = '''
606 ... From: Me@my.org
607 ... Subject: testin'...
608 ...
609 ... This is a test '''
610 >>> s.sendmail("me@my.org",tolist,msg)
611 { "three@three.org" : ( 550 ,"User unknown" ) }
612 >>> s.quit()
Tim Peters495ad3c2001-01-15 01:36:40 +0000613
Barry Warsaw4c4bec81998-12-22 03:02:20 +0000614 In the above example, the message was accepted for delivery to three
615 of the four addresses, and one was rejected, with the error code
Barry Warsawd25c1b71999-11-28 17:11:06 +0000616 550. If all addresses are accepted, then the method will return an
Barry Warsaw4c4bec81998-12-22 03:02:20 +0000617 empty dictionary.
618
619 """
Guido van Rossum296e1431999-04-07 15:03:39 +0000620 if self.helo_resp is None and self.ehlo_resp is None:
621 if not (200 <= self.ehlo()[0] <= 299):
622 (code,resp) = self.helo()
623 if not (200 <= code <= 299):
624 raise SMTPHeloError(code, resp)
Guido van Rossum95e6f701998-06-25 02:15:50 +0000625 esmtp_opts = []
Guido van Rossumfcfb6321998-08-04 15:29:54 +0000626 if self.does_esmtp:
627 # Hmmm? what's this? -ddm
628 # self.esmtp_features['7bit']=""
629 if self.has_extn('size'):
630 esmtp_opts.append("size=" + `len(msg)`)
631 for option in mail_options:
Guido van Rossum95e6f701998-06-25 02:15:50 +0000632 esmtp_opts.append(option)
Guido van Rossumfcfb6321998-08-04 15:29:54 +0000633
Guido van Rossum95e6f701998-06-25 02:15:50 +0000634 (code,resp) = self.mail(from_addr, esmtp_opts)
Fred Drake8152d322000-12-12 23:20:45 +0000635 if code != 250:
Guido van Rossum45e2fbc1998-03-26 21:13:24 +0000636 self.rset()
Guido van Rossum296e1431999-04-07 15:03:39 +0000637 raise SMTPSenderRefused(code, resp, from_addr)
Guido van Rossum45e2fbc1998-03-26 21:13:24 +0000638 senderrs={}
Martin v. Löwis33567662002-02-24 15:07:24 +0000639 if isinstance(to_addrs, types.StringTypes):
Jeremy Hylton31bb8ce1998-08-13 19:57:46 +0000640 to_addrs = [to_addrs]
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000641 for each in to_addrs:
Guido van Rossumfcfb6321998-08-04 15:29:54 +0000642 (code,resp)=self.rcpt(each, rcpt_options)
Fred Drake8152d322000-12-12 23:20:45 +0000643 if (code != 250) and (code != 251):
Guido van Rossumfc40a831998-01-29 17:26:45 +0000644 senderrs[each]=(code,resp)
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000645 if len(senderrs)==len(to_addrs):
Guido van Rossum95e6f701998-06-25 02:15:50 +0000646 # the server refused all our recipients
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000647 self.rset()
Guido van Rossum296e1431999-04-07 15:03:39 +0000648 raise SMTPRecipientsRefused(senderrs)
Fred Drake8152d322000-12-12 23:20:45 +0000649 (code,resp) = self.data(msg)
650 if code != 250:
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000651 self.rset()
Guido van Rossum296e1431999-04-07 15:03:39 +0000652 raise SMTPDataError(code, resp)
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000653 #if we got here then somebody got our mail
Tim Peters495ad3c2001-01-15 01:36:40 +0000654 return senderrs
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000655
656
657 def close(self):
658 """Close the connection to the SMTP server."""
659 if self.file:
660 self.file.close()
661 self.file = None
662 if self.sock:
663 self.sock.close()
664 self.sock = None
665
666
667 def quit(self):
Guido van Rossum95e6f701998-06-25 02:15:50 +0000668 """Terminate the SMTP session."""
Guido van Rossum45e2fbc1998-03-26 21:13:24 +0000669 self.docmd("quit")
670 self.close()
Guido van Rossum95e6f701998-06-25 02:15:50 +0000671
Barry Warsaw4c4bec81998-12-22 03:02:20 +0000672
Guido van Rossum95e6f701998-06-25 02:15:50 +0000673# Test the sendmail method, which tests most of the others.
674# Note: This always sends to localhost.
675if __name__ == '__main__':
Andrew M. Kuchling6be424f2001-08-13 14:41:39 +0000676 import sys
Guido van Rossum95e6f701998-06-25 02:15:50 +0000677
678 def prompt(prompt):
679 sys.stdout.write(prompt + ": ")
Eric S. Raymondc013f302001-02-09 05:40:38 +0000680 return sys.stdin.readline().strip()
Guido van Rossum95e6f701998-06-25 02:15:50 +0000681
682 fromaddr = prompt("From")
Eric S. Raymond38151ed2001-02-09 07:40:17 +0000683 toaddrs = prompt("To").split(',')
Guido van Rossum95e6f701998-06-25 02:15:50 +0000684 print "Enter message, end with ^D:"
685 msg = ''
686 while 1:
687 line = sys.stdin.readline()
688 if not line:
689 break
690 msg = msg + line
691 print "Message length is " + `len(msg)`
692
693 server = SMTP('localhost')
694 server.set_debuglevel(1)
695 server.sendmail(fromaddr, toaddrs, msg)
696 server.quit()