blob: 099e54a4fa1e3ccbd43a235a502e4fef7f5b2683 [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
Georg Brandl5a096e12007-01-22 19:40:21 +000046import email.utils
Guido van Rossumae010462001-09-11 15:57:46 +000047import base64
48import hmac
Georg Brandl5a096e12007-01-22 19:40:21 +000049from email.base64mime import encode as encode_base64
Brett Cannone6f8a892004-07-10 23:14:30 +000050from sys import stderr
Guido van Rossumbbe323e1998-01-29 17:24:40 +000051
Giampaolo Rodolà5c12ec62011-02-24 20:43:11 +000052__all__ = ["SMTPException", "SMTPServerDisconnected", "SMTPResponseException",
53 "SMTPSenderRefused", "SMTPRecipientsRefused", "SMTPDataError",
54 "SMTPConnectError", "SMTPHeloError", "SMTPAuthenticationError",
55 "quoteaddr", "quotedata", "SMTP"]
Skip Montanaro0de65802001-02-15 22:15:14 +000056
Guido van Rossumbbe323e1998-01-29 17:24:40 +000057SMTP_PORT = 25
Martin v. Löwisee82c0e2006-10-27 07:13:28 +000058SMTP_SSL_PORT = 465
Giampaolo Rodolà5c12ec62011-02-24 20:43:11 +000059CRLF = "\r\n"
Guido van Rossumbbe323e1998-01-29 17:24:40 +000060
Piers Lauder385a77a2002-07-27 00:38:30 +000061OLDSTYLE_AUTH = re.compile(r"auth=(.*)", re.I)
62
Giampaolo Rodolà5c12ec62011-02-24 20:43:11 +000063
Tim Peters495ad3c2001-01-15 01:36:40 +000064# Exception classes used by this module.
Guido van Rossum296e1431999-04-07 15:03:39 +000065class SMTPException(Exception):
66 """Base class for all exceptions raised by this module."""
67
68class SMTPServerDisconnected(SMTPException):
69 """Not connected to any SMTP server.
70
71 This exception is raised when the server unexpectedly disconnects,
72 or when an attempt is made to use the SMTP instance before
73 connecting it to a server.
74 """
75
76class SMTPResponseException(SMTPException):
77 """Base class for all exceptions that include an SMTP error code.
78
79 These exceptions are generated in some instances when the SMTP
80 server returns an error code. The error code is stored in the
81 `smtp_code' attribute of the error, and the `smtp_error' attribute
82 is set to the error message.
83 """
84
85 def __init__(self, code, msg):
86 self.smtp_code = code
87 self.smtp_error = msg
88 self.args = (code, msg)
89
90class SMTPSenderRefused(SMTPResponseException):
91 """Sender address refused.
Guido van Rossumae010462001-09-11 15:57:46 +000092
Guido van Rossum296e1431999-04-07 15:03:39 +000093 In addition to the attributes set by on all SMTPResponseException
Barry Warsawd25c1b71999-11-28 17:11:06 +000094 exceptions, this sets `sender' to the string that the SMTP refused.
Guido van Rossum296e1431999-04-07 15:03:39 +000095 """
96
97 def __init__(self, code, msg, sender):
98 self.smtp_code = code
99 self.smtp_error = msg
100 self.sender = sender
101 self.args = (code, msg, sender)
102
Guido van Rossum20c92281999-04-21 16:52:20 +0000103class SMTPRecipientsRefused(SMTPException):
Barry Warsawd25c1b71999-11-28 17:11:06 +0000104 """All recipient addresses refused.
Guido van Rossumae010462001-09-11 15:57:46 +0000105
Thomas Wouters7e474022000-07-16 12:04:32 +0000106 The errors for each recipient are accessible through the attribute
Tim Peters495ad3c2001-01-15 01:36:40 +0000107 'recipients', which is a dictionary of exactly the same sort as
108 SMTP.sendmail() returns.
Guido van Rossum296e1431999-04-07 15:03:39 +0000109 """
110
111 def __init__(self, recipients):
112 self.recipients = recipients
Giampaolo Rodolà5c12ec62011-02-24 20:43:11 +0000113 self.args = (recipients,)
Guido van Rossum296e1431999-04-07 15:03:39 +0000114
115
Guido van Rossum296e1431999-04-07 15:03:39 +0000116class SMTPDataError(SMTPResponseException):
117 """The SMTP server didn't accept the data."""
118
119class SMTPConnectError(SMTPResponseException):
Barry Warsawd25c1b71999-11-28 17:11:06 +0000120 """Error during connection establishment."""
Guido van Rossum296e1431999-04-07 15:03:39 +0000121
122class SMTPHeloError(SMTPResponseException):
Barry Warsawd25c1b71999-11-28 17:11:06 +0000123 """The server refused our HELO reply."""
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000124
Guido van Rossumae010462001-09-11 15:57:46 +0000125class SMTPAuthenticationError(SMTPResponseException):
126 """Authentication error.
127
128 Most probably the server didn't accept the username/password
129 combination provided.
130 """
Peter Schneider-Kamp7bc82bb2000-08-10 14:02:23 +0000131
Giampaolo Rodolà5c12ec62011-02-24 20:43:11 +0000132
Guido van Rossum69a79bc1998-07-13 15:18:49 +0000133def quoteaddr(addr):
134 """Quote a subset of the email addresses defined by RFC 821.
135
Barry Warsawa7d9bdf1998-12-22 03:24:27 +0000136 Should be able to handle anything rfc822.parseaddr can handle.
137 """
Raymond Hettinger342456d2002-09-05 01:14:07 +0000138 m = (None, None)
Guido van Rossum69a79bc1998-07-13 15:18:49 +0000139 try:
Georg Brandl5a096e12007-01-22 19:40:21 +0000140 m = email.utils.parseaddr(addr)[1]
Guido van Rossumfcfb6321998-08-04 15:29:54 +0000141 except AttributeError:
142 pass
Giampaolo Rodolà5c12ec62011-02-24 20:43:11 +0000143 if m == (None, None): # Indicates parse failure or AttributeError
Georg Brandlbd3bc4d2006-02-17 09:52:53 +0000144 # something weird here.. punt -ddm
Raymond Hettinger342456d2002-09-05 01:14:07 +0000145 return "<%s>" % addr
Georg Brandlbd3bc4d2006-02-17 09:52:53 +0000146 elif m is None:
147 # the sender wants an empty return address
148 return "<>"
Guido van Rossumfcfb6321998-08-04 15:29:54 +0000149 else:
150 return "<%s>" % m
Guido van Rossum69a79bc1998-07-13 15:18:49 +0000151
R David Murray95225952011-07-18 21:34:04 -0400152def _addr_only(addrstring):
153 displayname, addr = email.utils.parseaddr(addrstring)
154 if (displayname, addr) == ('', ''):
155 # parseaddr couldn't parse it, so use it as is.
156 return addrstring
157 return addr
158
Guido van Rossum69a79bc1998-07-13 15:18:49 +0000159def quotedata(data):
160 """Quote data for email.
161
Barry Warsawd25c1b71999-11-28 17:11:06 +0000162 Double leading '.', and change Unix newline '\\n', or Mac '\\r' into
Barry Warsawa7d9bdf1998-12-22 03:24:27 +0000163 Internet CRLF end-of-line.
164 """
Guido van Rossum69a79bc1998-07-13 15:18:49 +0000165 return re.sub(r'(?m)^\.', '..',
Guido van Rossumfcfb6321998-08-04 15:29:54 +0000166 re.sub(r'(?:\r\n|\n|\r(?!\n))', CRLF, data))
Guido van Rossum69a79bc1998-07-13 15:18:49 +0000167
Peter Schneider-Kamp7bc82bb2000-08-10 14:02:23 +0000168
Bill Janssen426ea0a2007-08-29 22:35:05 +0000169try:
170 import ssl
171except ImportError:
172 _have_ssl = False
173else:
Bill Janssen426ea0a2007-08-29 22:35:05 +0000174 class SSLFakeFile:
175 """A fake file like object that really wraps a SSLObject.
176
177 It only supports what is needed in smtplib.
178 """
179 def __init__(self, sslobj):
180 self.sslobj = sslobj
181
182 def readline(self):
183 str = ""
184 chr = None
185 while chr != "\n":
186 chr = self.sslobj.read(1)
Giampaolo Rodolà5c12ec62011-02-24 20:43:11 +0000187 if not chr:
188 break
Bill Janssen426ea0a2007-08-29 22:35:05 +0000189 str += chr
190 return str
191
192 def close(self):
193 pass
194
195 _have_ssl = True
196
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000197class SMTP:
Guido van Rossumfcfb6321998-08-04 15:29:54 +0000198 """This class manages a connection to an SMTP or ESMTP server.
199 SMTP Objects:
Tim Peters495ad3c2001-01-15 01:36:40 +0000200 SMTP objects have the following attributes:
201 helo_resp
202 This is the message given by the server in response to the
Guido van Rossumfcfb6321998-08-04 15:29:54 +0000203 most recent HELO command.
Tim Peters495ad3c2001-01-15 01:36:40 +0000204
Guido van Rossumfcfb6321998-08-04 15:29:54 +0000205 ehlo_resp
Tim Peters495ad3c2001-01-15 01:36:40 +0000206 This is the message given by the server in response to the
Guido van Rossumfcfb6321998-08-04 15:29:54 +0000207 most recent EHLO command. This is usually multiline.
208
Tim Peters495ad3c2001-01-15 01:36:40 +0000209 does_esmtp
Guido van Rossumfcfb6321998-08-04 15:29:54 +0000210 This is a True value _after you do an EHLO command_, if the
211 server supports ESMTP.
212
Tim Peters495ad3c2001-01-15 01:36:40 +0000213 esmtp_features
Guido van Rossumfcfb6321998-08-04 15:29:54 +0000214 This is a dictionary, which, if the server supports ESMTP,
Barry Warsawd25c1b71999-11-28 17:11:06 +0000215 will _after you do an EHLO command_, contain the names of the
216 SMTP service extensions this server supports, and their
Guido van Rossumfcfb6321998-08-04 15:29:54 +0000217 parameters (if any).
Barry Warsawd25c1b71999-11-28 17:11:06 +0000218
Tim Peters495ad3c2001-01-15 01:36:40 +0000219 Note, all extension names are mapped to lower case in the
220 dictionary.
Guido van Rossumfcfb6321998-08-04 15:29:54 +0000221
Barry Warsawd25c1b71999-11-28 17:11:06 +0000222 See each method's docstrings for details. In general, there is a
223 method of the same name to perform each SMTP command. There is also a
224 method called 'sendmail' that will do an entire mail transaction.
225 """
Guido van Rossum95e6f701998-06-25 02:15:50 +0000226 debuglevel = 0
227 file = None
228 helo_resp = None
Martin v. Löwis1190a382007-03-09 15:35:55 +0000229 ehlo_msg = "ehlo"
Guido van Rossum95e6f701998-06-25 02:15:50 +0000230 ehlo_resp = None
Guido van Rossumfcfb6321998-08-04 15:29:54 +0000231 does_esmtp = 0
Antoine Pitrou21ce8f02011-05-07 19:59:33 +0200232 default_port = SMTP_PORT
Guido van Rossum95e6f701998-06-25 02:15:50 +0000233
Facundo Batista4f1b1ed2008-05-29 16:39:26 +0000234 def __init__(self, host='', port=0, local_hostname=None,
235 timeout=socket._GLOBAL_DEFAULT_TIMEOUT):
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000236 """Initialize a new instance.
237
Barry Warsawa7d9bdf1998-12-22 03:24:27 +0000238 If specified, `host' is the name of the remote host to which to
239 connect. If specified, `port' specifies the port to which to connect.
Barry Warsawd25c1b71999-11-28 17:11:06 +0000240 By default, smtplib.SMTP_PORT is used. An SMTPConnectError is raised
Neil Schemenauer6730f262002-03-24 15:30:40 +0000241 if the specified `host' doesn't respond correctly. If specified,
Tim Peters863ac442002-04-16 01:38:40 +0000242 `local_hostname` is used as the FQDN of the local host. By default,
243 the local hostname is found using socket.getfqdn().
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000244
245 """
Facundo Batista366d6262007-03-28 18:25:54 +0000246 self.timeout = timeout
Guido van Rossumfcfb6321998-08-04 15:29:54 +0000247 self.esmtp_features = {}
Guido van Rossum296e1431999-04-07 15:03:39 +0000248 if host:
249 (code, msg) = self.connect(host, port)
250 if code != 220:
251 raise SMTPConnectError(code, msg)
Raymond Hettingerf13eb552002-06-02 00:40:05 +0000252 if local_hostname is not None:
Barry Warsaw13e34f72002-03-26 20:27:35 +0000253 self.local_hostname = local_hostname
Neil Schemenauer6730f262002-03-24 15:30:40 +0000254 else:
Barry Warsaw13e34f72002-03-26 20:27:35 +0000255 # RFC 2821 says we should use the fqdn in the EHLO/HELO verb, and
256 # if that can't be calculated, that we should use a domain literal
257 # instead (essentially an encoded IP address like [A.B.C.D]).
258 fqdn = socket.getfqdn()
259 if '.' in fqdn:
260 self.local_hostname = fqdn
261 else:
262 # We can't find an fqdn hostname, so use a domain literal
Georg Brandldcdfd222006-03-31 19:34:13 +0000263 addr = '127.0.0.1'
264 try:
265 addr = socket.gethostbyname(socket.gethostname())
266 except socket.gaierror:
267 pass
Barry Warsaw13e34f72002-03-26 20:27:35 +0000268 self.local_hostname = '[%s]' % addr
Tim Peters495ad3c2001-01-15 01:36:40 +0000269
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000270 def set_debuglevel(self, debuglevel):
271 """Set the debug output level.
272
Barry Warsawa7d9bdf1998-12-22 03:24:27 +0000273 A non-false value results in debug messages for connection and for all
274 messages sent to and received from the server.
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000275
276 """
277 self.debuglevel = debuglevel
278
Facundo Batista366d6262007-03-28 18:25:54 +0000279 def _get_socket(self, port, host, timeout):
Martin v. Löwisee82c0e2006-10-27 07:13:28 +0000280 # This makes it simpler for SMTP_SSL to use the SMTP connect code
281 # and just alter the socket connection bit.
Giampaolo Rodolà5c12ec62011-02-24 20:43:11 +0000282 if self.debuglevel > 0:
283 print>>stderr, 'connect:', (host, port)
Facundo Batista366d6262007-03-28 18:25:54 +0000284 return socket.create_connection((port, host), timeout)
Martin v. Löwisee82c0e2006-10-27 07:13:28 +0000285
Giampaolo Rodolà5c12ec62011-02-24 20:43:11 +0000286 def connect(self, host='localhost', port=0):
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000287 """Connect to a host on a given port.
Guido van Rossum95e6f701998-06-25 02:15:50 +0000288
Barry Warsaw4c4bec81998-12-22 03:02:20 +0000289 If the hostname ends with a colon (`:') followed by a number, and
290 there is no port specified, that suffix will be stripped off and the
291 number interpreted as the port number to use.
Guido van Rossum95e6f701998-06-25 02:15:50 +0000292
Barry Warsawa7d9bdf1998-12-22 03:24:27 +0000293 Note: This method is automatically invoked by __init__, if a host is
294 specified during instantiation.
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000295
296 """
Martin v. Löwis4eb59402001-07-26 13:37:33 +0000297 if not port and (host.find(':') == host.rfind(':')):
Martin v. Löwisa43c2f82001-07-24 20:34:08 +0000298 i = host.rfind(':')
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000299 if i >= 0:
Giampaolo Rodolà5c12ec62011-02-24 20:43:11 +0000300 host, port = host[:i], host[i + 1:]
301 try:
302 port = int(port)
Eric S. Raymond8d876032001-02-09 10:14:53 +0000303 except ValueError:
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000304 raise socket.error, "nonnumeric port"
Giampaolo Rodolà5c12ec62011-02-24 20:43:11 +0000305 if not port:
306 port = self.default_port
307 if self.debuglevel > 0:
308 print>>stderr, 'connect:', (host, port)
Facundo Batista366d6262007-03-28 18:25:54 +0000309 self.sock = self._get_socket(host, port, self.timeout)
Martin v. Löwisa43c2f82001-07-24 20:34:08 +0000310 (code, msg) = self.getreply()
Giampaolo Rodolà5c12ec62011-02-24 20:43:11 +0000311 if self.debuglevel > 0:
312 print>>stderr, "connect:", msg
Martin v. Löwisa43c2f82001-07-24 20:34:08 +0000313 return (code, msg)
Tim Peters495ad3c2001-01-15 01:36:40 +0000314
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000315 def send(self, str):
316 """Send `str' to the server."""
Giampaolo Rodolà5c12ec62011-02-24 20:43:11 +0000317 if self.debuglevel > 0:
318 print>>stderr, 'send:', repr(str)
Facundo Batista16609332008-02-23 12:27:17 +0000319 if hasattr(self, 'sock') and self.sock:
Guido van Rossum2880f6e1998-08-10 20:07:00 +0000320 try:
Martin v. Löwise12454f2002-02-16 23:06:19 +0000321 self.sock.sendall(str)
Guido van Rossum2880f6e1998-08-10 20:07:00 +0000322 except socket.error:
Barry Warsaw76750972001-12-14 20:34:20 +0000323 self.close()
Guido van Rossum40233ea1999-01-15 03:23:55 +0000324 raise SMTPServerDisconnected('Server not connected')
Guido van Rossumfc40a831998-01-29 17:26:45 +0000325 else:
Guido van Rossum40233ea1999-01-15 03:23:55 +0000326 raise SMTPServerDisconnected('please run connect() first')
Tim Peters495ad3c2001-01-15 01:36:40 +0000327
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000328 def putcmd(self, cmd, args=""):
Barry Warsawa7d9bdf1998-12-22 03:24:27 +0000329 """Send a command to the server."""
Guido van Rossumdb23d3d1999-06-09 15:13:10 +0000330 if args == "":
331 str = '%s%s' % (cmd, CRLF)
332 else:
333 str = '%s %s%s' % (cmd, args, CRLF)
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000334 self.send(str)
Tim Peters495ad3c2001-01-15 01:36:40 +0000335
Guido van Rossumfcfb6321998-08-04 15:29:54 +0000336 def getreply(self):
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000337 """Get a reply from the server.
Tim Peters495ad3c2001-01-15 01:36:40 +0000338
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000339 Returns a tuple consisting of:
Barry Warsawa7d9bdf1998-12-22 03:24:27 +0000340
341 - server response code (e.g. '250', or such, if all goes well)
342 Note: returns -1 if it can't read response code.
343
344 - server response string corresponding to response code (multiline
345 responses are converted to a single, multiline string).
Guido van Rossumf123f841999-03-29 20:33:21 +0000346
347 Raises SMTPServerDisconnected if end-of-file is reached.
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000348 """
Giampaolo Rodolà5c12ec62011-02-24 20:43:11 +0000349 resp = []
Guido van Rossum296e1431999-04-07 15:03:39 +0000350 if self.file is None:
351 self.file = self.sock.makefile('rb')
Guido van Rossum45e2fbc1998-03-26 21:13:24 +0000352 while 1:
Kristján Valur Jónsson51a035e2009-01-15 17:20:21 +0000353 try:
354 line = self.file.readline()
Antoine Pitrou0ad73582011-08-28 01:18:31 +0200355 except socket.error as e:
356 self.close()
357 raise SMTPServerDisconnected("Connection unexpectedly closed: "
358 + str(e))
Guido van Rossum296e1431999-04-07 15:03:39 +0000359 if line == '':
360 self.close()
361 raise SMTPServerDisconnected("Connection unexpectedly closed")
Giampaolo Rodolà5c12ec62011-02-24 20:43:11 +0000362 if self.debuglevel > 0:
363 print>>stderr, 'reply:', repr(line)
Eric S. Raymondc013f302001-02-09 05:40:38 +0000364 resp.append(line[4:].strip())
Giampaolo Rodolà5c12ec62011-02-24 20:43:11 +0000365 code = line[:3]
Guido van Rossum296e1431999-04-07 15:03:39 +0000366 # Check that the error code is syntactically correct.
367 # Don't attempt to read a continuation line if it is broken.
368 try:
Eric S. Raymondc013f302001-02-09 05:40:38 +0000369 errcode = int(code)
Guido van Rossum296e1431999-04-07 15:03:39 +0000370 except ValueError:
371 errcode = -1
372 break
Guido van Rossumf123f841999-03-29 20:33:21 +0000373 # Check if multiline response.
Giampaolo Rodolà5c12ec62011-02-24 20:43:11 +0000374 if line[3:4] != "-":
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000375 break
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000376
Eric S. Raymondc013f302001-02-09 05:40:38 +0000377 errmsg = "\n".join(resp)
Tim Peters495ad3c2001-01-15 01:36:40 +0000378 if self.debuglevel > 0:
Giampaolo Rodolà5c12ec62011-02-24 20:43:11 +0000379 print>>stderr, 'reply: retcode (%s); Msg: %s' % (errcode, errmsg)
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000380 return errcode, errmsg
Tim Peters495ad3c2001-01-15 01:36:40 +0000381
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000382 def docmd(self, cmd, args=""):
Barry Warsawa7d9bdf1998-12-22 03:24:27 +0000383 """Send a command, and return its response code."""
Giampaolo Rodolà5c12ec62011-02-24 20:43:11 +0000384 self.putcmd(cmd, args)
Guido van Rossum296e1431999-04-07 15:03:39 +0000385 return self.getreply()
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000386
Barry Warsawa7d9bdf1998-12-22 03:24:27 +0000387 # std smtp commands
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000388 def helo(self, name=''):
Barry Warsawa7d9bdf1998-12-22 03:24:27 +0000389 """SMTP 'helo' command.
390 Hostname to send for this command defaults to the FQDN of the local
391 host.
392 """
Neil Schemenauer6730f262002-03-24 15:30:40 +0000393 self.putcmd("helo", name or self.local_hostname)
Giampaolo Rodolà5c12ec62011-02-24 20:43:11 +0000394 (code, msg) = self.getreply()
395 self.helo_resp = msg
396 return (code, msg)
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000397
Guido van Rossum95e6f701998-06-25 02:15:50 +0000398 def ehlo(self, name=''):
Barry Warsawa7d9bdf1998-12-22 03:24:27 +0000399 """ SMTP 'ehlo' command.
400 Hostname to send for this command defaults to the FQDN of the local
401 host.
402 """
Guido van Rossumf7fcf5e2001-09-14 16:08:44 +0000403 self.esmtp_features = {}
Martin v. Löwis1190a382007-03-09 15:35:55 +0000404 self.putcmd(self.ehlo_msg, name or self.local_hostname)
Giampaolo Rodolà5c12ec62011-02-24 20:43:11 +0000405 (code, msg) = self.getreply()
Tim Peters495ad3c2001-01-15 01:36:40 +0000406 # According to RFC1869 some (badly written)
407 # MTA's will disconnect on an ehlo. Toss an exception if
Guido van Rossumfcfb6321998-08-04 15:29:54 +0000408 # that happens -ddm
409 if code == -1 and len(msg) == 0:
Barry Warsaw76750972001-12-14 20:34:20 +0000410 self.close()
Guido van Rossum40233ea1999-01-15 03:23:55 +0000411 raise SMTPServerDisconnected("Server not connected")
Giampaolo Rodolà5c12ec62011-02-24 20:43:11 +0000412 self.ehlo_resp = msg
Fred Drake8152d322000-12-12 23:20:45 +0000413 if code != 250:
Giampaolo Rodolà5c12ec62011-02-24 20:43:11 +0000414 return (code, msg)
415 self.does_esmtp = 1
Thomas Wouters7e474022000-07-16 12:04:32 +0000416 #parse the ehlo response -ddm
Giampaolo Rodolà5c12ec62011-02-24 20:43:11 +0000417 resp = self.ehlo_resp.split('\n')
Guido van Rossumfcfb6321998-08-04 15:29:54 +0000418 del resp[0]
Guido van Rossum2880f6e1998-08-10 20:07:00 +0000419 for each in resp:
Piers Lauder385a77a2002-07-27 00:38:30 +0000420 # To be able to communicate with as many SMTP servers as possible,
421 # we have to take the old-style auth advertisement into account,
422 # because:
423 # 1) Else our SMTP feature parser gets confused.
424 # 2) There are some servers that only advertise the auth methods we
425 # support using the old style.
426 auth_match = OLDSTYLE_AUTH.match(each)
427 if auth_match:
428 # This doesn't remove duplicates, but that's no problem
429 self.esmtp_features["auth"] = self.esmtp_features.get("auth", "") \
430 + " " + auth_match.groups(0)[0]
431 continue
432
Barry Warsawbe22ae62002-04-15 20:03:30 +0000433 # RFC 1869 requires a space between ehlo keyword and parameters.
434 # It's actually stricter, in that only spaces are allowed between
435 # parameters, but were not going to check for that here. Note
436 # that the space isn't present if there are no parameters.
Giampaolo Rodolà5c12ec62011-02-24 20:43:11 +0000437 m = re.match(r'(?P<feature>[A-Za-z0-9][A-Za-z0-9\-]*) ?', each)
Guido van Rossumfcfb6321998-08-04 15:29:54 +0000438 if m:
Giampaolo Rodolà5c12ec62011-02-24 20:43:11 +0000439 feature = m.group("feature").lower()
440 params = m.string[m.end("feature"):].strip()
Piers Lauder385a77a2002-07-27 00:38:30 +0000441 if feature == "auth":
442 self.esmtp_features[feature] = self.esmtp_features.get(feature, "") \
443 + " " + params
444 else:
Giampaolo Rodolà5c12ec62011-02-24 20:43:11 +0000445 self.esmtp_features[feature] = params
446 return (code, msg)
Guido van Rossum95e6f701998-06-25 02:15:50 +0000447
Guido van Rossumfcfb6321998-08-04 15:29:54 +0000448 def has_extn(self, opt):
449 """Does the server support a given SMTP service extension?"""
Raymond Hettinger54f02222002-06-01 14:18:47 +0000450 return opt.lower() in self.esmtp_features
Guido van Rossum95e6f701998-06-25 02:15:50 +0000451
Guido van Rossum18586f41998-04-03 17:03:13 +0000452 def help(self, args=''):
Barry Warsawa7d9bdf1998-12-22 03:24:27 +0000453 """SMTP 'help' command.
454 Returns help text from server."""
Guido van Rossum18586f41998-04-03 17:03:13 +0000455 self.putcmd("help", args)
Kurt B. Kaiser58bd1902005-06-26 18:27:36 +0000456 return self.getreply()[1]
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000457
458 def rset(self):
Barry Warsawa7d9bdf1998-12-22 03:24:27 +0000459 """SMTP 'rset' command -- resets session."""
Guido van Rossum296e1431999-04-07 15:03:39 +0000460 return self.docmd("rset")
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000461
462 def noop(self):
Barry Warsawa7d9bdf1998-12-22 03:24:27 +0000463 """SMTP 'noop' command -- doesn't do anything :>"""
Guido van Rossum296e1431999-04-07 15:03:39 +0000464 return self.docmd("noop")
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000465
Giampaolo Rodolà5c12ec62011-02-24 20:43:11 +0000466 def mail(self, sender, options=[]):
Barry Warsawa7d9bdf1998-12-22 03:24:27 +0000467 """SMTP 'mail' command -- begins mail xfer session."""
Guido van Rossumfcfb6321998-08-04 15:29:54 +0000468 optionlist = ''
469 if options and self.does_esmtp:
Eric S. Raymondc013f302001-02-09 05:40:38 +0000470 optionlist = ' ' + ' '.join(options)
Giampaolo Rodolà5c12ec62011-02-24 20:43:11 +0000471 self.putcmd("mail", "FROM:%s%s" % (quoteaddr(sender), optionlist))
Guido van Rossum45e2fbc1998-03-26 21:13:24 +0000472 return self.getreply()
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000473
Giampaolo Rodolà5c12ec62011-02-24 20:43:11 +0000474 def rcpt(self, recip, options=[]):
Barry Warsawa7d9bdf1998-12-22 03:24:27 +0000475 """SMTP 'rcpt' command -- indicates 1 recipient for this mail."""
Guido van Rossumfcfb6321998-08-04 15:29:54 +0000476 optionlist = ''
477 if options and self.does_esmtp:
Eric S. Raymondc013f302001-02-09 05:40:38 +0000478 optionlist = ' ' + ' '.join(options)
Giampaolo Rodolà5c12ec62011-02-24 20:43:11 +0000479 self.putcmd("rcpt", "TO:%s%s" % (quoteaddr(recip), optionlist))
Guido van Rossum45e2fbc1998-03-26 21:13:24 +0000480 return self.getreply()
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000481
Giampaolo Rodolà5c12ec62011-02-24 20:43:11 +0000482 def data(self, msg):
Tim Peters495ad3c2001-01-15 01:36:40 +0000483 """SMTP 'DATA' command -- sends message data to server.
Guido van Rossum296e1431999-04-07 15:03:39 +0000484
Barry Warsaw4c4bec81998-12-22 03:02:20 +0000485 Automatically quotes lines beginning with a period per rfc821.
Guido van Rossum296e1431999-04-07 15:03:39 +0000486 Raises SMTPDataError if there is an unexpected reply to the
487 DATA command; the return value from this method is the final
488 response code received when the all data is sent.
Barry Warsaw4c4bec81998-12-22 03:02:20 +0000489 """
Guido van Rossum45e2fbc1998-03-26 21:13:24 +0000490 self.putcmd("data")
Giampaolo Rodolà5c12ec62011-02-24 20:43:11 +0000491 (code, repl) = self.getreply()
492 if self.debuglevel > 0:
493 print>>stderr, "data:", (code, repl)
Fred Drake8152d322000-12-12 23:20:45 +0000494 if code != 354:
Giampaolo Rodolà5c12ec62011-02-24 20:43:11 +0000495 raise SMTPDataError(code, repl)
Guido van Rossum45e2fbc1998-03-26 21:13:24 +0000496 else:
Guido van Rossum20c92281999-04-21 16:52:20 +0000497 q = quotedata(msg)
498 if q[-2:] != CRLF:
499 q = q + CRLF
500 q = q + "." + CRLF
501 self.send(q)
Giampaolo Rodolà5c12ec62011-02-24 20:43:11 +0000502 (code, msg) = self.getreply()
503 if self.debuglevel > 0:
504 print>>stderr, "data:", (code, msg)
505 return (code, msg)
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000506
Guido van Rossumfcfb6321998-08-04 15:29:54 +0000507 def verify(self, address):
Barry Warsawa7d9bdf1998-12-22 03:24:27 +0000508 """SMTP 'verify' command -- checks for address validity."""
R David Murray95225952011-07-18 21:34:04 -0400509 self.putcmd("vrfy", _addr_only(address))
Guido van Rossumfcfb6321998-08-04 15:29:54 +0000510 return self.getreply()
Barry Warsaw4c4bec81998-12-22 03:02:20 +0000511 # a.k.a.
Giampaolo Rodolà5c12ec62011-02-24 20:43:11 +0000512 vrfy = verify
Guido van Rossumfcfb6321998-08-04 15:29:54 +0000513
514 def expn(self, address):
Facundo Batista16609332008-02-23 12:27:17 +0000515 """SMTP 'expn' command -- expands a mailing list."""
R David Murray95225952011-07-18 21:34:04 -0400516 self.putcmd("expn", _addr_only(address))
Guido van Rossumfcfb6321998-08-04 15:29:54 +0000517 return self.getreply()
518
Barry Warsaw4c4bec81998-12-22 03:02:20 +0000519 # some useful methods
Guido van Rossumae010462001-09-11 15:57:46 +0000520
Gregory P. Smithbde4ae42008-01-17 08:35:49 +0000521 def ehlo_or_helo_if_needed(self):
522 """Call self.ehlo() and/or self.helo() if needed.
523
524 If there has been no previous EHLO or HELO command this session, this
525 method tries ESMTP EHLO first.
526
527 This method may raise the following exceptions:
528
529 SMTPHeloError The server didn't reply properly to
530 the helo greeting.
531 """
532 if self.helo_resp is None and self.ehlo_resp is None:
533 if not (200 <= self.ehlo()[0] <= 299):
534 (code, resp) = self.helo()
535 if not (200 <= code <= 299):
536 raise SMTPHeloError(code, resp)
537
Guido van Rossumae010462001-09-11 15:57:46 +0000538 def login(self, user, password):
539 """Log in on an SMTP server that requires authentication.
540
541 The arguments are:
542 - user: The user name to authenticate with.
543 - password: The password for the authentication.
544
545 If there has been no previous EHLO or HELO command this session, this
546 method tries ESMTP EHLO first.
547
548 This method will return normally if the authentication was successful.
549
550 This method may raise the following exceptions:
551
552 SMTPHeloError The server didn't reply properly to
553 the helo greeting.
554 SMTPAuthenticationError The server didn't accept the username/
555 password combination.
Fred Drake2f8f4d32001-10-13 18:35:32 +0000556 SMTPException No suitable authentication method was
Guido van Rossumae010462001-09-11 15:57:46 +0000557 found.
558 """
559
560 def encode_cram_md5(challenge, user, password):
561 challenge = base64.decodestring(challenge)
562 response = user + " " + hmac.HMAC(password, challenge).hexdigest()
Piers Lauder385a77a2002-07-27 00:38:30 +0000563 return encode_base64(response, eol="")
Guido van Rossumae010462001-09-11 15:57:46 +0000564
565 def encode_plain(user, password):
Johannes Gijsbers25946dd2004-12-06 21:25:26 +0000566 return encode_base64("\0%s\0%s" % (user, password), eol="")
Tim Peters469cdad2002-08-08 20:19:19 +0000567
Guido van Rossumae010462001-09-11 15:57:46 +0000568
569 AUTH_PLAIN = "PLAIN"
570 AUTH_CRAM_MD5 = "CRAM-MD5"
Piers Lauder385a77a2002-07-27 00:38:30 +0000571 AUTH_LOGIN = "LOGIN"
Guido van Rossumae010462001-09-11 15:57:46 +0000572
Gregory P. Smithbde4ae42008-01-17 08:35:49 +0000573 self.ehlo_or_helo_if_needed()
Guido van Rossumae010462001-09-11 15:57:46 +0000574
575 if not self.has_extn("auth"):
576 raise SMTPException("SMTP AUTH extension not supported by server.")
577
578 # Authentication methods the server supports:
579 authlist = self.esmtp_features["auth"].split()
580
581 # List of authentication methods we support: from preferred to
582 # less preferred methods. Except for the purpose of testing the weaker
583 # ones, we prefer stronger methods like CRAM-MD5:
Piers Lauder385a77a2002-07-27 00:38:30 +0000584 preferred_auths = [AUTH_CRAM_MD5, AUTH_PLAIN, AUTH_LOGIN]
Guido van Rossumae010462001-09-11 15:57:46 +0000585
586 # Determine the authentication method we'll use
587 authmethod = None
588 for method in preferred_auths:
589 if method in authlist:
590 authmethod = method
591 break
Tim Petersb64bec32001-09-18 02:26:39 +0000592
Guido van Rossumae010462001-09-11 15:57:46 +0000593 if authmethod == AUTH_CRAM_MD5:
594 (code, resp) = self.docmd("AUTH", AUTH_CRAM_MD5)
595 if code == 503:
596 # 503 == 'Error: already authenticated'
597 return (code, resp)
598 (code, resp) = self.docmd(encode_cram_md5(resp, user, password))
599 elif authmethod == AUTH_PLAIN:
Tim Petersb64bec32001-09-18 02:26:39 +0000600 (code, resp) = self.docmd("AUTH",
Guido van Rossumae010462001-09-11 15:57:46 +0000601 AUTH_PLAIN + " " + encode_plain(user, password))
Piers Lauder385a77a2002-07-27 00:38:30 +0000602 elif authmethod == AUTH_LOGIN:
603 (code, resp) = self.docmd("AUTH",
604 "%s %s" % (AUTH_LOGIN, encode_base64(user, eol="")))
605 if code != 334:
606 raise SMTPAuthenticationError(code, resp)
Martin v. Löwis49c05d32002-10-06 17:55:08 +0000607 (code, resp) = self.docmd(encode_base64(password, eol=""))
Raymond Hettinger7fdfc2d2002-05-31 17:49:10 +0000608 elif authmethod is None:
Fred Drake2f8f4d32001-10-13 18:35:32 +0000609 raise SMTPException("No suitable authentication method found.")
Raymond Hettingerdbecd932005-02-06 06:57:08 +0000610 if code not in (235, 503):
Guido van Rossumae010462001-09-11 15:57:46 +0000611 # 235 == 'Authentication successful'
612 # 503 == 'Error: already authenticated'
613 raise SMTPAuthenticationError(code, resp)
614 return (code, resp)
615
Giampaolo Rodolà5c12ec62011-02-24 20:43:11 +0000616 def starttls(self, keyfile=None, certfile=None):
Guido van Rossumf7fcf5e2001-09-14 16:08:44 +0000617 """Puts the connection to the SMTP server into TLS mode.
Tim Petersb64bec32001-09-18 02:26:39 +0000618
Gregory P. Smithbde4ae42008-01-17 08:35:49 +0000619 If there has been no previous EHLO or HELO command this session, this
620 method tries ESMTP EHLO first.
621
Guido van Rossumf7fcf5e2001-09-14 16:08:44 +0000622 If the server supports TLS, this will encrypt the rest of the SMTP
623 session. If you provide the keyfile and certfile parameters,
624 the identity of the SMTP server and client can be checked. This,
625 however, depends on whether the socket module really checks the
626 certificates.
Gregory P. Smithbde4ae42008-01-17 08:35:49 +0000627
628 This method may raise the following exceptions:
629
630 SMTPHeloError The server didn't reply properly to
631 the helo greeting.
Guido van Rossumf7fcf5e2001-09-14 16:08:44 +0000632 """
Gregory P. Smithbde4ae42008-01-17 08:35:49 +0000633 self.ehlo_or_helo_if_needed()
634 if not self.has_extn("starttls"):
635 raise SMTPException("STARTTLS extension not supported by server.")
Tim Petersb64bec32001-09-18 02:26:39 +0000636 (resp, reply) = self.docmd("STARTTLS")
Guido van Rossumf7fcf5e2001-09-14 16:08:44 +0000637 if resp == 220:
Bill Janssen426ea0a2007-08-29 22:35:05 +0000638 if not _have_ssl:
639 raise RuntimeError("No SSL support included in this Python")
Bill Janssen98d19da2007-09-10 21:51:02 +0000640 self.sock = ssl.wrap_socket(self.sock, keyfile, certfile)
Bill Janssen426ea0a2007-08-29 22:35:05 +0000641 self.file = SSLFakeFile(self.sock)
Gregory P. Smith63bfc1d2008-01-17 07:43:20 +0000642 # RFC 3207:
643 # The client MUST discard any knowledge obtained from
644 # the server, such as the list of SMTP service extensions,
645 # which was not obtained from the TLS negotiation itself.
646 self.helo_resp = None
647 self.ehlo_resp = None
648 self.esmtp_features = {}
649 self.does_esmtp = 0
Guido van Rossumf7fcf5e2001-09-14 16:08:44 +0000650 return (resp, reply)
Tim Petersb64bec32001-09-18 02:26:39 +0000651
Jeremy Hylton31bb8ce1998-08-13 19:57:46 +0000652 def sendmail(self, from_addr, to_addrs, msg, mail_options=[],
Tim Peters495ad3c2001-01-15 01:36:40 +0000653 rcpt_options=[]):
654 """This command performs an entire mail transaction.
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000655
Tim Peters495ad3c2001-01-15 01:36:40 +0000656 The arguments are:
Barry Warsaw4c4bec81998-12-22 03:02:20 +0000657 - from_addr : The address sending this mail.
658 - to_addrs : A list of addresses to send this mail to. A bare
659 string will be treated as a list with 1 address.
Tim Peters495ad3c2001-01-15 01:36:40 +0000660 - msg : The message to send.
Barry Warsaw4c4bec81998-12-22 03:02:20 +0000661 - mail_options : List of ESMTP options (such as 8bitmime) for the
662 mail command.
663 - rcpt_options : List of ESMTP options (such as DSN commands) for
664 all the rcpt commands.
665
666 If there has been no previous EHLO or HELO command this session, this
667 method tries ESMTP EHLO first. If the server does ESMTP, message size
668 and each of the specified options will be passed to it. If EHLO
669 fails, HELO will be tried and ESMTP options suppressed.
670
671 This method will return normally if the mail is accepted for at least
Barry Warsawd25c1b71999-11-28 17:11:06 +0000672 one recipient. It returns a dictionary, with one entry for each
673 recipient that was refused. Each entry contains a tuple of the SMTP
674 error code and the accompanying error message sent by the server.
Guido van Rossum296e1431999-04-07 15:03:39 +0000675
676 This method may raise the following exceptions:
677
678 SMTPHeloError The server didn't reply properly to
Tim Peters495ad3c2001-01-15 01:36:40 +0000679 the helo greeting.
Barry Warsawd25c1b71999-11-28 17:11:06 +0000680 SMTPRecipientsRefused The server rejected ALL recipients
Guido van Rossum296e1431999-04-07 15:03:39 +0000681 (no mail was sent).
682 SMTPSenderRefused The server didn't accept the from_addr.
683 SMTPDataError The server replied with an unexpected
684 error code (other than a refusal of
685 a recipient).
686
687 Note: the connection will be open even after an exception is raised.
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000688
Guido van Rossum95e6f701998-06-25 02:15:50 +0000689 Example:
Tim Peters495ad3c2001-01-15 01:36:40 +0000690
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000691 >>> import smtplib
692 >>> s=smtplib.SMTP("localhost")
Guido van Rossumfc40a831998-01-29 17:26:45 +0000693 >>> tolist=["one@one.org","two@two.org","three@three.org","four@four.org"]
Martin v. Löwis301b1cd2002-07-28 16:52:01 +0000694 >>> msg = '''\\
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000695 ... From: Me@my.org
696 ... Subject: testin'...
697 ...
698 ... This is a test '''
699 >>> s.sendmail("me@my.org",tolist,msg)
700 { "three@three.org" : ( 550 ,"User unknown" ) }
701 >>> s.quit()
Tim Peters495ad3c2001-01-15 01:36:40 +0000702
Barry Warsaw4c4bec81998-12-22 03:02:20 +0000703 In the above example, the message was accepted for delivery to three
704 of the four addresses, and one was rejected, with the error code
Barry Warsawd25c1b71999-11-28 17:11:06 +0000705 550. If all addresses are accepted, then the method will return an
Barry Warsaw4c4bec81998-12-22 03:02:20 +0000706 empty dictionary.
707
708 """
Gregory P. Smithbde4ae42008-01-17 08:35:49 +0000709 self.ehlo_or_helo_if_needed()
Guido van Rossum95e6f701998-06-25 02:15:50 +0000710 esmtp_opts = []
Guido van Rossumfcfb6321998-08-04 15:29:54 +0000711 if self.does_esmtp:
712 # Hmmm? what's this? -ddm
713 # self.esmtp_features['7bit']=""
714 if self.has_extn('size'):
Walter Dörwald70a6b492004-02-12 17:35:32 +0000715 esmtp_opts.append("size=%d" % len(msg))
Guido van Rossumfcfb6321998-08-04 15:29:54 +0000716 for option in mail_options:
Guido van Rossum95e6f701998-06-25 02:15:50 +0000717 esmtp_opts.append(option)
Guido van Rossumfcfb6321998-08-04 15:29:54 +0000718
Giampaolo Rodolà5c12ec62011-02-24 20:43:11 +0000719 (code, resp) = self.mail(from_addr, esmtp_opts)
Fred Drake8152d322000-12-12 23:20:45 +0000720 if code != 250:
Guido van Rossum45e2fbc1998-03-26 21:13:24 +0000721 self.rset()
Guido van Rossum296e1431999-04-07 15:03:39 +0000722 raise SMTPSenderRefused(code, resp, from_addr)
Giampaolo Rodolà5c12ec62011-02-24 20:43:11 +0000723 senderrs = {}
Walter Dörwald65230a22002-06-03 15:58:32 +0000724 if isinstance(to_addrs, basestring):
Jeremy Hylton31bb8ce1998-08-13 19:57:46 +0000725 to_addrs = [to_addrs]
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000726 for each in to_addrs:
Giampaolo Rodolà5c12ec62011-02-24 20:43:11 +0000727 (code, resp) = self.rcpt(each, rcpt_options)
Fred Drake8152d322000-12-12 23:20:45 +0000728 if (code != 250) and (code != 251):
Giampaolo Rodolà5c12ec62011-02-24 20:43:11 +0000729 senderrs[each] = (code, resp)
730 if len(senderrs) == len(to_addrs):
Guido van Rossum95e6f701998-06-25 02:15:50 +0000731 # the server refused all our recipients
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000732 self.rset()
Guido van Rossum296e1431999-04-07 15:03:39 +0000733 raise SMTPRecipientsRefused(senderrs)
Giampaolo Rodolà5c12ec62011-02-24 20:43:11 +0000734 (code, resp) = self.data(msg)
Fred Drake8152d322000-12-12 23:20:45 +0000735 if code != 250:
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000736 self.rset()
Guido van Rossum296e1431999-04-07 15:03:39 +0000737 raise SMTPDataError(code, resp)
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000738 #if we got here then somebody got our mail
Tim Peters495ad3c2001-01-15 01:36:40 +0000739 return senderrs
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000740
741
742 def close(self):
743 """Close the connection to the SMTP server."""
744 if self.file:
745 self.file.close()
746 self.file = None
747 if self.sock:
748 self.sock.close()
749 self.sock = None
750
751
752 def quit(self):
Guido van Rossum95e6f701998-06-25 02:15:50 +0000753 """Terminate the SMTP session."""
Georg Brandldeaf2ca2008-03-27 13:27:31 +0000754 res = self.docmd("quit")
Guido van Rossum45e2fbc1998-03-26 21:13:24 +0000755 self.close()
Georg Brandldeaf2ca2008-03-27 13:27:31 +0000756 return res
Guido van Rossum95e6f701998-06-25 02:15:50 +0000757
Bill Janssen426ea0a2007-08-29 22:35:05 +0000758if _have_ssl:
Martin v. Löwisee82c0e2006-10-27 07:13:28 +0000759
Bill Janssen426ea0a2007-08-29 22:35:05 +0000760 class SMTP_SSL(SMTP):
761 """ This is a subclass derived from SMTP that connects over an SSL encrypted
762 socket (to use this class you need a socket module that was compiled with SSL
763 support). If host is not specified, '' (the local host) is used. If port is
764 omitted, the standard SMTP-over-SSL port (465) is used. keyfile and certfile
765 are also optional - they can contain a PEM formatted private key and
766 certificate chain file for the SSL connection.
767 """
Antoine Pitrou21ce8f02011-05-07 19:59:33 +0200768
769 default_port = SMTP_SSL_PORT
770
Bill Janssen426ea0a2007-08-29 22:35:05 +0000771 def __init__(self, host='', port=0, local_hostname=None,
Facundo Batista4f1b1ed2008-05-29 16:39:26 +0000772 keyfile=None, certfile=None,
773 timeout=socket._GLOBAL_DEFAULT_TIMEOUT):
Bill Janssen426ea0a2007-08-29 22:35:05 +0000774 self.keyfile = keyfile
775 self.certfile = certfile
776 SMTP.__init__(self, host, port, local_hostname, timeout)
Bill Janssen426ea0a2007-08-29 22:35:05 +0000777
778 def _get_socket(self, host, port, timeout):
Giampaolo Rodolà5c12ec62011-02-24 20:43:11 +0000779 if self.debuglevel > 0:
780 print>>stderr, 'connect:', (host, port)
R. David Murrayad3058e2009-05-23 00:48:58 +0000781 new_socket = socket.create_connection((host, port), timeout)
782 new_socket = ssl.wrap_socket(new_socket, self.keyfile, self.certfile)
783 self.file = SSLFakeFile(new_socket)
784 return new_socket
Barry Warsaw4c4bec81998-12-22 03:02:20 +0000785
Thomas Woutersa6900e82007-08-30 21:54:39 +0000786 __all__.append("SMTP_SSL")
787
Martin v. Löwis1190a382007-03-09 15:35:55 +0000788#
789# LMTP extension
790#
791LMTP_PORT = 2003
792
793class LMTP(SMTP):
794 """LMTP - Local Mail Transfer Protocol
795
796 The LMTP protocol, which is very similar to ESMTP, is heavily based
797 on the standard SMTP client. It's common to use Unix sockets for LMTP,
798 so our connect() method must support that as well as a regular
799 host:port server. To specify a Unix socket, you must use an absolute
800 path as the host, starting with a '/'.
801
802 Authentication is supported, using the regular SMTP mechanism. When
803 using a Unix socket, LMTP generally don't support or require any
804 authentication, but your mileage might vary."""
805
806 ehlo_msg = "lhlo"
Tim Petersea5962f2007-03-12 18:07:52 +0000807
Giampaolo Rodolà5c12ec62011-02-24 20:43:11 +0000808 def __init__(self, host='', port=LMTP_PORT, local_hostname=None):
Martin v. Löwis1190a382007-03-09 15:35:55 +0000809 """Initialize a new instance."""
810 SMTP.__init__(self, host, port, local_hostname)
811
Giampaolo Rodolà5c12ec62011-02-24 20:43:11 +0000812 def connect(self, host='localhost', port=0):
Martin v. Löwis1190a382007-03-09 15:35:55 +0000813 """Connect to the LMTP daemon, on either a Unix or a TCP socket."""
Neal Norwitzc8f6c232007-03-10 03:19:18 +0000814 if host[0] != '/':
Martin v. Löwis1190a382007-03-09 15:35:55 +0000815 return SMTP.connect(self, host, port)
816
Neal Norwitzc8f6c232007-03-10 03:19:18 +0000817 # Handle Unix-domain sockets.
818 try:
819 self.sock = socket.socket(socket.AF_UNIX, socket.SOCK_STREAM)
820 self.sock.connect(host)
Andrew Svetloved3f6c62012-12-17 19:06:43 +0200821 except socket.error:
Giampaolo Rodolà5c12ec62011-02-24 20:43:11 +0000822 if self.debuglevel > 0:
823 print>>stderr, 'connect fail:', host
Neal Norwitzc8f6c232007-03-10 03:19:18 +0000824 if self.sock:
825 self.sock.close()
826 self.sock = None
Andrew Svetloved3f6c62012-12-17 19:06:43 +0200827 raise
Neal Norwitzc8f6c232007-03-10 03:19:18 +0000828 (code, msg) = self.getreply()
Giampaolo Rodolà5c12ec62011-02-24 20:43:11 +0000829 if self.debuglevel > 0:
830 print>>stderr, "connect:", msg
Neal Norwitzc8f6c232007-03-10 03:19:18 +0000831 return (code, msg)
832
Martin v. Löwis1190a382007-03-09 15:35:55 +0000833
Guido van Rossum95e6f701998-06-25 02:15:50 +0000834# Test the sendmail method, which tests most of the others.
835# Note: This always sends to localhost.
836if __name__ == '__main__':
Andrew M. Kuchling6be424f2001-08-13 14:41:39 +0000837 import sys
Guido van Rossum95e6f701998-06-25 02:15:50 +0000838
839 def prompt(prompt):
840 sys.stdout.write(prompt + ": ")
Eric S. Raymondc013f302001-02-09 05:40:38 +0000841 return sys.stdin.readline().strip()
Guido van Rossum95e6f701998-06-25 02:15:50 +0000842
843 fromaddr = prompt("From")
Giampaolo Rodolà5c12ec62011-02-24 20:43:11 +0000844 toaddrs = prompt("To").split(',')
Guido van Rossum95e6f701998-06-25 02:15:50 +0000845 print "Enter message, end with ^D:"
846 msg = ''
847 while 1:
848 line = sys.stdin.readline()
849 if not line:
850 break
851 msg = msg + line
Walter Dörwald70a6b492004-02-12 17:35:32 +0000852 print "Message length is %d" % len(msg)
Guido van Rossum95e6f701998-06-25 02:15:50 +0000853
854 server = SMTP('localhost')
855 server.set_debuglevel(1)
856 server.sendmail(fromaddr, toaddrs, msg)
857 server.quit()