blob: d8d717c05b55833c60daf26fde29e1c42f546f49 [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")
Guido van Rossum7131f842007-02-09 20:13:25 +000018 >>> print(s.help())
Barry Warsawa7d9bdf1998-12-22 03:24:27 +000019 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
Thomas Woutersb2137042007-02-01 18:02:27 +000046import email.utils
Guido van Rossumae010462001-09-11 15:57:46 +000047import base64
48import hmac
Barry Warsaw2cc1f6d2007-08-30 14:28:55 +000049from email.base64mime import body_encode as encode_base64
Brett Cannone6f8a892004-07-10 23:14:30 +000050from sys import stderr
Guido van Rossumbbe323e1998-01-29 17:24:40 +000051
Skip Montanaro0de65802001-02-15 22:15:14 +000052__all__ = ["SMTPException","SMTPServerDisconnected","SMTPResponseException",
53 "SMTPSenderRefused","SMTPRecipientsRefused","SMTPDataError",
Guido van Rossumae010462001-09-11 15:57:46 +000054 "SMTPConnectError","SMTPHeloError","SMTPAuthenticationError",
Thomas Wouters47b49bf2007-08-30 22:15:33 +000055 "quoteaddr","quotedata","SMTP"]
Skip Montanaro0de65802001-02-15 22:15:14 +000056
Guido van Rossumbbe323e1998-01-29 17:24:40 +000057SMTP_PORT = 25
Thomas Wouters89f507f2006-12-13 04:49:30 +000058SMTP_SSL_PORT = 465
Guido van Rossumbbe323e1998-01-29 17:24:40 +000059CRLF="\r\n"
60
Piers Lauder385a77a2002-07-27 00:38:30 +000061OLDSTYLE_AUTH = re.compile(r"auth=(.*)", re.I)
62
Tim Peters495ad3c2001-01-15 01:36:40 +000063# Exception classes used by this module.
Guido van Rossum296e1431999-04-07 15:03:39 +000064class SMTPException(Exception):
65 """Base class for all exceptions raised by this module."""
66
67class SMTPServerDisconnected(SMTPException):
68 """Not connected to any SMTP server.
69
70 This exception is raised when the server unexpectedly disconnects,
71 or when an attempt is made to use the SMTP instance before
72 connecting it to a server.
73 """
74
75class SMTPResponseException(SMTPException):
76 """Base class for all exceptions that include an SMTP error code.
77
78 These exceptions are generated in some instances when the SMTP
79 server returns an error code. The error code is stored in the
80 `smtp_code' attribute of the error, and the `smtp_error' attribute
81 is set to the error message.
82 """
83
84 def __init__(self, code, msg):
85 self.smtp_code = code
86 self.smtp_error = msg
87 self.args = (code, msg)
88
89class SMTPSenderRefused(SMTPResponseException):
90 """Sender address refused.
Guido van Rossumae010462001-09-11 15:57:46 +000091
Guido van Rossum296e1431999-04-07 15:03:39 +000092 In addition to the attributes set by on all SMTPResponseException
Barry Warsawd25c1b71999-11-28 17:11:06 +000093 exceptions, this sets `sender' to the string that the SMTP refused.
Guido van Rossum296e1431999-04-07 15:03:39 +000094 """
95
96 def __init__(self, code, msg, sender):
97 self.smtp_code = code
98 self.smtp_error = msg
99 self.sender = sender
100 self.args = (code, msg, sender)
101
Guido van Rossum20c92281999-04-21 16:52:20 +0000102class SMTPRecipientsRefused(SMTPException):
Barry Warsawd25c1b71999-11-28 17:11:06 +0000103 """All recipient addresses refused.
Guido van Rossumae010462001-09-11 15:57:46 +0000104
Thomas Wouters7e474022000-07-16 12:04:32 +0000105 The errors for each recipient are accessible through the attribute
Tim Peters495ad3c2001-01-15 01:36:40 +0000106 'recipients', which is a dictionary of exactly the same sort as
107 SMTP.sendmail() returns.
Guido van Rossum296e1431999-04-07 15:03:39 +0000108 """
109
110 def __init__(self, recipients):
111 self.recipients = recipients
112 self.args = ( recipients,)
113
114
Guido van Rossum296e1431999-04-07 15:03:39 +0000115class SMTPDataError(SMTPResponseException):
116 """The SMTP server didn't accept the data."""
117
118class SMTPConnectError(SMTPResponseException):
Barry Warsawd25c1b71999-11-28 17:11:06 +0000119 """Error during connection establishment."""
Guido van Rossum296e1431999-04-07 15:03:39 +0000120
121class SMTPHeloError(SMTPResponseException):
Barry Warsawd25c1b71999-11-28 17:11:06 +0000122 """The server refused our HELO reply."""
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000123
Guido van Rossumae010462001-09-11 15:57:46 +0000124class SMTPAuthenticationError(SMTPResponseException):
125 """Authentication error.
126
127 Most probably the server didn't accept the username/password
128 combination provided.
129 """
Peter Schneider-Kamp7bc82bb2000-08-10 14:02:23 +0000130
Guido van Rossum69a79bc1998-07-13 15:18:49 +0000131def quoteaddr(addr):
132 """Quote a subset of the email addresses defined by RFC 821.
133
Georg Brandl9f0f9602008-06-12 22:23:59 +0000134 Should be able to handle anything email.utils.parseaddr can handle.
Barry Warsawa7d9bdf1998-12-22 03:24:27 +0000135 """
Raymond Hettinger342456d2002-09-05 01:14:07 +0000136 m = (None, None)
Guido van Rossum69a79bc1998-07-13 15:18:49 +0000137 try:
Thomas Woutersb2137042007-02-01 18:02:27 +0000138 m = email.utils.parseaddr(addr)[1]
Guido van Rossumfcfb6321998-08-04 15:29:54 +0000139 except AttributeError:
140 pass
Raymond Hettinger342456d2002-09-05 01:14:07 +0000141 if m == (None, None): # Indicates parse failure or AttributeError
Georg Brandlbd3bc4d2006-02-17 09:52:53 +0000142 # something weird here.. punt -ddm
Raymond Hettinger342456d2002-09-05 01:14:07 +0000143 return "<%s>" % addr
Georg Brandlbd3bc4d2006-02-17 09:52:53 +0000144 elif m is None:
145 # the sender wants an empty return address
146 return "<>"
Guido van Rossumfcfb6321998-08-04 15:29:54 +0000147 else:
148 return "<%s>" % m
Guido van Rossum69a79bc1998-07-13 15:18:49 +0000149
150def quotedata(data):
151 """Quote data for email.
152
Barry Warsawd25c1b71999-11-28 17:11:06 +0000153 Double leading '.', and change Unix newline '\\n', or Mac '\\r' into
Barry Warsawa7d9bdf1998-12-22 03:24:27 +0000154 Internet CRLF end-of-line.
155 """
Guido van Rossum69a79bc1998-07-13 15:18:49 +0000156 return re.sub(r'(?m)^\.', '..',
Guido van Rossumfcfb6321998-08-04 15:29:54 +0000157 re.sub(r'(?:\r\n|\n|\r(?!\n))', CRLF, data))
Guido van Rossum69a79bc1998-07-13 15:18:49 +0000158
Thomas Wouters47b49bf2007-08-30 22:15:33 +0000159try:
160 import ssl
161except ImportError:
162 _have_ssl = False
163else:
Thomas Wouters47b49bf2007-08-30 22:15:33 +0000164 class SSLFakeFile:
165 """A fake file like object that really wraps a SSLObject.
166
167 It only supports what is needed in smtplib.
168 """
169 def __init__(self, sslobj):
170 self.sslobj = sslobj
171
172 def readline(self):
173 str = b""
174 chr = None
175 while chr != b"\n":
176 chr = self.sslobj.read(1)
Christian Heimese25f35e2008-03-20 10:49:03 +0000177 if not chr: break
Thomas Wouters47b49bf2007-08-30 22:15:33 +0000178 str += chr
179 return str
180
181 def close(self):
182 pass
183
184 _have_ssl = True
185
Peter Schneider-Kamp7bc82bb2000-08-10 14:02:23 +0000186
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000187class SMTP:
Guido van Rossumfcfb6321998-08-04 15:29:54 +0000188 """This class manages a connection to an SMTP or ESMTP server.
189 SMTP Objects:
Tim Peters495ad3c2001-01-15 01:36:40 +0000190 SMTP objects have the following attributes:
191 helo_resp
192 This is the message given by the server in response to the
Guido van Rossumfcfb6321998-08-04 15:29:54 +0000193 most recent HELO command.
Tim Peters495ad3c2001-01-15 01:36:40 +0000194
Guido van Rossumfcfb6321998-08-04 15:29:54 +0000195 ehlo_resp
Tim Peters495ad3c2001-01-15 01:36:40 +0000196 This is the message given by the server in response to the
Guido van Rossumfcfb6321998-08-04 15:29:54 +0000197 most recent EHLO command. This is usually multiline.
198
Tim Peters495ad3c2001-01-15 01:36:40 +0000199 does_esmtp
Guido van Rossumfcfb6321998-08-04 15:29:54 +0000200 This is a True value _after you do an EHLO command_, if the
201 server supports ESMTP.
202
Tim Peters495ad3c2001-01-15 01:36:40 +0000203 esmtp_features
Guido van Rossumfcfb6321998-08-04 15:29:54 +0000204 This is a dictionary, which, if the server supports ESMTP,
Barry Warsawd25c1b71999-11-28 17:11:06 +0000205 will _after you do an EHLO command_, contain the names of the
206 SMTP service extensions this server supports, and their
Guido van Rossumfcfb6321998-08-04 15:29:54 +0000207 parameters (if any).
Barry Warsawd25c1b71999-11-28 17:11:06 +0000208
Tim Peters495ad3c2001-01-15 01:36:40 +0000209 Note, all extension names are mapped to lower case in the
210 dictionary.
Guido van Rossumfcfb6321998-08-04 15:29:54 +0000211
Barry Warsawd25c1b71999-11-28 17:11:06 +0000212 See each method's docstrings for details. In general, there is a
213 method of the same name to perform each SMTP command. There is also a
214 method called 'sendmail' that will do an entire mail transaction.
215 """
Guido van Rossum95e6f701998-06-25 02:15:50 +0000216 debuglevel = 0
217 file = None
218 helo_resp = None
Guido van Rossumd8faa362007-04-27 19:54:29 +0000219 ehlo_msg = "ehlo"
Guido van Rossum95e6f701998-06-25 02:15:50 +0000220 ehlo_resp = None
Guido van Rossumfcfb6321998-08-04 15:29:54 +0000221 does_esmtp = 0
Guido van Rossum95e6f701998-06-25 02:15:50 +0000222
Georg Brandlf78e02b2008-06-10 17:40:04 +0000223 def __init__(self, host='', port=0, local_hostname=None,
224 timeout=socket._GLOBAL_DEFAULT_TIMEOUT):
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000225 """Initialize a new instance.
226
Barry Warsawa7d9bdf1998-12-22 03:24:27 +0000227 If specified, `host' is the name of the remote host to which to
228 connect. If specified, `port' specifies the port to which to connect.
Barry Warsawd25c1b71999-11-28 17:11:06 +0000229 By default, smtplib.SMTP_PORT is used. An SMTPConnectError is raised
Neil Schemenauer6730f262002-03-24 15:30:40 +0000230 if the specified `host' doesn't respond correctly. If specified,
Tim Peters863ac442002-04-16 01:38:40 +0000231 `local_hostname` is used as the FQDN of the local host. By default,
232 the local hostname is found using socket.getfqdn().
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000233
234 """
Guido van Rossumd8faa362007-04-27 19:54:29 +0000235 self.timeout = timeout
Guido van Rossumfcfb6321998-08-04 15:29:54 +0000236 self.esmtp_features = {}
Thomas Wouters89f507f2006-12-13 04:49:30 +0000237 self.default_port = SMTP_PORT
Guido van Rossum296e1431999-04-07 15:03:39 +0000238 if host:
239 (code, msg) = self.connect(host, port)
240 if code != 220:
241 raise SMTPConnectError(code, msg)
Raymond Hettingerf13eb552002-06-02 00:40:05 +0000242 if local_hostname is not None:
Barry Warsaw13e34f72002-03-26 20:27:35 +0000243 self.local_hostname = local_hostname
Neil Schemenauer6730f262002-03-24 15:30:40 +0000244 else:
Barry Warsaw13e34f72002-03-26 20:27:35 +0000245 # RFC 2821 says we should use the fqdn in the EHLO/HELO verb, and
246 # if that can't be calculated, that we should use a domain literal
247 # instead (essentially an encoded IP address like [A.B.C.D]).
248 fqdn = socket.getfqdn()
249 if '.' in fqdn:
250 self.local_hostname = fqdn
251 else:
252 # We can't find an fqdn hostname, so use a domain literal
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000253 addr = '127.0.0.1'
254 try:
255 addr = socket.gethostbyname(socket.gethostname())
256 except socket.gaierror:
257 pass
Barry Warsaw13e34f72002-03-26 20:27:35 +0000258 self.local_hostname = '[%s]' % addr
Tim Peters495ad3c2001-01-15 01:36:40 +0000259
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000260 def set_debuglevel(self, debuglevel):
261 """Set the debug output level.
262
Barry Warsawa7d9bdf1998-12-22 03:24:27 +0000263 A non-false value results in debug messages for connection and for all
264 messages sent to and received from the server.
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000265
266 """
267 self.debuglevel = debuglevel
268
Barry Warsawc9181712008-03-19 14:25:51 +0000269 def _get_socket(self, host, port, timeout):
Thomas Wouters89f507f2006-12-13 04:49:30 +0000270 # This makes it simpler for SMTP_SSL to use the SMTP connect code
271 # and just alter the socket connection bit.
Guido van Rossumbe19ed72007-02-09 05:37:30 +0000272 if self.debuglevel > 0: print('connect:', (host, port), file=stderr)
Barry Warsawc9181712008-03-19 14:25:51 +0000273 return socket.create_connection((host, port), timeout)
Thomas Wouters89f507f2006-12-13 04:49:30 +0000274
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000275 def connect(self, host='localhost', port = 0):
276 """Connect to a host on a given port.
Guido van Rossum95e6f701998-06-25 02:15:50 +0000277
Barry Warsaw4c4bec81998-12-22 03:02:20 +0000278 If the hostname ends with a colon (`:') followed by a number, and
279 there is no port specified, that suffix will be stripped off and the
280 number interpreted as the port number to use.
Guido van Rossum95e6f701998-06-25 02:15:50 +0000281
Barry Warsawa7d9bdf1998-12-22 03:24:27 +0000282 Note: This method is automatically invoked by __init__, if a host is
283 specified during instantiation.
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000284
285 """
Martin v. Löwis4eb59402001-07-26 13:37:33 +0000286 if not port and (host.find(':') == host.rfind(':')):
Martin v. Löwisa43c2f82001-07-24 20:34:08 +0000287 i = host.rfind(':')
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000288 if i >= 0:
289 host, port = host[:i], host[i+1:]
Eric S. Raymondc013f302001-02-09 05:40:38 +0000290 try: port = int(port)
Eric S. Raymond8d876032001-02-09 10:14:53 +0000291 except ValueError:
Guido van Rossumd8faa362007-04-27 19:54:29 +0000292 raise socket.error("nonnumeric port")
Thomas Wouters89f507f2006-12-13 04:49:30 +0000293 if not port: port = self.default_port
Guido van Rossumbe19ed72007-02-09 05:37:30 +0000294 if self.debuglevel > 0: print('connect:', (host, port), file=stderr)
Guido van Rossumd8faa362007-04-27 19:54:29 +0000295 self.sock = self._get_socket(host, port, self.timeout)
Martin v. Löwisa43c2f82001-07-24 20:34:08 +0000296 (code, msg) = self.getreply()
Guido van Rossumbe19ed72007-02-09 05:37:30 +0000297 if self.debuglevel > 0: print("connect:", msg, file=stderr)
Martin v. Löwisa43c2f82001-07-24 20:34:08 +0000298 return (code, msg)
Tim Peters495ad3c2001-01-15 01:36:40 +0000299
Guido van Rossum8a392d72007-11-21 22:09:45 +0000300 def send(self, s):
301 """Send `s' to the server."""
302 if self.debuglevel > 0: print('send:', repr(s), file=stderr)
Christian Heimes90c3d9b2008-02-23 13:18:03 +0000303 if hasattr(self, 'sock') and self.sock:
Guido van Rossum8a392d72007-11-21 22:09:45 +0000304 if isinstance(s, str):
305 s = s.encode("ascii")
Guido van Rossum2880f6e1998-08-10 20:07:00 +0000306 try:
Guido van Rossum8a392d72007-11-21 22:09:45 +0000307 self.sock.sendall(s)
Guido van Rossum2880f6e1998-08-10 20:07:00 +0000308 except socket.error:
Barry Warsaw76750972001-12-14 20:34:20 +0000309 self.close()
Guido van Rossum40233ea1999-01-15 03:23:55 +0000310 raise SMTPServerDisconnected('Server not connected')
Guido van Rossumfc40a831998-01-29 17:26:45 +0000311 else:
Guido van Rossum40233ea1999-01-15 03:23:55 +0000312 raise SMTPServerDisconnected('please run connect() first')
Tim Peters495ad3c2001-01-15 01:36:40 +0000313
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000314 def putcmd(self, cmd, args=""):
Barry Warsawa7d9bdf1998-12-22 03:24:27 +0000315 """Send a command to the server."""
Guido van Rossumdb23d3d1999-06-09 15:13:10 +0000316 if args == "":
317 str = '%s%s' % (cmd, CRLF)
318 else:
319 str = '%s %s%s' % (cmd, args, CRLF)
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000320 self.send(str)
Tim Peters495ad3c2001-01-15 01:36:40 +0000321
Guido van Rossumfcfb6321998-08-04 15:29:54 +0000322 def getreply(self):
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000323 """Get a reply from the server.
Tim Peters495ad3c2001-01-15 01:36:40 +0000324
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000325 Returns a tuple consisting of:
Barry Warsawa7d9bdf1998-12-22 03:24:27 +0000326
327 - server response code (e.g. '250', or such, if all goes well)
328 Note: returns -1 if it can't read response code.
329
330 - server response string corresponding to response code (multiline
331 responses are converted to a single, multiline string).
Guido van Rossumf123f841999-03-29 20:33:21 +0000332
333 Raises SMTPServerDisconnected if end-of-file is reached.
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000334 """
335 resp=[]
Guido van Rossum296e1431999-04-07 15:03:39 +0000336 if self.file is None:
337 self.file = self.sock.makefile('rb')
Guido van Rossum45e2fbc1998-03-26 21:13:24 +0000338 while 1:
Benjamin Petersone1cdfd72009-01-18 21:02:37 +0000339 try:
340 line = self.file.readline()
341 except socket.error:
342 line = ''
Guido van Rossum806c2462007-08-06 23:33:07 +0000343 if not line:
Guido van Rossum296e1431999-04-07 15:03:39 +0000344 self.close()
345 raise SMTPServerDisconnected("Connection unexpectedly closed")
Guido van Rossumbe19ed72007-02-09 05:37:30 +0000346 if self.debuglevel > 0: print('reply:', repr(line), file=stderr)
Guido van Rossum806c2462007-08-06 23:33:07 +0000347 resp.append(line[4:].strip(b' \t\r\n'))
Guido van Rossum45e2fbc1998-03-26 21:13:24 +0000348 code=line[:3]
Guido van Rossum296e1431999-04-07 15:03:39 +0000349 # Check that the error code is syntactically correct.
350 # Don't attempt to read a continuation line if it is broken.
351 try:
Eric S. Raymondc013f302001-02-09 05:40:38 +0000352 errcode = int(code)
Guido van Rossum296e1431999-04-07 15:03:39 +0000353 except ValueError:
354 errcode = -1
355 break
Guido van Rossumf123f841999-03-29 20:33:21 +0000356 # Check if multiline response.
Guido van Rossum806c2462007-08-06 23:33:07 +0000357 if line[3:4] != b"-":
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000358 break
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000359
Guido van Rossumc43e79f2007-06-18 18:26:36 +0000360 errmsg = b"\n".join(resp)
Tim Peters495ad3c2001-01-15 01:36:40 +0000361 if self.debuglevel > 0:
Guido van Rossumbe19ed72007-02-09 05:37:30 +0000362 print('reply: retcode (%s); Msg: %s' % (errcode,errmsg), file=stderr)
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000363 return errcode, errmsg
Tim Peters495ad3c2001-01-15 01:36:40 +0000364
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000365 def docmd(self, cmd, args=""):
Barry Warsawa7d9bdf1998-12-22 03:24:27 +0000366 """Send a command, and return its response code."""
Guido van Rossum45e2fbc1998-03-26 21:13:24 +0000367 self.putcmd(cmd,args)
Guido van Rossum296e1431999-04-07 15:03:39 +0000368 return self.getreply()
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000369
Barry Warsawa7d9bdf1998-12-22 03:24:27 +0000370 # std smtp commands
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000371 def helo(self, name=''):
Barry Warsawa7d9bdf1998-12-22 03:24:27 +0000372 """SMTP 'helo' command.
373 Hostname to send for this command defaults to the FQDN of the local
374 host.
375 """
Neil Schemenauer6730f262002-03-24 15:30:40 +0000376 self.putcmd("helo", name or self.local_hostname)
Guido van Rossum45e2fbc1998-03-26 21:13:24 +0000377 (code,msg)=self.getreply()
378 self.helo_resp=msg
Guido van Rossum296e1431999-04-07 15:03:39 +0000379 return (code,msg)
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000380
Guido van Rossum95e6f701998-06-25 02:15:50 +0000381 def ehlo(self, name=''):
Barry Warsawa7d9bdf1998-12-22 03:24:27 +0000382 """ SMTP 'ehlo' command.
383 Hostname to send for this command defaults to the FQDN of the local
384 host.
385 """
Guido van Rossumf7fcf5e2001-09-14 16:08:44 +0000386 self.esmtp_features = {}
Guido van Rossumd8faa362007-04-27 19:54:29 +0000387 self.putcmd(self.ehlo_msg, name or self.local_hostname)
Guido van Rossumfcfb6321998-08-04 15:29:54 +0000388 (code,msg)=self.getreply()
Tim Peters495ad3c2001-01-15 01:36:40 +0000389 # According to RFC1869 some (badly written)
390 # MTA's will disconnect on an ehlo. Toss an exception if
Guido van Rossumfcfb6321998-08-04 15:29:54 +0000391 # that happens -ddm
392 if code == -1 and len(msg) == 0:
Barry Warsaw76750972001-12-14 20:34:20 +0000393 self.close()
Guido van Rossum40233ea1999-01-15 03:23:55 +0000394 raise SMTPServerDisconnected("Server not connected")
Guido van Rossum95e6f701998-06-25 02:15:50 +0000395 self.ehlo_resp=msg
Fred Drake8152d322000-12-12 23:20:45 +0000396 if code != 250:
Guido van Rossum296e1431999-04-07 15:03:39 +0000397 return (code,msg)
Guido van Rossumfcfb6321998-08-04 15:29:54 +0000398 self.does_esmtp=1
Thomas Wouters7e474022000-07-16 12:04:32 +0000399 #parse the ehlo response -ddm
Guido van Rossum04110fb2007-08-24 16:32:05 +0000400 assert isinstance(self.ehlo_resp, bytes), repr(self.ehlo_resp)
401 resp=self.ehlo_resp.decode("latin-1").split('\n')
Guido van Rossumfcfb6321998-08-04 15:29:54 +0000402 del resp[0]
Guido van Rossum2880f6e1998-08-10 20:07:00 +0000403 for each in resp:
Piers Lauder385a77a2002-07-27 00:38:30 +0000404 # To be able to communicate with as many SMTP servers as possible,
405 # we have to take the old-style auth advertisement into account,
406 # because:
407 # 1) Else our SMTP feature parser gets confused.
408 # 2) There are some servers that only advertise the auth methods we
409 # support using the old style.
410 auth_match = OLDSTYLE_AUTH.match(each)
411 if auth_match:
412 # This doesn't remove duplicates, but that's no problem
413 self.esmtp_features["auth"] = self.esmtp_features.get("auth", "") \
414 + " " + auth_match.groups(0)[0]
415 continue
416
Barry Warsawbe22ae62002-04-15 20:03:30 +0000417 # RFC 1869 requires a space between ehlo keyword and parameters.
418 # It's actually stricter, in that only spaces are allowed between
419 # parameters, but were not going to check for that here. Note
420 # that the space isn't present if there are no parameters.
421 m=re.match(r'(?P<feature>[A-Za-z0-9][A-Za-z0-9\-]*) ?',each)
Guido van Rossumfcfb6321998-08-04 15:29:54 +0000422 if m:
Eric S. Raymondc013f302001-02-09 05:40:38 +0000423 feature=m.group("feature").lower()
424 params=m.string[m.end("feature"):].strip()
Piers Lauder385a77a2002-07-27 00:38:30 +0000425 if feature == "auth":
426 self.esmtp_features[feature] = self.esmtp_features.get(feature, "") \
427 + " " + params
428 else:
429 self.esmtp_features[feature]=params
Guido van Rossum296e1431999-04-07 15:03:39 +0000430 return (code,msg)
Guido van Rossum95e6f701998-06-25 02:15:50 +0000431
Guido van Rossumfcfb6321998-08-04 15:29:54 +0000432 def has_extn(self, opt):
433 """Does the server support a given SMTP service extension?"""
Raymond Hettinger54f02222002-06-01 14:18:47 +0000434 return opt.lower() in self.esmtp_features
Guido van Rossum95e6f701998-06-25 02:15:50 +0000435
Guido van Rossum18586f41998-04-03 17:03:13 +0000436 def help(self, args=''):
Barry Warsawa7d9bdf1998-12-22 03:24:27 +0000437 """SMTP 'help' command.
438 Returns help text from server."""
Guido van Rossum18586f41998-04-03 17:03:13 +0000439 self.putcmd("help", args)
Kurt B. Kaiser58bd1902005-06-26 18:27:36 +0000440 return self.getreply()[1]
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000441
442 def rset(self):
Barry Warsawa7d9bdf1998-12-22 03:24:27 +0000443 """SMTP 'rset' command -- resets session."""
Guido van Rossum296e1431999-04-07 15:03:39 +0000444 return self.docmd("rset")
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000445
446 def noop(self):
Barry Warsawa7d9bdf1998-12-22 03:24:27 +0000447 """SMTP 'noop' command -- doesn't do anything :>"""
Guido van Rossum296e1431999-04-07 15:03:39 +0000448 return self.docmd("noop")
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000449
Guido van Rossum95e6f701998-06-25 02:15:50 +0000450 def mail(self,sender,options=[]):
Barry Warsawa7d9bdf1998-12-22 03:24:27 +0000451 """SMTP 'mail' command -- begins mail xfer session."""
Guido van Rossumfcfb6321998-08-04 15:29:54 +0000452 optionlist = ''
453 if options and self.does_esmtp:
Eric S. Raymondc013f302001-02-09 05:40:38 +0000454 optionlist = ' ' + ' '.join(options)
Guido van Rossumdb23d3d1999-06-09 15:13:10 +0000455 self.putcmd("mail", "FROM:%s%s" % (quoteaddr(sender) ,optionlist))
Guido van Rossum45e2fbc1998-03-26 21:13:24 +0000456 return self.getreply()
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000457
Guido van Rossumfcfb6321998-08-04 15:29:54 +0000458 def rcpt(self,recip,options=[]):
Barry Warsawa7d9bdf1998-12-22 03:24:27 +0000459 """SMTP 'rcpt' command -- indicates 1 recipient for this mail."""
Guido van Rossumfcfb6321998-08-04 15:29:54 +0000460 optionlist = ''
461 if options and self.does_esmtp:
Eric S. Raymondc013f302001-02-09 05:40:38 +0000462 optionlist = ' ' + ' '.join(options)
Guido van Rossum348fd061999-01-14 04:18:46 +0000463 self.putcmd("rcpt","TO:%s%s" % (quoteaddr(recip),optionlist))
Guido van Rossum45e2fbc1998-03-26 21:13:24 +0000464 return self.getreply()
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000465
466 def data(self,msg):
Tim Peters495ad3c2001-01-15 01:36:40 +0000467 """SMTP 'DATA' command -- sends message data to server.
Guido van Rossum296e1431999-04-07 15:03:39 +0000468
Barry Warsaw4c4bec81998-12-22 03:02:20 +0000469 Automatically quotes lines beginning with a period per rfc821.
Guido van Rossum296e1431999-04-07 15:03:39 +0000470 Raises SMTPDataError if there is an unexpected reply to the
471 DATA command; the return value from this method is the final
472 response code received when the all data is sent.
Barry Warsaw4c4bec81998-12-22 03:02:20 +0000473 """
Guido van Rossum45e2fbc1998-03-26 21:13:24 +0000474 self.putcmd("data")
475 (code,repl)=self.getreply()
Guido van Rossumbe19ed72007-02-09 05:37:30 +0000476 if self.debuglevel >0 : print("data:", (code,repl), file=stderr)
Fred Drake8152d322000-12-12 23:20:45 +0000477 if code != 354:
Guido van Rossum296e1431999-04-07 15:03:39 +0000478 raise SMTPDataError(code,repl)
Guido van Rossum45e2fbc1998-03-26 21:13:24 +0000479 else:
Guido van Rossum20c92281999-04-21 16:52:20 +0000480 q = quotedata(msg)
481 if q[-2:] != CRLF:
482 q = q + CRLF
483 q = q + "." + CRLF
484 self.send(q)
Guido van Rossum45e2fbc1998-03-26 21:13:24 +0000485 (code,msg)=self.getreply()
Guido van Rossumbe19ed72007-02-09 05:37:30 +0000486 if self.debuglevel >0 : print("data:", (code,msg), file=stderr)
Guido van Rossum296e1431999-04-07 15:03:39 +0000487 return (code,msg)
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000488
Guido van Rossumfcfb6321998-08-04 15:29:54 +0000489 def verify(self, address):
Barry Warsawa7d9bdf1998-12-22 03:24:27 +0000490 """SMTP 'verify' command -- checks for address validity."""
Guido van Rossumfcfb6321998-08-04 15:29:54 +0000491 self.putcmd("vrfy", quoteaddr(address))
492 return self.getreply()
Barry Warsaw4c4bec81998-12-22 03:02:20 +0000493 # a.k.a.
494 vrfy=verify
Guido van Rossumfcfb6321998-08-04 15:29:54 +0000495
496 def expn(self, address):
Christian Heimes90c3d9b2008-02-23 13:18:03 +0000497 """SMTP 'expn' command -- expands a mailing list."""
Guido van Rossumfcfb6321998-08-04 15:29:54 +0000498 self.putcmd("expn", quoteaddr(address))
499 return self.getreply()
500
Barry Warsaw4c4bec81998-12-22 03:02:20 +0000501 # some useful methods
Guido van Rossumae010462001-09-11 15:57:46 +0000502
Christian Heimes679db4a2008-01-18 09:56:22 +0000503 def ehlo_or_helo_if_needed(self):
504 """Call self.ehlo() and/or self.helo() if needed.
505
506 If there has been no previous EHLO or HELO command this session, this
507 method tries ESMTP EHLO first.
508
509 This method may raise the following exceptions:
510
511 SMTPHeloError The server didn't reply properly to
512 the helo greeting.
513 """
514 if self.helo_resp is None and self.ehlo_resp is None:
515 if not (200 <= self.ehlo()[0] <= 299):
516 (code, resp) = self.helo()
517 if not (200 <= code <= 299):
518 raise SMTPHeloError(code, resp)
519
Guido van Rossumae010462001-09-11 15:57:46 +0000520 def login(self, user, password):
521 """Log in on an SMTP server that requires authentication.
522
523 The arguments are:
524 - user: The user name to authenticate with.
525 - password: The password for the authentication.
526
527 If there has been no previous EHLO or HELO command this session, this
528 method tries ESMTP EHLO first.
529
530 This method will return normally if the authentication was successful.
531
532 This method may raise the following exceptions:
533
534 SMTPHeloError The server didn't reply properly to
535 the helo greeting.
536 SMTPAuthenticationError The server didn't accept the username/
537 password combination.
Fred Drake2f8f4d32001-10-13 18:35:32 +0000538 SMTPException No suitable authentication method was
Guido van Rossumae010462001-09-11 15:57:46 +0000539 found.
540 """
541
542 def encode_cram_md5(challenge, user, password):
543 challenge = base64.decodestring(challenge)
544 response = user + " " + hmac.HMAC(password, challenge).hexdigest()
Barry Warsaw2cc1f6d2007-08-30 14:28:55 +0000545 return encode_base64(response)
Guido van Rossumae010462001-09-11 15:57:46 +0000546
547 def encode_plain(user, password):
Barry Warsaw2cc1f6d2007-08-30 14:28:55 +0000548 return encode_base64("\0%s\0%s" % (user, password))
Tim Peters469cdad2002-08-08 20:19:19 +0000549
Guido van Rossumae010462001-09-11 15:57:46 +0000550
551 AUTH_PLAIN = "PLAIN"
552 AUTH_CRAM_MD5 = "CRAM-MD5"
Piers Lauder385a77a2002-07-27 00:38:30 +0000553 AUTH_LOGIN = "LOGIN"
Guido van Rossumae010462001-09-11 15:57:46 +0000554
Christian Heimes679db4a2008-01-18 09:56:22 +0000555 self.ehlo_or_helo_if_needed()
Guido van Rossumae010462001-09-11 15:57:46 +0000556
557 if not self.has_extn("auth"):
558 raise SMTPException("SMTP AUTH extension not supported by server.")
559
560 # Authentication methods the server supports:
561 authlist = self.esmtp_features["auth"].split()
562
563 # List of authentication methods we support: from preferred to
564 # less preferred methods. Except for the purpose of testing the weaker
565 # ones, we prefer stronger methods like CRAM-MD5:
Piers Lauder385a77a2002-07-27 00:38:30 +0000566 preferred_auths = [AUTH_CRAM_MD5, AUTH_PLAIN, AUTH_LOGIN]
Guido van Rossumae010462001-09-11 15:57:46 +0000567
568 # Determine the authentication method we'll use
569 authmethod = None
570 for method in preferred_auths:
571 if method in authlist:
572 authmethod = method
573 break
Tim Petersb64bec32001-09-18 02:26:39 +0000574
Guido van Rossumae010462001-09-11 15:57:46 +0000575 if authmethod == AUTH_CRAM_MD5:
576 (code, resp) = self.docmd("AUTH", AUTH_CRAM_MD5)
577 if code == 503:
578 # 503 == 'Error: already authenticated'
579 return (code, resp)
580 (code, resp) = self.docmd(encode_cram_md5(resp, user, password))
581 elif authmethod == AUTH_PLAIN:
Tim Petersb64bec32001-09-18 02:26:39 +0000582 (code, resp) = self.docmd("AUTH",
Guido van Rossumae010462001-09-11 15:57:46 +0000583 AUTH_PLAIN + " " + encode_plain(user, password))
Piers Lauder385a77a2002-07-27 00:38:30 +0000584 elif authmethod == AUTH_LOGIN:
585 (code, resp) = self.docmd("AUTH",
Barry Warsaw2cc1f6d2007-08-30 14:28:55 +0000586 "%s %s" % (AUTH_LOGIN, encode_base64(user)))
Piers Lauder385a77a2002-07-27 00:38:30 +0000587 if code != 334:
588 raise SMTPAuthenticationError(code, resp)
Barry Warsaw2cc1f6d2007-08-30 14:28:55 +0000589 (code, resp) = self.docmd(encode_base64(password))
Raymond Hettinger7fdfc2d2002-05-31 17:49:10 +0000590 elif authmethod is None:
Fred Drake2f8f4d32001-10-13 18:35:32 +0000591 raise SMTPException("No suitable authentication method found.")
Raymond Hettingerdbecd932005-02-06 06:57:08 +0000592 if code not in (235, 503):
Guido van Rossumae010462001-09-11 15:57:46 +0000593 # 235 == 'Authentication successful'
594 # 503 == 'Error: already authenticated'
595 raise SMTPAuthenticationError(code, resp)
596 return (code, resp)
597
Guido van Rossumf7fcf5e2001-09-14 16:08:44 +0000598 def starttls(self, keyfile = None, certfile = None):
599 """Puts the connection to the SMTP server into TLS mode.
Tim Petersb64bec32001-09-18 02:26:39 +0000600
Christian Heimes679db4a2008-01-18 09:56:22 +0000601 If there has been no previous EHLO or HELO command this session, this
602 method tries ESMTP EHLO first.
603
Guido van Rossumf7fcf5e2001-09-14 16:08:44 +0000604 If the server supports TLS, this will encrypt the rest of the SMTP
605 session. If you provide the keyfile and certfile parameters,
606 the identity of the SMTP server and client can be checked. This,
607 however, depends on whether the socket module really checks the
608 certificates.
Christian Heimes679db4a2008-01-18 09:56:22 +0000609
610 This method may raise the following exceptions:
611
612 SMTPHeloError The server didn't reply properly to
613 the helo greeting.
Guido van Rossumf7fcf5e2001-09-14 16:08:44 +0000614 """
Christian Heimes679db4a2008-01-18 09:56:22 +0000615 self.ehlo_or_helo_if_needed()
616 if not self.has_extn("starttls"):
617 raise SMTPException("STARTTLS extension not supported by server.")
Tim Petersb64bec32001-09-18 02:26:39 +0000618 (resp, reply) = self.docmd("STARTTLS")
Guido van Rossumf7fcf5e2001-09-14 16:08:44 +0000619 if resp == 220:
Thomas Wouters47b49bf2007-08-30 22:15:33 +0000620 if not _have_ssl:
621 raise RuntimeError("No SSL support included in this Python")
Thomas Wouters1b7f8912007-09-19 03:06:30 +0000622 self.sock = ssl.wrap_socket(self.sock, keyfile, certfile)
Thomas Wouters47b49bf2007-08-30 22:15:33 +0000623 self.file = SSLFakeFile(self.sock)
Christian Heimes679db4a2008-01-18 09:56:22 +0000624 # RFC 3207:
625 # The client MUST discard any knowledge obtained from
626 # the server, such as the list of SMTP service extensions,
627 # which was not obtained from the TLS negotiation itself.
628 self.helo_resp = None
629 self.ehlo_resp = None
630 self.esmtp_features = {}
631 self.does_esmtp = 0
Guido van Rossumf7fcf5e2001-09-14 16:08:44 +0000632 return (resp, reply)
Tim Petersb64bec32001-09-18 02:26:39 +0000633
Jeremy Hylton31bb8ce1998-08-13 19:57:46 +0000634 def sendmail(self, from_addr, to_addrs, msg, mail_options=[],
Tim Peters495ad3c2001-01-15 01:36:40 +0000635 rcpt_options=[]):
636 """This command performs an entire mail transaction.
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000637
Tim Peters495ad3c2001-01-15 01:36:40 +0000638 The arguments are:
Barry Warsaw4c4bec81998-12-22 03:02:20 +0000639 - from_addr : The address sending this mail.
640 - to_addrs : A list of addresses to send this mail to. A bare
641 string will be treated as a list with 1 address.
Tim Peters495ad3c2001-01-15 01:36:40 +0000642 - msg : The message to send.
Barry Warsaw4c4bec81998-12-22 03:02:20 +0000643 - mail_options : List of ESMTP options (such as 8bitmime) for the
644 mail command.
645 - rcpt_options : List of ESMTP options (such as DSN commands) for
646 all the rcpt commands.
647
648 If there has been no previous EHLO or HELO command this session, this
649 method tries ESMTP EHLO first. If the server does ESMTP, message size
650 and each of the specified options will be passed to it. If EHLO
651 fails, HELO will be tried and ESMTP options suppressed.
652
653 This method will return normally if the mail is accepted for at least
Barry Warsawd25c1b71999-11-28 17:11:06 +0000654 one recipient. It returns a dictionary, with one entry for each
655 recipient that was refused. Each entry contains a tuple of the SMTP
656 error code and the accompanying error message sent by the server.
Guido van Rossum296e1431999-04-07 15:03:39 +0000657
658 This method may raise the following exceptions:
659
660 SMTPHeloError The server didn't reply properly to
Tim Peters495ad3c2001-01-15 01:36:40 +0000661 the helo greeting.
Barry Warsawd25c1b71999-11-28 17:11:06 +0000662 SMTPRecipientsRefused The server rejected ALL recipients
Guido van Rossum296e1431999-04-07 15:03:39 +0000663 (no mail was sent).
664 SMTPSenderRefused The server didn't accept the from_addr.
665 SMTPDataError The server replied with an unexpected
666 error code (other than a refusal of
667 a recipient).
668
669 Note: the connection will be open even after an exception is raised.
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000670
Guido van Rossum95e6f701998-06-25 02:15:50 +0000671 Example:
Tim Peters495ad3c2001-01-15 01:36:40 +0000672
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000673 >>> import smtplib
674 >>> s=smtplib.SMTP("localhost")
Guido van Rossumfc40a831998-01-29 17:26:45 +0000675 >>> tolist=["one@one.org","two@two.org","three@three.org","four@four.org"]
Martin v. Löwis301b1cd2002-07-28 16:52:01 +0000676 >>> msg = '''\\
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000677 ... From: Me@my.org
678 ... Subject: testin'...
679 ...
680 ... This is a test '''
681 >>> s.sendmail("me@my.org",tolist,msg)
682 { "three@three.org" : ( 550 ,"User unknown" ) }
683 >>> s.quit()
Tim Peters495ad3c2001-01-15 01:36:40 +0000684
Barry Warsaw4c4bec81998-12-22 03:02:20 +0000685 In the above example, the message was accepted for delivery to three
686 of the four addresses, and one was rejected, with the error code
Barry Warsawd25c1b71999-11-28 17:11:06 +0000687 550. If all addresses are accepted, then the method will return an
Barry Warsaw4c4bec81998-12-22 03:02:20 +0000688 empty dictionary.
689
690 """
Christian Heimes679db4a2008-01-18 09:56:22 +0000691 self.ehlo_or_helo_if_needed()
Guido van Rossum95e6f701998-06-25 02:15:50 +0000692 esmtp_opts = []
Guido van Rossumfcfb6321998-08-04 15:29:54 +0000693 if self.does_esmtp:
694 # Hmmm? what's this? -ddm
695 # self.esmtp_features['7bit']=""
696 if self.has_extn('size'):
Walter Dörwald70a6b492004-02-12 17:35:32 +0000697 esmtp_opts.append("size=%d" % len(msg))
Guido van Rossumfcfb6321998-08-04 15:29:54 +0000698 for option in mail_options:
Guido van Rossum95e6f701998-06-25 02:15:50 +0000699 esmtp_opts.append(option)
Guido van Rossumfcfb6321998-08-04 15:29:54 +0000700
Guido van Rossum95e6f701998-06-25 02:15:50 +0000701 (code,resp) = self.mail(from_addr, esmtp_opts)
Fred Drake8152d322000-12-12 23:20:45 +0000702 if code != 250:
Guido van Rossum45e2fbc1998-03-26 21:13:24 +0000703 self.rset()
Guido van Rossum296e1431999-04-07 15:03:39 +0000704 raise SMTPSenderRefused(code, resp, from_addr)
Guido van Rossum45e2fbc1998-03-26 21:13:24 +0000705 senderrs={}
Guido van Rossum3172c5d2007-10-16 18:12:55 +0000706 if isinstance(to_addrs, str):
Jeremy Hylton31bb8ce1998-08-13 19:57:46 +0000707 to_addrs = [to_addrs]
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000708 for each in to_addrs:
Guido van Rossumfcfb6321998-08-04 15:29:54 +0000709 (code,resp)=self.rcpt(each, rcpt_options)
Fred Drake8152d322000-12-12 23:20:45 +0000710 if (code != 250) and (code != 251):
Guido van Rossumfc40a831998-01-29 17:26:45 +0000711 senderrs[each]=(code,resp)
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000712 if len(senderrs)==len(to_addrs):
Guido van Rossum95e6f701998-06-25 02:15:50 +0000713 # the server refused all our recipients
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000714 self.rset()
Guido van Rossum296e1431999-04-07 15:03:39 +0000715 raise SMTPRecipientsRefused(senderrs)
Fred Drake8152d322000-12-12 23:20:45 +0000716 (code,resp) = self.data(msg)
717 if code != 250:
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000718 self.rset()
Guido van Rossum296e1431999-04-07 15:03:39 +0000719 raise SMTPDataError(code, resp)
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000720 #if we got here then somebody got our mail
Tim Peters495ad3c2001-01-15 01:36:40 +0000721 return senderrs
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000722
723
724 def close(self):
725 """Close the connection to the SMTP server."""
726 if self.file:
727 self.file.close()
728 self.file = None
729 if self.sock:
730 self.sock.close()
731 self.sock = None
732
733
734 def quit(self):
Guido van Rossum95e6f701998-06-25 02:15:50 +0000735 """Terminate the SMTP session."""
Christian Heimesba4af492008-03-28 00:55:15 +0000736 res = self.docmd("quit")
Guido van Rossum45e2fbc1998-03-26 21:13:24 +0000737 self.close()
Christian Heimesba4af492008-03-28 00:55:15 +0000738 return res
Guido van Rossum95e6f701998-06-25 02:15:50 +0000739
Thomas Wouters47b49bf2007-08-30 22:15:33 +0000740if _have_ssl:
Thomas Wouters89f507f2006-12-13 04:49:30 +0000741
Thomas Wouters47b49bf2007-08-30 22:15:33 +0000742 class SMTP_SSL(SMTP):
743 """ This is a subclass derived from SMTP that connects over an SSL encrypted
744 socket (to use this class you need a socket module that was compiled with SSL
745 support). If host is not specified, '' (the local host) is used. If port is
746 omitted, the standard SMTP-over-SSL port (465) is used. keyfile and certfile
747 are also optional - they can contain a PEM formatted private key and
748 certificate chain file for the SSL connection.
749 """
750 def __init__(self, host='', port=0, local_hostname=None,
Georg Brandlf78e02b2008-06-10 17:40:04 +0000751 keyfile=None, certfile=None,
752 timeout=socket._GLOBAL_DEFAULT_TIMEOUT):
Thomas Wouters47b49bf2007-08-30 22:15:33 +0000753 self.keyfile = keyfile
754 self.certfile = certfile
755 SMTP.__init__(self, host, port, local_hostname, timeout)
756 self.default_port = SMTP_SSL_PORT
757
758 def _get_socket(self, host, port, timeout):
759 if self.debuglevel > 0: print('connect:', (host, port), file=stderr)
R. David Murray87e20742009-05-23 01:30:26 +0000760 new_socket = socket.create_connection((host, port), timeout)
761 new_socket = ssl.wrap_socket(new_socket, self.keyfile, self.certfile)
762 self.file = SSLFakeFile(new_socket)
763 return new_socket
Thomas Wouters47b49bf2007-08-30 22:15:33 +0000764
765 __all__.append("SMTP_SSL")
Barry Warsaw4c4bec81998-12-22 03:02:20 +0000766
Guido van Rossumd8faa362007-04-27 19:54:29 +0000767#
768# LMTP extension
769#
770LMTP_PORT = 2003
771
772class LMTP(SMTP):
773 """LMTP - Local Mail Transfer Protocol
774
775 The LMTP protocol, which is very similar to ESMTP, is heavily based
776 on the standard SMTP client. It's common to use Unix sockets for LMTP,
777 so our connect() method must support that as well as a regular
778 host:port server. To specify a Unix socket, you must use an absolute
779 path as the host, starting with a '/'.
780
781 Authentication is supported, using the regular SMTP mechanism. When
782 using a Unix socket, LMTP generally don't support or require any
783 authentication, but your mileage might vary."""
784
785 ehlo_msg = "lhlo"
786
787 def __init__(self, host = '', port = LMTP_PORT, local_hostname = None):
788 """Initialize a new instance."""
789 SMTP.__init__(self, host, port, local_hostname)
790
791 def connect(self, host = 'localhost', port = 0):
792 """Connect to the LMTP daemon, on either a Unix or a TCP socket."""
793 if host[0] != '/':
794 return SMTP.connect(self, host, port)
795
796 # Handle Unix-domain sockets.
797 try:
798 self.sock = socket.socket(socket.AF_UNIX, socket.SOCK_STREAM)
799 self.sock.connect(host)
800 except socket.error as msg:
801 if self.debuglevel > 0: print>>stderr, 'connect fail:', host
802 if self.sock:
803 self.sock.close()
804 self.sock = None
805 raise socket.error(msg)
806 (code, msg) = self.getreply()
807 if self.debuglevel > 0: print>>stderr, "connect:", msg
808 return (code, msg)
809
810
Guido van Rossum95e6f701998-06-25 02:15:50 +0000811# Test the sendmail method, which tests most of the others.
812# Note: This always sends to localhost.
813if __name__ == '__main__':
Andrew M. Kuchling6be424f2001-08-13 14:41:39 +0000814 import sys
Guido van Rossum95e6f701998-06-25 02:15:50 +0000815
816 def prompt(prompt):
817 sys.stdout.write(prompt + ": ")
Eric S. Raymondc013f302001-02-09 05:40:38 +0000818 return sys.stdin.readline().strip()
Guido van Rossum95e6f701998-06-25 02:15:50 +0000819
820 fromaddr = prompt("From")
Eric S. Raymond38151ed2001-02-09 07:40:17 +0000821 toaddrs = prompt("To").split(',')
Guido van Rossumbe19ed72007-02-09 05:37:30 +0000822 print("Enter message, end with ^D:")
Guido van Rossum95e6f701998-06-25 02:15:50 +0000823 msg = ''
824 while 1:
825 line = sys.stdin.readline()
826 if not line:
827 break
828 msg = msg + line
Guido van Rossumbe19ed72007-02-09 05:37:30 +0000829 print("Message length is %d" % len(msg))
Guido van Rossum95e6f701998-06-25 02:15:50 +0000830
831 server = SMTP('localhost')
832 server.set_debuglevel(1)
833 server.sendmail(fromaddr, toaddrs, msg)
834 server.quit()