blob: 14e62504d3204c2f6828a23d8670a194073f8b07 [file] [log] [blame]
Benjamin Peterson90f5ba52010-03-11 22:53:45 +00001#! /usr/bin/env python3
Barry Warsaw4c4bec81998-12-22 03:02:20 +00002
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
R. David Murray7dff9e02010-11-08 17:15:13 +000045import io
Barry Warsaw07201771998-12-22 20:37:36 +000046import re
Thomas Woutersb2137042007-02-01 18:02:27 +000047import email.utils
R. David Murray7dff9e02010-11-08 17:15:13 +000048import email.message
49import email.generator
Guido van Rossumae010462001-09-11 15:57:46 +000050import base64
51import hmac
Barry Warsaw2cc1f6d2007-08-30 14:28:55 +000052from email.base64mime import body_encode as encode_base64
Brett Cannone6f8a892004-07-10 23:14:30 +000053from sys import stderr
Guido van Rossumbbe323e1998-01-29 17:24:40 +000054
Giampaolo Rodolàbd258bd2011-02-22 15:56:20 +000055__all__ = ["SMTPException", "SMTPServerDisconnected", "SMTPResponseException",
56 "SMTPSenderRefused", "SMTPRecipientsRefused", "SMTPDataError",
57 "SMTPConnectError", "SMTPHeloError", "SMTPAuthenticationError",
58 "quoteaddr", "quotedata", "SMTP"]
Skip Montanaro0de65802001-02-15 22:15:14 +000059
Guido van Rossumbbe323e1998-01-29 17:24:40 +000060SMTP_PORT = 25
Thomas Wouters89f507f2006-12-13 04:49:30 +000061SMTP_SSL_PORT = 465
Giampaolo Rodolàbd258bd2011-02-22 15:56:20 +000062CRLF = "\r\n"
63bCRLF = b"\r\n"
Guido van Rossumbbe323e1998-01-29 17:24:40 +000064
Piers Lauder385a77a2002-07-27 00:38:30 +000065OLDSTYLE_AUTH = re.compile(r"auth=(.*)", re.I)
66
Tim Peters495ad3c2001-01-15 01:36:40 +000067# Exception classes used by this module.
Guido van Rossum296e1431999-04-07 15:03:39 +000068class SMTPException(Exception):
69 """Base class for all exceptions raised by this module."""
70
71class SMTPServerDisconnected(SMTPException):
72 """Not connected to any SMTP server.
73
74 This exception is raised when the server unexpectedly disconnects,
75 or when an attempt is made to use the SMTP instance before
76 connecting it to a server.
77 """
78
79class SMTPResponseException(SMTPException):
80 """Base class for all exceptions that include an SMTP error code.
81
82 These exceptions are generated in some instances when the SMTP
83 server returns an error code. The error code is stored in the
84 `smtp_code' attribute of the error, and the `smtp_error' attribute
85 is set to the error message.
86 """
87
88 def __init__(self, code, msg):
89 self.smtp_code = code
90 self.smtp_error = msg
91 self.args = (code, msg)
92
93class SMTPSenderRefused(SMTPResponseException):
94 """Sender address refused.
Guido van Rossumae010462001-09-11 15:57:46 +000095
Guido van Rossum296e1431999-04-07 15:03:39 +000096 In addition to the attributes set by on all SMTPResponseException
Barry Warsawd25c1b71999-11-28 17:11:06 +000097 exceptions, this sets `sender' to the string that the SMTP refused.
Guido van Rossum296e1431999-04-07 15:03:39 +000098 """
99
100 def __init__(self, code, msg, sender):
101 self.smtp_code = code
102 self.smtp_error = msg
103 self.sender = sender
104 self.args = (code, msg, sender)
105
Guido van Rossum20c92281999-04-21 16:52:20 +0000106class SMTPRecipientsRefused(SMTPException):
Barry Warsawd25c1b71999-11-28 17:11:06 +0000107 """All recipient addresses refused.
Guido van Rossumae010462001-09-11 15:57:46 +0000108
Thomas Wouters7e474022000-07-16 12:04:32 +0000109 The errors for each recipient are accessible through the attribute
Tim Peters495ad3c2001-01-15 01:36:40 +0000110 'recipients', which is a dictionary of exactly the same sort as
111 SMTP.sendmail() returns.
Guido van Rossum296e1431999-04-07 15:03:39 +0000112 """
113
114 def __init__(self, recipients):
115 self.recipients = recipients
Giampaolo Rodolàbd258bd2011-02-22 15:56:20 +0000116 self.args = (recipients,)
Guido van Rossum296e1431999-04-07 15:03:39 +0000117
118
Guido van Rossum296e1431999-04-07 15:03:39 +0000119class SMTPDataError(SMTPResponseException):
120 """The SMTP server didn't accept the data."""
121
122class SMTPConnectError(SMTPResponseException):
Barry Warsawd25c1b71999-11-28 17:11:06 +0000123 """Error during connection establishment."""
Guido van Rossum296e1431999-04-07 15:03:39 +0000124
125class SMTPHeloError(SMTPResponseException):
Barry Warsawd25c1b71999-11-28 17:11:06 +0000126 """The server refused our HELO reply."""
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000127
Guido van Rossumae010462001-09-11 15:57:46 +0000128class SMTPAuthenticationError(SMTPResponseException):
129 """Authentication error.
130
131 Most probably the server didn't accept the username/password
132 combination provided.
133 """
Peter Schneider-Kamp7bc82bb2000-08-10 14:02:23 +0000134
Guido van Rossum69a79bc1998-07-13 15:18:49 +0000135def quoteaddr(addr):
136 """Quote a subset of the email addresses defined by RFC 821.
137
Georg Brandl9f0f9602008-06-12 22:23:59 +0000138 Should be able to handle anything email.utils.parseaddr can handle.
Barry Warsawa7d9bdf1998-12-22 03:24:27 +0000139 """
Raymond Hettinger342456d2002-09-05 01:14:07 +0000140 m = (None, None)
Guido van Rossum69a79bc1998-07-13 15:18:49 +0000141 try:
Thomas Woutersb2137042007-02-01 18:02:27 +0000142 m = email.utils.parseaddr(addr)[1]
Guido van Rossumfcfb6321998-08-04 15:29:54 +0000143 except AttributeError:
144 pass
Giampaolo Rodolàbd258bd2011-02-22 15:56:20 +0000145 if m == (None, None): # Indicates parse failure or AttributeError
Georg Brandlbd3bc4d2006-02-17 09:52:53 +0000146 # something weird here.. punt -ddm
Raymond Hettinger342456d2002-09-05 01:14:07 +0000147 return "<%s>" % addr
Georg Brandlbd3bc4d2006-02-17 09:52:53 +0000148 elif m is None:
149 # the sender wants an empty return address
150 return "<>"
Guido van Rossumfcfb6321998-08-04 15:29:54 +0000151 else:
152 return "<%s>" % m
Guido van Rossum69a79bc1998-07-13 15:18:49 +0000153
R. David Murray7dff9e02010-11-08 17:15:13 +0000154# Legacy method kept for backward compatibility.
Guido van Rossum69a79bc1998-07-13 15:18:49 +0000155def quotedata(data):
156 """Quote data for email.
157
Barry Warsawd25c1b71999-11-28 17:11:06 +0000158 Double leading '.', and change Unix newline '\\n', or Mac '\\r' into
Barry Warsawa7d9bdf1998-12-22 03:24:27 +0000159 Internet CRLF end-of-line.
160 """
Guido van Rossum69a79bc1998-07-13 15:18:49 +0000161 return re.sub(r'(?m)^\.', '..',
Guido van Rossumfcfb6321998-08-04 15:29:54 +0000162 re.sub(r'(?:\r\n|\n|\r(?!\n))', CRLF, data))
Guido van Rossum69a79bc1998-07-13 15:18:49 +0000163
R. David Murray7dff9e02010-11-08 17:15:13 +0000164def _quote_periods(bindata):
165 return re.sub(br'(?m)^\.', '..', bindata)
166
167def _fix_eols(data):
168 return re.sub(r'(?:\r\n|\n|\r(?!\n))', CRLF, data)
169
Thomas Wouters47b49bf2007-08-30 22:15:33 +0000170try:
171 import ssl
172except ImportError:
173 _have_ssl = False
174else:
Thomas Wouters47b49bf2007-08-30 22:15:33 +0000175 class SSLFakeFile:
176 """A fake file like object that really wraps a SSLObject.
177
178 It only supports what is needed in smtplib.
179 """
180 def __init__(self, sslobj):
181 self.sslobj = sslobj
182
183 def readline(self):
184 str = b""
185 chr = None
186 while chr != b"\n":
187 chr = self.sslobj.read(1)
Giampaolo Rodolàbd258bd2011-02-22 15:56:20 +0000188 if not chr:
189 break
Thomas Wouters47b49bf2007-08-30 22:15:33 +0000190 str += chr
191 return str
192
193 def close(self):
194 pass
195
196 _have_ssl = True
197
Peter Schneider-Kamp7bc82bb2000-08-10 14:02:23 +0000198
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000199class SMTP:
Guido van Rossumfcfb6321998-08-04 15:29:54 +0000200 """This class manages a connection to an SMTP or ESMTP server.
201 SMTP Objects:
Tim Peters495ad3c2001-01-15 01:36:40 +0000202 SMTP objects have the following attributes:
203 helo_resp
204 This is the message given by the server in response to the
Guido van Rossumfcfb6321998-08-04 15:29:54 +0000205 most recent HELO command.
Tim Peters495ad3c2001-01-15 01:36:40 +0000206
Guido van Rossumfcfb6321998-08-04 15:29:54 +0000207 ehlo_resp
Tim Peters495ad3c2001-01-15 01:36:40 +0000208 This is the message given by the server in response to the
Guido van Rossumfcfb6321998-08-04 15:29:54 +0000209 most recent EHLO command. This is usually multiline.
210
Tim Peters495ad3c2001-01-15 01:36:40 +0000211 does_esmtp
Guido van Rossumfcfb6321998-08-04 15:29:54 +0000212 This is a True value _after you do an EHLO command_, if the
213 server supports ESMTP.
214
Tim Peters495ad3c2001-01-15 01:36:40 +0000215 esmtp_features
Guido van Rossumfcfb6321998-08-04 15:29:54 +0000216 This is a dictionary, which, if the server supports ESMTP,
Barry Warsawd25c1b71999-11-28 17:11:06 +0000217 will _after you do an EHLO command_, contain the names of the
218 SMTP service extensions this server supports, and their
Guido van Rossumfcfb6321998-08-04 15:29:54 +0000219 parameters (if any).
Barry Warsawd25c1b71999-11-28 17:11:06 +0000220
Tim Peters495ad3c2001-01-15 01:36:40 +0000221 Note, all extension names are mapped to lower case in the
222 dictionary.
Guido van Rossumfcfb6321998-08-04 15:29:54 +0000223
Barry Warsawd25c1b71999-11-28 17:11:06 +0000224 See each method's docstrings for details. In general, there is a
225 method of the same name to perform each SMTP command. There is also a
226 method called 'sendmail' that will do an entire mail transaction.
227 """
Guido van Rossum95e6f701998-06-25 02:15:50 +0000228 debuglevel = 0
229 file = None
230 helo_resp = None
Guido van Rossumd8faa362007-04-27 19:54:29 +0000231 ehlo_msg = "ehlo"
Guido van Rossum95e6f701998-06-25 02:15:50 +0000232 ehlo_resp = None
Guido van Rossumfcfb6321998-08-04 15:29:54 +0000233 does_esmtp = 0
Guido van Rossum95e6f701998-06-25 02:15:50 +0000234
Georg Brandlf78e02b2008-06-10 17:40:04 +0000235 def __init__(self, host='', port=0, local_hostname=None,
236 timeout=socket._GLOBAL_DEFAULT_TIMEOUT):
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000237 """Initialize a new instance.
238
Barry Warsawa7d9bdf1998-12-22 03:24:27 +0000239 If specified, `host' is the name of the remote host to which to
240 connect. If specified, `port' specifies the port to which to connect.
Barry Warsawd25c1b71999-11-28 17:11:06 +0000241 By default, smtplib.SMTP_PORT is used. An SMTPConnectError is raised
Neil Schemenauer6730f262002-03-24 15:30:40 +0000242 if the specified `host' doesn't respond correctly. If specified,
Tim Peters863ac442002-04-16 01:38:40 +0000243 `local_hostname` is used as the FQDN of the local host. By default,
244 the local hostname is found using socket.getfqdn().
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000245
246 """
Guido van Rossumd8faa362007-04-27 19:54:29 +0000247 self.timeout = timeout
Guido van Rossumfcfb6321998-08-04 15:29:54 +0000248 self.esmtp_features = {}
Thomas Wouters89f507f2006-12-13 04:49:30 +0000249 self.default_port = SMTP_PORT
Guido van Rossum296e1431999-04-07 15:03:39 +0000250 if host:
251 (code, msg) = self.connect(host, port)
252 if code != 220:
253 raise SMTPConnectError(code, msg)
Raymond Hettingerf13eb552002-06-02 00:40:05 +0000254 if local_hostname is not None:
Barry Warsaw13e34f72002-03-26 20:27:35 +0000255 self.local_hostname = local_hostname
Neil Schemenauer6730f262002-03-24 15:30:40 +0000256 else:
Barry Warsaw13e34f72002-03-26 20:27:35 +0000257 # RFC 2821 says we should use the fqdn in the EHLO/HELO verb, and
258 # if that can't be calculated, that we should use a domain literal
259 # instead (essentially an encoded IP address like [A.B.C.D]).
260 fqdn = socket.getfqdn()
261 if '.' in fqdn:
262 self.local_hostname = fqdn
263 else:
264 # We can't find an fqdn hostname, so use a domain literal
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000265 addr = '127.0.0.1'
266 try:
267 addr = socket.gethostbyname(socket.gethostname())
268 except socket.gaierror:
269 pass
Barry Warsaw13e34f72002-03-26 20:27:35 +0000270 self.local_hostname = '[%s]' % addr
Tim Peters495ad3c2001-01-15 01:36:40 +0000271
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000272 def set_debuglevel(self, debuglevel):
273 """Set the debug output level.
274
Barry Warsawa7d9bdf1998-12-22 03:24:27 +0000275 A non-false value results in debug messages for connection and for all
276 messages sent to and received from the server.
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000277
278 """
279 self.debuglevel = debuglevel
280
Barry Warsawc9181712008-03-19 14:25:51 +0000281 def _get_socket(self, host, port, timeout):
Thomas Wouters89f507f2006-12-13 04:49:30 +0000282 # This makes it simpler for SMTP_SSL to use the SMTP connect code
283 # and just alter the socket connection bit.
Giampaolo Rodolàbd258bd2011-02-22 15:56:20 +0000284 if self.debuglevel > 0:
285 print('connect:', (host, port), file=stderr)
Barry Warsawc9181712008-03-19 14:25:51 +0000286 return socket.create_connection((host, port), timeout)
Thomas Wouters89f507f2006-12-13 04:49:30 +0000287
Giampaolo Rodolàbd258bd2011-02-22 15:56:20 +0000288 def connect(self, host='localhost', port=0):
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000289 """Connect to a host on a given port.
Guido van Rossum95e6f701998-06-25 02:15:50 +0000290
Barry Warsaw4c4bec81998-12-22 03:02:20 +0000291 If the hostname ends with a colon (`:') followed by a number, and
292 there is no port specified, that suffix will be stripped off and the
293 number interpreted as the port number to use.
Guido van Rossum95e6f701998-06-25 02:15:50 +0000294
Barry Warsawa7d9bdf1998-12-22 03:24:27 +0000295 Note: This method is automatically invoked by __init__, if a host is
296 specified during instantiation.
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000297
298 """
Martin v. Löwis4eb59402001-07-26 13:37:33 +0000299 if not port and (host.find(':') == host.rfind(':')):
Martin v. Löwisa43c2f82001-07-24 20:34:08 +0000300 i = host.rfind(':')
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000301 if i >= 0:
Giampaolo Rodolàbd258bd2011-02-22 15:56:20 +0000302 host, port = host[:i], host[i + 1:]
303 try:
304 port = int(port)
Eric S. Raymond8d876032001-02-09 10:14:53 +0000305 except ValueError:
Guido van Rossumd8faa362007-04-27 19:54:29 +0000306 raise socket.error("nonnumeric port")
Giampaolo Rodolàbd258bd2011-02-22 15:56:20 +0000307 if not port:
308 port = self.default_port
309 if self.debuglevel > 0:
310 print('connect:', (host, port), file=stderr)
Guido van Rossumd8faa362007-04-27 19:54:29 +0000311 self.sock = self._get_socket(host, port, self.timeout)
Martin v. Löwisa43c2f82001-07-24 20:34:08 +0000312 (code, msg) = self.getreply()
Giampaolo Rodolàbd258bd2011-02-22 15:56:20 +0000313 if self.debuglevel > 0:
314 print("connect:", msg, file=stderr)
Martin v. Löwisa43c2f82001-07-24 20:34:08 +0000315 return (code, msg)
Tim Peters495ad3c2001-01-15 01:36:40 +0000316
Guido van Rossum8a392d72007-11-21 22:09:45 +0000317 def send(self, s):
318 """Send `s' to the server."""
Giampaolo Rodolàbd258bd2011-02-22 15:56:20 +0000319 if self.debuglevel > 0:
320 print('send:', repr(s), file=stderr)
Christian Heimes90c3d9b2008-02-23 13:18:03 +0000321 if hasattr(self, 'sock') and self.sock:
Guido van Rossum8a392d72007-11-21 22:09:45 +0000322 if isinstance(s, str):
323 s = s.encode("ascii")
Guido van Rossum2880f6e1998-08-10 20:07:00 +0000324 try:
Guido van Rossum8a392d72007-11-21 22:09:45 +0000325 self.sock.sendall(s)
Guido van Rossum2880f6e1998-08-10 20:07:00 +0000326 except socket.error:
Barry Warsaw76750972001-12-14 20:34:20 +0000327 self.close()
Guido van Rossum40233ea1999-01-15 03:23:55 +0000328 raise SMTPServerDisconnected('Server not connected')
Guido van Rossumfc40a831998-01-29 17:26:45 +0000329 else:
Guido van Rossum40233ea1999-01-15 03:23:55 +0000330 raise SMTPServerDisconnected('please run connect() first')
Tim Peters495ad3c2001-01-15 01:36:40 +0000331
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000332 def putcmd(self, cmd, args=""):
Barry Warsawa7d9bdf1998-12-22 03:24:27 +0000333 """Send a command to the server."""
Guido van Rossumdb23d3d1999-06-09 15:13:10 +0000334 if args == "":
335 str = '%s%s' % (cmd, CRLF)
336 else:
337 str = '%s %s%s' % (cmd, args, CRLF)
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000338 self.send(str)
Tim Peters495ad3c2001-01-15 01:36:40 +0000339
Guido van Rossumfcfb6321998-08-04 15:29:54 +0000340 def getreply(self):
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000341 """Get a reply from the server.
Tim Peters495ad3c2001-01-15 01:36:40 +0000342
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000343 Returns a tuple consisting of:
Barry Warsawa7d9bdf1998-12-22 03:24:27 +0000344
345 - server response code (e.g. '250', or such, if all goes well)
346 Note: returns -1 if it can't read response code.
347
348 - server response string corresponding to response code (multiline
349 responses are converted to a single, multiline string).
Guido van Rossumf123f841999-03-29 20:33:21 +0000350
351 Raises SMTPServerDisconnected if end-of-file is reached.
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000352 """
Giampaolo Rodolàbd258bd2011-02-22 15:56:20 +0000353 resp = []
Guido van Rossum296e1431999-04-07 15:03:39 +0000354 if self.file is None:
355 self.file = self.sock.makefile('rb')
Guido van Rossum45e2fbc1998-03-26 21:13:24 +0000356 while 1:
Benjamin Petersone1cdfd72009-01-18 21:02:37 +0000357 try:
358 line = self.file.readline()
359 except socket.error:
360 line = ''
Guido van Rossum806c2462007-08-06 23:33:07 +0000361 if not line:
Guido van Rossum296e1431999-04-07 15:03:39 +0000362 self.close()
363 raise SMTPServerDisconnected("Connection unexpectedly closed")
Giampaolo Rodolàbd258bd2011-02-22 15:56:20 +0000364 if self.debuglevel > 0:
365 print('reply:', repr(line), file=stderr)
Guido van Rossum806c2462007-08-06 23:33:07 +0000366 resp.append(line[4:].strip(b' \t\r\n'))
Giampaolo Rodolàbd258bd2011-02-22 15:56:20 +0000367 code = line[:3]
Guido van Rossum296e1431999-04-07 15:03:39 +0000368 # Check that the error code is syntactically correct.
369 # Don't attempt to read a continuation line if it is broken.
370 try:
Eric S. Raymondc013f302001-02-09 05:40:38 +0000371 errcode = int(code)
Guido van Rossum296e1431999-04-07 15:03:39 +0000372 except ValueError:
373 errcode = -1
374 break
Guido van Rossumf123f841999-03-29 20:33:21 +0000375 # Check if multiline response.
Guido van Rossum806c2462007-08-06 23:33:07 +0000376 if line[3:4] != b"-":
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000377 break
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000378
Guido van Rossumc43e79f2007-06-18 18:26:36 +0000379 errmsg = b"\n".join(resp)
Tim Peters495ad3c2001-01-15 01:36:40 +0000380 if self.debuglevel > 0:
Giampaolo Rodolàbd258bd2011-02-22 15:56:20 +0000381 print('reply: retcode (%s); Msg: %s' % (errcode, errmsg), file=stderr)
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000382 return errcode, errmsg
Tim Peters495ad3c2001-01-15 01:36:40 +0000383
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000384 def docmd(self, cmd, args=""):
Barry Warsawa7d9bdf1998-12-22 03:24:27 +0000385 """Send a command, and return its response code."""
Giampaolo Rodolàbd258bd2011-02-22 15:56:20 +0000386 self.putcmd(cmd, args)
Guido van Rossum296e1431999-04-07 15:03:39 +0000387 return self.getreply()
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000388
Barry Warsawa7d9bdf1998-12-22 03:24:27 +0000389 # std smtp commands
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000390 def helo(self, name=''):
Barry Warsawa7d9bdf1998-12-22 03:24:27 +0000391 """SMTP 'helo' command.
392 Hostname to send for this command defaults to the FQDN of the local
393 host.
394 """
Neil Schemenauer6730f262002-03-24 15:30:40 +0000395 self.putcmd("helo", name or self.local_hostname)
Giampaolo Rodolàbd258bd2011-02-22 15:56:20 +0000396 (code, msg) = self.getreply()
397 self.helo_resp = msg
398 return (code, msg)
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000399
Guido van Rossum95e6f701998-06-25 02:15:50 +0000400 def ehlo(self, name=''):
Barry Warsawa7d9bdf1998-12-22 03:24:27 +0000401 """ SMTP 'ehlo' command.
402 Hostname to send for this command defaults to the FQDN of the local
403 host.
404 """
Guido van Rossumf7fcf5e2001-09-14 16:08:44 +0000405 self.esmtp_features = {}
Guido van Rossumd8faa362007-04-27 19:54:29 +0000406 self.putcmd(self.ehlo_msg, name or self.local_hostname)
Giampaolo Rodolàbd258bd2011-02-22 15:56:20 +0000407 (code, msg) = self.getreply()
Tim Peters495ad3c2001-01-15 01:36:40 +0000408 # According to RFC1869 some (badly written)
409 # MTA's will disconnect on an ehlo. Toss an exception if
Guido van Rossumfcfb6321998-08-04 15:29:54 +0000410 # that happens -ddm
411 if code == -1 and len(msg) == 0:
Barry Warsaw76750972001-12-14 20:34:20 +0000412 self.close()
Guido van Rossum40233ea1999-01-15 03:23:55 +0000413 raise SMTPServerDisconnected("Server not connected")
Giampaolo Rodolàbd258bd2011-02-22 15:56:20 +0000414 self.ehlo_resp = msg
Fred Drake8152d322000-12-12 23:20:45 +0000415 if code != 250:
Giampaolo Rodolàbd258bd2011-02-22 15:56:20 +0000416 return (code, msg)
417 self.does_esmtp = 1
Thomas Wouters7e474022000-07-16 12:04:32 +0000418 #parse the ehlo response -ddm
Guido van Rossum04110fb2007-08-24 16:32:05 +0000419 assert isinstance(self.ehlo_resp, bytes), repr(self.ehlo_resp)
Giampaolo Rodolàbd258bd2011-02-22 15:56:20 +0000420 resp = self.ehlo_resp.decode("latin-1").split('\n')
Guido van Rossumfcfb6321998-08-04 15:29:54 +0000421 del resp[0]
Guido van Rossum2880f6e1998-08-10 20:07:00 +0000422 for each in resp:
Piers Lauder385a77a2002-07-27 00:38:30 +0000423 # To be able to communicate with as many SMTP servers as possible,
424 # we have to take the old-style auth advertisement into account,
425 # because:
426 # 1) Else our SMTP feature parser gets confused.
427 # 2) There are some servers that only advertise the auth methods we
428 # support using the old style.
429 auth_match = OLDSTYLE_AUTH.match(each)
430 if auth_match:
431 # This doesn't remove duplicates, but that's no problem
432 self.esmtp_features["auth"] = self.esmtp_features.get("auth", "") \
433 + " " + auth_match.groups(0)[0]
434 continue
435
Barry Warsawbe22ae62002-04-15 20:03:30 +0000436 # RFC 1869 requires a space between ehlo keyword and parameters.
437 # It's actually stricter, in that only spaces are allowed between
438 # parameters, but were not going to check for that here. Note
439 # that the space isn't present if there are no parameters.
Giampaolo Rodolàbd258bd2011-02-22 15:56:20 +0000440 m = re.match(r'(?P<feature>[A-Za-z0-9][A-Za-z0-9\-]*) ?', each)
Guido van Rossumfcfb6321998-08-04 15:29:54 +0000441 if m:
Giampaolo Rodolàbd258bd2011-02-22 15:56:20 +0000442 feature = m.group("feature").lower()
443 params = m.string[m.end("feature"):].strip()
Piers Lauder385a77a2002-07-27 00:38:30 +0000444 if feature == "auth":
445 self.esmtp_features[feature] = self.esmtp_features.get(feature, "") \
446 + " " + params
447 else:
Giampaolo Rodolàbd258bd2011-02-22 15:56:20 +0000448 self.esmtp_features[feature] = params
449 return (code, msg)
Guido van Rossum95e6f701998-06-25 02:15:50 +0000450
Guido van Rossumfcfb6321998-08-04 15:29:54 +0000451 def has_extn(self, opt):
452 """Does the server support a given SMTP service extension?"""
Raymond Hettinger54f02222002-06-01 14:18:47 +0000453 return opt.lower() in self.esmtp_features
Guido van Rossum95e6f701998-06-25 02:15:50 +0000454
Guido van Rossum18586f41998-04-03 17:03:13 +0000455 def help(self, args=''):
Barry Warsawa7d9bdf1998-12-22 03:24:27 +0000456 """SMTP 'help' command.
457 Returns help text from server."""
Guido van Rossum18586f41998-04-03 17:03:13 +0000458 self.putcmd("help", args)
Kurt B. Kaiser58bd1902005-06-26 18:27:36 +0000459 return self.getreply()[1]
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000460
461 def rset(self):
Barry Warsawa7d9bdf1998-12-22 03:24:27 +0000462 """SMTP 'rset' command -- resets session."""
Guido van Rossum296e1431999-04-07 15:03:39 +0000463 return self.docmd("rset")
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000464
465 def noop(self):
Barry Warsawa7d9bdf1998-12-22 03:24:27 +0000466 """SMTP 'noop' command -- doesn't do anything :>"""
Guido van Rossum296e1431999-04-07 15:03:39 +0000467 return self.docmd("noop")
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000468
Giampaolo Rodolàbd258bd2011-02-22 15:56:20 +0000469 def mail(self, sender, options=[]):
Barry Warsawa7d9bdf1998-12-22 03:24:27 +0000470 """SMTP 'mail' command -- begins mail xfer session."""
Guido van Rossumfcfb6321998-08-04 15:29:54 +0000471 optionlist = ''
472 if options and self.does_esmtp:
Eric S. Raymondc013f302001-02-09 05:40:38 +0000473 optionlist = ' ' + ' '.join(options)
Giampaolo Rodolàbd258bd2011-02-22 15:56:20 +0000474 self.putcmd("mail", "FROM:%s%s" % (quoteaddr(sender), optionlist))
Guido van Rossum45e2fbc1998-03-26 21:13:24 +0000475 return self.getreply()
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000476
Giampaolo Rodolàbd258bd2011-02-22 15:56:20 +0000477 def rcpt(self, recip, options=[]):
Barry Warsawa7d9bdf1998-12-22 03:24:27 +0000478 """SMTP 'rcpt' command -- indicates 1 recipient for this mail."""
Guido van Rossumfcfb6321998-08-04 15:29:54 +0000479 optionlist = ''
480 if options and self.does_esmtp:
Eric S. Raymondc013f302001-02-09 05:40:38 +0000481 optionlist = ' ' + ' '.join(options)
Giampaolo Rodolàbd258bd2011-02-22 15:56:20 +0000482 self.putcmd("rcpt", "TO:%s%s" % (quoteaddr(recip), optionlist))
Guido van Rossum45e2fbc1998-03-26 21:13:24 +0000483 return self.getreply()
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000484
Giampaolo Rodolàbd258bd2011-02-22 15:56:20 +0000485 def data(self, msg):
Tim Peters495ad3c2001-01-15 01:36:40 +0000486 """SMTP 'DATA' command -- sends message data to server.
Guido van Rossum296e1431999-04-07 15:03:39 +0000487
Barry Warsaw4c4bec81998-12-22 03:02:20 +0000488 Automatically quotes lines beginning with a period per rfc821.
Guido van Rossum296e1431999-04-07 15:03:39 +0000489 Raises SMTPDataError if there is an unexpected reply to the
490 DATA command; the return value from this method is the final
R. David Murray7dff9e02010-11-08 17:15:13 +0000491 response code received when the all data is sent. If msg
492 is a string, lone '\r' and '\n' characters are converted to
493 '\r\n' characters. If msg is bytes, it is transmitted as is.
Barry Warsaw4c4bec81998-12-22 03:02:20 +0000494 """
Guido van Rossum45e2fbc1998-03-26 21:13:24 +0000495 self.putcmd("data")
Giampaolo Rodolàbd258bd2011-02-22 15:56:20 +0000496 (code, repl) = self.getreply()
497 if self.debuglevel > 0:
498 print("data:", (code, repl), file=stderr)
Fred Drake8152d322000-12-12 23:20:45 +0000499 if code != 354:
Giampaolo Rodolàbd258bd2011-02-22 15:56:20 +0000500 raise SMTPDataError(code, repl)
Guido van Rossum45e2fbc1998-03-26 21:13:24 +0000501 else:
R. David Murray7dff9e02010-11-08 17:15:13 +0000502 if isinstance(msg, str):
503 msg = _fix_eols(msg).encode('ascii')
504 q = _quote_periods(msg)
505 if q[-2:] != bCRLF:
506 q = q + bCRLF
507 q = q + b"." + bCRLF
Guido van Rossum20c92281999-04-21 16:52:20 +0000508 self.send(q)
Giampaolo Rodolàbd258bd2011-02-22 15:56:20 +0000509 (code, msg) = self.getreply()
510 if self.debuglevel > 0:
511 print("data:", (code, msg), file=stderr)
512 return (code, msg)
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000513
Guido van Rossumfcfb6321998-08-04 15:29:54 +0000514 def verify(self, address):
Barry Warsawa7d9bdf1998-12-22 03:24:27 +0000515 """SMTP 'verify' command -- checks for address validity."""
Guido van Rossumfcfb6321998-08-04 15:29:54 +0000516 self.putcmd("vrfy", quoteaddr(address))
517 return self.getreply()
Barry Warsaw4c4bec81998-12-22 03:02:20 +0000518 # a.k.a.
Giampaolo Rodolàbd258bd2011-02-22 15:56:20 +0000519 vrfy = verify
Guido van Rossumfcfb6321998-08-04 15:29:54 +0000520
521 def expn(self, address):
Christian Heimes90c3d9b2008-02-23 13:18:03 +0000522 """SMTP 'expn' command -- expands a mailing list."""
Guido van Rossumfcfb6321998-08-04 15:29:54 +0000523 self.putcmd("expn", quoteaddr(address))
524 return self.getreply()
525
Barry Warsaw4c4bec81998-12-22 03:02:20 +0000526 # some useful methods
Guido van Rossumae010462001-09-11 15:57:46 +0000527
Christian Heimes679db4a2008-01-18 09:56:22 +0000528 def ehlo_or_helo_if_needed(self):
529 """Call self.ehlo() and/or self.helo() if needed.
530
531 If there has been no previous EHLO or HELO command this session, this
532 method tries ESMTP EHLO first.
533
534 This method may raise the following exceptions:
535
536 SMTPHeloError The server didn't reply properly to
537 the helo greeting.
538 """
539 if self.helo_resp is None and self.ehlo_resp is None:
540 if not (200 <= self.ehlo()[0] <= 299):
541 (code, resp) = self.helo()
542 if not (200 <= code <= 299):
543 raise SMTPHeloError(code, resp)
544
Guido van Rossumae010462001-09-11 15:57:46 +0000545 def login(self, user, password):
546 """Log in on an SMTP server that requires authentication.
547
548 The arguments are:
549 - user: The user name to authenticate with.
550 - password: The password for the authentication.
551
552 If there has been no previous EHLO or HELO command this session, this
553 method tries ESMTP EHLO first.
554
555 This method will return normally if the authentication was successful.
556
557 This method may raise the following exceptions:
558
559 SMTPHeloError The server didn't reply properly to
560 the helo greeting.
561 SMTPAuthenticationError The server didn't accept the username/
562 password combination.
Fred Drake2f8f4d32001-10-13 18:35:32 +0000563 SMTPException No suitable authentication method was
Guido van Rossumae010462001-09-11 15:57:46 +0000564 found.
565 """
566
567 def encode_cram_md5(challenge, user, password):
Georg Brandl706824f2009-06-04 09:42:55 +0000568 challenge = base64.decodebytes(challenge)
R. David Murrayfb123912009-05-28 18:19:00 +0000569 response = user + " " + hmac.HMAC(password.encode('ascii'),
570 challenge).hexdigest()
571 return encode_base64(response.encode('ascii'), eol='')
Guido van Rossumae010462001-09-11 15:57:46 +0000572
573 def encode_plain(user, password):
R. David Murraycaa27b72009-05-23 18:49:56 +0000574 s = "\0%s\0%s" % (user, password)
575 return encode_base64(s.encode('ascii'), eol='')
Tim Peters469cdad2002-08-08 20:19:19 +0000576
Guido van Rossumae010462001-09-11 15:57:46 +0000577 AUTH_PLAIN = "PLAIN"
578 AUTH_CRAM_MD5 = "CRAM-MD5"
Piers Lauder385a77a2002-07-27 00:38:30 +0000579 AUTH_LOGIN = "LOGIN"
Guido van Rossumae010462001-09-11 15:57:46 +0000580
Christian Heimes679db4a2008-01-18 09:56:22 +0000581 self.ehlo_or_helo_if_needed()
Guido van Rossumae010462001-09-11 15:57:46 +0000582
583 if not self.has_extn("auth"):
584 raise SMTPException("SMTP AUTH extension not supported by server.")
585
Gerhard Häring1c5471f2010-08-05 14:08:44 +0000586 # Authentication methods the server claims to support
587 advertised_authlist = self.esmtp_features["auth"].split()
Guido van Rossumae010462001-09-11 15:57:46 +0000588
589 # List of authentication methods we support: from preferred to
590 # less preferred methods. Except for the purpose of testing the weaker
591 # ones, we prefer stronger methods like CRAM-MD5:
Piers Lauder385a77a2002-07-27 00:38:30 +0000592 preferred_auths = [AUTH_CRAM_MD5, AUTH_PLAIN, AUTH_LOGIN]
Guido van Rossumae010462001-09-11 15:57:46 +0000593
Gerhard Häring1c5471f2010-08-05 14:08:44 +0000594 # We try the authentication methods the server advertises, but only the
595 # ones *we* support. And in our preferred order.
596 authlist = [auth for auth in preferred_auths if auth in advertised_authlist]
597 if not authlist:
Fred Drake2f8f4d32001-10-13 18:35:32 +0000598 raise SMTPException("No suitable authentication method found.")
Gerhard Häring1c5471f2010-08-05 14:08:44 +0000599
600 # Some servers advertise authentication methods they don't really
601 # support, so if authentication fails, we continue until we've tried
602 # all methods.
603 for authmethod in authlist:
604 if authmethod == AUTH_CRAM_MD5:
605 (code, resp) = self.docmd("AUTH", AUTH_CRAM_MD5)
606 if code == 334:
607 (code, resp) = self.docmd(encode_cram_md5(resp, user, password))
608 elif authmethod == AUTH_PLAIN:
609 (code, resp) = self.docmd("AUTH",
610 AUTH_PLAIN + " " + encode_plain(user, password))
611 elif authmethod == AUTH_LOGIN:
612 (code, resp) = self.docmd("AUTH",
613 "%s %s" % (AUTH_LOGIN, encode_base64(user.encode('ascii'), eol='')))
614 if code == 334:
615 (code, resp) = self.docmd(encode_base64(password.encode('ascii'), eol=''))
616
Guido van Rossumae010462001-09-11 15:57:46 +0000617 # 235 == 'Authentication successful'
618 # 503 == 'Error: already authenticated'
Gerhard Häring1c5471f2010-08-05 14:08:44 +0000619 if code in (235, 503):
620 return (code, resp)
621
622 # We could not login sucessfully. Return result of last attempt.
623 raise SMTPAuthenticationError(code, resp)
Guido van Rossumae010462001-09-11 15:57:46 +0000624
Giampaolo Rodolàbd258bd2011-02-22 15:56:20 +0000625 def starttls(self, keyfile=None, certfile=None):
Guido van Rossumf7fcf5e2001-09-14 16:08:44 +0000626 """Puts the connection to the SMTP server into TLS mode.
Tim Petersb64bec32001-09-18 02:26:39 +0000627
Christian Heimes679db4a2008-01-18 09:56:22 +0000628 If there has been no previous EHLO or HELO command this session, this
629 method tries ESMTP EHLO first.
630
Guido van Rossumf7fcf5e2001-09-14 16:08:44 +0000631 If the server supports TLS, this will encrypt the rest of the SMTP
632 session. If you provide the keyfile and certfile parameters,
633 the identity of the SMTP server and client can be checked. This,
634 however, depends on whether the socket module really checks the
635 certificates.
Christian Heimes679db4a2008-01-18 09:56:22 +0000636
637 This method may raise the following exceptions:
638
639 SMTPHeloError The server didn't reply properly to
640 the helo greeting.
Guido van Rossumf7fcf5e2001-09-14 16:08:44 +0000641 """
Christian Heimes679db4a2008-01-18 09:56:22 +0000642 self.ehlo_or_helo_if_needed()
643 if not self.has_extn("starttls"):
644 raise SMTPException("STARTTLS extension not supported by server.")
Tim Petersb64bec32001-09-18 02:26:39 +0000645 (resp, reply) = self.docmd("STARTTLS")
Guido van Rossumf7fcf5e2001-09-14 16:08:44 +0000646 if resp == 220:
Thomas Wouters47b49bf2007-08-30 22:15:33 +0000647 if not _have_ssl:
648 raise RuntimeError("No SSL support included in this Python")
Thomas Wouters1b7f8912007-09-19 03:06:30 +0000649 self.sock = ssl.wrap_socket(self.sock, keyfile, certfile)
Thomas Wouters47b49bf2007-08-30 22:15:33 +0000650 self.file = SSLFakeFile(self.sock)
Christian Heimes679db4a2008-01-18 09:56:22 +0000651 # RFC 3207:
652 # The client MUST discard any knowledge obtained from
653 # the server, such as the list of SMTP service extensions,
654 # which was not obtained from the TLS negotiation itself.
655 self.helo_resp = None
656 self.ehlo_resp = None
657 self.esmtp_features = {}
658 self.does_esmtp = 0
Guido van Rossumf7fcf5e2001-09-14 16:08:44 +0000659 return (resp, reply)
Tim Petersb64bec32001-09-18 02:26:39 +0000660
Jeremy Hylton31bb8ce1998-08-13 19:57:46 +0000661 def sendmail(self, from_addr, to_addrs, msg, mail_options=[],
Tim Peters495ad3c2001-01-15 01:36:40 +0000662 rcpt_options=[]):
663 """This command performs an entire mail transaction.
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000664
Tim Peters495ad3c2001-01-15 01:36:40 +0000665 The arguments are:
Barry Warsaw4c4bec81998-12-22 03:02:20 +0000666 - from_addr : The address sending this mail.
667 - to_addrs : A list of addresses to send this mail to. A bare
668 string will be treated as a list with 1 address.
Tim Peters495ad3c2001-01-15 01:36:40 +0000669 - msg : The message to send.
Barry Warsaw4c4bec81998-12-22 03:02:20 +0000670 - mail_options : List of ESMTP options (such as 8bitmime) for the
671 mail command.
672 - rcpt_options : List of ESMTP options (such as DSN commands) for
673 all the rcpt commands.
674
R. David Murray7dff9e02010-11-08 17:15:13 +0000675 msg may be a string containing characters in the ASCII range, or a byte
676 string. A string is encoded to bytes using the ascii codec, and lone
677 \r and \n characters are converted to \r\n characters.
678
Barry Warsaw4c4bec81998-12-22 03:02:20 +0000679 If there has been no previous EHLO or HELO command this session, this
680 method tries ESMTP EHLO first. If the server does ESMTP, message size
681 and each of the specified options will be passed to it. If EHLO
682 fails, HELO will be tried and ESMTP options suppressed.
683
684 This method will return normally if the mail is accepted for at least
Barry Warsawd25c1b71999-11-28 17:11:06 +0000685 one recipient. It returns a dictionary, with one entry for each
686 recipient that was refused. Each entry contains a tuple of the SMTP
687 error code and the accompanying error message sent by the server.
Guido van Rossum296e1431999-04-07 15:03:39 +0000688
689 This method may raise the following exceptions:
690
691 SMTPHeloError The server didn't reply properly to
Tim Peters495ad3c2001-01-15 01:36:40 +0000692 the helo greeting.
Barry Warsawd25c1b71999-11-28 17:11:06 +0000693 SMTPRecipientsRefused The server rejected ALL recipients
Guido van Rossum296e1431999-04-07 15:03:39 +0000694 (no mail was sent).
695 SMTPSenderRefused The server didn't accept the from_addr.
696 SMTPDataError The server replied with an unexpected
697 error code (other than a refusal of
698 a recipient).
699
700 Note: the connection will be open even after an exception is raised.
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000701
Guido van Rossum95e6f701998-06-25 02:15:50 +0000702 Example:
Tim Peters495ad3c2001-01-15 01:36:40 +0000703
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000704 >>> import smtplib
705 >>> s=smtplib.SMTP("localhost")
Guido van Rossumfc40a831998-01-29 17:26:45 +0000706 >>> tolist=["one@one.org","two@two.org","three@three.org","four@four.org"]
Martin v. Löwis301b1cd2002-07-28 16:52:01 +0000707 >>> msg = '''\\
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000708 ... From: Me@my.org
709 ... Subject: testin'...
710 ...
711 ... This is a test '''
712 >>> s.sendmail("me@my.org",tolist,msg)
713 { "three@three.org" : ( 550 ,"User unknown" ) }
714 >>> s.quit()
Tim Peters495ad3c2001-01-15 01:36:40 +0000715
Barry Warsaw4c4bec81998-12-22 03:02:20 +0000716 In the above example, the message was accepted for delivery to three
717 of the four addresses, and one was rejected, with the error code
Barry Warsawd25c1b71999-11-28 17:11:06 +0000718 550. If all addresses are accepted, then the method will return an
Barry Warsaw4c4bec81998-12-22 03:02:20 +0000719 empty dictionary.
720
721 """
Christian Heimes679db4a2008-01-18 09:56:22 +0000722 self.ehlo_or_helo_if_needed()
Guido van Rossum95e6f701998-06-25 02:15:50 +0000723 esmtp_opts = []
R. David Murray7dff9e02010-11-08 17:15:13 +0000724 if isinstance(msg, str):
725 msg = _fix_eols(msg).encode('ascii')
Guido van Rossumfcfb6321998-08-04 15:29:54 +0000726 if self.does_esmtp:
727 # Hmmm? what's this? -ddm
728 # self.esmtp_features['7bit']=""
729 if self.has_extn('size'):
Walter Dörwald70a6b492004-02-12 17:35:32 +0000730 esmtp_opts.append("size=%d" % len(msg))
Guido van Rossumfcfb6321998-08-04 15:29:54 +0000731 for option in mail_options:
Guido van Rossum95e6f701998-06-25 02:15:50 +0000732 esmtp_opts.append(option)
Giampaolo Rodolàbd258bd2011-02-22 15:56:20 +0000733 (code, resp) = self.mail(from_addr, esmtp_opts)
Fred Drake8152d322000-12-12 23:20:45 +0000734 if code != 250:
Guido van Rossum45e2fbc1998-03-26 21:13:24 +0000735 self.rset()
Guido van Rossum296e1431999-04-07 15:03:39 +0000736 raise SMTPSenderRefused(code, resp, from_addr)
Giampaolo Rodolàbd258bd2011-02-22 15:56:20 +0000737 senderrs = {}
Guido van Rossum3172c5d2007-10-16 18:12:55 +0000738 if isinstance(to_addrs, str):
Jeremy Hylton31bb8ce1998-08-13 19:57:46 +0000739 to_addrs = [to_addrs]
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000740 for each in to_addrs:
Giampaolo Rodolàbd258bd2011-02-22 15:56:20 +0000741 (code, resp) = self.rcpt(each, rcpt_options)
Fred Drake8152d322000-12-12 23:20:45 +0000742 if (code != 250) and (code != 251):
Giampaolo Rodolàbd258bd2011-02-22 15:56:20 +0000743 senderrs[each] = (code, resp)
744 if len(senderrs) == len(to_addrs):
Guido van Rossum95e6f701998-06-25 02:15:50 +0000745 # the server refused all our recipients
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000746 self.rset()
Guido van Rossum296e1431999-04-07 15:03:39 +0000747 raise SMTPRecipientsRefused(senderrs)
Giampaolo Rodolàbd258bd2011-02-22 15:56:20 +0000748 (code, resp) = self.data(msg)
Fred Drake8152d322000-12-12 23:20:45 +0000749 if code != 250:
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000750 self.rset()
Guido van Rossum296e1431999-04-07 15:03:39 +0000751 raise SMTPDataError(code, resp)
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000752 #if we got here then somebody got our mail
Tim Peters495ad3c2001-01-15 01:36:40 +0000753 return senderrs
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000754
R. David Murray7dff9e02010-11-08 17:15:13 +0000755 def send_message(self, msg, from_addr=None, to_addrs=None,
756 mail_options=[], rcpt_options={}):
757 """Converts message to a bytestring and passes it to sendmail.
758
759 The arguments are as for sendmail, except that msg is an
760 email.message.Message object. If from_addr is None, the from_addr is
761 taken from the 'From' header of the Message. If to_addrs is None, its
762 value is composed from the addresses listed in the 'To', 'CC', and
763 'Bcc' fields. Regardless of the values of from_addr and to_addr, any
764 Bcc field in the Message object is deleted. The Message object is then
765 serialized using email.generator.BytesGenerator and sendmail is called
766 to transmit the message.
767 """
768 if from_addr is None:
769 from_addr = msg['From']
770 if to_addrs is None:
771 addr_fields = [f for f in (msg['To'], msg['Bcc'], msg['CC'])
772 if f is not None]
773 to_addrs = [a[1] for a in email.utils.getaddresses(addr_fields)]
774 del msg['Bcc']
775 with io.BytesIO() as bytesmsg:
776 g = email.generator.BytesGenerator(bytesmsg)
777 g.flatten(msg, linesep='\r\n')
778 flatmsg = bytesmsg.getvalue()
779 return self.sendmail(from_addr, to_addrs, flatmsg, mail_options,
780 rcpt_options)
781
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000782 def close(self):
783 """Close the connection to the SMTP server."""
784 if self.file:
785 self.file.close()
786 self.file = None
787 if self.sock:
788 self.sock.close()
789 self.sock = None
790
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000791 def quit(self):
Guido van Rossum95e6f701998-06-25 02:15:50 +0000792 """Terminate the SMTP session."""
Christian Heimesba4af492008-03-28 00:55:15 +0000793 res = self.docmd("quit")
Guido van Rossum45e2fbc1998-03-26 21:13:24 +0000794 self.close()
Christian Heimesba4af492008-03-28 00:55:15 +0000795 return res
Guido van Rossum95e6f701998-06-25 02:15:50 +0000796
Thomas Wouters47b49bf2007-08-30 22:15:33 +0000797if _have_ssl:
Thomas Wouters89f507f2006-12-13 04:49:30 +0000798
Thomas Wouters47b49bf2007-08-30 22:15:33 +0000799 class SMTP_SSL(SMTP):
800 """ This is a subclass derived from SMTP that connects over an SSL encrypted
801 socket (to use this class you need a socket module that was compiled with SSL
802 support). If host is not specified, '' (the local host) is used. If port is
803 omitted, the standard SMTP-over-SSL port (465) is used. keyfile and certfile
804 are also optional - they can contain a PEM formatted private key and
805 certificate chain file for the SSL connection.
806 """
807 def __init__(self, host='', port=0, local_hostname=None,
Georg Brandlf78e02b2008-06-10 17:40:04 +0000808 keyfile=None, certfile=None,
809 timeout=socket._GLOBAL_DEFAULT_TIMEOUT):
Thomas Wouters47b49bf2007-08-30 22:15:33 +0000810 self.keyfile = keyfile
811 self.certfile = certfile
812 SMTP.__init__(self, host, port, local_hostname, timeout)
813 self.default_port = SMTP_SSL_PORT
814
815 def _get_socket(self, host, port, timeout):
Giampaolo Rodolàbd258bd2011-02-22 15:56:20 +0000816 if self.debuglevel > 0:
817 print('connect:', (host, port), file=stderr)
R. David Murray87e20742009-05-23 01:30:26 +0000818 new_socket = socket.create_connection((host, port), timeout)
819 new_socket = ssl.wrap_socket(new_socket, self.keyfile, self.certfile)
820 self.file = SSLFakeFile(new_socket)
821 return new_socket
Thomas Wouters47b49bf2007-08-30 22:15:33 +0000822
823 __all__.append("SMTP_SSL")
Barry Warsaw4c4bec81998-12-22 03:02:20 +0000824
Guido van Rossumd8faa362007-04-27 19:54:29 +0000825#
826# LMTP extension
827#
828LMTP_PORT = 2003
829
830class LMTP(SMTP):
831 """LMTP - Local Mail Transfer Protocol
832
833 The LMTP protocol, which is very similar to ESMTP, is heavily based
834 on the standard SMTP client. It's common to use Unix sockets for LMTP,
835 so our connect() method must support that as well as a regular
836 host:port server. To specify a Unix socket, you must use an absolute
837 path as the host, starting with a '/'.
838
839 Authentication is supported, using the regular SMTP mechanism. When
840 using a Unix socket, LMTP generally don't support or require any
841 authentication, but your mileage might vary."""
842
843 ehlo_msg = "lhlo"
844
Giampaolo Rodolàbd258bd2011-02-22 15:56:20 +0000845 def __init__(self, host='', port=LMTP_PORT, local_hostname=None):
Guido van Rossumd8faa362007-04-27 19:54:29 +0000846 """Initialize a new instance."""
847 SMTP.__init__(self, host, port, local_hostname)
848
Giampaolo Rodolàbd258bd2011-02-22 15:56:20 +0000849 def connect(self, host='localhost', port=0):
Guido van Rossumd8faa362007-04-27 19:54:29 +0000850 """Connect to the LMTP daemon, on either a Unix or a TCP socket."""
851 if host[0] != '/':
852 return SMTP.connect(self, host, port)
853
854 # Handle Unix-domain sockets.
855 try:
856 self.sock = socket.socket(socket.AF_UNIX, socket.SOCK_STREAM)
857 self.sock.connect(host)
858 except socket.error as msg:
Giampaolo Rodolàbd258bd2011-02-22 15:56:20 +0000859 if self.debuglevel > 0:
860 print('connect fail:', host, file=stderr)
Guido van Rossumd8faa362007-04-27 19:54:29 +0000861 if self.sock:
862 self.sock.close()
863 self.sock = None
864 raise socket.error(msg)
865 (code, msg) = self.getreply()
Giampaolo Rodolàbd258bd2011-02-22 15:56:20 +0000866 if self.debuglevel > 0:
867 print('connect:', msg, file=stderr)
Guido van Rossumd8faa362007-04-27 19:54:29 +0000868 return (code, msg)
869
870
Guido van Rossum95e6f701998-06-25 02:15:50 +0000871# Test the sendmail method, which tests most of the others.
872# Note: This always sends to localhost.
873if __name__ == '__main__':
Andrew M. Kuchling6be424f2001-08-13 14:41:39 +0000874 import sys
Guido van Rossum95e6f701998-06-25 02:15:50 +0000875
876 def prompt(prompt):
877 sys.stdout.write(prompt + ": ")
Eric S. Raymondc013f302001-02-09 05:40:38 +0000878 return sys.stdin.readline().strip()
Guido van Rossum95e6f701998-06-25 02:15:50 +0000879
880 fromaddr = prompt("From")
Giampaolo Rodolàbd258bd2011-02-22 15:56:20 +0000881 toaddrs = prompt("To").split(',')
Guido van Rossumbe19ed72007-02-09 05:37:30 +0000882 print("Enter message, end with ^D:")
Guido van Rossum95e6f701998-06-25 02:15:50 +0000883 msg = ''
884 while 1:
885 line = sys.stdin.readline()
886 if not line:
887 break
888 msg = msg + line
Guido van Rossumbe19ed72007-02-09 05:37:30 +0000889 print("Message length is %d" % len(msg))
Guido van Rossum95e6f701998-06-25 02:15:50 +0000890
891 server = SMTP('localhost')
892 server.set_debuglevel(1)
893 server.sendmail(fromaddr, toaddrs, msg)
894 server.quit()