blob: 20395927190155c30aac50c35839eb1495e992c2 [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
R David Murrayac4e5ab2011-07-02 21:03:19 -040052import copy
Barry Warsaw2cc1f6d2007-08-30 14:28:55 +000053from email.base64mime import body_encode as encode_base64
Brett Cannone6f8a892004-07-10 23:14:30 +000054from sys import stderr
Guido van Rossumbbe323e1998-01-29 17:24:40 +000055
Giampaolo Rodolàbd258bd2011-02-22 15:56:20 +000056__all__ = ["SMTPException", "SMTPServerDisconnected", "SMTPResponseException",
57 "SMTPSenderRefused", "SMTPRecipientsRefused", "SMTPDataError",
58 "SMTPConnectError", "SMTPHeloError", "SMTPAuthenticationError",
59 "quoteaddr", "quotedata", "SMTP"]
Skip Montanaro0de65802001-02-15 22:15:14 +000060
Guido van Rossumbbe323e1998-01-29 17:24:40 +000061SMTP_PORT = 25
Thomas Wouters89f507f2006-12-13 04:49:30 +000062SMTP_SSL_PORT = 465
Giampaolo Rodolàbd258bd2011-02-22 15:56:20 +000063CRLF = "\r\n"
64bCRLF = b"\r\n"
Guido van Rossumbbe323e1998-01-29 17:24:40 +000065
Piers Lauder385a77a2002-07-27 00:38:30 +000066OLDSTYLE_AUTH = re.compile(r"auth=(.*)", re.I)
67
Tim Peters495ad3c2001-01-15 01:36:40 +000068# Exception classes used by this module.
Guido van Rossum296e1431999-04-07 15:03:39 +000069class SMTPException(Exception):
70 """Base class for all exceptions raised by this module."""
71
72class SMTPServerDisconnected(SMTPException):
73 """Not connected to any SMTP server.
74
75 This exception is raised when the server unexpectedly disconnects,
76 or when an attempt is made to use the SMTP instance before
77 connecting it to a server.
78 """
79
80class SMTPResponseException(SMTPException):
81 """Base class for all exceptions that include an SMTP error code.
82
83 These exceptions are generated in some instances when the SMTP
84 server returns an error code. The error code is stored in the
85 `smtp_code' attribute of the error, and the `smtp_error' attribute
86 is set to the error message.
87 """
88
89 def __init__(self, code, msg):
90 self.smtp_code = code
91 self.smtp_error = msg
92 self.args = (code, msg)
93
94class SMTPSenderRefused(SMTPResponseException):
95 """Sender address refused.
Guido van Rossumae010462001-09-11 15:57:46 +000096
Guido van Rossum296e1431999-04-07 15:03:39 +000097 In addition to the attributes set by on all SMTPResponseException
Barry Warsawd25c1b71999-11-28 17:11:06 +000098 exceptions, this sets `sender' to the string that the SMTP refused.
Guido van Rossum296e1431999-04-07 15:03:39 +000099 """
100
101 def __init__(self, code, msg, sender):
102 self.smtp_code = code
103 self.smtp_error = msg
104 self.sender = sender
105 self.args = (code, msg, sender)
106
Guido van Rossum20c92281999-04-21 16:52:20 +0000107class SMTPRecipientsRefused(SMTPException):
Barry Warsawd25c1b71999-11-28 17:11:06 +0000108 """All recipient addresses refused.
Guido van Rossumae010462001-09-11 15:57:46 +0000109
Thomas Wouters7e474022000-07-16 12:04:32 +0000110 The errors for each recipient are accessible through the attribute
Tim Peters495ad3c2001-01-15 01:36:40 +0000111 'recipients', which is a dictionary of exactly the same sort as
112 SMTP.sendmail() returns.
Guido van Rossum296e1431999-04-07 15:03:39 +0000113 """
114
115 def __init__(self, recipients):
116 self.recipients = recipients
Giampaolo Rodolàbd258bd2011-02-22 15:56:20 +0000117 self.args = (recipients,)
Guido van Rossum296e1431999-04-07 15:03:39 +0000118
119
Guido van Rossum296e1431999-04-07 15:03:39 +0000120class SMTPDataError(SMTPResponseException):
121 """The SMTP server didn't accept the data."""
122
123class SMTPConnectError(SMTPResponseException):
Barry Warsawd25c1b71999-11-28 17:11:06 +0000124 """Error during connection establishment."""
Guido van Rossum296e1431999-04-07 15:03:39 +0000125
126class SMTPHeloError(SMTPResponseException):
Barry Warsawd25c1b71999-11-28 17:11:06 +0000127 """The server refused our HELO reply."""
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000128
Guido van Rossumae010462001-09-11 15:57:46 +0000129class SMTPAuthenticationError(SMTPResponseException):
130 """Authentication error.
131
132 Most probably the server didn't accept the username/password
133 combination provided.
134 """
Peter Schneider-Kamp7bc82bb2000-08-10 14:02:23 +0000135
R David Murray4c14bba2011-07-18 21:59:53 -0400136def quoteaddr(addrstring):
Guido van Rossum69a79bc1998-07-13 15:18:49 +0000137 """Quote a subset of the email addresses defined by RFC 821.
138
Georg Brandl9f0f9602008-06-12 22:23:59 +0000139 Should be able to handle anything email.utils.parseaddr can handle.
Barry Warsawa7d9bdf1998-12-22 03:24:27 +0000140 """
R David Murray4c14bba2011-07-18 21:59:53 -0400141 displayname, addr = email.utils.parseaddr(addrstring)
142 if (displayname, addr) == ('', ''):
143 # parseaddr couldn't parse it, use it as is and hope for the best.
144 if addrstring.strip().startswith('<'):
145 return addrstring
146 return "<%s>" % addrstring
147 return "<%s>" % addr
Guido van Rossum69a79bc1998-07-13 15:18:49 +0000148
R David Murray46346762011-07-18 21:38:54 -0400149def _addr_only(addrstring):
150 displayname, addr = email.utils.parseaddr(addrstring)
151 if (displayname, addr) == ('', ''):
152 # parseaddr couldn't parse it, so use it as is.
153 return addrstring
154 return addr
155
R. David Murray7dff9e02010-11-08 17:15:13 +0000156# Legacy method kept for backward compatibility.
Guido van Rossum69a79bc1998-07-13 15:18:49 +0000157def quotedata(data):
158 """Quote data for email.
159
Barry Warsawd25c1b71999-11-28 17:11:06 +0000160 Double leading '.', and change Unix newline '\\n', or Mac '\\r' into
Barry Warsawa7d9bdf1998-12-22 03:24:27 +0000161 Internet CRLF end-of-line.
162 """
Guido van Rossum69a79bc1998-07-13 15:18:49 +0000163 return re.sub(r'(?m)^\.', '..',
Guido van Rossumfcfb6321998-08-04 15:29:54 +0000164 re.sub(r'(?:\r\n|\n|\r(?!\n))', CRLF, data))
Guido van Rossum69a79bc1998-07-13 15:18:49 +0000165
R. David Murray7dff9e02010-11-08 17:15:13 +0000166def _quote_periods(bindata):
R David Murray0f663d02011-06-09 15:05:57 -0400167 return re.sub(br'(?m)^\.', b'..', bindata)
R. David Murray7dff9e02010-11-08 17:15:13 +0000168
169def _fix_eols(data):
170 return re.sub(r'(?:\r\n|\n|\r(?!\n))', CRLF, data)
171
Thomas Wouters47b49bf2007-08-30 22:15:33 +0000172try:
173 import ssl
174except ImportError:
175 _have_ssl = False
176else:
Thomas Wouters47b49bf2007-08-30 22:15:33 +0000177 _have_ssl = True
178
Peter Schneider-Kamp7bc82bb2000-08-10 14:02:23 +0000179
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000180class SMTP:
Guido van Rossumfcfb6321998-08-04 15:29:54 +0000181 """This class manages a connection to an SMTP or ESMTP server.
182 SMTP Objects:
Tim Peters495ad3c2001-01-15 01:36:40 +0000183 SMTP objects have the following attributes:
184 helo_resp
185 This is the message given by the server in response to the
Guido van Rossumfcfb6321998-08-04 15:29:54 +0000186 most recent HELO command.
Tim Peters495ad3c2001-01-15 01:36:40 +0000187
Guido van Rossumfcfb6321998-08-04 15:29:54 +0000188 ehlo_resp
Tim Peters495ad3c2001-01-15 01:36:40 +0000189 This is the message given by the server in response to the
Guido van Rossumfcfb6321998-08-04 15:29:54 +0000190 most recent EHLO command. This is usually multiline.
191
Tim Peters495ad3c2001-01-15 01:36:40 +0000192 does_esmtp
Guido van Rossumfcfb6321998-08-04 15:29:54 +0000193 This is a True value _after you do an EHLO command_, if the
194 server supports ESMTP.
195
Tim Peters495ad3c2001-01-15 01:36:40 +0000196 esmtp_features
Guido van Rossumfcfb6321998-08-04 15:29:54 +0000197 This is a dictionary, which, if the server supports ESMTP,
Barry Warsawd25c1b71999-11-28 17:11:06 +0000198 will _after you do an EHLO command_, contain the names of the
199 SMTP service extensions this server supports, and their
Guido van Rossumfcfb6321998-08-04 15:29:54 +0000200 parameters (if any).
Barry Warsawd25c1b71999-11-28 17:11:06 +0000201
Tim Peters495ad3c2001-01-15 01:36:40 +0000202 Note, all extension names are mapped to lower case in the
203 dictionary.
Guido van Rossumfcfb6321998-08-04 15:29:54 +0000204
Barry Warsawd25c1b71999-11-28 17:11:06 +0000205 See each method's docstrings for details. In general, there is a
206 method of the same name to perform each SMTP command. There is also a
207 method called 'sendmail' that will do an entire mail transaction.
208 """
Guido van Rossum95e6f701998-06-25 02:15:50 +0000209 debuglevel = 0
210 file = None
211 helo_resp = None
Guido van Rossumd8faa362007-04-27 19:54:29 +0000212 ehlo_msg = "ehlo"
Guido van Rossum95e6f701998-06-25 02:15:50 +0000213 ehlo_resp = None
Guido van Rossumfcfb6321998-08-04 15:29:54 +0000214 does_esmtp = 0
Antoine Pitrouc1d52062011-05-07 19:39:37 +0200215 default_port = SMTP_PORT
Guido van Rossum95e6f701998-06-25 02:15:50 +0000216
Georg Brandlf78e02b2008-06-10 17:40:04 +0000217 def __init__(self, host='', port=0, local_hostname=None,
Senthil Kumaran3d23fd62011-07-30 10:56:50 +0800218 timeout=socket._GLOBAL_DEFAULT_TIMEOUT,
219 source_address=None):
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000220 """Initialize a new instance.
221
Barry Warsawa7d9bdf1998-12-22 03:24:27 +0000222 If specified, `host' is the name of the remote host to which to
223 connect. If specified, `port' specifies the port to which to connect.
Barry Warsawd25c1b71999-11-28 17:11:06 +0000224 By default, smtplib.SMTP_PORT is used. An SMTPConnectError is raised
Neil Schemenauer6730f262002-03-24 15:30:40 +0000225 if the specified `host' doesn't respond correctly. If specified,
Tim Peters863ac442002-04-16 01:38:40 +0000226 `local_hostname` is used as the FQDN of the local host. By default,
Senthil Kumaran3d23fd62011-07-30 10:56:50 +0800227 the local hostname is found using socket.getfqdn(). The
228 `source_address` parameter takes a 2-tuple (host, port) for the socket
229 to bind to as its source address before connecting. If the host is ''
230 and port is 0, the OS default behavior will be used.
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000231
232 """
Guido van Rossumd8faa362007-04-27 19:54:29 +0000233 self.timeout = timeout
Guido van Rossumfcfb6321998-08-04 15:29:54 +0000234 self.esmtp_features = {}
Senthil Kumaran3d23fd62011-07-30 10:56:50 +0800235 self.source_address = source_address
236
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
Barry Warsaw1f5c9582011-03-15 15:04:44 -0400259 def __enter__(self):
260 return self
261
262 def __exit__(self, *args):
263 try:
264 code, message = self.docmd("QUIT")
265 if code != 221:
266 raise SMTPResponseException(code, message)
267 except SMTPServerDisconnected:
268 pass
269 finally:
270 self.close()
271
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:
Senthil Kumaran3d23fd62011-07-30 10:56:50 +0800285 print('connect: to', (host, port), self.source_address, file=stderr)
286 return socket.create_connection((host, port), timeout,
287 self.source_address)
Thomas Wouters89f507f2006-12-13 04:49:30 +0000288
Senthil Kumaran3d23fd62011-07-30 10:56:50 +0800289 def connect(self, host='localhost', port=0, source_address=None):
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000290 """Connect to a host on a given port.
Guido van Rossum95e6f701998-06-25 02:15:50 +0000291
Barry Warsaw4c4bec81998-12-22 03:02:20 +0000292 If the hostname ends with a colon (`:') followed by a number, and
293 there is no port specified, that suffix will be stripped off and the
294 number interpreted as the port number to use.
Guido van Rossum95e6f701998-06-25 02:15:50 +0000295
Barry Warsawa7d9bdf1998-12-22 03:24:27 +0000296 Note: This method is automatically invoked by __init__, if a host is
297 specified during instantiation.
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000298
299 """
Senthil Kumaran3d23fd62011-07-30 10:56:50 +0800300 if source_address: self.source_address = source_address
Martin v. Löwis4eb59402001-07-26 13:37:33 +0000301 if not port and (host.find(':') == host.rfind(':')):
Martin v. Löwisa43c2f82001-07-24 20:34:08 +0000302 i = host.rfind(':')
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000303 if i >= 0:
Giampaolo Rodolàbd258bd2011-02-22 15:56:20 +0000304 host, port = host[:i], host[i + 1:]
305 try:
306 port = int(port)
Eric S. Raymond8d876032001-02-09 10:14:53 +0000307 except ValueError:
Guido van Rossumd8faa362007-04-27 19:54:29 +0000308 raise socket.error("nonnumeric port")
Giampaolo Rodolàbd258bd2011-02-22 15:56:20 +0000309 if not port:
310 port = self.default_port
311 if self.debuglevel > 0:
312 print('connect:', (host, port), file=stderr)
Guido van Rossumd8faa362007-04-27 19:54:29 +0000313 self.sock = self._get_socket(host, port, self.timeout)
Antoine Pitrouf068ab82011-06-06 19:17:09 +0200314 self.file = None
Martin v. Löwisa43c2f82001-07-24 20:34:08 +0000315 (code, msg) = self.getreply()
Giampaolo Rodolàbd258bd2011-02-22 15:56:20 +0000316 if self.debuglevel > 0:
317 print("connect:", msg, file=stderr)
Martin v. Löwisa43c2f82001-07-24 20:34:08 +0000318 return (code, msg)
Tim Peters495ad3c2001-01-15 01:36:40 +0000319
Guido van Rossum8a392d72007-11-21 22:09:45 +0000320 def send(self, s):
321 """Send `s' to the server."""
Giampaolo Rodolàbd258bd2011-02-22 15:56:20 +0000322 if self.debuglevel > 0:
323 print('send:', repr(s), file=stderr)
Christian Heimes90c3d9b2008-02-23 13:18:03 +0000324 if hasattr(self, 'sock') and self.sock:
Guido van Rossum8a392d72007-11-21 22:09:45 +0000325 if isinstance(s, str):
326 s = s.encode("ascii")
Guido van Rossum2880f6e1998-08-10 20:07:00 +0000327 try:
Guido van Rossum8a392d72007-11-21 22:09:45 +0000328 self.sock.sendall(s)
Guido van Rossum2880f6e1998-08-10 20:07:00 +0000329 except socket.error:
Barry Warsaw76750972001-12-14 20:34:20 +0000330 self.close()
Guido van Rossum40233ea1999-01-15 03:23:55 +0000331 raise SMTPServerDisconnected('Server not connected')
Guido van Rossumfc40a831998-01-29 17:26:45 +0000332 else:
Guido van Rossum40233ea1999-01-15 03:23:55 +0000333 raise SMTPServerDisconnected('please run connect() first')
Tim Peters495ad3c2001-01-15 01:36:40 +0000334
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000335 def putcmd(self, cmd, args=""):
Barry Warsawa7d9bdf1998-12-22 03:24:27 +0000336 """Send a command to the server."""
Guido van Rossumdb23d3d1999-06-09 15:13:10 +0000337 if args == "":
338 str = '%s%s' % (cmd, CRLF)
339 else:
340 str = '%s %s%s' % (cmd, args, CRLF)
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000341 self.send(str)
Tim Peters495ad3c2001-01-15 01:36:40 +0000342
Guido van Rossumfcfb6321998-08-04 15:29:54 +0000343 def getreply(self):
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000344 """Get a reply from the server.
Tim Peters495ad3c2001-01-15 01:36:40 +0000345
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000346 Returns a tuple consisting of:
Barry Warsawa7d9bdf1998-12-22 03:24:27 +0000347
348 - server response code (e.g. '250', or such, if all goes well)
349 Note: returns -1 if it can't read response code.
350
351 - server response string corresponding to response code (multiline
352 responses are converted to a single, multiline string).
Guido van Rossumf123f841999-03-29 20:33:21 +0000353
354 Raises SMTPServerDisconnected if end-of-file is reached.
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000355 """
Giampaolo Rodolàbd258bd2011-02-22 15:56:20 +0000356 resp = []
Guido van Rossum296e1431999-04-07 15:03:39 +0000357 if self.file is None:
358 self.file = self.sock.makefile('rb')
Guido van Rossum45e2fbc1998-03-26 21:13:24 +0000359 while 1:
Benjamin Petersone1cdfd72009-01-18 21:02:37 +0000360 try:
361 line = self.file.readline()
362 except socket.error:
363 line = ''
Guido van Rossum806c2462007-08-06 23:33:07 +0000364 if not line:
Guido van Rossum296e1431999-04-07 15:03:39 +0000365 self.close()
366 raise SMTPServerDisconnected("Connection unexpectedly closed")
Giampaolo Rodolàbd258bd2011-02-22 15:56:20 +0000367 if self.debuglevel > 0:
368 print('reply:', repr(line), file=stderr)
Guido van Rossum806c2462007-08-06 23:33:07 +0000369 resp.append(line[4:].strip(b' \t\r\n'))
Giampaolo Rodolàbd258bd2011-02-22 15:56:20 +0000370 code = line[:3]
Guido van Rossum296e1431999-04-07 15:03:39 +0000371 # Check that the error code is syntactically correct.
372 # Don't attempt to read a continuation line if it is broken.
373 try:
Eric S. Raymondc013f302001-02-09 05:40:38 +0000374 errcode = int(code)
Guido van Rossum296e1431999-04-07 15:03:39 +0000375 except ValueError:
376 errcode = -1
377 break
Guido van Rossumf123f841999-03-29 20:33:21 +0000378 # Check if multiline response.
Guido van Rossum806c2462007-08-06 23:33:07 +0000379 if line[3:4] != b"-":
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000380 break
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000381
Guido van Rossumc43e79f2007-06-18 18:26:36 +0000382 errmsg = b"\n".join(resp)
Tim Peters495ad3c2001-01-15 01:36:40 +0000383 if self.debuglevel > 0:
Giampaolo Rodolàbd258bd2011-02-22 15:56:20 +0000384 print('reply: retcode (%s); Msg: %s' % (errcode, errmsg), file=stderr)
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000385 return errcode, errmsg
Tim Peters495ad3c2001-01-15 01:36:40 +0000386
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000387 def docmd(self, cmd, args=""):
Barry Warsawa7d9bdf1998-12-22 03:24:27 +0000388 """Send a command, and return its response code."""
Giampaolo Rodolàbd258bd2011-02-22 15:56:20 +0000389 self.putcmd(cmd, args)
Guido van Rossum296e1431999-04-07 15:03:39 +0000390 return self.getreply()
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000391
Barry Warsawa7d9bdf1998-12-22 03:24:27 +0000392 # std smtp commands
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000393 def helo(self, name=''):
Barry Warsawa7d9bdf1998-12-22 03:24:27 +0000394 """SMTP 'helo' command.
395 Hostname to send for this command defaults to the FQDN of the local
396 host.
397 """
Neil Schemenauer6730f262002-03-24 15:30:40 +0000398 self.putcmd("helo", name or self.local_hostname)
Giampaolo Rodolàbd258bd2011-02-22 15:56:20 +0000399 (code, msg) = self.getreply()
400 self.helo_resp = msg
401 return (code, msg)
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000402
Guido van Rossum95e6f701998-06-25 02:15:50 +0000403 def ehlo(self, name=''):
Barry Warsawa7d9bdf1998-12-22 03:24:27 +0000404 """ SMTP 'ehlo' command.
405 Hostname to send for this command defaults to the FQDN of the local
406 host.
407 """
Guido van Rossumf7fcf5e2001-09-14 16:08:44 +0000408 self.esmtp_features = {}
Guido van Rossumd8faa362007-04-27 19:54:29 +0000409 self.putcmd(self.ehlo_msg, name or self.local_hostname)
Giampaolo Rodolàbd258bd2011-02-22 15:56:20 +0000410 (code, msg) = self.getreply()
Tim Peters495ad3c2001-01-15 01:36:40 +0000411 # According to RFC1869 some (badly written)
412 # MTA's will disconnect on an ehlo. Toss an exception if
Guido van Rossumfcfb6321998-08-04 15:29:54 +0000413 # that happens -ddm
414 if code == -1 and len(msg) == 0:
Barry Warsaw76750972001-12-14 20:34:20 +0000415 self.close()
Guido van Rossum40233ea1999-01-15 03:23:55 +0000416 raise SMTPServerDisconnected("Server not connected")
Giampaolo Rodolàbd258bd2011-02-22 15:56:20 +0000417 self.ehlo_resp = msg
Fred Drake8152d322000-12-12 23:20:45 +0000418 if code != 250:
Giampaolo Rodolàbd258bd2011-02-22 15:56:20 +0000419 return (code, msg)
420 self.does_esmtp = 1
Thomas Wouters7e474022000-07-16 12:04:32 +0000421 #parse the ehlo response -ddm
Guido van Rossum04110fb2007-08-24 16:32:05 +0000422 assert isinstance(self.ehlo_resp, bytes), repr(self.ehlo_resp)
Giampaolo Rodolàbd258bd2011-02-22 15:56:20 +0000423 resp = self.ehlo_resp.decode("latin-1").split('\n')
Guido van Rossumfcfb6321998-08-04 15:29:54 +0000424 del resp[0]
Guido van Rossum2880f6e1998-08-10 20:07:00 +0000425 for each in resp:
Piers Lauder385a77a2002-07-27 00:38:30 +0000426 # To be able to communicate with as many SMTP servers as possible,
427 # we have to take the old-style auth advertisement into account,
428 # because:
429 # 1) Else our SMTP feature parser gets confused.
430 # 2) There are some servers that only advertise the auth methods we
431 # support using the old style.
432 auth_match = OLDSTYLE_AUTH.match(each)
433 if auth_match:
434 # This doesn't remove duplicates, but that's no problem
435 self.esmtp_features["auth"] = self.esmtp_features.get("auth", "") \
436 + " " + auth_match.groups(0)[0]
437 continue
438
Barry Warsawbe22ae62002-04-15 20:03:30 +0000439 # RFC 1869 requires a space between ehlo keyword and parameters.
440 # It's actually stricter, in that only spaces are allowed between
441 # parameters, but were not going to check for that here. Note
442 # that the space isn't present if there are no parameters.
Giampaolo Rodolàbd258bd2011-02-22 15:56:20 +0000443 m = re.match(r'(?P<feature>[A-Za-z0-9][A-Za-z0-9\-]*) ?', each)
Guido van Rossumfcfb6321998-08-04 15:29:54 +0000444 if m:
Giampaolo Rodolàbd258bd2011-02-22 15:56:20 +0000445 feature = m.group("feature").lower()
446 params = m.string[m.end("feature"):].strip()
Piers Lauder385a77a2002-07-27 00:38:30 +0000447 if feature == "auth":
448 self.esmtp_features[feature] = self.esmtp_features.get(feature, "") \
449 + " " + params
450 else:
Giampaolo Rodolàbd258bd2011-02-22 15:56:20 +0000451 self.esmtp_features[feature] = params
452 return (code, msg)
Guido van Rossum95e6f701998-06-25 02:15:50 +0000453
Guido van Rossumfcfb6321998-08-04 15:29:54 +0000454 def has_extn(self, opt):
455 """Does the server support a given SMTP service extension?"""
Raymond Hettinger54f02222002-06-01 14:18:47 +0000456 return opt.lower() in self.esmtp_features
Guido van Rossum95e6f701998-06-25 02:15:50 +0000457
Guido van Rossum18586f41998-04-03 17:03:13 +0000458 def help(self, args=''):
Barry Warsawa7d9bdf1998-12-22 03:24:27 +0000459 """SMTP 'help' command.
460 Returns help text from server."""
Guido van Rossum18586f41998-04-03 17:03:13 +0000461 self.putcmd("help", args)
Kurt B. Kaiser58bd1902005-06-26 18:27:36 +0000462 return self.getreply()[1]
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000463
464 def rset(self):
Barry Warsawa7d9bdf1998-12-22 03:24:27 +0000465 """SMTP 'rset' command -- resets session."""
Guido van Rossum296e1431999-04-07 15:03:39 +0000466 return self.docmd("rset")
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000467
468 def noop(self):
Barry Warsawa7d9bdf1998-12-22 03:24:27 +0000469 """SMTP 'noop' command -- doesn't do anything :>"""
Guido van Rossum296e1431999-04-07 15:03:39 +0000470 return self.docmd("noop")
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000471
Giampaolo Rodolàbd258bd2011-02-22 15:56:20 +0000472 def mail(self, sender, options=[]):
Barry Warsawa7d9bdf1998-12-22 03:24:27 +0000473 """SMTP 'mail' command -- begins mail xfer session."""
Guido van Rossumfcfb6321998-08-04 15:29:54 +0000474 optionlist = ''
475 if options and self.does_esmtp:
Eric S. Raymondc013f302001-02-09 05:40:38 +0000476 optionlist = ' ' + ' '.join(options)
Giampaolo Rodolàbd258bd2011-02-22 15:56:20 +0000477 self.putcmd("mail", "FROM:%s%s" % (quoteaddr(sender), optionlist))
Guido van Rossum45e2fbc1998-03-26 21:13:24 +0000478 return self.getreply()
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000479
Giampaolo Rodolàbd258bd2011-02-22 15:56:20 +0000480 def rcpt(self, recip, options=[]):
Barry Warsawa7d9bdf1998-12-22 03:24:27 +0000481 """SMTP 'rcpt' command -- indicates 1 recipient for this mail."""
Guido van Rossumfcfb6321998-08-04 15:29:54 +0000482 optionlist = ''
483 if options and self.does_esmtp:
Eric S. Raymondc013f302001-02-09 05:40:38 +0000484 optionlist = ' ' + ' '.join(options)
Giampaolo Rodolàbd258bd2011-02-22 15:56:20 +0000485 self.putcmd("rcpt", "TO:%s%s" % (quoteaddr(recip), optionlist))
Guido van Rossum45e2fbc1998-03-26 21:13:24 +0000486 return self.getreply()
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000487
Giampaolo Rodolàbd258bd2011-02-22 15:56:20 +0000488 def data(self, msg):
Tim Peters495ad3c2001-01-15 01:36:40 +0000489 """SMTP 'DATA' command -- sends message data to server.
Guido van Rossum296e1431999-04-07 15:03:39 +0000490
Barry Warsaw4c4bec81998-12-22 03:02:20 +0000491 Automatically quotes lines beginning with a period per rfc821.
Guido van Rossum296e1431999-04-07 15:03:39 +0000492 Raises SMTPDataError if there is an unexpected reply to the
493 DATA command; the return value from this method is the final
R. David Murray7dff9e02010-11-08 17:15:13 +0000494 response code received when the all data is sent. If msg
495 is a string, lone '\r' and '\n' characters are converted to
496 '\r\n' characters. If msg is bytes, it is transmitted as is.
Barry Warsaw4c4bec81998-12-22 03:02:20 +0000497 """
Guido van Rossum45e2fbc1998-03-26 21:13:24 +0000498 self.putcmd("data")
Giampaolo Rodolàbd258bd2011-02-22 15:56:20 +0000499 (code, repl) = self.getreply()
500 if self.debuglevel > 0:
501 print("data:", (code, repl), file=stderr)
Fred Drake8152d322000-12-12 23:20:45 +0000502 if code != 354:
Giampaolo Rodolàbd258bd2011-02-22 15:56:20 +0000503 raise SMTPDataError(code, repl)
Guido van Rossum45e2fbc1998-03-26 21:13:24 +0000504 else:
R. David Murray7dff9e02010-11-08 17:15:13 +0000505 if isinstance(msg, str):
506 msg = _fix_eols(msg).encode('ascii')
507 q = _quote_periods(msg)
508 if q[-2:] != bCRLF:
509 q = q + bCRLF
510 q = q + b"." + bCRLF
Guido van Rossum20c92281999-04-21 16:52:20 +0000511 self.send(q)
Giampaolo Rodolàbd258bd2011-02-22 15:56:20 +0000512 (code, msg) = self.getreply()
513 if self.debuglevel > 0:
514 print("data:", (code, msg), file=stderr)
515 return (code, msg)
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000516
Guido van Rossumfcfb6321998-08-04 15:29:54 +0000517 def verify(self, address):
Barry Warsawa7d9bdf1998-12-22 03:24:27 +0000518 """SMTP 'verify' command -- checks for address validity."""
R David Murray46346762011-07-18 21:38:54 -0400519 self.putcmd("vrfy", _addr_only(address))
Guido van Rossumfcfb6321998-08-04 15:29:54 +0000520 return self.getreply()
Barry Warsaw4c4bec81998-12-22 03:02:20 +0000521 # a.k.a.
Giampaolo Rodolàbd258bd2011-02-22 15:56:20 +0000522 vrfy = verify
Guido van Rossumfcfb6321998-08-04 15:29:54 +0000523
524 def expn(self, address):
Christian Heimes90c3d9b2008-02-23 13:18:03 +0000525 """SMTP 'expn' command -- expands a mailing list."""
R David Murray46346762011-07-18 21:38:54 -0400526 self.putcmd("expn", _addr_only(address))
Guido van Rossumfcfb6321998-08-04 15:29:54 +0000527 return self.getreply()
528
Barry Warsaw4c4bec81998-12-22 03:02:20 +0000529 # some useful methods
Guido van Rossumae010462001-09-11 15:57:46 +0000530
Christian Heimes679db4a2008-01-18 09:56:22 +0000531 def ehlo_or_helo_if_needed(self):
532 """Call self.ehlo() and/or self.helo() if needed.
533
534 If there has been no previous EHLO or HELO command this session, this
535 method tries ESMTP EHLO first.
536
537 This method may raise the following exceptions:
538
539 SMTPHeloError The server didn't reply properly to
540 the helo greeting.
541 """
542 if self.helo_resp is None and self.ehlo_resp is None:
543 if not (200 <= self.ehlo()[0] <= 299):
544 (code, resp) = self.helo()
545 if not (200 <= code <= 299):
546 raise SMTPHeloError(code, resp)
547
Guido van Rossumae010462001-09-11 15:57:46 +0000548 def login(self, user, password):
549 """Log in on an SMTP server that requires authentication.
550
551 The arguments are:
552 - user: The user name to authenticate with.
553 - password: The password for the authentication.
554
555 If there has been no previous EHLO or HELO command this session, this
556 method tries ESMTP EHLO first.
557
558 This method will return normally if the authentication was successful.
559
560 This method may raise the following exceptions:
561
562 SMTPHeloError The server didn't reply properly to
563 the helo greeting.
564 SMTPAuthenticationError The server didn't accept the username/
565 password combination.
Fred Drake2f8f4d32001-10-13 18:35:32 +0000566 SMTPException No suitable authentication method was
Guido van Rossumae010462001-09-11 15:57:46 +0000567 found.
568 """
569
570 def encode_cram_md5(challenge, user, password):
Georg Brandl706824f2009-06-04 09:42:55 +0000571 challenge = base64.decodebytes(challenge)
R. David Murrayfb123912009-05-28 18:19:00 +0000572 response = user + " " + hmac.HMAC(password.encode('ascii'),
573 challenge).hexdigest()
574 return encode_base64(response.encode('ascii'), eol='')
Guido van Rossumae010462001-09-11 15:57:46 +0000575
576 def encode_plain(user, password):
R. David Murraycaa27b72009-05-23 18:49:56 +0000577 s = "\0%s\0%s" % (user, password)
578 return encode_base64(s.encode('ascii'), eol='')
Tim Peters469cdad2002-08-08 20:19:19 +0000579
Guido van Rossumae010462001-09-11 15:57:46 +0000580 AUTH_PLAIN = "PLAIN"
581 AUTH_CRAM_MD5 = "CRAM-MD5"
Piers Lauder385a77a2002-07-27 00:38:30 +0000582 AUTH_LOGIN = "LOGIN"
Guido van Rossumae010462001-09-11 15:57:46 +0000583
Christian Heimes679db4a2008-01-18 09:56:22 +0000584 self.ehlo_or_helo_if_needed()
Guido van Rossumae010462001-09-11 15:57:46 +0000585
586 if not self.has_extn("auth"):
587 raise SMTPException("SMTP AUTH extension not supported by server.")
588
Gerhard Häring1c5471f2010-08-05 14:08:44 +0000589 # Authentication methods the server claims to support
590 advertised_authlist = self.esmtp_features["auth"].split()
Guido van Rossumae010462001-09-11 15:57:46 +0000591
592 # List of authentication methods we support: from preferred to
593 # less preferred methods. Except for the purpose of testing the weaker
594 # ones, we prefer stronger methods like CRAM-MD5:
Piers Lauder385a77a2002-07-27 00:38:30 +0000595 preferred_auths = [AUTH_CRAM_MD5, AUTH_PLAIN, AUTH_LOGIN]
Guido van Rossumae010462001-09-11 15:57:46 +0000596
Gerhard Häring1c5471f2010-08-05 14:08:44 +0000597 # We try the authentication methods the server advertises, but only the
598 # ones *we* support. And in our preferred order.
599 authlist = [auth for auth in preferred_auths if auth in advertised_authlist]
600 if not authlist:
Fred Drake2f8f4d32001-10-13 18:35:32 +0000601 raise SMTPException("No suitable authentication method found.")
Gerhard Häring1c5471f2010-08-05 14:08:44 +0000602
603 # Some servers advertise authentication methods they don't really
604 # support, so if authentication fails, we continue until we've tried
605 # all methods.
606 for authmethod in authlist:
607 if authmethod == AUTH_CRAM_MD5:
608 (code, resp) = self.docmd("AUTH", AUTH_CRAM_MD5)
609 if code == 334:
610 (code, resp) = self.docmd(encode_cram_md5(resp, user, password))
611 elif authmethod == AUTH_PLAIN:
612 (code, resp) = self.docmd("AUTH",
613 AUTH_PLAIN + " " + encode_plain(user, password))
614 elif authmethod == AUTH_LOGIN:
615 (code, resp) = self.docmd("AUTH",
616 "%s %s" % (AUTH_LOGIN, encode_base64(user.encode('ascii'), eol='')))
617 if code == 334:
618 (code, resp) = self.docmd(encode_base64(password.encode('ascii'), eol=''))
619
Guido van Rossumae010462001-09-11 15:57:46 +0000620 # 235 == 'Authentication successful'
621 # 503 == 'Error: already authenticated'
Gerhard Häring1c5471f2010-08-05 14:08:44 +0000622 if code in (235, 503):
623 return (code, resp)
624
625 # We could not login sucessfully. Return result of last attempt.
626 raise SMTPAuthenticationError(code, resp)
Guido van Rossumae010462001-09-11 15:57:46 +0000627
Antoine Pitroue0650202011-05-18 18:03:09 +0200628 def starttls(self, keyfile=None, certfile=None, context=None):
Guido van Rossumf7fcf5e2001-09-14 16:08:44 +0000629 """Puts the connection to the SMTP server into TLS mode.
Tim Petersb64bec32001-09-18 02:26:39 +0000630
Christian Heimes679db4a2008-01-18 09:56:22 +0000631 If there has been no previous EHLO or HELO command this session, this
632 method tries ESMTP EHLO first.
633
Guido van Rossumf7fcf5e2001-09-14 16:08:44 +0000634 If the server supports TLS, this will encrypt the rest of the SMTP
635 session. If you provide the keyfile and certfile parameters,
636 the identity of the SMTP server and client can be checked. This,
637 however, depends on whether the socket module really checks the
638 certificates.
Christian Heimes679db4a2008-01-18 09:56:22 +0000639
640 This method may raise the following exceptions:
641
642 SMTPHeloError The server didn't reply properly to
643 the helo greeting.
Guido van Rossumf7fcf5e2001-09-14 16:08:44 +0000644 """
Christian Heimes679db4a2008-01-18 09:56:22 +0000645 self.ehlo_or_helo_if_needed()
646 if not self.has_extn("starttls"):
647 raise SMTPException("STARTTLS extension not supported by server.")
Tim Petersb64bec32001-09-18 02:26:39 +0000648 (resp, reply) = self.docmd("STARTTLS")
Guido van Rossumf7fcf5e2001-09-14 16:08:44 +0000649 if resp == 220:
Thomas Wouters47b49bf2007-08-30 22:15:33 +0000650 if not _have_ssl:
651 raise RuntimeError("No SSL support included in this Python")
Antoine Pitroue0650202011-05-18 18:03:09 +0200652 if context is not None and keyfile is not None:
653 raise ValueError("context and keyfile arguments are mutually "
654 "exclusive")
655 if context is not None and certfile is not None:
656 raise ValueError("context and certfile arguments are mutually "
657 "exclusive")
658 if context is not None:
659 self.sock = context.wrap_socket(self.sock)
660 else:
661 self.sock = ssl.wrap_socket(self.sock, keyfile, certfile)
Antoine Pitrouf068ab82011-06-06 19:17:09 +0200662 self.file = None
Christian Heimes679db4a2008-01-18 09:56:22 +0000663 # RFC 3207:
664 # The client MUST discard any knowledge obtained from
665 # the server, such as the list of SMTP service extensions,
666 # which was not obtained from the TLS negotiation itself.
667 self.helo_resp = None
668 self.ehlo_resp = None
669 self.esmtp_features = {}
670 self.does_esmtp = 0
Guido van Rossumf7fcf5e2001-09-14 16:08:44 +0000671 return (resp, reply)
Tim Petersb64bec32001-09-18 02:26:39 +0000672
Jeremy Hylton31bb8ce1998-08-13 19:57:46 +0000673 def sendmail(self, from_addr, to_addrs, msg, mail_options=[],
Tim Peters495ad3c2001-01-15 01:36:40 +0000674 rcpt_options=[]):
675 """This command performs an entire mail transaction.
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000676
Tim Peters495ad3c2001-01-15 01:36:40 +0000677 The arguments are:
Barry Warsaw4c4bec81998-12-22 03:02:20 +0000678 - from_addr : The address sending this mail.
679 - to_addrs : A list of addresses to send this mail to. A bare
680 string will be treated as a list with 1 address.
Tim Peters495ad3c2001-01-15 01:36:40 +0000681 - msg : The message to send.
Barry Warsaw4c4bec81998-12-22 03:02:20 +0000682 - mail_options : List of ESMTP options (such as 8bitmime) for the
683 mail command.
684 - rcpt_options : List of ESMTP options (such as DSN commands) for
685 all the rcpt commands.
686
R. David Murray7dff9e02010-11-08 17:15:13 +0000687 msg may be a string containing characters in the ASCII range, or a byte
688 string. A string is encoded to bytes using the ascii codec, and lone
R David Murrayac4e5ab2011-07-02 21:03:19 -0400689 \\r and \\n characters are converted to \\r\\n characters.
R. David Murray7dff9e02010-11-08 17:15:13 +0000690
Barry Warsaw4c4bec81998-12-22 03:02:20 +0000691 If there has been no previous EHLO or HELO command this session, this
692 method tries ESMTP EHLO first. If the server does ESMTP, message size
693 and each of the specified options will be passed to it. If EHLO
694 fails, HELO will be tried and ESMTP options suppressed.
695
696 This method will return normally if the mail is accepted for at least
Barry Warsawd25c1b71999-11-28 17:11:06 +0000697 one recipient. It returns a dictionary, with one entry for each
698 recipient that was refused. Each entry contains a tuple of the SMTP
699 error code and the accompanying error message sent by the server.
Guido van Rossum296e1431999-04-07 15:03:39 +0000700
701 This method may raise the following exceptions:
702
703 SMTPHeloError The server didn't reply properly to
Tim Peters495ad3c2001-01-15 01:36:40 +0000704 the helo greeting.
Barry Warsawd25c1b71999-11-28 17:11:06 +0000705 SMTPRecipientsRefused The server rejected ALL recipients
Guido van Rossum296e1431999-04-07 15:03:39 +0000706 (no mail was sent).
707 SMTPSenderRefused The server didn't accept the from_addr.
708 SMTPDataError The server replied with an unexpected
709 error code (other than a refusal of
710 a recipient).
711
712 Note: the connection will be open even after an exception is raised.
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000713
Guido van Rossum95e6f701998-06-25 02:15:50 +0000714 Example:
Tim Peters495ad3c2001-01-15 01:36:40 +0000715
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000716 >>> import smtplib
717 >>> s=smtplib.SMTP("localhost")
Guido van Rossumfc40a831998-01-29 17:26:45 +0000718 >>> tolist=["one@one.org","two@two.org","three@three.org","four@four.org"]
Martin v. Löwis301b1cd2002-07-28 16:52:01 +0000719 >>> msg = '''\\
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000720 ... From: Me@my.org
721 ... Subject: testin'...
722 ...
723 ... This is a test '''
724 >>> s.sendmail("me@my.org",tolist,msg)
725 { "three@three.org" : ( 550 ,"User unknown" ) }
726 >>> s.quit()
Tim Peters495ad3c2001-01-15 01:36:40 +0000727
Barry Warsaw4c4bec81998-12-22 03:02:20 +0000728 In the above example, the message was accepted for delivery to three
729 of the four addresses, and one was rejected, with the error code
Barry Warsawd25c1b71999-11-28 17:11:06 +0000730 550. If all addresses are accepted, then the method will return an
Barry Warsaw4c4bec81998-12-22 03:02:20 +0000731 empty dictionary.
732
733 """
Christian Heimes679db4a2008-01-18 09:56:22 +0000734 self.ehlo_or_helo_if_needed()
Guido van Rossum95e6f701998-06-25 02:15:50 +0000735 esmtp_opts = []
R. David Murray7dff9e02010-11-08 17:15:13 +0000736 if isinstance(msg, str):
737 msg = _fix_eols(msg).encode('ascii')
Guido van Rossumfcfb6321998-08-04 15:29:54 +0000738 if self.does_esmtp:
739 # Hmmm? what's this? -ddm
740 # self.esmtp_features['7bit']=""
741 if self.has_extn('size'):
Walter Dörwald70a6b492004-02-12 17:35:32 +0000742 esmtp_opts.append("size=%d" % len(msg))
Guido van Rossumfcfb6321998-08-04 15:29:54 +0000743 for option in mail_options:
Guido van Rossum95e6f701998-06-25 02:15:50 +0000744 esmtp_opts.append(option)
Giampaolo Rodolàbd258bd2011-02-22 15:56:20 +0000745 (code, resp) = self.mail(from_addr, esmtp_opts)
Fred Drake8152d322000-12-12 23:20:45 +0000746 if code != 250:
Guido van Rossum45e2fbc1998-03-26 21:13:24 +0000747 self.rset()
Guido van Rossum296e1431999-04-07 15:03:39 +0000748 raise SMTPSenderRefused(code, resp, from_addr)
Giampaolo Rodolàbd258bd2011-02-22 15:56:20 +0000749 senderrs = {}
Guido van Rossum3172c5d2007-10-16 18:12:55 +0000750 if isinstance(to_addrs, str):
Jeremy Hylton31bb8ce1998-08-13 19:57:46 +0000751 to_addrs = [to_addrs]
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000752 for each in to_addrs:
Giampaolo Rodolàbd258bd2011-02-22 15:56:20 +0000753 (code, resp) = self.rcpt(each, rcpt_options)
Fred Drake8152d322000-12-12 23:20:45 +0000754 if (code != 250) and (code != 251):
Giampaolo Rodolàbd258bd2011-02-22 15:56:20 +0000755 senderrs[each] = (code, resp)
756 if len(senderrs) == len(to_addrs):
Guido van Rossum95e6f701998-06-25 02:15:50 +0000757 # the server refused all our recipients
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000758 self.rset()
Guido van Rossum296e1431999-04-07 15:03:39 +0000759 raise SMTPRecipientsRefused(senderrs)
Giampaolo Rodolàbd258bd2011-02-22 15:56:20 +0000760 (code, resp) = self.data(msg)
Fred Drake8152d322000-12-12 23:20:45 +0000761 if code != 250:
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000762 self.rset()
Guido van Rossum296e1431999-04-07 15:03:39 +0000763 raise SMTPDataError(code, resp)
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000764 #if we got here then somebody got our mail
Tim Peters495ad3c2001-01-15 01:36:40 +0000765 return senderrs
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000766
R. David Murray7dff9e02010-11-08 17:15:13 +0000767 def send_message(self, msg, from_addr=None, to_addrs=None,
768 mail_options=[], rcpt_options={}):
769 """Converts message to a bytestring and passes it to sendmail.
770
771 The arguments are as for sendmail, except that msg is an
R David Murrayac4e5ab2011-07-02 21:03:19 -0400772 email.message.Message object. If from_addr is None or to_addrs is
773 None, these arguments are taken from the headers of the Message as
774 described in RFC 2822 (a ValueError is raised if there is more than
775 one set of 'Resent-' headers). Regardless of the values of from_addr and
776 to_addr, any Bcc field (or Resent-Bcc field, when the Message is a
777 resent) of the Message object won't be transmitted. The Message
778 object is then serialized using email.generator.BytesGenerator and
779 sendmail is called to transmit the message.
780
R. David Murray7dff9e02010-11-08 17:15:13 +0000781 """
R David Murrayac4e5ab2011-07-02 21:03:19 -0400782 # 'Resent-Date' is a mandatory field if the Message is resent (RFC 2822
783 # Section 3.6.6). In such a case, we use the 'Resent-*' fields. However,
784 # if there is more than one 'Resent-' block there's no way to
785 # unambiguously determine which one is the most recent in all cases,
786 # so rather than guess we raise a ValueError in that case.
787 #
788 # TODO implement heuristics to guess the correct Resent-* block with an
789 # option allowing the user to enable the heuristics. (It should be
790 # possible to guess correctly almost all of the time.)
791 resent =msg.get_all('Resent-Date')
792 if resent is None:
793 header_prefix = ''
794 elif len(resent) == 1:
795 header_prefix = 'Resent-'
796 else:
797 raise ValueError("message has more than one 'Resent-' header block")
R. David Murray7dff9e02010-11-08 17:15:13 +0000798 if from_addr is None:
R David Murrayac4e5ab2011-07-02 21:03:19 -0400799 # Prefer the sender field per RFC 2822:3.6.2.
800 from_addr = (msg[header_prefix+'Sender']
801 if (header_prefix+'Sender') in msg
802 else msg[header_prefix+'From'])
R. David Murray7dff9e02010-11-08 17:15:13 +0000803 if to_addrs is None:
R David Murrayac4e5ab2011-07-02 21:03:19 -0400804 addr_fields = [f for f in (msg[header_prefix+'To'],
805 msg[header_prefix+'Bcc'],
806 msg[header_prefix+'Cc']) if f is not None]
R. David Murray7dff9e02010-11-08 17:15:13 +0000807 to_addrs = [a[1] for a in email.utils.getaddresses(addr_fields)]
R David Murrayac4e5ab2011-07-02 21:03:19 -0400808 # Make a local copy so we can delete the bcc headers.
809 msg_copy = copy.copy(msg)
810 del msg_copy['Bcc']
811 del msg_copy['Resent-Bcc']
R. David Murray7dff9e02010-11-08 17:15:13 +0000812 with io.BytesIO() as bytesmsg:
813 g = email.generator.BytesGenerator(bytesmsg)
R David Murrayac4e5ab2011-07-02 21:03:19 -0400814 g.flatten(msg_copy, linesep='\r\n')
R. David Murray7dff9e02010-11-08 17:15:13 +0000815 flatmsg = bytesmsg.getvalue()
816 return self.sendmail(from_addr, to_addrs, flatmsg, mail_options,
817 rcpt_options)
818
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000819 def close(self):
820 """Close the connection to the SMTP server."""
821 if self.file:
822 self.file.close()
823 self.file = None
824 if self.sock:
825 self.sock.close()
826 self.sock = None
827
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000828 def quit(self):
Guido van Rossum95e6f701998-06-25 02:15:50 +0000829 """Terminate the SMTP session."""
Christian Heimesba4af492008-03-28 00:55:15 +0000830 res = self.docmd("quit")
Guido van Rossum45e2fbc1998-03-26 21:13:24 +0000831 self.close()
Christian Heimesba4af492008-03-28 00:55:15 +0000832 return res
Guido van Rossum95e6f701998-06-25 02:15:50 +0000833
Thomas Wouters47b49bf2007-08-30 22:15:33 +0000834if _have_ssl:
Thomas Wouters89f507f2006-12-13 04:49:30 +0000835
Thomas Wouters47b49bf2007-08-30 22:15:33 +0000836 class SMTP_SSL(SMTP):
837 """ This is a subclass derived from SMTP that connects over an SSL encrypted
838 socket (to use this class you need a socket module that was compiled with SSL
839 support). If host is not specified, '' (the local host) is used. If port is
Senthil Kumaran3d23fd62011-07-30 10:56:50 +0800840 omitted, the standard SMTP-over-SSL port (465) is used. The optional
841 source_address takes a two-tuple (host,port) for socket to bind to. keyfile and certfile
Thomas Wouters47b49bf2007-08-30 22:15:33 +0000842 are also optional - they can contain a PEM formatted private key and
Antoine Pitroue0650202011-05-18 18:03:09 +0200843 certificate chain file for the SSL connection. context also optional, can contain
844 a SSLContext, and is an alternative to keyfile and certfile; If it is specified both
845 keyfile and certfile must be None.
Thomas Wouters47b49bf2007-08-30 22:15:33 +0000846 """
Antoine Pitrouc1d52062011-05-07 19:39:37 +0200847
848 default_port = SMTP_SSL_PORT
849
Thomas Wouters47b49bf2007-08-30 22:15:33 +0000850 def __init__(self, host='', port=0, local_hostname=None,
Georg Brandlf78e02b2008-06-10 17:40:04 +0000851 keyfile=None, certfile=None,
Senthil Kumaran3d23fd62011-07-30 10:56:50 +0800852 timeout=socket._GLOBAL_DEFAULT_TIMEOUT,
853 source_address=None, context=None):
Antoine Pitroue0650202011-05-18 18:03:09 +0200854 if context is not None and keyfile is not None:
855 raise ValueError("context and keyfile arguments are mutually "
856 "exclusive")
857 if context is not None and certfile is not None:
858 raise ValueError("context and certfile arguments are mutually "
859 "exclusive")
Thomas Wouters47b49bf2007-08-30 22:15:33 +0000860 self.keyfile = keyfile
861 self.certfile = certfile
Antoine Pitroue0650202011-05-18 18:03:09 +0200862 self.context = context
Senthil Kumaran3d23fd62011-07-30 10:56:50 +0800863 SMTP.__init__(self, host, port, local_hostname, timeout,
864 source_address)
Thomas Wouters47b49bf2007-08-30 22:15:33 +0000865
866 def _get_socket(self, host, port, timeout):
Giampaolo Rodolàbd258bd2011-02-22 15:56:20 +0000867 if self.debuglevel > 0:
868 print('connect:', (host, port), file=stderr)
Senthil Kumaran3d23fd62011-07-30 10:56:50 +0800869 new_socket = socket.create_connection((host, port), timeout,
870 self.source_address)
Antoine Pitroue0650202011-05-18 18:03:09 +0200871 if self.context is not None:
872 new_socket = self.context.wrap_socket(new_socket)
873 else:
874 new_socket = ssl.wrap_socket(new_socket, self.keyfile, self.certfile)
R. David Murray87e20742009-05-23 01:30:26 +0000875 return new_socket
Thomas Wouters47b49bf2007-08-30 22:15:33 +0000876
877 __all__.append("SMTP_SSL")
Barry Warsaw4c4bec81998-12-22 03:02:20 +0000878
Guido van Rossumd8faa362007-04-27 19:54:29 +0000879#
880# LMTP extension
881#
882LMTP_PORT = 2003
883
884class LMTP(SMTP):
885 """LMTP - Local Mail Transfer Protocol
886
887 The LMTP protocol, which is very similar to ESMTP, is heavily based
888 on the standard SMTP client. It's common to use Unix sockets for LMTP,
889 so our connect() method must support that as well as a regular
890 host:port server. To specify a Unix socket, you must use an absolute
891 path as the host, starting with a '/'.
892
893 Authentication is supported, using the regular SMTP mechanism. When
894 using a Unix socket, LMTP generally don't support or require any
895 authentication, but your mileage might vary."""
896
897 ehlo_msg = "lhlo"
898
Senthil Kumaran3d23fd62011-07-30 10:56:50 +0800899 def __init__(self, host='', port=LMTP_PORT, local_hostname=None,
900 source_address=None):
Guido van Rossumd8faa362007-04-27 19:54:29 +0000901 """Initialize a new instance."""
Senthil Kumaran3d23fd62011-07-30 10:56:50 +0800902 SMTP.__init__(self, host, port, local_hostname = local_hostname,
903 source_address = source_address)
Guido van Rossumd8faa362007-04-27 19:54:29 +0000904
Senthil Kumaran3d23fd62011-07-30 10:56:50 +0800905 def connect(self, host='localhost', port=0, source_address=None):
Guido van Rossumd8faa362007-04-27 19:54:29 +0000906 """Connect to the LMTP daemon, on either a Unix or a TCP socket."""
907 if host[0] != '/':
Senthil Kumaran3d23fd62011-07-30 10:56:50 +0800908 return SMTP.connect(self, host, port, source_address = source_address)
Guido van Rossumd8faa362007-04-27 19:54:29 +0000909
910 # Handle Unix-domain sockets.
911 try:
912 self.sock = socket.socket(socket.AF_UNIX, socket.SOCK_STREAM)
Antoine Pitrouf068ab82011-06-06 19:17:09 +0200913 self.file = None
Guido van Rossumd8faa362007-04-27 19:54:29 +0000914 self.sock.connect(host)
915 except socket.error as msg:
Giampaolo Rodolàbd258bd2011-02-22 15:56:20 +0000916 if self.debuglevel > 0:
917 print('connect fail:', host, file=stderr)
Guido van Rossumd8faa362007-04-27 19:54:29 +0000918 if self.sock:
919 self.sock.close()
920 self.sock = None
921 raise socket.error(msg)
922 (code, msg) = self.getreply()
Giampaolo Rodolàbd258bd2011-02-22 15:56:20 +0000923 if self.debuglevel > 0:
924 print('connect:', msg, file=stderr)
Guido van Rossumd8faa362007-04-27 19:54:29 +0000925 return (code, msg)
926
927
Guido van Rossum95e6f701998-06-25 02:15:50 +0000928# Test the sendmail method, which tests most of the others.
929# Note: This always sends to localhost.
930if __name__ == '__main__':
Andrew M. Kuchling6be424f2001-08-13 14:41:39 +0000931 import sys
Guido van Rossum95e6f701998-06-25 02:15:50 +0000932
933 def prompt(prompt):
934 sys.stdout.write(prompt + ": ")
Eric S. Raymondc013f302001-02-09 05:40:38 +0000935 return sys.stdin.readline().strip()
Guido van Rossum95e6f701998-06-25 02:15:50 +0000936
937 fromaddr = prompt("From")
Giampaolo Rodolàbd258bd2011-02-22 15:56:20 +0000938 toaddrs = prompt("To").split(',')
Guido van Rossumbe19ed72007-02-09 05:37:30 +0000939 print("Enter message, end with ^D:")
Guido van Rossum95e6f701998-06-25 02:15:50 +0000940 msg = ''
941 while 1:
942 line = sys.stdin.readline()
943 if not line:
944 break
945 msg = msg + line
Guido van Rossumbe19ed72007-02-09 05:37:30 +0000946 print("Message length is %d" % len(msg))
Guido van Rossum95e6f701998-06-25 02:15:50 +0000947
948 server = SMTP('localhost')
949 server.set_debuglevel(1)
950 server.sendmail(fromaddr, toaddrs, msg)
951 server.quit()