blob: 796b86612247e7f43f32ba89af14a66e7b760874 [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.
R David Murray8a345962013-04-14 06:46:35 -040069class SMTPException(OSError):
Guido van Rossum296e1431999-04-07 15:03:39 +000070 """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
Brett Cannoncd171c82013-07-04 17:43:24 -0400174except ImportError:
Thomas Wouters47b49bf2007-08-30 22:15:33 +0000175 _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.
R David Murray14ee3cf2013-04-13 14:40:33 -0400224 By default, smtplib.SMTP_PORT is used. If a host is specified the
R David Murray021362d2013-06-23 16:05:44 -0400225 connect method is called, and if it returns anything other than a
226 success code an SMTPConnectError is raised. If specified,
227 `local_hostname` is used as the FQDN of the local host in the HELO/EHLO
228 command. Otherwise, the local hostname is found using
229 socket.getfqdn(). The `source_address` parameter takes a 2-tuple (host,
230 port) for the socket to bind to as its source address before
231 connecting. If the host is '' and port is 0, the OS default behavior
232 will be used.
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000233
234 """
Christian Heimesa5768f72013-12-02 20:44:17 +0100235 self._host = host
Guido van Rossumd8faa362007-04-27 19:54:29 +0000236 self.timeout = timeout
Guido van Rossumfcfb6321998-08-04 15:29:54 +0000237 self.esmtp_features = {}
Senthil Kumaran3d23fd62011-07-30 10:56:50 +0800238 self.source_address = source_address
239
Guido van Rossum296e1431999-04-07 15:03:39 +0000240 if host:
241 (code, msg) = self.connect(host, port)
242 if code != 220:
243 raise SMTPConnectError(code, msg)
Raymond Hettingerf13eb552002-06-02 00:40:05 +0000244 if local_hostname is not None:
Barry Warsaw13e34f72002-03-26 20:27:35 +0000245 self.local_hostname = local_hostname
Neil Schemenauer6730f262002-03-24 15:30:40 +0000246 else:
Barry Warsaw13e34f72002-03-26 20:27:35 +0000247 # RFC 2821 says we should use the fqdn in the EHLO/HELO verb, and
248 # if that can't be calculated, that we should use a domain literal
249 # instead (essentially an encoded IP address like [A.B.C.D]).
250 fqdn = socket.getfqdn()
251 if '.' in fqdn:
252 self.local_hostname = fqdn
253 else:
254 # We can't find an fqdn hostname, so use a domain literal
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000255 addr = '127.0.0.1'
256 try:
257 addr = socket.gethostbyname(socket.gethostname())
258 except socket.gaierror:
259 pass
Barry Warsaw13e34f72002-03-26 20:27:35 +0000260 self.local_hostname = '[%s]' % addr
Tim Peters495ad3c2001-01-15 01:36:40 +0000261
Barry Warsaw1f5c9582011-03-15 15:04:44 -0400262 def __enter__(self):
263 return self
264
265 def __exit__(self, *args):
266 try:
267 code, message = self.docmd("QUIT")
268 if code != 221:
269 raise SMTPResponseException(code, message)
270 except SMTPServerDisconnected:
271 pass
272 finally:
273 self.close()
274
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000275 def set_debuglevel(self, debuglevel):
276 """Set the debug output level.
277
Barry Warsawa7d9bdf1998-12-22 03:24:27 +0000278 A non-false value results in debug messages for connection and for all
279 messages sent to and received from the server.
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000280
281 """
282 self.debuglevel = debuglevel
283
Barry Warsawc9181712008-03-19 14:25:51 +0000284 def _get_socket(self, host, port, timeout):
Thomas Wouters89f507f2006-12-13 04:49:30 +0000285 # This makes it simpler for SMTP_SSL to use the SMTP connect code
286 # and just alter the socket connection bit.
Giampaolo Rodolàbd258bd2011-02-22 15:56:20 +0000287 if self.debuglevel > 0:
Senthil Kumaranb351a482011-07-31 09:14:17 +0800288 print('connect: to', (host, port), self.source_address,
289 file=stderr)
Senthil Kumaran3d23fd62011-07-30 10:56:50 +0800290 return socket.create_connection((host, port), timeout,
291 self.source_address)
Thomas Wouters89f507f2006-12-13 04:49:30 +0000292
Senthil Kumaran3d23fd62011-07-30 10:56:50 +0800293 def connect(self, host='localhost', port=0, source_address=None):
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000294 """Connect to a host on a given port.
Guido van Rossum95e6f701998-06-25 02:15:50 +0000295
Barry Warsaw4c4bec81998-12-22 03:02:20 +0000296 If the hostname ends with a colon (`:') followed by a number, and
297 there is no port specified, that suffix will be stripped off and the
298 number interpreted as the port number to use.
Guido van Rossum95e6f701998-06-25 02:15:50 +0000299
Barry Warsawa7d9bdf1998-12-22 03:24:27 +0000300 Note: This method is automatically invoked by __init__, if a host is
301 specified during instantiation.
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000302
303 """
Senthil Kumaranb351a482011-07-31 09:14:17 +0800304
305 if source_address:
306 self.source_address = source_address
307
Martin v. Löwis4eb59402001-07-26 13:37:33 +0000308 if not port and (host.find(':') == host.rfind(':')):
Martin v. Löwisa43c2f82001-07-24 20:34:08 +0000309 i = host.rfind(':')
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000310 if i >= 0:
Giampaolo Rodolàbd258bd2011-02-22 15:56:20 +0000311 host, port = host[:i], host[i + 1:]
312 try:
313 port = int(port)
Eric S. Raymond8d876032001-02-09 10:14:53 +0000314 except ValueError:
Andrew Svetlov2ade6f22012-12-17 18:57:16 +0200315 raise OSError("nonnumeric port")
Giampaolo Rodolàbd258bd2011-02-22 15:56:20 +0000316 if not port:
317 port = self.default_port
318 if self.debuglevel > 0:
319 print('connect:', (host, port), file=stderr)
Guido van Rossumd8faa362007-04-27 19:54:29 +0000320 self.sock = self._get_socket(host, port, self.timeout)
Antoine Pitrouf068ab82011-06-06 19:17:09 +0200321 self.file = None
Martin v. Löwisa43c2f82001-07-24 20:34:08 +0000322 (code, msg) = self.getreply()
Giampaolo Rodolàbd258bd2011-02-22 15:56:20 +0000323 if self.debuglevel > 0:
324 print("connect:", msg, file=stderr)
Martin v. Löwisa43c2f82001-07-24 20:34:08 +0000325 return (code, msg)
Tim Peters495ad3c2001-01-15 01:36:40 +0000326
Guido van Rossum8a392d72007-11-21 22:09:45 +0000327 def send(self, s):
328 """Send `s' to the server."""
Giampaolo Rodolàbd258bd2011-02-22 15:56:20 +0000329 if self.debuglevel > 0:
330 print('send:', repr(s), file=stderr)
Christian Heimes90c3d9b2008-02-23 13:18:03 +0000331 if hasattr(self, 'sock') and self.sock:
Guido van Rossum8a392d72007-11-21 22:09:45 +0000332 if isinstance(s, str):
333 s = s.encode("ascii")
Guido van Rossum2880f6e1998-08-10 20:07:00 +0000334 try:
Guido van Rossum8a392d72007-11-21 22:09:45 +0000335 self.sock.sendall(s)
Andrew Svetlov2ade6f22012-12-17 18:57:16 +0200336 except OSError:
Barry Warsaw76750972001-12-14 20:34:20 +0000337 self.close()
Guido van Rossum40233ea1999-01-15 03:23:55 +0000338 raise SMTPServerDisconnected('Server not connected')
Guido van Rossumfc40a831998-01-29 17:26:45 +0000339 else:
Guido van Rossum40233ea1999-01-15 03:23:55 +0000340 raise SMTPServerDisconnected('please run connect() first')
Tim Peters495ad3c2001-01-15 01:36:40 +0000341
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000342 def putcmd(self, cmd, args=""):
Barry Warsawa7d9bdf1998-12-22 03:24:27 +0000343 """Send a command to the server."""
Guido van Rossumdb23d3d1999-06-09 15:13:10 +0000344 if args == "":
345 str = '%s%s' % (cmd, CRLF)
346 else:
347 str = '%s %s%s' % (cmd, args, CRLF)
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000348 self.send(str)
Tim Peters495ad3c2001-01-15 01:36:40 +0000349
Guido van Rossumfcfb6321998-08-04 15:29:54 +0000350 def getreply(self):
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000351 """Get a reply from the server.
Tim Peters495ad3c2001-01-15 01:36:40 +0000352
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000353 Returns a tuple consisting of:
Barry Warsawa7d9bdf1998-12-22 03:24:27 +0000354
355 - server response code (e.g. '250', or such, if all goes well)
356 Note: returns -1 if it can't read response code.
357
358 - server response string corresponding to response code (multiline
359 responses are converted to a single, multiline string).
Guido van Rossumf123f841999-03-29 20:33:21 +0000360
361 Raises SMTPServerDisconnected if end-of-file is reached.
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000362 """
Giampaolo Rodolàbd258bd2011-02-22 15:56:20 +0000363 resp = []
Guido van Rossum296e1431999-04-07 15:03:39 +0000364 if self.file is None:
365 self.file = self.sock.makefile('rb')
Guido van Rossum45e2fbc1998-03-26 21:13:24 +0000366 while 1:
Benjamin Petersone1cdfd72009-01-18 21:02:37 +0000367 try:
368 line = self.file.readline()
Andrew Svetlov2ade6f22012-12-17 18:57:16 +0200369 except OSError as e:
Antoine Pitrou6b2e1602011-08-28 01:20:42 +0200370 self.close()
371 raise SMTPServerDisconnected("Connection unexpectedly closed: "
372 + str(e))
Guido van Rossum806c2462007-08-06 23:33:07 +0000373 if not line:
Guido van Rossum296e1431999-04-07 15:03:39 +0000374 self.close()
375 raise SMTPServerDisconnected("Connection unexpectedly closed")
Giampaolo Rodolàbd258bd2011-02-22 15:56:20 +0000376 if self.debuglevel > 0:
377 print('reply:', repr(line), file=stderr)
Guido van Rossum806c2462007-08-06 23:33:07 +0000378 resp.append(line[4:].strip(b' \t\r\n'))
Giampaolo Rodolàbd258bd2011-02-22 15:56:20 +0000379 code = line[:3]
Guido van Rossum296e1431999-04-07 15:03:39 +0000380 # Check that the error code is syntactically correct.
381 # Don't attempt to read a continuation line if it is broken.
382 try:
Eric S. Raymondc013f302001-02-09 05:40:38 +0000383 errcode = int(code)
Guido van Rossum296e1431999-04-07 15:03:39 +0000384 except ValueError:
385 errcode = -1
386 break
Guido van Rossumf123f841999-03-29 20:33:21 +0000387 # Check if multiline response.
Guido van Rossum806c2462007-08-06 23:33:07 +0000388 if line[3:4] != b"-":
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000389 break
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000390
Guido van Rossumc43e79f2007-06-18 18:26:36 +0000391 errmsg = b"\n".join(resp)
Tim Peters495ad3c2001-01-15 01:36:40 +0000392 if self.debuglevel > 0:
Senthil Kumaranb351a482011-07-31 09:14:17 +0800393 print('reply: retcode (%s); Msg: %s' % (errcode, errmsg),
394 file=stderr)
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000395 return errcode, errmsg
Tim Peters495ad3c2001-01-15 01:36:40 +0000396
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000397 def docmd(self, cmd, args=""):
Barry Warsawa7d9bdf1998-12-22 03:24:27 +0000398 """Send a command, and return its response code."""
Giampaolo Rodolàbd258bd2011-02-22 15:56:20 +0000399 self.putcmd(cmd, args)
Guido van Rossum296e1431999-04-07 15:03:39 +0000400 return self.getreply()
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000401
Barry Warsawa7d9bdf1998-12-22 03:24:27 +0000402 # std smtp commands
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000403 def helo(self, name=''):
Barry Warsawa7d9bdf1998-12-22 03:24:27 +0000404 """SMTP 'helo' command.
405 Hostname to send for this command defaults to the FQDN of the local
406 host.
407 """
Neil Schemenauer6730f262002-03-24 15:30:40 +0000408 self.putcmd("helo", name or self.local_hostname)
Giampaolo Rodolàbd258bd2011-02-22 15:56:20 +0000409 (code, msg) = self.getreply()
410 self.helo_resp = msg
411 return (code, msg)
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000412
Guido van Rossum95e6f701998-06-25 02:15:50 +0000413 def ehlo(self, name=''):
Barry Warsawa7d9bdf1998-12-22 03:24:27 +0000414 """ SMTP 'ehlo' command.
415 Hostname to send for this command defaults to the FQDN of the local
416 host.
417 """
Guido van Rossumf7fcf5e2001-09-14 16:08:44 +0000418 self.esmtp_features = {}
Guido van Rossumd8faa362007-04-27 19:54:29 +0000419 self.putcmd(self.ehlo_msg, name or self.local_hostname)
Giampaolo Rodolàbd258bd2011-02-22 15:56:20 +0000420 (code, msg) = self.getreply()
Tim Peters495ad3c2001-01-15 01:36:40 +0000421 # According to RFC1869 some (badly written)
422 # MTA's will disconnect on an ehlo. Toss an exception if
Guido van Rossumfcfb6321998-08-04 15:29:54 +0000423 # that happens -ddm
424 if code == -1 and len(msg) == 0:
Barry Warsaw76750972001-12-14 20:34:20 +0000425 self.close()
Guido van Rossum40233ea1999-01-15 03:23:55 +0000426 raise SMTPServerDisconnected("Server not connected")
Giampaolo Rodolàbd258bd2011-02-22 15:56:20 +0000427 self.ehlo_resp = msg
Fred Drake8152d322000-12-12 23:20:45 +0000428 if code != 250:
Giampaolo Rodolàbd258bd2011-02-22 15:56:20 +0000429 return (code, msg)
430 self.does_esmtp = 1
Thomas Wouters7e474022000-07-16 12:04:32 +0000431 #parse the ehlo response -ddm
Guido van Rossum04110fb2007-08-24 16:32:05 +0000432 assert isinstance(self.ehlo_resp, bytes), repr(self.ehlo_resp)
Giampaolo Rodolàbd258bd2011-02-22 15:56:20 +0000433 resp = self.ehlo_resp.decode("latin-1").split('\n')
Guido van Rossumfcfb6321998-08-04 15:29:54 +0000434 del resp[0]
Guido van Rossum2880f6e1998-08-10 20:07:00 +0000435 for each in resp:
Piers Lauder385a77a2002-07-27 00:38:30 +0000436 # To be able to communicate with as many SMTP servers as possible,
437 # we have to take the old-style auth advertisement into account,
438 # because:
439 # 1) Else our SMTP feature parser gets confused.
440 # 2) There are some servers that only advertise the auth methods we
441 # support using the old style.
442 auth_match = OLDSTYLE_AUTH.match(each)
443 if auth_match:
444 # This doesn't remove duplicates, but that's no problem
445 self.esmtp_features["auth"] = self.esmtp_features.get("auth", "") \
446 + " " + auth_match.groups(0)[0]
447 continue
448
Barry Warsawbe22ae62002-04-15 20:03:30 +0000449 # RFC 1869 requires a space between ehlo keyword and parameters.
450 # It's actually stricter, in that only spaces are allowed between
451 # parameters, but were not going to check for that here. Note
452 # that the space isn't present if there are no parameters.
Giampaolo Rodolàbd258bd2011-02-22 15:56:20 +0000453 m = re.match(r'(?P<feature>[A-Za-z0-9][A-Za-z0-9\-]*) ?', each)
Guido van Rossumfcfb6321998-08-04 15:29:54 +0000454 if m:
Giampaolo Rodolàbd258bd2011-02-22 15:56:20 +0000455 feature = m.group("feature").lower()
456 params = m.string[m.end("feature"):].strip()
Piers Lauder385a77a2002-07-27 00:38:30 +0000457 if feature == "auth":
458 self.esmtp_features[feature] = self.esmtp_features.get(feature, "") \
459 + " " + params
460 else:
Giampaolo Rodolàbd258bd2011-02-22 15:56:20 +0000461 self.esmtp_features[feature] = params
462 return (code, msg)
Guido van Rossum95e6f701998-06-25 02:15:50 +0000463
Guido van Rossumfcfb6321998-08-04 15:29:54 +0000464 def has_extn(self, opt):
465 """Does the server support a given SMTP service extension?"""
Raymond Hettinger54f02222002-06-01 14:18:47 +0000466 return opt.lower() in self.esmtp_features
Guido van Rossum95e6f701998-06-25 02:15:50 +0000467
Guido van Rossum18586f41998-04-03 17:03:13 +0000468 def help(self, args=''):
Barry Warsawa7d9bdf1998-12-22 03:24:27 +0000469 """SMTP 'help' command.
470 Returns help text from server."""
Guido van Rossum18586f41998-04-03 17:03:13 +0000471 self.putcmd("help", args)
Kurt B. Kaiser58bd1902005-06-26 18:27:36 +0000472 return self.getreply()[1]
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000473
474 def rset(self):
Barry Warsawa7d9bdf1998-12-22 03:24:27 +0000475 """SMTP 'rset' command -- resets session."""
Guido van Rossum296e1431999-04-07 15:03:39 +0000476 return self.docmd("rset")
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000477
478 def noop(self):
Barry Warsawa7d9bdf1998-12-22 03:24:27 +0000479 """SMTP 'noop' command -- doesn't do anything :>"""
Guido van Rossum296e1431999-04-07 15:03:39 +0000480 return self.docmd("noop")
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000481
Giampaolo Rodolàbd258bd2011-02-22 15:56:20 +0000482 def mail(self, sender, options=[]):
Barry Warsawa7d9bdf1998-12-22 03:24:27 +0000483 """SMTP 'mail' command -- begins mail xfer session."""
Guido van Rossumfcfb6321998-08-04 15:29:54 +0000484 optionlist = ''
485 if options and self.does_esmtp:
Eric S. Raymondc013f302001-02-09 05:40:38 +0000486 optionlist = ' ' + ' '.join(options)
Giampaolo Rodolàbd258bd2011-02-22 15:56:20 +0000487 self.putcmd("mail", "FROM:%s%s" % (quoteaddr(sender), optionlist))
Guido van Rossum45e2fbc1998-03-26 21:13:24 +0000488 return self.getreply()
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000489
Giampaolo Rodolàbd258bd2011-02-22 15:56:20 +0000490 def rcpt(self, recip, options=[]):
Barry Warsawa7d9bdf1998-12-22 03:24:27 +0000491 """SMTP 'rcpt' command -- indicates 1 recipient for this mail."""
Guido van Rossumfcfb6321998-08-04 15:29:54 +0000492 optionlist = ''
493 if options and self.does_esmtp:
Eric S. Raymondc013f302001-02-09 05:40:38 +0000494 optionlist = ' ' + ' '.join(options)
Giampaolo Rodolàbd258bd2011-02-22 15:56:20 +0000495 self.putcmd("rcpt", "TO:%s%s" % (quoteaddr(recip), optionlist))
Guido van Rossum45e2fbc1998-03-26 21:13:24 +0000496 return self.getreply()
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000497
Giampaolo Rodolàbd258bd2011-02-22 15:56:20 +0000498 def data(self, msg):
Tim Peters495ad3c2001-01-15 01:36:40 +0000499 """SMTP 'DATA' command -- sends message data to server.
Guido van Rossum296e1431999-04-07 15:03:39 +0000500
Barry Warsaw4c4bec81998-12-22 03:02:20 +0000501 Automatically quotes lines beginning with a period per rfc821.
Guido van Rossum296e1431999-04-07 15:03:39 +0000502 Raises SMTPDataError if there is an unexpected reply to the
503 DATA command; the return value from this method is the final
R. David Murray7dff9e02010-11-08 17:15:13 +0000504 response code received when the all data is sent. If msg
505 is a string, lone '\r' and '\n' characters are converted to
506 '\r\n' characters. If msg is bytes, it is transmitted as is.
Barry Warsaw4c4bec81998-12-22 03:02:20 +0000507 """
Guido van Rossum45e2fbc1998-03-26 21:13:24 +0000508 self.putcmd("data")
Giampaolo Rodolàbd258bd2011-02-22 15:56:20 +0000509 (code, repl) = self.getreply()
510 if self.debuglevel > 0:
511 print("data:", (code, repl), file=stderr)
Fred Drake8152d322000-12-12 23:20:45 +0000512 if code != 354:
Giampaolo Rodolàbd258bd2011-02-22 15:56:20 +0000513 raise SMTPDataError(code, repl)
Guido van Rossum45e2fbc1998-03-26 21:13:24 +0000514 else:
R. David Murray7dff9e02010-11-08 17:15:13 +0000515 if isinstance(msg, str):
516 msg = _fix_eols(msg).encode('ascii')
517 q = _quote_periods(msg)
518 if q[-2:] != bCRLF:
519 q = q + bCRLF
520 q = q + b"." + bCRLF
Guido van Rossum20c92281999-04-21 16:52:20 +0000521 self.send(q)
Giampaolo Rodolàbd258bd2011-02-22 15:56:20 +0000522 (code, msg) = self.getreply()
523 if self.debuglevel > 0:
524 print("data:", (code, msg), file=stderr)
525 return (code, msg)
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000526
Guido van Rossumfcfb6321998-08-04 15:29:54 +0000527 def verify(self, address):
Barry Warsawa7d9bdf1998-12-22 03:24:27 +0000528 """SMTP 'verify' command -- checks for address validity."""
R David Murray46346762011-07-18 21:38:54 -0400529 self.putcmd("vrfy", _addr_only(address))
Guido van Rossumfcfb6321998-08-04 15:29:54 +0000530 return self.getreply()
Barry Warsaw4c4bec81998-12-22 03:02:20 +0000531 # a.k.a.
Giampaolo Rodolàbd258bd2011-02-22 15:56:20 +0000532 vrfy = verify
Guido van Rossumfcfb6321998-08-04 15:29:54 +0000533
534 def expn(self, address):
Christian Heimes90c3d9b2008-02-23 13:18:03 +0000535 """SMTP 'expn' command -- expands a mailing list."""
R David Murray46346762011-07-18 21:38:54 -0400536 self.putcmd("expn", _addr_only(address))
Guido van Rossumfcfb6321998-08-04 15:29:54 +0000537 return self.getreply()
538
Barry Warsaw4c4bec81998-12-22 03:02:20 +0000539 # some useful methods
Guido van Rossumae010462001-09-11 15:57:46 +0000540
Christian Heimes679db4a2008-01-18 09:56:22 +0000541 def ehlo_or_helo_if_needed(self):
542 """Call self.ehlo() and/or self.helo() if needed.
543
544 If there has been no previous EHLO or HELO command this session, this
545 method tries ESMTP EHLO first.
546
547 This method may raise the following exceptions:
548
549 SMTPHeloError The server didn't reply properly to
550 the helo greeting.
551 """
552 if self.helo_resp is None and self.ehlo_resp is None:
553 if not (200 <= self.ehlo()[0] <= 299):
554 (code, resp) = self.helo()
555 if not (200 <= code <= 299):
556 raise SMTPHeloError(code, resp)
557
Guido van Rossumae010462001-09-11 15:57:46 +0000558 def login(self, user, password):
559 """Log in on an SMTP server that requires authentication.
560
561 The arguments are:
562 - user: The user name to authenticate with.
563 - password: The password for the authentication.
564
565 If there has been no previous EHLO or HELO command this session, this
566 method tries ESMTP EHLO first.
567
568 This method will return normally if the authentication was successful.
569
570 This method may raise the following exceptions:
571
572 SMTPHeloError The server didn't reply properly to
573 the helo greeting.
574 SMTPAuthenticationError The server didn't accept the username/
575 password combination.
Fred Drake2f8f4d32001-10-13 18:35:32 +0000576 SMTPException No suitable authentication method was
Guido van Rossumae010462001-09-11 15:57:46 +0000577 found.
578 """
579
580 def encode_cram_md5(challenge, user, password):
Georg Brandl706824f2009-06-04 09:42:55 +0000581 challenge = base64.decodebytes(challenge)
R. David Murrayfb123912009-05-28 18:19:00 +0000582 response = user + " " + hmac.HMAC(password.encode('ascii'),
Christian Heimes634919a2013-11-20 17:23:06 +0100583 challenge, 'md5').hexdigest()
R. David Murrayfb123912009-05-28 18:19:00 +0000584 return encode_base64(response.encode('ascii'), eol='')
Guido van Rossumae010462001-09-11 15:57:46 +0000585
586 def encode_plain(user, password):
R. David Murraycaa27b72009-05-23 18:49:56 +0000587 s = "\0%s\0%s" % (user, password)
588 return encode_base64(s.encode('ascii'), eol='')
Tim Peters469cdad2002-08-08 20:19:19 +0000589
Guido van Rossumae010462001-09-11 15:57:46 +0000590 AUTH_PLAIN = "PLAIN"
591 AUTH_CRAM_MD5 = "CRAM-MD5"
Piers Lauder385a77a2002-07-27 00:38:30 +0000592 AUTH_LOGIN = "LOGIN"
Guido van Rossumae010462001-09-11 15:57:46 +0000593
Christian Heimes679db4a2008-01-18 09:56:22 +0000594 self.ehlo_or_helo_if_needed()
Guido van Rossumae010462001-09-11 15:57:46 +0000595
596 if not self.has_extn("auth"):
597 raise SMTPException("SMTP AUTH extension not supported by server.")
598
Gerhard Häring1c5471f2010-08-05 14:08:44 +0000599 # Authentication methods the server claims to support
600 advertised_authlist = self.esmtp_features["auth"].split()
Guido van Rossumae010462001-09-11 15:57:46 +0000601
602 # List of authentication methods we support: from preferred to
603 # less preferred methods. Except for the purpose of testing the weaker
604 # ones, we prefer stronger methods like CRAM-MD5:
Piers Lauder385a77a2002-07-27 00:38:30 +0000605 preferred_auths = [AUTH_CRAM_MD5, AUTH_PLAIN, AUTH_LOGIN]
Guido van Rossumae010462001-09-11 15:57:46 +0000606
Gerhard Häring1c5471f2010-08-05 14:08:44 +0000607 # We try the authentication methods the server advertises, but only the
608 # ones *we* support. And in our preferred order.
609 authlist = [auth for auth in preferred_auths if auth in advertised_authlist]
610 if not authlist:
Fred Drake2f8f4d32001-10-13 18:35:32 +0000611 raise SMTPException("No suitable authentication method found.")
Gerhard Häring1c5471f2010-08-05 14:08:44 +0000612
613 # Some servers advertise authentication methods they don't really
614 # support, so if authentication fails, we continue until we've tried
615 # all methods.
616 for authmethod in authlist:
617 if authmethod == AUTH_CRAM_MD5:
618 (code, resp) = self.docmd("AUTH", AUTH_CRAM_MD5)
619 if code == 334:
620 (code, resp) = self.docmd(encode_cram_md5(resp, user, password))
621 elif authmethod == AUTH_PLAIN:
622 (code, resp) = self.docmd("AUTH",
623 AUTH_PLAIN + " " + encode_plain(user, password))
624 elif authmethod == AUTH_LOGIN:
625 (code, resp) = self.docmd("AUTH",
626 "%s %s" % (AUTH_LOGIN, encode_base64(user.encode('ascii'), eol='')))
627 if code == 334:
628 (code, resp) = self.docmd(encode_base64(password.encode('ascii'), eol=''))
629
Guido van Rossumae010462001-09-11 15:57:46 +0000630 # 235 == 'Authentication successful'
631 # 503 == 'Error: already authenticated'
Gerhard Häring1c5471f2010-08-05 14:08:44 +0000632 if code in (235, 503):
633 return (code, resp)
634
635 # We could not login sucessfully. Return result of last attempt.
636 raise SMTPAuthenticationError(code, resp)
Guido van Rossumae010462001-09-11 15:57:46 +0000637
Antoine Pitroue0650202011-05-18 18:03:09 +0200638 def starttls(self, keyfile=None, certfile=None, context=None):
Guido van Rossumf7fcf5e2001-09-14 16:08:44 +0000639 """Puts the connection to the SMTP server into TLS mode.
Tim Petersb64bec32001-09-18 02:26:39 +0000640
Christian Heimes679db4a2008-01-18 09:56:22 +0000641 If there has been no previous EHLO or HELO command this session, this
642 method tries ESMTP EHLO first.
643
Guido van Rossumf7fcf5e2001-09-14 16:08:44 +0000644 If the server supports TLS, this will encrypt the rest of the SMTP
645 session. If you provide the keyfile and certfile parameters,
646 the identity of the SMTP server and client can be checked. This,
647 however, depends on whether the socket module really checks the
648 certificates.
Christian Heimes679db4a2008-01-18 09:56:22 +0000649
650 This method may raise the following exceptions:
651
652 SMTPHeloError The server didn't reply properly to
653 the helo greeting.
Guido van Rossumf7fcf5e2001-09-14 16:08:44 +0000654 """
Christian Heimes679db4a2008-01-18 09:56:22 +0000655 self.ehlo_or_helo_if_needed()
656 if not self.has_extn("starttls"):
657 raise SMTPException("STARTTLS extension not supported by server.")
Tim Petersb64bec32001-09-18 02:26:39 +0000658 (resp, reply) = self.docmd("STARTTLS")
Guido van Rossumf7fcf5e2001-09-14 16:08:44 +0000659 if resp == 220:
Thomas Wouters47b49bf2007-08-30 22:15:33 +0000660 if not _have_ssl:
661 raise RuntimeError("No SSL support included in this Python")
Antoine Pitroue0650202011-05-18 18:03:09 +0200662 if context is not None and keyfile is not None:
663 raise ValueError("context and keyfile arguments are mutually "
664 "exclusive")
665 if context is not None and certfile is not None:
666 raise ValueError("context and certfile arguments are mutually "
667 "exclusive")
Christian Heimes67986f92013-11-23 22:43:47 +0100668 if context is None:
669 context = ssl._create_stdlib_context(certfile=certfile,
670 keyfile=keyfile)
Christian Heimesa5768f72013-12-02 20:44:17 +0100671 server_hostname = self._host if ssl.HAS_SNI else None
672 self.sock = context.wrap_socket(self.sock,
673 server_hostname=server_hostname)
Antoine Pitrouf068ab82011-06-06 19:17:09 +0200674 self.file = None
Christian Heimes679db4a2008-01-18 09:56:22 +0000675 # RFC 3207:
676 # The client MUST discard any knowledge obtained from
677 # the server, such as the list of SMTP service extensions,
678 # which was not obtained from the TLS negotiation itself.
679 self.helo_resp = None
680 self.ehlo_resp = None
681 self.esmtp_features = {}
682 self.does_esmtp = 0
Guido van Rossumf7fcf5e2001-09-14 16:08:44 +0000683 return (resp, reply)
Tim Petersb64bec32001-09-18 02:26:39 +0000684
Jeremy Hylton31bb8ce1998-08-13 19:57:46 +0000685 def sendmail(self, from_addr, to_addrs, msg, mail_options=[],
Tim Peters495ad3c2001-01-15 01:36:40 +0000686 rcpt_options=[]):
687 """This command performs an entire mail transaction.
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000688
Tim Peters495ad3c2001-01-15 01:36:40 +0000689 The arguments are:
Barry Warsaw4c4bec81998-12-22 03:02:20 +0000690 - from_addr : The address sending this mail.
691 - to_addrs : A list of addresses to send this mail to. A bare
692 string will be treated as a list with 1 address.
Tim Peters495ad3c2001-01-15 01:36:40 +0000693 - msg : The message to send.
Barry Warsaw4c4bec81998-12-22 03:02:20 +0000694 - mail_options : List of ESMTP options (such as 8bitmime) for the
695 mail command.
696 - rcpt_options : List of ESMTP options (such as DSN commands) for
697 all the rcpt commands.
698
R. David Murray7dff9e02010-11-08 17:15:13 +0000699 msg may be a string containing characters in the ASCII range, or a byte
700 string. A string is encoded to bytes using the ascii codec, and lone
R David Murrayac4e5ab2011-07-02 21:03:19 -0400701 \\r and \\n characters are converted to \\r\\n characters.
R. David Murray7dff9e02010-11-08 17:15:13 +0000702
Barry Warsaw4c4bec81998-12-22 03:02:20 +0000703 If there has been no previous EHLO or HELO command this session, this
704 method tries ESMTP EHLO first. If the server does ESMTP, message size
705 and each of the specified options will be passed to it. If EHLO
706 fails, HELO will be tried and ESMTP options suppressed.
707
708 This method will return normally if the mail is accepted for at least
Barry Warsawd25c1b71999-11-28 17:11:06 +0000709 one recipient. It returns a dictionary, with one entry for each
710 recipient that was refused. Each entry contains a tuple of the SMTP
711 error code and the accompanying error message sent by the server.
Guido van Rossum296e1431999-04-07 15:03:39 +0000712
713 This method may raise the following exceptions:
714
715 SMTPHeloError The server didn't reply properly to
Tim Peters495ad3c2001-01-15 01:36:40 +0000716 the helo greeting.
Barry Warsawd25c1b71999-11-28 17:11:06 +0000717 SMTPRecipientsRefused The server rejected ALL recipients
Guido van Rossum296e1431999-04-07 15:03:39 +0000718 (no mail was sent).
719 SMTPSenderRefused The server didn't accept the from_addr.
720 SMTPDataError The server replied with an unexpected
721 error code (other than a refusal of
722 a recipient).
723
724 Note: the connection will be open even after an exception is raised.
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000725
Guido van Rossum95e6f701998-06-25 02:15:50 +0000726 Example:
Tim Peters495ad3c2001-01-15 01:36:40 +0000727
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000728 >>> import smtplib
729 >>> s=smtplib.SMTP("localhost")
Guido van Rossumfc40a831998-01-29 17:26:45 +0000730 >>> tolist=["one@one.org","two@two.org","three@three.org","four@four.org"]
Martin v. Löwis301b1cd2002-07-28 16:52:01 +0000731 >>> msg = '''\\
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000732 ... From: Me@my.org
733 ... Subject: testin'...
734 ...
735 ... This is a test '''
736 >>> s.sendmail("me@my.org",tolist,msg)
737 { "three@three.org" : ( 550 ,"User unknown" ) }
738 >>> s.quit()
Tim Peters495ad3c2001-01-15 01:36:40 +0000739
Barry Warsaw4c4bec81998-12-22 03:02:20 +0000740 In the above example, the message was accepted for delivery to three
741 of the four addresses, and one was rejected, with the error code
Barry Warsawd25c1b71999-11-28 17:11:06 +0000742 550. If all addresses are accepted, then the method will return an
Barry Warsaw4c4bec81998-12-22 03:02:20 +0000743 empty dictionary.
744
745 """
Christian Heimes679db4a2008-01-18 09:56:22 +0000746 self.ehlo_or_helo_if_needed()
Guido van Rossum95e6f701998-06-25 02:15:50 +0000747 esmtp_opts = []
R. David Murray7dff9e02010-11-08 17:15:13 +0000748 if isinstance(msg, str):
749 msg = _fix_eols(msg).encode('ascii')
Guido van Rossumfcfb6321998-08-04 15:29:54 +0000750 if self.does_esmtp:
751 # Hmmm? what's this? -ddm
752 # self.esmtp_features['7bit']=""
753 if self.has_extn('size'):
Walter Dörwald70a6b492004-02-12 17:35:32 +0000754 esmtp_opts.append("size=%d" % len(msg))
Guido van Rossumfcfb6321998-08-04 15:29:54 +0000755 for option in mail_options:
Guido van Rossum95e6f701998-06-25 02:15:50 +0000756 esmtp_opts.append(option)
Giampaolo Rodolàbd258bd2011-02-22 15:56:20 +0000757 (code, resp) = self.mail(from_addr, esmtp_opts)
Fred Drake8152d322000-12-12 23:20:45 +0000758 if code != 250:
R David Murrayd312c742013-03-20 20:36:14 -0400759 if code == 421:
760 self.close()
761 else:
762 self.rset()
Guido van Rossum296e1431999-04-07 15:03:39 +0000763 raise SMTPSenderRefused(code, resp, from_addr)
Giampaolo Rodolàbd258bd2011-02-22 15:56:20 +0000764 senderrs = {}
Guido van Rossum3172c5d2007-10-16 18:12:55 +0000765 if isinstance(to_addrs, str):
Jeremy Hylton31bb8ce1998-08-13 19:57:46 +0000766 to_addrs = [to_addrs]
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000767 for each in to_addrs:
Giampaolo Rodolàbd258bd2011-02-22 15:56:20 +0000768 (code, resp) = self.rcpt(each, rcpt_options)
Fred Drake8152d322000-12-12 23:20:45 +0000769 if (code != 250) and (code != 251):
Giampaolo Rodolàbd258bd2011-02-22 15:56:20 +0000770 senderrs[each] = (code, resp)
R David Murrayd312c742013-03-20 20:36:14 -0400771 if code == 421:
772 self.close()
773 raise SMTPRecipientsRefused(senderrs)
Giampaolo Rodolàbd258bd2011-02-22 15:56:20 +0000774 if len(senderrs) == len(to_addrs):
Guido van Rossum95e6f701998-06-25 02:15:50 +0000775 # the server refused all our recipients
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000776 self.rset()
Guido van Rossum296e1431999-04-07 15:03:39 +0000777 raise SMTPRecipientsRefused(senderrs)
Giampaolo Rodolàbd258bd2011-02-22 15:56:20 +0000778 (code, resp) = self.data(msg)
Fred Drake8152d322000-12-12 23:20:45 +0000779 if code != 250:
R David Murrayd312c742013-03-20 20:36:14 -0400780 if code == 421:
781 self.close()
782 else:
783 self.rset()
Guido van Rossum296e1431999-04-07 15:03:39 +0000784 raise SMTPDataError(code, resp)
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000785 #if we got here then somebody got our mail
Tim Peters495ad3c2001-01-15 01:36:40 +0000786 return senderrs
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000787
R. David Murray7dff9e02010-11-08 17:15:13 +0000788 def send_message(self, msg, from_addr=None, to_addrs=None,
789 mail_options=[], rcpt_options={}):
790 """Converts message to a bytestring and passes it to sendmail.
791
792 The arguments are as for sendmail, except that msg is an
R David Murrayac4e5ab2011-07-02 21:03:19 -0400793 email.message.Message object. If from_addr is None or to_addrs is
794 None, these arguments are taken from the headers of the Message as
795 described in RFC 2822 (a ValueError is raised if there is more than
796 one set of 'Resent-' headers). Regardless of the values of from_addr and
797 to_addr, any Bcc field (or Resent-Bcc field, when the Message is a
798 resent) of the Message object won't be transmitted. The Message
799 object is then serialized using email.generator.BytesGenerator and
800 sendmail is called to transmit the message.
801
R. David Murray7dff9e02010-11-08 17:15:13 +0000802 """
R David Murrayac4e5ab2011-07-02 21:03:19 -0400803 # 'Resent-Date' is a mandatory field if the Message is resent (RFC 2822
804 # Section 3.6.6). In such a case, we use the 'Resent-*' fields. However,
805 # if there is more than one 'Resent-' block there's no way to
806 # unambiguously determine which one is the most recent in all cases,
807 # so rather than guess we raise a ValueError in that case.
808 #
809 # TODO implement heuristics to guess the correct Resent-* block with an
810 # option allowing the user to enable the heuristics. (It should be
811 # possible to guess correctly almost all of the time.)
Senthil Kumaranb351a482011-07-31 09:14:17 +0800812
813 resent = msg.get_all('Resent-Date')
R David Murrayac4e5ab2011-07-02 21:03:19 -0400814 if resent is None:
815 header_prefix = ''
816 elif len(resent) == 1:
817 header_prefix = 'Resent-'
818 else:
819 raise ValueError("message has more than one 'Resent-' header block")
R. David Murray7dff9e02010-11-08 17:15:13 +0000820 if from_addr is None:
R David Murrayac4e5ab2011-07-02 21:03:19 -0400821 # Prefer the sender field per RFC 2822:3.6.2.
Senthil Kumaranb351a482011-07-31 09:14:17 +0800822 from_addr = (msg[header_prefix + 'Sender']
823 if (header_prefix + 'Sender') in msg
824 else msg[header_prefix + 'From'])
R. David Murray7dff9e02010-11-08 17:15:13 +0000825 if to_addrs is None:
Senthil Kumaranb351a482011-07-31 09:14:17 +0800826 addr_fields = [f for f in (msg[header_prefix + 'To'],
827 msg[header_prefix + 'Bcc'],
828 msg[header_prefix + 'Cc']) if f is not None]
R. David Murray7dff9e02010-11-08 17:15:13 +0000829 to_addrs = [a[1] for a in email.utils.getaddresses(addr_fields)]
R David Murrayac4e5ab2011-07-02 21:03:19 -0400830 # Make a local copy so we can delete the bcc headers.
831 msg_copy = copy.copy(msg)
832 del msg_copy['Bcc']
833 del msg_copy['Resent-Bcc']
R. David Murray7dff9e02010-11-08 17:15:13 +0000834 with io.BytesIO() as bytesmsg:
835 g = email.generator.BytesGenerator(bytesmsg)
R David Murrayac4e5ab2011-07-02 21:03:19 -0400836 g.flatten(msg_copy, linesep='\r\n')
R. David Murray7dff9e02010-11-08 17:15:13 +0000837 flatmsg = bytesmsg.getvalue()
838 return self.sendmail(from_addr, to_addrs, flatmsg, mail_options,
839 rcpt_options)
840
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000841 def close(self):
842 """Close the connection to the SMTP server."""
843 if self.file:
844 self.file.close()
845 self.file = None
846 if self.sock:
847 self.sock.close()
848 self.sock = None
849
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000850 def quit(self):
Guido van Rossum95e6f701998-06-25 02:15:50 +0000851 """Terminate the SMTP session."""
Christian Heimesba4af492008-03-28 00:55:15 +0000852 res = self.docmd("quit")
Guido van Rossum45e2fbc1998-03-26 21:13:24 +0000853 self.close()
Christian Heimesba4af492008-03-28 00:55:15 +0000854 return res
Guido van Rossum95e6f701998-06-25 02:15:50 +0000855
Thomas Wouters47b49bf2007-08-30 22:15:33 +0000856if _have_ssl:
Thomas Wouters89f507f2006-12-13 04:49:30 +0000857
Thomas Wouters47b49bf2007-08-30 22:15:33 +0000858 class SMTP_SSL(SMTP):
R David Murray021362d2013-06-23 16:05:44 -0400859 """ This is a subclass derived from SMTP that connects over an SSL
860 encrypted socket (to use this class you need a socket module that was
861 compiled with SSL support). If host is not specified, '' (the local
862 host) is used. If port is omitted, the standard SMTP-over-SSL port
863 (465) is used. local_hostname and source_address have the same meaning
864 as they do in the SMTP class. keyfile and certfile are also optional -
865 they can contain a PEM formatted private key and certificate chain file
866 for the SSL connection. context also optional, can contain a
867 SSLContext, and is an alternative to keyfile and certfile; If it is
868 specified both keyfile and certfile must be None.
869
Thomas Wouters47b49bf2007-08-30 22:15:33 +0000870 """
Antoine Pitrouc1d52062011-05-07 19:39:37 +0200871
872 default_port = SMTP_SSL_PORT
873
Thomas Wouters47b49bf2007-08-30 22:15:33 +0000874 def __init__(self, host='', port=0, local_hostname=None,
Georg Brandlf78e02b2008-06-10 17:40:04 +0000875 keyfile=None, certfile=None,
Senthil Kumaran3d23fd62011-07-30 10:56:50 +0800876 timeout=socket._GLOBAL_DEFAULT_TIMEOUT,
877 source_address=None, context=None):
Antoine Pitroue0650202011-05-18 18:03:09 +0200878 if context is not None and keyfile is not None:
879 raise ValueError("context and keyfile arguments are mutually "
880 "exclusive")
881 if context is not None and certfile is not None:
882 raise ValueError("context and certfile arguments are mutually "
883 "exclusive")
Thomas Wouters47b49bf2007-08-30 22:15:33 +0000884 self.keyfile = keyfile
885 self.certfile = certfile
Christian Heimes67986f92013-11-23 22:43:47 +0100886 if context is None:
887 context = ssl._create_stdlib_context(certfile=certfile,
888 keyfile=keyfile)
Antoine Pitroue0650202011-05-18 18:03:09 +0200889 self.context = context
Senthil Kumaran3d23fd62011-07-30 10:56:50 +0800890 SMTP.__init__(self, host, port, local_hostname, timeout,
891 source_address)
Thomas Wouters47b49bf2007-08-30 22:15:33 +0000892
893 def _get_socket(self, host, port, timeout):
Giampaolo Rodolàbd258bd2011-02-22 15:56:20 +0000894 if self.debuglevel > 0:
895 print('connect:', (host, port), file=stderr)
Senthil Kumaran3d23fd62011-07-30 10:56:50 +0800896 new_socket = socket.create_connection((host, port), timeout,
897 self.source_address)
Christian Heimesa5768f72013-12-02 20:44:17 +0100898 server_hostname = self._host if ssl.HAS_SNI else None
899 new_socket = self.context.wrap_socket(new_socket,
900 server_hostname=server_hostname)
R. David Murray87e20742009-05-23 01:30:26 +0000901 return new_socket
Thomas Wouters47b49bf2007-08-30 22:15:33 +0000902
903 __all__.append("SMTP_SSL")
Barry Warsaw4c4bec81998-12-22 03:02:20 +0000904
Guido van Rossumd8faa362007-04-27 19:54:29 +0000905#
906# LMTP extension
907#
908LMTP_PORT = 2003
909
910class LMTP(SMTP):
911 """LMTP - Local Mail Transfer Protocol
912
913 The LMTP protocol, which is very similar to ESMTP, is heavily based
R David Murray021362d2013-06-23 16:05:44 -0400914 on the standard SMTP client. It's common to use Unix sockets for
915 LMTP, so our connect() method must support that as well as a regular
R David Murray36beb662013-06-23 15:47:50 -0400916 host:port server. local_hostname and source_address have the same
R David Murray021362d2013-06-23 16:05:44 -0400917 meaning as they do in the SMTP class. To specify a Unix socket,
918 you must use an absolute path as the host, starting with a '/'.
Guido van Rossumd8faa362007-04-27 19:54:29 +0000919
920 Authentication is supported, using the regular SMTP mechanism. When
921 using a Unix socket, LMTP generally don't support or require any
922 authentication, but your mileage might vary."""
923
924 ehlo_msg = "lhlo"
925
Senthil Kumaran3d23fd62011-07-30 10:56:50 +0800926 def __init__(self, host='', port=LMTP_PORT, local_hostname=None,
927 source_address=None):
Guido van Rossumd8faa362007-04-27 19:54:29 +0000928 """Initialize a new instance."""
Senthil Kumaranb351a482011-07-31 09:14:17 +0800929 SMTP.__init__(self, host, port, local_hostname=local_hostname,
930 source_address=source_address)
Guido van Rossumd8faa362007-04-27 19:54:29 +0000931
Senthil Kumaran3d23fd62011-07-30 10:56:50 +0800932 def connect(self, host='localhost', port=0, source_address=None):
Guido van Rossumd8faa362007-04-27 19:54:29 +0000933 """Connect to the LMTP daemon, on either a Unix or a TCP socket."""
934 if host[0] != '/':
Senthil Kumaranb351a482011-07-31 09:14:17 +0800935 return SMTP.connect(self, host, port, source_address=source_address)
Guido van Rossumd8faa362007-04-27 19:54:29 +0000936
937 # Handle Unix-domain sockets.
938 try:
939 self.sock = socket.socket(socket.AF_UNIX, socket.SOCK_STREAM)
Antoine Pitrouf068ab82011-06-06 19:17:09 +0200940 self.file = None
Guido van Rossumd8faa362007-04-27 19:54:29 +0000941 self.sock.connect(host)
Andrew Svetlov2ade6f22012-12-17 18:57:16 +0200942 except OSError:
Giampaolo Rodolàbd258bd2011-02-22 15:56:20 +0000943 if self.debuglevel > 0:
944 print('connect fail:', host, file=stderr)
Guido van Rossumd8faa362007-04-27 19:54:29 +0000945 if self.sock:
946 self.sock.close()
947 self.sock = None
Andrew Svetlovb6693c42012-12-17 18:54:53 +0200948 raise
Guido van Rossumd8faa362007-04-27 19:54:29 +0000949 (code, msg) = self.getreply()
Giampaolo Rodolàbd258bd2011-02-22 15:56:20 +0000950 if self.debuglevel > 0:
951 print('connect:', msg, file=stderr)
Guido van Rossumd8faa362007-04-27 19:54:29 +0000952 return (code, msg)
953
954
Guido van Rossum95e6f701998-06-25 02:15:50 +0000955# Test the sendmail method, which tests most of the others.
956# Note: This always sends to localhost.
957if __name__ == '__main__':
Andrew M. Kuchling6be424f2001-08-13 14:41:39 +0000958 import sys
Guido van Rossum95e6f701998-06-25 02:15:50 +0000959
960 def prompt(prompt):
961 sys.stdout.write(prompt + ": ")
Ezio Melotti6bfecd12011-10-18 13:20:07 +0300962 sys.stdout.flush()
Eric S. Raymondc013f302001-02-09 05:40:38 +0000963 return sys.stdin.readline().strip()
Guido van Rossum95e6f701998-06-25 02:15:50 +0000964
965 fromaddr = prompt("From")
Giampaolo Rodolàbd258bd2011-02-22 15:56:20 +0000966 toaddrs = prompt("To").split(',')
Guido van Rossumbe19ed72007-02-09 05:37:30 +0000967 print("Enter message, end with ^D:")
Guido van Rossum95e6f701998-06-25 02:15:50 +0000968 msg = ''
969 while 1:
970 line = sys.stdin.readline()
971 if not line:
972 break
973 msg = msg + line
Guido van Rossumbe19ed72007-02-09 05:37:30 +0000974 print("Message length is %d" % len(msg))
Guido van Rossum95e6f701998-06-25 02:15:50 +0000975
976 server = SMTP('localhost')
977 server.set_debuglevel(1)
978 server.sendmail(fromaddr, toaddrs, msg)
979 server.quit()