blob: a3cc65d2951896ba0e368d69a3690ae4d8dd2a8e [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
Barry Warsawa7d9bdf1998-12-22 03:24:27 +0000134 Should be able to handle anything rfc822.parseaddr can handle.
135 """
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
Guido van Rossumd8faa362007-04-27 19:54:29 +0000223 def __init__(self, host='', port=0, local_hostname=None, timeout=None):
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000224 """Initialize a new instance.
225
Barry Warsawa7d9bdf1998-12-22 03:24:27 +0000226 If specified, `host' is the name of the remote host to which to
227 connect. If specified, `port' specifies the port to which to connect.
Barry Warsawd25c1b71999-11-28 17:11:06 +0000228 By default, smtplib.SMTP_PORT is used. An SMTPConnectError is raised
Neil Schemenauer6730f262002-03-24 15:30:40 +0000229 if the specified `host' doesn't respond correctly. If specified,
Tim Peters863ac442002-04-16 01:38:40 +0000230 `local_hostname` is used as the FQDN of the local host. By default,
231 the local hostname is found using socket.getfqdn().
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000232
233 """
Guido van Rossumd8faa362007-04-27 19:54:29 +0000234 self.timeout = timeout
Guido van Rossumfcfb6321998-08-04 15:29:54 +0000235 self.esmtp_features = {}
Thomas Wouters89f507f2006-12-13 04:49:30 +0000236 self.default_port = SMTP_PORT
Guido van Rossum296e1431999-04-07 15:03:39 +0000237 if host:
238 (code, msg) = self.connect(host, port)
239 if code != 220:
240 raise SMTPConnectError(code, msg)
Raymond Hettingerf13eb552002-06-02 00:40:05 +0000241 if local_hostname is not None:
Barry Warsaw13e34f72002-03-26 20:27:35 +0000242 self.local_hostname = local_hostname
Neil Schemenauer6730f262002-03-24 15:30:40 +0000243 else:
Barry Warsaw13e34f72002-03-26 20:27:35 +0000244 # RFC 2821 says we should use the fqdn in the EHLO/HELO verb, and
245 # if that can't be calculated, that we should use a domain literal
246 # instead (essentially an encoded IP address like [A.B.C.D]).
247 fqdn = socket.getfqdn()
248 if '.' in fqdn:
249 self.local_hostname = fqdn
250 else:
251 # We can't find an fqdn hostname, so use a domain literal
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000252 addr = '127.0.0.1'
253 try:
254 addr = socket.gethostbyname(socket.gethostname())
255 except socket.gaierror:
256 pass
Barry Warsaw13e34f72002-03-26 20:27:35 +0000257 self.local_hostname = '[%s]' % addr
Tim Peters495ad3c2001-01-15 01:36:40 +0000258
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000259 def set_debuglevel(self, debuglevel):
260 """Set the debug output level.
261
Barry Warsawa7d9bdf1998-12-22 03:24:27 +0000262 A non-false value results in debug messages for connection and for all
263 messages sent to and received from the server.
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000264
265 """
266 self.debuglevel = debuglevel
267
Barry Warsawc9181712008-03-19 14:25:51 +0000268 def _get_socket(self, host, port, timeout):
Thomas Wouters89f507f2006-12-13 04:49:30 +0000269 # This makes it simpler for SMTP_SSL to use the SMTP connect code
270 # and just alter the socket connection bit.
Guido van Rossumbe19ed72007-02-09 05:37:30 +0000271 if self.debuglevel > 0: print('connect:', (host, port), file=stderr)
Barry Warsawc9181712008-03-19 14:25:51 +0000272 return socket.create_connection((host, port), timeout)
Thomas Wouters89f507f2006-12-13 04:49:30 +0000273
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000274 def connect(self, host='localhost', port = 0):
275 """Connect to a host on a given port.
Guido van Rossum95e6f701998-06-25 02:15:50 +0000276
Barry Warsaw4c4bec81998-12-22 03:02:20 +0000277 If the hostname ends with a colon (`:') followed by a number, and
278 there is no port specified, that suffix will be stripped off and the
279 number interpreted as the port number to use.
Guido van Rossum95e6f701998-06-25 02:15:50 +0000280
Barry Warsawa7d9bdf1998-12-22 03:24:27 +0000281 Note: This method is automatically invoked by __init__, if a host is
282 specified during instantiation.
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000283
284 """
Martin v. Löwis4eb59402001-07-26 13:37:33 +0000285 if not port and (host.find(':') == host.rfind(':')):
Martin v. Löwisa43c2f82001-07-24 20:34:08 +0000286 i = host.rfind(':')
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000287 if i >= 0:
288 host, port = host[:i], host[i+1:]
Eric S. Raymondc013f302001-02-09 05:40:38 +0000289 try: port = int(port)
Eric S. Raymond8d876032001-02-09 10:14:53 +0000290 except ValueError:
Guido van Rossumd8faa362007-04-27 19:54:29 +0000291 raise socket.error("nonnumeric port")
Thomas Wouters89f507f2006-12-13 04:49:30 +0000292 if not port: port = self.default_port
Guido van Rossumbe19ed72007-02-09 05:37:30 +0000293 if self.debuglevel > 0: print('connect:', (host, port), file=stderr)
Guido van Rossumd8faa362007-04-27 19:54:29 +0000294 self.sock = self._get_socket(host, port, self.timeout)
Martin v. Löwisa43c2f82001-07-24 20:34:08 +0000295 (code, msg) = self.getreply()
Guido van Rossumbe19ed72007-02-09 05:37:30 +0000296 if self.debuglevel > 0: print("connect:", msg, file=stderr)
Martin v. Löwisa43c2f82001-07-24 20:34:08 +0000297 return (code, msg)
Tim Peters495ad3c2001-01-15 01:36:40 +0000298
Guido van Rossum8a392d72007-11-21 22:09:45 +0000299 def send(self, s):
300 """Send `s' to the server."""
301 if self.debuglevel > 0: print('send:', repr(s), file=stderr)
Christian Heimes90c3d9b2008-02-23 13:18:03 +0000302 if hasattr(self, 'sock') and self.sock:
Guido van Rossum8a392d72007-11-21 22:09:45 +0000303 if isinstance(s, str):
304 s = s.encode("ascii")
Guido van Rossum2880f6e1998-08-10 20:07:00 +0000305 try:
Guido van Rossum8a392d72007-11-21 22:09:45 +0000306 self.sock.sendall(s)
Guido van Rossum2880f6e1998-08-10 20:07:00 +0000307 except socket.error:
Barry Warsaw76750972001-12-14 20:34:20 +0000308 self.close()
Guido van Rossum40233ea1999-01-15 03:23:55 +0000309 raise SMTPServerDisconnected('Server not connected')
Guido van Rossumfc40a831998-01-29 17:26:45 +0000310 else:
Guido van Rossum40233ea1999-01-15 03:23:55 +0000311 raise SMTPServerDisconnected('please run connect() first')
Tim Peters495ad3c2001-01-15 01:36:40 +0000312
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000313 def putcmd(self, cmd, args=""):
Barry Warsawa7d9bdf1998-12-22 03:24:27 +0000314 """Send a command to the server."""
Guido van Rossumdb23d3d1999-06-09 15:13:10 +0000315 if args == "":
316 str = '%s%s' % (cmd, CRLF)
317 else:
318 str = '%s %s%s' % (cmd, args, CRLF)
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000319 self.send(str)
Tim Peters495ad3c2001-01-15 01:36:40 +0000320
Guido van Rossumfcfb6321998-08-04 15:29:54 +0000321 def getreply(self):
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000322 """Get a reply from the server.
Tim Peters495ad3c2001-01-15 01:36:40 +0000323
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000324 Returns a tuple consisting of:
Barry Warsawa7d9bdf1998-12-22 03:24:27 +0000325
326 - server response code (e.g. '250', or such, if all goes well)
327 Note: returns -1 if it can't read response code.
328
329 - server response string corresponding to response code (multiline
330 responses are converted to a single, multiline string).
Guido van Rossumf123f841999-03-29 20:33:21 +0000331
332 Raises SMTPServerDisconnected if end-of-file is reached.
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000333 """
334 resp=[]
Guido van Rossum296e1431999-04-07 15:03:39 +0000335 if self.file is None:
336 self.file = self.sock.makefile('rb')
Guido van Rossum45e2fbc1998-03-26 21:13:24 +0000337 while 1:
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000338 line = self.file.readline()
Guido van Rossum806c2462007-08-06 23:33:07 +0000339 if not line:
Guido van Rossum296e1431999-04-07 15:03:39 +0000340 self.close()
341 raise SMTPServerDisconnected("Connection unexpectedly closed")
Guido van Rossumbe19ed72007-02-09 05:37:30 +0000342 if self.debuglevel > 0: print('reply:', repr(line), file=stderr)
Guido van Rossum806c2462007-08-06 23:33:07 +0000343 resp.append(line[4:].strip(b' \t\r\n'))
Guido van Rossum45e2fbc1998-03-26 21:13:24 +0000344 code=line[:3]
Guido van Rossum296e1431999-04-07 15:03:39 +0000345 # Check that the error code is syntactically correct.
346 # Don't attempt to read a continuation line if it is broken.
347 try:
Eric S. Raymondc013f302001-02-09 05:40:38 +0000348 errcode = int(code)
Guido van Rossum296e1431999-04-07 15:03:39 +0000349 except ValueError:
350 errcode = -1
351 break
Guido van Rossumf123f841999-03-29 20:33:21 +0000352 # Check if multiline response.
Guido van Rossum806c2462007-08-06 23:33:07 +0000353 if line[3:4] != b"-":
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000354 break
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000355
Guido van Rossumc43e79f2007-06-18 18:26:36 +0000356 errmsg = b"\n".join(resp)
Tim Peters495ad3c2001-01-15 01:36:40 +0000357 if self.debuglevel > 0:
Guido van Rossumbe19ed72007-02-09 05:37:30 +0000358 print('reply: retcode (%s); Msg: %s' % (errcode,errmsg), file=stderr)
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000359 return errcode, errmsg
Tim Peters495ad3c2001-01-15 01:36:40 +0000360
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000361 def docmd(self, cmd, args=""):
Barry Warsawa7d9bdf1998-12-22 03:24:27 +0000362 """Send a command, and return its response code."""
Guido van Rossum45e2fbc1998-03-26 21:13:24 +0000363 self.putcmd(cmd,args)
Guido van Rossum296e1431999-04-07 15:03:39 +0000364 return self.getreply()
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000365
Barry Warsawa7d9bdf1998-12-22 03:24:27 +0000366 # std smtp commands
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000367 def helo(self, name=''):
Barry Warsawa7d9bdf1998-12-22 03:24:27 +0000368 """SMTP 'helo' command.
369 Hostname to send for this command defaults to the FQDN of the local
370 host.
371 """
Neil Schemenauer6730f262002-03-24 15:30:40 +0000372 self.putcmd("helo", name or self.local_hostname)
Guido van Rossum45e2fbc1998-03-26 21:13:24 +0000373 (code,msg)=self.getreply()
374 self.helo_resp=msg
Guido van Rossum296e1431999-04-07 15:03:39 +0000375 return (code,msg)
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000376
Guido van Rossum95e6f701998-06-25 02:15:50 +0000377 def ehlo(self, name=''):
Barry Warsawa7d9bdf1998-12-22 03:24:27 +0000378 """ SMTP 'ehlo' command.
379 Hostname to send for this command defaults to the FQDN of the local
380 host.
381 """
Guido van Rossumf7fcf5e2001-09-14 16:08:44 +0000382 self.esmtp_features = {}
Guido van Rossumd8faa362007-04-27 19:54:29 +0000383 self.putcmd(self.ehlo_msg, name or self.local_hostname)
Guido van Rossumfcfb6321998-08-04 15:29:54 +0000384 (code,msg)=self.getreply()
Tim Peters495ad3c2001-01-15 01:36:40 +0000385 # According to RFC1869 some (badly written)
386 # MTA's will disconnect on an ehlo. Toss an exception if
Guido van Rossumfcfb6321998-08-04 15:29:54 +0000387 # that happens -ddm
388 if code == -1 and len(msg) == 0:
Barry Warsaw76750972001-12-14 20:34:20 +0000389 self.close()
Guido van Rossum40233ea1999-01-15 03:23:55 +0000390 raise SMTPServerDisconnected("Server not connected")
Guido van Rossum95e6f701998-06-25 02:15:50 +0000391 self.ehlo_resp=msg
Fred Drake8152d322000-12-12 23:20:45 +0000392 if code != 250:
Guido van Rossum296e1431999-04-07 15:03:39 +0000393 return (code,msg)
Guido van Rossumfcfb6321998-08-04 15:29:54 +0000394 self.does_esmtp=1
Thomas Wouters7e474022000-07-16 12:04:32 +0000395 #parse the ehlo response -ddm
Guido van Rossum04110fb2007-08-24 16:32:05 +0000396 assert isinstance(self.ehlo_resp, bytes), repr(self.ehlo_resp)
397 resp=self.ehlo_resp.decode("latin-1").split('\n')
Guido van Rossumfcfb6321998-08-04 15:29:54 +0000398 del resp[0]
Guido van Rossum2880f6e1998-08-10 20:07:00 +0000399 for each in resp:
Piers Lauder385a77a2002-07-27 00:38:30 +0000400 # To be able to communicate with as many SMTP servers as possible,
401 # we have to take the old-style auth advertisement into account,
402 # because:
403 # 1) Else our SMTP feature parser gets confused.
404 # 2) There are some servers that only advertise the auth methods we
405 # support using the old style.
406 auth_match = OLDSTYLE_AUTH.match(each)
407 if auth_match:
408 # This doesn't remove duplicates, but that's no problem
409 self.esmtp_features["auth"] = self.esmtp_features.get("auth", "") \
410 + " " + auth_match.groups(0)[0]
411 continue
412
Barry Warsawbe22ae62002-04-15 20:03:30 +0000413 # RFC 1869 requires a space between ehlo keyword and parameters.
414 # It's actually stricter, in that only spaces are allowed between
415 # parameters, but were not going to check for that here. Note
416 # that the space isn't present if there are no parameters.
417 m=re.match(r'(?P<feature>[A-Za-z0-9][A-Za-z0-9\-]*) ?',each)
Guido van Rossumfcfb6321998-08-04 15:29:54 +0000418 if m:
Eric S. Raymondc013f302001-02-09 05:40:38 +0000419 feature=m.group("feature").lower()
420 params=m.string[m.end("feature"):].strip()
Piers Lauder385a77a2002-07-27 00:38:30 +0000421 if feature == "auth":
422 self.esmtp_features[feature] = self.esmtp_features.get(feature, "") \
423 + " " + params
424 else:
425 self.esmtp_features[feature]=params
Guido van Rossum296e1431999-04-07 15:03:39 +0000426 return (code,msg)
Guido van Rossum95e6f701998-06-25 02:15:50 +0000427
Guido van Rossumfcfb6321998-08-04 15:29:54 +0000428 def has_extn(self, opt):
429 """Does the server support a given SMTP service extension?"""
Raymond Hettinger54f02222002-06-01 14:18:47 +0000430 return opt.lower() in self.esmtp_features
Guido van Rossum95e6f701998-06-25 02:15:50 +0000431
Guido van Rossum18586f41998-04-03 17:03:13 +0000432 def help(self, args=''):
Barry Warsawa7d9bdf1998-12-22 03:24:27 +0000433 """SMTP 'help' command.
434 Returns help text from server."""
Guido van Rossum18586f41998-04-03 17:03:13 +0000435 self.putcmd("help", args)
Kurt B. Kaiser58bd1902005-06-26 18:27:36 +0000436 return self.getreply()[1]
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000437
438 def rset(self):
Barry Warsawa7d9bdf1998-12-22 03:24:27 +0000439 """SMTP 'rset' command -- resets session."""
Guido van Rossum296e1431999-04-07 15:03:39 +0000440 return self.docmd("rset")
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000441
442 def noop(self):
Barry Warsawa7d9bdf1998-12-22 03:24:27 +0000443 """SMTP 'noop' command -- doesn't do anything :>"""
Guido van Rossum296e1431999-04-07 15:03:39 +0000444 return self.docmd("noop")
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000445
Guido van Rossum95e6f701998-06-25 02:15:50 +0000446 def mail(self,sender,options=[]):
Barry Warsawa7d9bdf1998-12-22 03:24:27 +0000447 """SMTP 'mail' command -- begins mail xfer session."""
Guido van Rossumfcfb6321998-08-04 15:29:54 +0000448 optionlist = ''
449 if options and self.does_esmtp:
Eric S. Raymondc013f302001-02-09 05:40:38 +0000450 optionlist = ' ' + ' '.join(options)
Guido van Rossumdb23d3d1999-06-09 15:13:10 +0000451 self.putcmd("mail", "FROM:%s%s" % (quoteaddr(sender) ,optionlist))
Guido van Rossum45e2fbc1998-03-26 21:13:24 +0000452 return self.getreply()
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000453
Guido van Rossumfcfb6321998-08-04 15:29:54 +0000454 def rcpt(self,recip,options=[]):
Barry Warsawa7d9bdf1998-12-22 03:24:27 +0000455 """SMTP 'rcpt' command -- indicates 1 recipient for this mail."""
Guido van Rossumfcfb6321998-08-04 15:29:54 +0000456 optionlist = ''
457 if options and self.does_esmtp:
Eric S. Raymondc013f302001-02-09 05:40:38 +0000458 optionlist = ' ' + ' '.join(options)
Guido van Rossum348fd061999-01-14 04:18:46 +0000459 self.putcmd("rcpt","TO:%s%s" % (quoteaddr(recip),optionlist))
Guido van Rossum45e2fbc1998-03-26 21:13:24 +0000460 return self.getreply()
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000461
462 def data(self,msg):
Tim Peters495ad3c2001-01-15 01:36:40 +0000463 """SMTP 'DATA' command -- sends message data to server.
Guido van Rossum296e1431999-04-07 15:03:39 +0000464
Barry Warsaw4c4bec81998-12-22 03:02:20 +0000465 Automatically quotes lines beginning with a period per rfc821.
Guido van Rossum296e1431999-04-07 15:03:39 +0000466 Raises SMTPDataError if there is an unexpected reply to the
467 DATA command; the return value from this method is the final
468 response code received when the all data is sent.
Barry Warsaw4c4bec81998-12-22 03:02:20 +0000469 """
Guido van Rossum45e2fbc1998-03-26 21:13:24 +0000470 self.putcmd("data")
471 (code,repl)=self.getreply()
Guido van Rossumbe19ed72007-02-09 05:37:30 +0000472 if self.debuglevel >0 : print("data:", (code,repl), file=stderr)
Fred Drake8152d322000-12-12 23:20:45 +0000473 if code != 354:
Guido van Rossum296e1431999-04-07 15:03:39 +0000474 raise SMTPDataError(code,repl)
Guido van Rossum45e2fbc1998-03-26 21:13:24 +0000475 else:
Guido van Rossum20c92281999-04-21 16:52:20 +0000476 q = quotedata(msg)
477 if q[-2:] != CRLF:
478 q = q + CRLF
479 q = q + "." + CRLF
480 self.send(q)
Guido van Rossum45e2fbc1998-03-26 21:13:24 +0000481 (code,msg)=self.getreply()
Guido van Rossumbe19ed72007-02-09 05:37:30 +0000482 if self.debuglevel >0 : print("data:", (code,msg), file=stderr)
Guido van Rossum296e1431999-04-07 15:03:39 +0000483 return (code,msg)
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000484
Guido van Rossumfcfb6321998-08-04 15:29:54 +0000485 def verify(self, address):
Barry Warsawa7d9bdf1998-12-22 03:24:27 +0000486 """SMTP 'verify' command -- checks for address validity."""
Guido van Rossumfcfb6321998-08-04 15:29:54 +0000487 self.putcmd("vrfy", quoteaddr(address))
488 return self.getreply()
Barry Warsaw4c4bec81998-12-22 03:02:20 +0000489 # a.k.a.
490 vrfy=verify
Guido van Rossumfcfb6321998-08-04 15:29:54 +0000491
492 def expn(self, address):
Christian Heimes90c3d9b2008-02-23 13:18:03 +0000493 """SMTP 'expn' command -- expands a mailing list."""
Guido van Rossumfcfb6321998-08-04 15:29:54 +0000494 self.putcmd("expn", quoteaddr(address))
495 return self.getreply()
496
Barry Warsaw4c4bec81998-12-22 03:02:20 +0000497 # some useful methods
Guido van Rossumae010462001-09-11 15:57:46 +0000498
Christian Heimes679db4a2008-01-18 09:56:22 +0000499 def ehlo_or_helo_if_needed(self):
500 """Call self.ehlo() and/or self.helo() if needed.
501
502 If there has been no previous EHLO or HELO command this session, this
503 method tries ESMTP EHLO first.
504
505 This method may raise the following exceptions:
506
507 SMTPHeloError The server didn't reply properly to
508 the helo greeting.
509 """
510 if self.helo_resp is None and self.ehlo_resp is None:
511 if not (200 <= self.ehlo()[0] <= 299):
512 (code, resp) = self.helo()
513 if not (200 <= code <= 299):
514 raise SMTPHeloError(code, resp)
515
Guido van Rossumae010462001-09-11 15:57:46 +0000516 def login(self, user, password):
517 """Log in on an SMTP server that requires authentication.
518
519 The arguments are:
520 - user: The user name to authenticate with.
521 - password: The password for the authentication.
522
523 If there has been no previous EHLO or HELO command this session, this
524 method tries ESMTP EHLO first.
525
526 This method will return normally if the authentication was successful.
527
528 This method may raise the following exceptions:
529
530 SMTPHeloError The server didn't reply properly to
531 the helo greeting.
532 SMTPAuthenticationError The server didn't accept the username/
533 password combination.
Fred Drake2f8f4d32001-10-13 18:35:32 +0000534 SMTPException No suitable authentication method was
Guido van Rossumae010462001-09-11 15:57:46 +0000535 found.
536 """
537
538 def encode_cram_md5(challenge, user, password):
539 challenge = base64.decodestring(challenge)
540 response = user + " " + hmac.HMAC(password, challenge).hexdigest()
Barry Warsaw2cc1f6d2007-08-30 14:28:55 +0000541 return encode_base64(response)
Guido van Rossumae010462001-09-11 15:57:46 +0000542
543 def encode_plain(user, password):
Barry Warsaw2cc1f6d2007-08-30 14:28:55 +0000544 return encode_base64("\0%s\0%s" % (user, password))
Tim Peters469cdad2002-08-08 20:19:19 +0000545
Guido van Rossumae010462001-09-11 15:57:46 +0000546
547 AUTH_PLAIN = "PLAIN"
548 AUTH_CRAM_MD5 = "CRAM-MD5"
Piers Lauder385a77a2002-07-27 00:38:30 +0000549 AUTH_LOGIN = "LOGIN"
Guido van Rossumae010462001-09-11 15:57:46 +0000550
Christian Heimes679db4a2008-01-18 09:56:22 +0000551 self.ehlo_or_helo_if_needed()
Guido van Rossumae010462001-09-11 15:57:46 +0000552
553 if not self.has_extn("auth"):
554 raise SMTPException("SMTP AUTH extension not supported by server.")
555
556 # Authentication methods the server supports:
557 authlist = self.esmtp_features["auth"].split()
558
559 # List of authentication methods we support: from preferred to
560 # less preferred methods. Except for the purpose of testing the weaker
561 # ones, we prefer stronger methods like CRAM-MD5:
Piers Lauder385a77a2002-07-27 00:38:30 +0000562 preferred_auths = [AUTH_CRAM_MD5, AUTH_PLAIN, AUTH_LOGIN]
Guido van Rossumae010462001-09-11 15:57:46 +0000563
564 # Determine the authentication method we'll use
565 authmethod = None
566 for method in preferred_auths:
567 if method in authlist:
568 authmethod = method
569 break
Tim Petersb64bec32001-09-18 02:26:39 +0000570
Guido van Rossumae010462001-09-11 15:57:46 +0000571 if authmethod == AUTH_CRAM_MD5:
572 (code, resp) = self.docmd("AUTH", AUTH_CRAM_MD5)
573 if code == 503:
574 # 503 == 'Error: already authenticated'
575 return (code, resp)
576 (code, resp) = self.docmd(encode_cram_md5(resp, user, password))
577 elif authmethod == AUTH_PLAIN:
Tim Petersb64bec32001-09-18 02:26:39 +0000578 (code, resp) = self.docmd("AUTH",
Guido van Rossumae010462001-09-11 15:57:46 +0000579 AUTH_PLAIN + " " + encode_plain(user, password))
Piers Lauder385a77a2002-07-27 00:38:30 +0000580 elif authmethod == AUTH_LOGIN:
581 (code, resp) = self.docmd("AUTH",
Barry Warsaw2cc1f6d2007-08-30 14:28:55 +0000582 "%s %s" % (AUTH_LOGIN, encode_base64(user)))
Piers Lauder385a77a2002-07-27 00:38:30 +0000583 if code != 334:
584 raise SMTPAuthenticationError(code, resp)
Barry Warsaw2cc1f6d2007-08-30 14:28:55 +0000585 (code, resp) = self.docmd(encode_base64(password))
Raymond Hettinger7fdfc2d2002-05-31 17:49:10 +0000586 elif authmethod is None:
Fred Drake2f8f4d32001-10-13 18:35:32 +0000587 raise SMTPException("No suitable authentication method found.")
Raymond Hettingerdbecd932005-02-06 06:57:08 +0000588 if code not in (235, 503):
Guido van Rossumae010462001-09-11 15:57:46 +0000589 # 235 == 'Authentication successful'
590 # 503 == 'Error: already authenticated'
591 raise SMTPAuthenticationError(code, resp)
592 return (code, resp)
593
Guido van Rossumf7fcf5e2001-09-14 16:08:44 +0000594 def starttls(self, keyfile = None, certfile = None):
595 """Puts the connection to the SMTP server into TLS mode.
Tim Petersb64bec32001-09-18 02:26:39 +0000596
Christian Heimes679db4a2008-01-18 09:56:22 +0000597 If there has been no previous EHLO or HELO command this session, this
598 method tries ESMTP EHLO first.
599
Guido van Rossumf7fcf5e2001-09-14 16:08:44 +0000600 If the server supports TLS, this will encrypt the rest of the SMTP
601 session. If you provide the keyfile and certfile parameters,
602 the identity of the SMTP server and client can be checked. This,
603 however, depends on whether the socket module really checks the
604 certificates.
Christian Heimes679db4a2008-01-18 09:56:22 +0000605
606 This method may raise the following exceptions:
607
608 SMTPHeloError The server didn't reply properly to
609 the helo greeting.
Guido van Rossumf7fcf5e2001-09-14 16:08:44 +0000610 """
Christian Heimes679db4a2008-01-18 09:56:22 +0000611 self.ehlo_or_helo_if_needed()
612 if not self.has_extn("starttls"):
613 raise SMTPException("STARTTLS extension not supported by server.")
Tim Petersb64bec32001-09-18 02:26:39 +0000614 (resp, reply) = self.docmd("STARTTLS")
Guido van Rossumf7fcf5e2001-09-14 16:08:44 +0000615 if resp == 220:
Thomas Wouters47b49bf2007-08-30 22:15:33 +0000616 if not _have_ssl:
617 raise RuntimeError("No SSL support included in this Python")
Thomas Wouters1b7f8912007-09-19 03:06:30 +0000618 self.sock = ssl.wrap_socket(self.sock, keyfile, certfile)
Thomas Wouters47b49bf2007-08-30 22:15:33 +0000619 self.file = SSLFakeFile(self.sock)
Christian Heimes679db4a2008-01-18 09:56:22 +0000620 # RFC 3207:
621 # The client MUST discard any knowledge obtained from
622 # the server, such as the list of SMTP service extensions,
623 # which was not obtained from the TLS negotiation itself.
624 self.helo_resp = None
625 self.ehlo_resp = None
626 self.esmtp_features = {}
627 self.does_esmtp = 0
Guido van Rossumf7fcf5e2001-09-14 16:08:44 +0000628 return (resp, reply)
Tim Petersb64bec32001-09-18 02:26:39 +0000629
Jeremy Hylton31bb8ce1998-08-13 19:57:46 +0000630 def sendmail(self, from_addr, to_addrs, msg, mail_options=[],
Tim Peters495ad3c2001-01-15 01:36:40 +0000631 rcpt_options=[]):
632 """This command performs an entire mail transaction.
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000633
Tim Peters495ad3c2001-01-15 01:36:40 +0000634 The arguments are:
Barry Warsaw4c4bec81998-12-22 03:02:20 +0000635 - from_addr : The address sending this mail.
636 - to_addrs : A list of addresses to send this mail to. A bare
637 string will be treated as a list with 1 address.
Tim Peters495ad3c2001-01-15 01:36:40 +0000638 - msg : The message to send.
Barry Warsaw4c4bec81998-12-22 03:02:20 +0000639 - mail_options : List of ESMTP options (such as 8bitmime) for the
640 mail command.
641 - rcpt_options : List of ESMTP options (such as DSN commands) for
642 all the rcpt commands.
643
644 If there has been no previous EHLO or HELO command this session, this
645 method tries ESMTP EHLO first. If the server does ESMTP, message size
646 and each of the specified options will be passed to it. If EHLO
647 fails, HELO will be tried and ESMTP options suppressed.
648
649 This method will return normally if the mail is accepted for at least
Barry Warsawd25c1b71999-11-28 17:11:06 +0000650 one recipient. It returns a dictionary, with one entry for each
651 recipient that was refused. Each entry contains a tuple of the SMTP
652 error code and the accompanying error message sent by the server.
Guido van Rossum296e1431999-04-07 15:03:39 +0000653
654 This method may raise the following exceptions:
655
656 SMTPHeloError The server didn't reply properly to
Tim Peters495ad3c2001-01-15 01:36:40 +0000657 the helo greeting.
Barry Warsawd25c1b71999-11-28 17:11:06 +0000658 SMTPRecipientsRefused The server rejected ALL recipients
Guido van Rossum296e1431999-04-07 15:03:39 +0000659 (no mail was sent).
660 SMTPSenderRefused The server didn't accept the from_addr.
661 SMTPDataError The server replied with an unexpected
662 error code (other than a refusal of
663 a recipient).
664
665 Note: the connection will be open even after an exception is raised.
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000666
Guido van Rossum95e6f701998-06-25 02:15:50 +0000667 Example:
Tim Peters495ad3c2001-01-15 01:36:40 +0000668
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000669 >>> import smtplib
670 >>> s=smtplib.SMTP("localhost")
Guido van Rossumfc40a831998-01-29 17:26:45 +0000671 >>> tolist=["one@one.org","two@two.org","three@three.org","four@four.org"]
Martin v. Löwis301b1cd2002-07-28 16:52:01 +0000672 >>> msg = '''\\
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000673 ... From: Me@my.org
674 ... Subject: testin'...
675 ...
676 ... This is a test '''
677 >>> s.sendmail("me@my.org",tolist,msg)
678 { "three@three.org" : ( 550 ,"User unknown" ) }
679 >>> s.quit()
Tim Peters495ad3c2001-01-15 01:36:40 +0000680
Barry Warsaw4c4bec81998-12-22 03:02:20 +0000681 In the above example, the message was accepted for delivery to three
682 of the four addresses, and one was rejected, with the error code
Barry Warsawd25c1b71999-11-28 17:11:06 +0000683 550. If all addresses are accepted, then the method will return an
Barry Warsaw4c4bec81998-12-22 03:02:20 +0000684 empty dictionary.
685
686 """
Christian Heimes679db4a2008-01-18 09:56:22 +0000687 self.ehlo_or_helo_if_needed()
Guido van Rossum95e6f701998-06-25 02:15:50 +0000688 esmtp_opts = []
Guido van Rossumfcfb6321998-08-04 15:29:54 +0000689 if self.does_esmtp:
690 # Hmmm? what's this? -ddm
691 # self.esmtp_features['7bit']=""
692 if self.has_extn('size'):
Walter Dörwald70a6b492004-02-12 17:35:32 +0000693 esmtp_opts.append("size=%d" % len(msg))
Guido van Rossumfcfb6321998-08-04 15:29:54 +0000694 for option in mail_options:
Guido van Rossum95e6f701998-06-25 02:15:50 +0000695 esmtp_opts.append(option)
Guido van Rossumfcfb6321998-08-04 15:29:54 +0000696
Guido van Rossum95e6f701998-06-25 02:15:50 +0000697 (code,resp) = self.mail(from_addr, esmtp_opts)
Fred Drake8152d322000-12-12 23:20:45 +0000698 if code != 250:
Guido van Rossum45e2fbc1998-03-26 21:13:24 +0000699 self.rset()
Guido van Rossum296e1431999-04-07 15:03:39 +0000700 raise SMTPSenderRefused(code, resp, from_addr)
Guido van Rossum45e2fbc1998-03-26 21:13:24 +0000701 senderrs={}
Guido van Rossum3172c5d2007-10-16 18:12:55 +0000702 if isinstance(to_addrs, str):
Jeremy Hylton31bb8ce1998-08-13 19:57:46 +0000703 to_addrs = [to_addrs]
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000704 for each in to_addrs:
Guido van Rossumfcfb6321998-08-04 15:29:54 +0000705 (code,resp)=self.rcpt(each, rcpt_options)
Fred Drake8152d322000-12-12 23:20:45 +0000706 if (code != 250) and (code != 251):
Guido van Rossumfc40a831998-01-29 17:26:45 +0000707 senderrs[each]=(code,resp)
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000708 if len(senderrs)==len(to_addrs):
Guido van Rossum95e6f701998-06-25 02:15:50 +0000709 # the server refused all our recipients
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000710 self.rset()
Guido van Rossum296e1431999-04-07 15:03:39 +0000711 raise SMTPRecipientsRefused(senderrs)
Fred Drake8152d322000-12-12 23:20:45 +0000712 (code,resp) = self.data(msg)
713 if code != 250:
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000714 self.rset()
Guido van Rossum296e1431999-04-07 15:03:39 +0000715 raise SMTPDataError(code, resp)
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000716 #if we got here then somebody got our mail
Tim Peters495ad3c2001-01-15 01:36:40 +0000717 return senderrs
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000718
719
720 def close(self):
721 """Close the connection to the SMTP server."""
722 if self.file:
723 self.file.close()
724 self.file = None
725 if self.sock:
726 self.sock.close()
727 self.sock = None
728
729
730 def quit(self):
Guido van Rossum95e6f701998-06-25 02:15:50 +0000731 """Terminate the SMTP session."""
Christian Heimesba4af492008-03-28 00:55:15 +0000732 res = self.docmd("quit")
Guido van Rossum45e2fbc1998-03-26 21:13:24 +0000733 self.close()
Christian Heimesba4af492008-03-28 00:55:15 +0000734 return res
Guido van Rossum95e6f701998-06-25 02:15:50 +0000735
Thomas Wouters47b49bf2007-08-30 22:15:33 +0000736if _have_ssl:
Thomas Wouters89f507f2006-12-13 04:49:30 +0000737
Thomas Wouters47b49bf2007-08-30 22:15:33 +0000738 class SMTP_SSL(SMTP):
739 """ This is a subclass derived from SMTP that connects over an SSL encrypted
740 socket (to use this class you need a socket module that was compiled with SSL
741 support). If host is not specified, '' (the local host) is used. If port is
742 omitted, the standard SMTP-over-SSL port (465) is used. keyfile and certfile
743 are also optional - they can contain a PEM formatted private key and
744 certificate chain file for the SSL connection.
745 """
746 def __init__(self, host='', port=0, local_hostname=None,
747 keyfile=None, certfile=None, timeout=None):
748 self.keyfile = keyfile
749 self.certfile = certfile
750 SMTP.__init__(self, host, port, local_hostname, timeout)
751 self.default_port = SMTP_SSL_PORT
752
753 def _get_socket(self, host, port, timeout):
754 if self.debuglevel > 0: print('connect:', (host, port), file=stderr)
755 self.sock = socket.create_connection((host, port), timeout)
Thomas Wouters1b7f8912007-09-19 03:06:30 +0000756 self.sock = ssl.wrap_socket(self.sock, self.keyfile, self.certfile)
Thomas Wouters89d996e2007-09-08 17:39:28 +0000757 self.file = SSLFakeFile(self.sock)
Thomas Wouters47b49bf2007-08-30 22:15:33 +0000758
759 __all__.append("SMTP_SSL")
Barry Warsaw4c4bec81998-12-22 03:02:20 +0000760
Guido van Rossumd8faa362007-04-27 19:54:29 +0000761#
762# LMTP extension
763#
764LMTP_PORT = 2003
765
766class LMTP(SMTP):
767 """LMTP - Local Mail Transfer Protocol
768
769 The LMTP protocol, which is very similar to ESMTP, is heavily based
770 on the standard SMTP client. It's common to use Unix sockets for LMTP,
771 so our connect() method must support that as well as a regular
772 host:port server. To specify a Unix socket, you must use an absolute
773 path as the host, starting with a '/'.
774
775 Authentication is supported, using the regular SMTP mechanism. When
776 using a Unix socket, LMTP generally don't support or require any
777 authentication, but your mileage might vary."""
778
779 ehlo_msg = "lhlo"
780
781 def __init__(self, host = '', port = LMTP_PORT, local_hostname = None):
782 """Initialize a new instance."""
783 SMTP.__init__(self, host, port, local_hostname)
784
785 def connect(self, host = 'localhost', port = 0):
786 """Connect to the LMTP daemon, on either a Unix or a TCP socket."""
787 if host[0] != '/':
788 return SMTP.connect(self, host, port)
789
790 # Handle Unix-domain sockets.
791 try:
792 self.sock = socket.socket(socket.AF_UNIX, socket.SOCK_STREAM)
793 self.sock.connect(host)
794 except socket.error as msg:
795 if self.debuglevel > 0: print>>stderr, 'connect fail:', host
796 if self.sock:
797 self.sock.close()
798 self.sock = None
799 raise socket.error(msg)
800 (code, msg) = self.getreply()
801 if self.debuglevel > 0: print>>stderr, "connect:", msg
802 return (code, msg)
803
804
Guido van Rossum95e6f701998-06-25 02:15:50 +0000805# Test the sendmail method, which tests most of the others.
806# Note: This always sends to localhost.
807if __name__ == '__main__':
Andrew M. Kuchling6be424f2001-08-13 14:41:39 +0000808 import sys
Guido van Rossum95e6f701998-06-25 02:15:50 +0000809
810 def prompt(prompt):
811 sys.stdout.write(prompt + ": ")
Eric S. Raymondc013f302001-02-09 05:40:38 +0000812 return sys.stdin.readline().strip()
Guido van Rossum95e6f701998-06-25 02:15:50 +0000813
814 fromaddr = prompt("From")
Eric S. Raymond38151ed2001-02-09 07:40:17 +0000815 toaddrs = prompt("To").split(',')
Guido van Rossumbe19ed72007-02-09 05:37:30 +0000816 print("Enter message, end with ^D:")
Guido van Rossum95e6f701998-06-25 02:15:50 +0000817 msg = ''
818 while 1:
819 line = sys.stdin.readline()
820 if not line:
821 break
822 msg = msg + line
Guido van Rossumbe19ed72007-02-09 05:37:30 +0000823 print("Message length is %d" % len(msg))
Guido van Rossum95e6f701998-06-25 02:15:50 +0000824
825 server = SMTP('localhost')
826 server.set_debuglevel(1)
827 server.sendmail(fromaddr, toaddrs, msg)
828 server.quit()