blob: 66b5879defdca1f3dec0839db6211d8d6541d313 [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"
Georg Brandlb38b5c42014-02-10 22:11:21 +010065_MAXLINE = 8192 # more than 8 times larger than RFC 821, 4.5.3
Guido van Rossumbbe323e1998-01-29 17:24:40 +000066
Piers Lauder385a77a2002-07-27 00:38:30 +000067OLDSTYLE_AUTH = re.compile(r"auth=(.*)", re.I)
68
Tim Peters495ad3c2001-01-15 01:36:40 +000069# Exception classes used by this module.
R David Murray8a345962013-04-14 06:46:35 -040070class SMTPException(OSError):
Guido van Rossum296e1431999-04-07 15:03:39 +000071 """Base class for all exceptions raised by this module."""
72
73class SMTPServerDisconnected(SMTPException):
74 """Not connected to any SMTP server.
75
76 This exception is raised when the server unexpectedly disconnects,
77 or when an attempt is made to use the SMTP instance before
78 connecting it to a server.
79 """
80
81class SMTPResponseException(SMTPException):
82 """Base class for all exceptions that include an SMTP error code.
83
84 These exceptions are generated in some instances when the SMTP
85 server returns an error code. The error code is stored in the
86 `smtp_code' attribute of the error, and the `smtp_error' attribute
87 is set to the error message.
88 """
89
90 def __init__(self, code, msg):
91 self.smtp_code = code
92 self.smtp_error = msg
93 self.args = (code, msg)
94
95class SMTPSenderRefused(SMTPResponseException):
96 """Sender address refused.
Guido van Rossumae010462001-09-11 15:57:46 +000097
Guido van Rossum296e1431999-04-07 15:03:39 +000098 In addition to the attributes set by on all SMTPResponseException
Barry Warsawd25c1b71999-11-28 17:11:06 +000099 exceptions, this sets `sender' to the string that the SMTP refused.
Guido van Rossum296e1431999-04-07 15:03:39 +0000100 """
101
102 def __init__(self, code, msg, sender):
103 self.smtp_code = code
104 self.smtp_error = msg
105 self.sender = sender
106 self.args = (code, msg, sender)
107
Guido van Rossum20c92281999-04-21 16:52:20 +0000108class SMTPRecipientsRefused(SMTPException):
Barry Warsawd25c1b71999-11-28 17:11:06 +0000109 """All recipient addresses refused.
Guido van Rossumae010462001-09-11 15:57:46 +0000110
Thomas Wouters7e474022000-07-16 12:04:32 +0000111 The errors for each recipient are accessible through the attribute
Tim Peters495ad3c2001-01-15 01:36:40 +0000112 'recipients', which is a dictionary of exactly the same sort as
113 SMTP.sendmail() returns.
Guido van Rossum296e1431999-04-07 15:03:39 +0000114 """
115
116 def __init__(self, recipients):
117 self.recipients = recipients
Giampaolo Rodolàbd258bd2011-02-22 15:56:20 +0000118 self.args = (recipients,)
Guido van Rossum296e1431999-04-07 15:03:39 +0000119
120
Guido van Rossum296e1431999-04-07 15:03:39 +0000121class SMTPDataError(SMTPResponseException):
122 """The SMTP server didn't accept the data."""
123
124class SMTPConnectError(SMTPResponseException):
Barry Warsawd25c1b71999-11-28 17:11:06 +0000125 """Error during connection establishment."""
Guido van Rossum296e1431999-04-07 15:03:39 +0000126
127class SMTPHeloError(SMTPResponseException):
Barry Warsawd25c1b71999-11-28 17:11:06 +0000128 """The server refused our HELO reply."""
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000129
Guido van Rossumae010462001-09-11 15:57:46 +0000130class SMTPAuthenticationError(SMTPResponseException):
131 """Authentication error.
132
133 Most probably the server didn't accept the username/password
134 combination provided.
135 """
Peter Schneider-Kamp7bc82bb2000-08-10 14:02:23 +0000136
R David Murray4c14bba2011-07-18 21:59:53 -0400137def quoteaddr(addrstring):
Guido van Rossum69a79bc1998-07-13 15:18:49 +0000138 """Quote a subset of the email addresses defined by RFC 821.
139
Georg Brandl9f0f9602008-06-12 22:23:59 +0000140 Should be able to handle anything email.utils.parseaddr can handle.
Barry Warsawa7d9bdf1998-12-22 03:24:27 +0000141 """
R David Murray4c14bba2011-07-18 21:59:53 -0400142 displayname, addr = email.utils.parseaddr(addrstring)
143 if (displayname, addr) == ('', ''):
144 # parseaddr couldn't parse it, use it as is and hope for the best.
145 if addrstring.strip().startswith('<'):
146 return addrstring
147 return "<%s>" % addrstring
148 return "<%s>" % addr
Guido van Rossum69a79bc1998-07-13 15:18:49 +0000149
R David Murray46346762011-07-18 21:38:54 -0400150def _addr_only(addrstring):
151 displayname, addr = email.utils.parseaddr(addrstring)
152 if (displayname, addr) == ('', ''):
153 # parseaddr couldn't parse it, so use it as is.
154 return addrstring
155 return addr
156
R. David Murray7dff9e02010-11-08 17:15:13 +0000157# Legacy method kept for backward compatibility.
Guido van Rossum69a79bc1998-07-13 15:18:49 +0000158def quotedata(data):
159 """Quote data for email.
160
Barry Warsawd25c1b71999-11-28 17:11:06 +0000161 Double leading '.', and change Unix newline '\\n', or Mac '\\r' into
Barry Warsawa7d9bdf1998-12-22 03:24:27 +0000162 Internet CRLF end-of-line.
163 """
Guido van Rossum69a79bc1998-07-13 15:18:49 +0000164 return re.sub(r'(?m)^\.', '..',
Guido van Rossumfcfb6321998-08-04 15:29:54 +0000165 re.sub(r'(?:\r\n|\n|\r(?!\n))', CRLF, data))
Guido van Rossum69a79bc1998-07-13 15:18:49 +0000166
R. David Murray7dff9e02010-11-08 17:15:13 +0000167def _quote_periods(bindata):
R David Murray0f663d02011-06-09 15:05:57 -0400168 return re.sub(br'(?m)^\.', b'..', bindata)
R. David Murray7dff9e02010-11-08 17:15:13 +0000169
170def _fix_eols(data):
171 return re.sub(r'(?:\r\n|\n|\r(?!\n))', CRLF, data)
172
Thomas Wouters47b49bf2007-08-30 22:15:33 +0000173try:
174 import ssl
Brett Cannoncd171c82013-07-04 17:43:24 -0400175except ImportError:
Thomas Wouters47b49bf2007-08-30 22:15:33 +0000176 _have_ssl = False
177else:
Thomas Wouters47b49bf2007-08-30 22:15:33 +0000178 _have_ssl = True
179
Peter Schneider-Kamp7bc82bb2000-08-10 14:02:23 +0000180
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000181class SMTP:
Guido van Rossumfcfb6321998-08-04 15:29:54 +0000182 """This class manages a connection to an SMTP or ESMTP server.
183 SMTP Objects:
Tim Peters495ad3c2001-01-15 01:36:40 +0000184 SMTP objects have the following attributes:
185 helo_resp
186 This is the message given by the server in response to the
Guido van Rossumfcfb6321998-08-04 15:29:54 +0000187 most recent HELO command.
Tim Peters495ad3c2001-01-15 01:36:40 +0000188
Guido van Rossumfcfb6321998-08-04 15:29:54 +0000189 ehlo_resp
Tim Peters495ad3c2001-01-15 01:36:40 +0000190 This is the message given by the server in response to the
Guido van Rossumfcfb6321998-08-04 15:29:54 +0000191 most recent EHLO command. This is usually multiline.
192
Tim Peters495ad3c2001-01-15 01:36:40 +0000193 does_esmtp
Guido van Rossumfcfb6321998-08-04 15:29:54 +0000194 This is a True value _after you do an EHLO command_, if the
195 server supports ESMTP.
196
Tim Peters495ad3c2001-01-15 01:36:40 +0000197 esmtp_features
Guido van Rossumfcfb6321998-08-04 15:29:54 +0000198 This is a dictionary, which, if the server supports ESMTP,
Barry Warsawd25c1b71999-11-28 17:11:06 +0000199 will _after you do an EHLO command_, contain the names of the
200 SMTP service extensions this server supports, and their
Guido van Rossumfcfb6321998-08-04 15:29:54 +0000201 parameters (if any).
Barry Warsawd25c1b71999-11-28 17:11:06 +0000202
Tim Peters495ad3c2001-01-15 01:36:40 +0000203 Note, all extension names are mapped to lower case in the
204 dictionary.
Guido van Rossumfcfb6321998-08-04 15:29:54 +0000205
Barry Warsawd25c1b71999-11-28 17:11:06 +0000206 See each method's docstrings for details. In general, there is a
207 method of the same name to perform each SMTP command. There is also a
208 method called 'sendmail' that will do an entire mail transaction.
209 """
Guido van Rossum95e6f701998-06-25 02:15:50 +0000210 debuglevel = 0
211 file = None
212 helo_resp = None
Guido van Rossumd8faa362007-04-27 19:54:29 +0000213 ehlo_msg = "ehlo"
Guido van Rossum95e6f701998-06-25 02:15:50 +0000214 ehlo_resp = None
Guido van Rossumfcfb6321998-08-04 15:29:54 +0000215 does_esmtp = 0
Antoine Pitrouc1d52062011-05-07 19:39:37 +0200216 default_port = SMTP_PORT
Guido van Rossum95e6f701998-06-25 02:15:50 +0000217
Georg Brandlf78e02b2008-06-10 17:40:04 +0000218 def __init__(self, host='', port=0, local_hostname=None,
Senthil Kumaran3d23fd62011-07-30 10:56:50 +0800219 timeout=socket._GLOBAL_DEFAULT_TIMEOUT,
220 source_address=None):
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000221 """Initialize a new instance.
222
Barry Warsawa7d9bdf1998-12-22 03:24:27 +0000223 If specified, `host' is the name of the remote host to which to
224 connect. If specified, `port' specifies the port to which to connect.
R David Murray14ee3cf2013-04-13 14:40:33 -0400225 By default, smtplib.SMTP_PORT is used. If a host is specified the
R David Murray021362d2013-06-23 16:05:44 -0400226 connect method is called, and if it returns anything other than a
227 success code an SMTPConnectError is raised. If specified,
228 `local_hostname` is used as the FQDN of the local host in the HELO/EHLO
229 command. Otherwise, the local hostname is found using
230 socket.getfqdn(). The `source_address` parameter takes a 2-tuple (host,
231 port) for the socket to bind to as its source address before
232 connecting. If the host is '' and port is 0, the OS default behavior
233 will be used.
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000234
235 """
Christian Heimesa5768f72013-12-02 20:44:17 +0100236 self._host = host
Guido van Rossumd8faa362007-04-27 19:54:29 +0000237 self.timeout = timeout
Guido van Rossumfcfb6321998-08-04 15:29:54 +0000238 self.esmtp_features = {}
Senthil Kumaran3d23fd62011-07-30 10:56:50 +0800239 self.source_address = source_address
240
Guido van Rossum296e1431999-04-07 15:03:39 +0000241 if host:
242 (code, msg) = self.connect(host, port)
243 if code != 220:
244 raise SMTPConnectError(code, msg)
Raymond Hettingerf13eb552002-06-02 00:40:05 +0000245 if local_hostname is not None:
Barry Warsaw13e34f72002-03-26 20:27:35 +0000246 self.local_hostname = local_hostname
Neil Schemenauer6730f262002-03-24 15:30:40 +0000247 else:
Barry Warsaw13e34f72002-03-26 20:27:35 +0000248 # RFC 2821 says we should use the fqdn in the EHLO/HELO verb, and
249 # if that can't be calculated, that we should use a domain literal
250 # instead (essentially an encoded IP address like [A.B.C.D]).
251 fqdn = socket.getfqdn()
252 if '.' in fqdn:
253 self.local_hostname = fqdn
254 else:
255 # We can't find an fqdn hostname, so use a domain literal
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000256 addr = '127.0.0.1'
257 try:
258 addr = socket.gethostbyname(socket.gethostname())
259 except socket.gaierror:
260 pass
Barry Warsaw13e34f72002-03-26 20:27:35 +0000261 self.local_hostname = '[%s]' % addr
Tim Peters495ad3c2001-01-15 01:36:40 +0000262
Barry Warsaw1f5c9582011-03-15 15:04:44 -0400263 def __enter__(self):
264 return self
265
266 def __exit__(self, *args):
267 try:
268 code, message = self.docmd("QUIT")
269 if code != 221:
270 raise SMTPResponseException(code, message)
271 except SMTPServerDisconnected:
272 pass
273 finally:
274 self.close()
275
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000276 def set_debuglevel(self, debuglevel):
277 """Set the debug output level.
278
Barry Warsawa7d9bdf1998-12-22 03:24:27 +0000279 A non-false value results in debug messages for connection and for all
280 messages sent to and received from the server.
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000281
282 """
283 self.debuglevel = debuglevel
284
Barry Warsawc9181712008-03-19 14:25:51 +0000285 def _get_socket(self, host, port, timeout):
Thomas Wouters89f507f2006-12-13 04:49:30 +0000286 # This makes it simpler for SMTP_SSL to use the SMTP connect code
287 # and just alter the socket connection bit.
Giampaolo Rodolàbd258bd2011-02-22 15:56:20 +0000288 if self.debuglevel > 0:
Senthil Kumaranb351a482011-07-31 09:14:17 +0800289 print('connect: to', (host, port), self.source_address,
290 file=stderr)
Senthil Kumaran3d23fd62011-07-30 10:56:50 +0800291 return socket.create_connection((host, port), timeout,
292 self.source_address)
Thomas Wouters89f507f2006-12-13 04:49:30 +0000293
Senthil Kumaran3d23fd62011-07-30 10:56:50 +0800294 def connect(self, host='localhost', port=0, source_address=None):
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000295 """Connect to a host on a given port.
Guido van Rossum95e6f701998-06-25 02:15:50 +0000296
Barry Warsaw4c4bec81998-12-22 03:02:20 +0000297 If the hostname ends with a colon (`:') followed by a number, and
298 there is no port specified, that suffix will be stripped off and the
299 number interpreted as the port number to use.
Guido van Rossum95e6f701998-06-25 02:15:50 +0000300
Barry Warsawa7d9bdf1998-12-22 03:24:27 +0000301 Note: This method is automatically invoked by __init__, if a host is
302 specified during instantiation.
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000303
304 """
Senthil Kumaranb351a482011-07-31 09:14:17 +0800305
306 if source_address:
307 self.source_address = source_address
308
Martin v. Löwis4eb59402001-07-26 13:37:33 +0000309 if not port and (host.find(':') == host.rfind(':')):
Martin v. Löwisa43c2f82001-07-24 20:34:08 +0000310 i = host.rfind(':')
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000311 if i >= 0:
Giampaolo Rodolàbd258bd2011-02-22 15:56:20 +0000312 host, port = host[:i], host[i + 1:]
313 try:
314 port = int(port)
Eric S. Raymond8d876032001-02-09 10:14:53 +0000315 except ValueError:
Andrew Svetlov2ade6f22012-12-17 18:57:16 +0200316 raise OSError("nonnumeric port")
Giampaolo Rodolàbd258bd2011-02-22 15:56:20 +0000317 if not port:
318 port = self.default_port
319 if self.debuglevel > 0:
320 print('connect:', (host, port), file=stderr)
Guido van Rossumd8faa362007-04-27 19:54:29 +0000321 self.sock = self._get_socket(host, port, self.timeout)
Antoine Pitrouf068ab82011-06-06 19:17:09 +0200322 self.file = None
Martin v. Löwisa43c2f82001-07-24 20:34:08 +0000323 (code, msg) = self.getreply()
Giampaolo Rodolàbd258bd2011-02-22 15:56:20 +0000324 if self.debuglevel > 0:
325 print("connect:", msg, file=stderr)
Martin v. Löwisa43c2f82001-07-24 20:34:08 +0000326 return (code, msg)
Tim Peters495ad3c2001-01-15 01:36:40 +0000327
Guido van Rossum8a392d72007-11-21 22:09:45 +0000328 def send(self, s):
329 """Send `s' to the server."""
Giampaolo Rodolàbd258bd2011-02-22 15:56:20 +0000330 if self.debuglevel > 0:
331 print('send:', repr(s), file=stderr)
Christian Heimes90c3d9b2008-02-23 13:18:03 +0000332 if hasattr(self, 'sock') and self.sock:
Guido van Rossum8a392d72007-11-21 22:09:45 +0000333 if isinstance(s, str):
334 s = s.encode("ascii")
Guido van Rossum2880f6e1998-08-10 20:07:00 +0000335 try:
Guido van Rossum8a392d72007-11-21 22:09:45 +0000336 self.sock.sendall(s)
Andrew Svetlov2ade6f22012-12-17 18:57:16 +0200337 except OSError:
Barry Warsaw76750972001-12-14 20:34:20 +0000338 self.close()
Guido van Rossum40233ea1999-01-15 03:23:55 +0000339 raise SMTPServerDisconnected('Server not connected')
Guido van Rossumfc40a831998-01-29 17:26:45 +0000340 else:
Guido van Rossum40233ea1999-01-15 03:23:55 +0000341 raise SMTPServerDisconnected('please run connect() first')
Tim Peters495ad3c2001-01-15 01:36:40 +0000342
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000343 def putcmd(self, cmd, args=""):
Barry Warsawa7d9bdf1998-12-22 03:24:27 +0000344 """Send a command to the server."""
Guido van Rossumdb23d3d1999-06-09 15:13:10 +0000345 if args == "":
346 str = '%s%s' % (cmd, CRLF)
347 else:
348 str = '%s %s%s' % (cmd, args, CRLF)
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000349 self.send(str)
Tim Peters495ad3c2001-01-15 01:36:40 +0000350
Guido van Rossumfcfb6321998-08-04 15:29:54 +0000351 def getreply(self):
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000352 """Get a reply from the server.
Tim Peters495ad3c2001-01-15 01:36:40 +0000353
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000354 Returns a tuple consisting of:
Barry Warsawa7d9bdf1998-12-22 03:24:27 +0000355
356 - server response code (e.g. '250', or such, if all goes well)
357 Note: returns -1 if it can't read response code.
358
359 - server response string corresponding to response code (multiline
360 responses are converted to a single, multiline string).
Guido van Rossumf123f841999-03-29 20:33:21 +0000361
362 Raises SMTPServerDisconnected if end-of-file is reached.
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000363 """
Giampaolo Rodolàbd258bd2011-02-22 15:56:20 +0000364 resp = []
Guido van Rossum296e1431999-04-07 15:03:39 +0000365 if self.file is None:
366 self.file = self.sock.makefile('rb')
Guido van Rossum45e2fbc1998-03-26 21:13:24 +0000367 while 1:
Benjamin Petersone1cdfd72009-01-18 21:02:37 +0000368 try:
Georg Brandlb38b5c42014-02-10 22:11:21 +0100369 line = self.file.readline(_MAXLINE + 1)
Andrew Svetlov2ade6f22012-12-17 18:57:16 +0200370 except OSError as e:
Antoine Pitrou6b2e1602011-08-28 01:20:42 +0200371 self.close()
372 raise SMTPServerDisconnected("Connection unexpectedly closed: "
373 + str(e))
Guido van Rossum806c2462007-08-06 23:33:07 +0000374 if not line:
Guido van Rossum296e1431999-04-07 15:03:39 +0000375 self.close()
376 raise SMTPServerDisconnected("Connection unexpectedly closed")
Giampaolo Rodolàbd258bd2011-02-22 15:56:20 +0000377 if self.debuglevel > 0:
378 print('reply:', repr(line), file=stderr)
Georg Brandlb38b5c42014-02-10 22:11:21 +0100379 if len(line) > _MAXLINE:
380 raise SMTPResponseException(500, "Line too long.")
Guido van Rossum806c2462007-08-06 23:33:07 +0000381 resp.append(line[4:].strip(b' \t\r\n'))
Giampaolo Rodolàbd258bd2011-02-22 15:56:20 +0000382 code = line[:3]
Guido van Rossum296e1431999-04-07 15:03:39 +0000383 # Check that the error code is syntactically correct.
384 # Don't attempt to read a continuation line if it is broken.
385 try:
Eric S. Raymondc013f302001-02-09 05:40:38 +0000386 errcode = int(code)
Guido van Rossum296e1431999-04-07 15:03:39 +0000387 except ValueError:
388 errcode = -1
389 break
Guido van Rossumf123f841999-03-29 20:33:21 +0000390 # Check if multiline response.
Guido van Rossum806c2462007-08-06 23:33:07 +0000391 if line[3:4] != b"-":
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000392 break
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000393
Guido van Rossumc43e79f2007-06-18 18:26:36 +0000394 errmsg = b"\n".join(resp)
Tim Peters495ad3c2001-01-15 01:36:40 +0000395 if self.debuglevel > 0:
Senthil Kumaranb351a482011-07-31 09:14:17 +0800396 print('reply: retcode (%s); Msg: %s' % (errcode, errmsg),
397 file=stderr)
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000398 return errcode, errmsg
Tim Peters495ad3c2001-01-15 01:36:40 +0000399
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000400 def docmd(self, cmd, args=""):
Barry Warsawa7d9bdf1998-12-22 03:24:27 +0000401 """Send a command, and return its response code."""
Giampaolo Rodolàbd258bd2011-02-22 15:56:20 +0000402 self.putcmd(cmd, args)
Guido van Rossum296e1431999-04-07 15:03:39 +0000403 return self.getreply()
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000404
Barry Warsawa7d9bdf1998-12-22 03:24:27 +0000405 # std smtp commands
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000406 def helo(self, name=''):
Barry Warsawa7d9bdf1998-12-22 03:24:27 +0000407 """SMTP 'helo' command.
408 Hostname to send for this command defaults to the FQDN of the local
409 host.
410 """
Neil Schemenauer6730f262002-03-24 15:30:40 +0000411 self.putcmd("helo", name or self.local_hostname)
Giampaolo Rodolàbd258bd2011-02-22 15:56:20 +0000412 (code, msg) = self.getreply()
413 self.helo_resp = msg
414 return (code, msg)
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000415
Guido van Rossum95e6f701998-06-25 02:15:50 +0000416 def ehlo(self, name=''):
Barry Warsawa7d9bdf1998-12-22 03:24:27 +0000417 """ SMTP 'ehlo' command.
418 Hostname to send for this command defaults to the FQDN of the local
419 host.
420 """
Guido van Rossumf7fcf5e2001-09-14 16:08:44 +0000421 self.esmtp_features = {}
Guido van Rossumd8faa362007-04-27 19:54:29 +0000422 self.putcmd(self.ehlo_msg, name or self.local_hostname)
Giampaolo Rodolàbd258bd2011-02-22 15:56:20 +0000423 (code, msg) = self.getreply()
Tim Peters495ad3c2001-01-15 01:36:40 +0000424 # According to RFC1869 some (badly written)
425 # MTA's will disconnect on an ehlo. Toss an exception if
Guido van Rossumfcfb6321998-08-04 15:29:54 +0000426 # that happens -ddm
427 if code == -1 and len(msg) == 0:
Barry Warsaw76750972001-12-14 20:34:20 +0000428 self.close()
Guido van Rossum40233ea1999-01-15 03:23:55 +0000429 raise SMTPServerDisconnected("Server not connected")
Giampaolo Rodolàbd258bd2011-02-22 15:56:20 +0000430 self.ehlo_resp = msg
Fred Drake8152d322000-12-12 23:20:45 +0000431 if code != 250:
Giampaolo Rodolàbd258bd2011-02-22 15:56:20 +0000432 return (code, msg)
433 self.does_esmtp = 1
Thomas Wouters7e474022000-07-16 12:04:32 +0000434 #parse the ehlo response -ddm
Guido van Rossum04110fb2007-08-24 16:32:05 +0000435 assert isinstance(self.ehlo_resp, bytes), repr(self.ehlo_resp)
Giampaolo Rodolàbd258bd2011-02-22 15:56:20 +0000436 resp = self.ehlo_resp.decode("latin-1").split('\n')
Guido van Rossumfcfb6321998-08-04 15:29:54 +0000437 del resp[0]
Guido van Rossum2880f6e1998-08-10 20:07:00 +0000438 for each in resp:
Piers Lauder385a77a2002-07-27 00:38:30 +0000439 # To be able to communicate with as many SMTP servers as possible,
440 # we have to take the old-style auth advertisement into account,
441 # because:
442 # 1) Else our SMTP feature parser gets confused.
443 # 2) There are some servers that only advertise the auth methods we
444 # support using the old style.
445 auth_match = OLDSTYLE_AUTH.match(each)
446 if auth_match:
447 # This doesn't remove duplicates, but that's no problem
448 self.esmtp_features["auth"] = self.esmtp_features.get("auth", "") \
449 + " " + auth_match.groups(0)[0]
450 continue
451
Barry Warsawbe22ae62002-04-15 20:03:30 +0000452 # RFC 1869 requires a space between ehlo keyword and parameters.
453 # It's actually stricter, in that only spaces are allowed between
454 # parameters, but were not going to check for that here. Note
455 # that the space isn't present if there are no parameters.
Giampaolo Rodolàbd258bd2011-02-22 15:56:20 +0000456 m = re.match(r'(?P<feature>[A-Za-z0-9][A-Za-z0-9\-]*) ?', each)
Guido van Rossumfcfb6321998-08-04 15:29:54 +0000457 if m:
Giampaolo Rodolàbd258bd2011-02-22 15:56:20 +0000458 feature = m.group("feature").lower()
459 params = m.string[m.end("feature"):].strip()
Piers Lauder385a77a2002-07-27 00:38:30 +0000460 if feature == "auth":
461 self.esmtp_features[feature] = self.esmtp_features.get(feature, "") \
462 + " " + params
463 else:
Giampaolo Rodolàbd258bd2011-02-22 15:56:20 +0000464 self.esmtp_features[feature] = params
465 return (code, msg)
Guido van Rossum95e6f701998-06-25 02:15:50 +0000466
Guido van Rossumfcfb6321998-08-04 15:29:54 +0000467 def has_extn(self, opt):
468 """Does the server support a given SMTP service extension?"""
Raymond Hettinger54f02222002-06-01 14:18:47 +0000469 return opt.lower() in self.esmtp_features
Guido van Rossum95e6f701998-06-25 02:15:50 +0000470
Guido van Rossum18586f41998-04-03 17:03:13 +0000471 def help(self, args=''):
Barry Warsawa7d9bdf1998-12-22 03:24:27 +0000472 """SMTP 'help' command.
473 Returns help text from server."""
Guido van Rossum18586f41998-04-03 17:03:13 +0000474 self.putcmd("help", args)
Kurt B. Kaiser58bd1902005-06-26 18:27:36 +0000475 return self.getreply()[1]
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000476
477 def rset(self):
Barry Warsawa7d9bdf1998-12-22 03:24:27 +0000478 """SMTP 'rset' command -- resets session."""
Guido van Rossum296e1431999-04-07 15:03:39 +0000479 return self.docmd("rset")
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000480
481 def noop(self):
Barry Warsawa7d9bdf1998-12-22 03:24:27 +0000482 """SMTP 'noop' command -- doesn't do anything :>"""
Guido van Rossum296e1431999-04-07 15:03:39 +0000483 return self.docmd("noop")
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000484
Giampaolo Rodolàbd258bd2011-02-22 15:56:20 +0000485 def mail(self, sender, options=[]):
Barry Warsawa7d9bdf1998-12-22 03:24:27 +0000486 """SMTP 'mail' command -- begins mail xfer session."""
Guido van Rossumfcfb6321998-08-04 15:29:54 +0000487 optionlist = ''
488 if options and self.does_esmtp:
Eric S. Raymondc013f302001-02-09 05:40:38 +0000489 optionlist = ' ' + ' '.join(options)
Giampaolo Rodolàbd258bd2011-02-22 15:56:20 +0000490 self.putcmd("mail", "FROM:%s%s" % (quoteaddr(sender), optionlist))
Guido van Rossum45e2fbc1998-03-26 21:13:24 +0000491 return self.getreply()
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000492
Giampaolo Rodolàbd258bd2011-02-22 15:56:20 +0000493 def rcpt(self, recip, options=[]):
Barry Warsawa7d9bdf1998-12-22 03:24:27 +0000494 """SMTP 'rcpt' command -- indicates 1 recipient for this mail."""
Guido van Rossumfcfb6321998-08-04 15:29:54 +0000495 optionlist = ''
496 if options and self.does_esmtp:
Eric S. Raymondc013f302001-02-09 05:40:38 +0000497 optionlist = ' ' + ' '.join(options)
Giampaolo Rodolàbd258bd2011-02-22 15:56:20 +0000498 self.putcmd("rcpt", "TO:%s%s" % (quoteaddr(recip), optionlist))
Guido van Rossum45e2fbc1998-03-26 21:13:24 +0000499 return self.getreply()
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000500
Giampaolo Rodolàbd258bd2011-02-22 15:56:20 +0000501 def data(self, msg):
Tim Peters495ad3c2001-01-15 01:36:40 +0000502 """SMTP 'DATA' command -- sends message data to server.
Guido van Rossum296e1431999-04-07 15:03:39 +0000503
Barry Warsaw4c4bec81998-12-22 03:02:20 +0000504 Automatically quotes lines beginning with a period per rfc821.
Guido van Rossum296e1431999-04-07 15:03:39 +0000505 Raises SMTPDataError if there is an unexpected reply to the
506 DATA command; the return value from this method is the final
R. David Murray7dff9e02010-11-08 17:15:13 +0000507 response code received when the all data is sent. If msg
508 is a string, lone '\r' and '\n' characters are converted to
509 '\r\n' characters. If msg is bytes, it is transmitted as is.
Barry Warsaw4c4bec81998-12-22 03:02:20 +0000510 """
Guido van Rossum45e2fbc1998-03-26 21:13:24 +0000511 self.putcmd("data")
Giampaolo Rodolàbd258bd2011-02-22 15:56:20 +0000512 (code, repl) = self.getreply()
513 if self.debuglevel > 0:
514 print("data:", (code, repl), file=stderr)
Fred Drake8152d322000-12-12 23:20:45 +0000515 if code != 354:
Giampaolo Rodolàbd258bd2011-02-22 15:56:20 +0000516 raise SMTPDataError(code, repl)
Guido van Rossum45e2fbc1998-03-26 21:13:24 +0000517 else:
R. David Murray7dff9e02010-11-08 17:15:13 +0000518 if isinstance(msg, str):
519 msg = _fix_eols(msg).encode('ascii')
520 q = _quote_periods(msg)
521 if q[-2:] != bCRLF:
522 q = q + bCRLF
523 q = q + b"." + bCRLF
Guido van Rossum20c92281999-04-21 16:52:20 +0000524 self.send(q)
Giampaolo Rodolàbd258bd2011-02-22 15:56:20 +0000525 (code, msg) = self.getreply()
526 if self.debuglevel > 0:
527 print("data:", (code, msg), file=stderr)
528 return (code, msg)
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000529
Guido van Rossumfcfb6321998-08-04 15:29:54 +0000530 def verify(self, address):
Barry Warsawa7d9bdf1998-12-22 03:24:27 +0000531 """SMTP 'verify' command -- checks for address validity."""
R David Murray46346762011-07-18 21:38:54 -0400532 self.putcmd("vrfy", _addr_only(address))
Guido van Rossumfcfb6321998-08-04 15:29:54 +0000533 return self.getreply()
Barry Warsaw4c4bec81998-12-22 03:02:20 +0000534 # a.k.a.
Giampaolo Rodolàbd258bd2011-02-22 15:56:20 +0000535 vrfy = verify
Guido van Rossumfcfb6321998-08-04 15:29:54 +0000536
537 def expn(self, address):
Christian Heimes90c3d9b2008-02-23 13:18:03 +0000538 """SMTP 'expn' command -- expands a mailing list."""
R David Murray46346762011-07-18 21:38:54 -0400539 self.putcmd("expn", _addr_only(address))
Guido van Rossumfcfb6321998-08-04 15:29:54 +0000540 return self.getreply()
541
Barry Warsaw4c4bec81998-12-22 03:02:20 +0000542 # some useful methods
Guido van Rossumae010462001-09-11 15:57:46 +0000543
Christian Heimes679db4a2008-01-18 09:56:22 +0000544 def ehlo_or_helo_if_needed(self):
545 """Call self.ehlo() and/or self.helo() if needed.
546
547 If there has been no previous EHLO or HELO command this session, this
548 method tries ESMTP EHLO first.
549
550 This method may raise the following exceptions:
551
552 SMTPHeloError The server didn't reply properly to
553 the helo greeting.
554 """
555 if self.helo_resp is None and self.ehlo_resp is None:
556 if not (200 <= self.ehlo()[0] <= 299):
557 (code, resp) = self.helo()
558 if not (200 <= code <= 299):
559 raise SMTPHeloError(code, resp)
560
Guido van Rossumae010462001-09-11 15:57:46 +0000561 def login(self, user, password):
562 """Log in on an SMTP server that requires authentication.
563
564 The arguments are:
565 - user: The user name to authenticate with.
566 - password: The password for the authentication.
567
568 If there has been no previous EHLO or HELO command this session, this
569 method tries ESMTP EHLO first.
570
571 This method will return normally if the authentication was successful.
572
573 This method may raise the following exceptions:
574
575 SMTPHeloError The server didn't reply properly to
576 the helo greeting.
577 SMTPAuthenticationError The server didn't accept the username/
578 password combination.
Fred Drake2f8f4d32001-10-13 18:35:32 +0000579 SMTPException No suitable authentication method was
Guido van Rossumae010462001-09-11 15:57:46 +0000580 found.
581 """
582
583 def encode_cram_md5(challenge, user, password):
Georg Brandl706824f2009-06-04 09:42:55 +0000584 challenge = base64.decodebytes(challenge)
R. David Murrayfb123912009-05-28 18:19:00 +0000585 response = user + " " + hmac.HMAC(password.encode('ascii'),
Christian Heimes634919a2013-11-20 17:23:06 +0100586 challenge, 'md5').hexdigest()
R. David Murrayfb123912009-05-28 18:19:00 +0000587 return encode_base64(response.encode('ascii'), eol='')
Guido van Rossumae010462001-09-11 15:57:46 +0000588
589 def encode_plain(user, password):
R. David Murraycaa27b72009-05-23 18:49:56 +0000590 s = "\0%s\0%s" % (user, password)
591 return encode_base64(s.encode('ascii'), eol='')
Tim Peters469cdad2002-08-08 20:19:19 +0000592
Guido van Rossumae010462001-09-11 15:57:46 +0000593 AUTH_PLAIN = "PLAIN"
594 AUTH_CRAM_MD5 = "CRAM-MD5"
Piers Lauder385a77a2002-07-27 00:38:30 +0000595 AUTH_LOGIN = "LOGIN"
Guido van Rossumae010462001-09-11 15:57:46 +0000596
Christian Heimes679db4a2008-01-18 09:56:22 +0000597 self.ehlo_or_helo_if_needed()
Guido van Rossumae010462001-09-11 15:57:46 +0000598
599 if not self.has_extn("auth"):
600 raise SMTPException("SMTP AUTH extension not supported by server.")
601
Gerhard Häring1c5471f2010-08-05 14:08:44 +0000602 # Authentication methods the server claims to support
603 advertised_authlist = self.esmtp_features["auth"].split()
Guido van Rossumae010462001-09-11 15:57:46 +0000604
605 # List of authentication methods we support: from preferred to
606 # less preferred methods. Except for the purpose of testing the weaker
607 # ones, we prefer stronger methods like CRAM-MD5:
Piers Lauder385a77a2002-07-27 00:38:30 +0000608 preferred_auths = [AUTH_CRAM_MD5, AUTH_PLAIN, AUTH_LOGIN]
Guido van Rossumae010462001-09-11 15:57:46 +0000609
Gerhard Häring1c5471f2010-08-05 14:08:44 +0000610 # We try the authentication methods the server advertises, but only the
611 # ones *we* support. And in our preferred order.
612 authlist = [auth for auth in preferred_auths if auth in advertised_authlist]
613 if not authlist:
Fred Drake2f8f4d32001-10-13 18:35:32 +0000614 raise SMTPException("No suitable authentication method found.")
Gerhard Häring1c5471f2010-08-05 14:08:44 +0000615
616 # Some servers advertise authentication methods they don't really
617 # support, so if authentication fails, we continue until we've tried
618 # all methods.
619 for authmethod in authlist:
620 if authmethod == AUTH_CRAM_MD5:
621 (code, resp) = self.docmd("AUTH", AUTH_CRAM_MD5)
622 if code == 334:
623 (code, resp) = self.docmd(encode_cram_md5(resp, user, password))
624 elif authmethod == AUTH_PLAIN:
625 (code, resp) = self.docmd("AUTH",
626 AUTH_PLAIN + " " + encode_plain(user, password))
627 elif authmethod == AUTH_LOGIN:
628 (code, resp) = self.docmd("AUTH",
629 "%s %s" % (AUTH_LOGIN, encode_base64(user.encode('ascii'), eol='')))
630 if code == 334:
631 (code, resp) = self.docmd(encode_base64(password.encode('ascii'), eol=''))
632
Guido van Rossumae010462001-09-11 15:57:46 +0000633 # 235 == 'Authentication successful'
634 # 503 == 'Error: already authenticated'
Gerhard Häring1c5471f2010-08-05 14:08:44 +0000635 if code in (235, 503):
636 return (code, resp)
637
638 # We could not login sucessfully. Return result of last attempt.
639 raise SMTPAuthenticationError(code, resp)
Guido van Rossumae010462001-09-11 15:57:46 +0000640
Antoine Pitroue0650202011-05-18 18:03:09 +0200641 def starttls(self, keyfile=None, certfile=None, context=None):
Guido van Rossumf7fcf5e2001-09-14 16:08:44 +0000642 """Puts the connection to the SMTP server into TLS mode.
Tim Petersb64bec32001-09-18 02:26:39 +0000643
Christian Heimes679db4a2008-01-18 09:56:22 +0000644 If there has been no previous EHLO or HELO command this session, this
645 method tries ESMTP EHLO first.
646
Guido van Rossumf7fcf5e2001-09-14 16:08:44 +0000647 If the server supports TLS, this will encrypt the rest of the SMTP
648 session. If you provide the keyfile and certfile parameters,
649 the identity of the SMTP server and client can be checked. This,
650 however, depends on whether the socket module really checks the
651 certificates.
Christian Heimes679db4a2008-01-18 09:56:22 +0000652
653 This method may raise the following exceptions:
654
655 SMTPHeloError The server didn't reply properly to
656 the helo greeting.
Guido van Rossumf7fcf5e2001-09-14 16:08:44 +0000657 """
Christian Heimes679db4a2008-01-18 09:56:22 +0000658 self.ehlo_or_helo_if_needed()
659 if not self.has_extn("starttls"):
660 raise SMTPException("STARTTLS extension not supported by server.")
Tim Petersb64bec32001-09-18 02:26:39 +0000661 (resp, reply) = self.docmd("STARTTLS")
Guido van Rossumf7fcf5e2001-09-14 16:08:44 +0000662 if resp == 220:
Thomas Wouters47b49bf2007-08-30 22:15:33 +0000663 if not _have_ssl:
664 raise RuntimeError("No SSL support included in this Python")
Antoine Pitroue0650202011-05-18 18:03:09 +0200665 if context is not None and keyfile is not None:
666 raise ValueError("context and keyfile arguments are mutually "
667 "exclusive")
668 if context is not None and certfile is not None:
669 raise ValueError("context and certfile arguments are mutually "
670 "exclusive")
Christian Heimes67986f92013-11-23 22:43:47 +0100671 if context is None:
672 context = ssl._create_stdlib_context(certfile=certfile,
673 keyfile=keyfile)
Christian Heimesa5768f72013-12-02 20:44:17 +0100674 server_hostname = self._host if ssl.HAS_SNI else None
675 self.sock = context.wrap_socket(self.sock,
676 server_hostname=server_hostname)
Antoine Pitrouf068ab82011-06-06 19:17:09 +0200677 self.file = None
Christian Heimes679db4a2008-01-18 09:56:22 +0000678 # RFC 3207:
679 # The client MUST discard any knowledge obtained from
680 # the server, such as the list of SMTP service extensions,
681 # which was not obtained from the TLS negotiation itself.
682 self.helo_resp = None
683 self.ehlo_resp = None
684 self.esmtp_features = {}
685 self.does_esmtp = 0
Guido van Rossumf7fcf5e2001-09-14 16:08:44 +0000686 return (resp, reply)
Tim Petersb64bec32001-09-18 02:26:39 +0000687
Jeremy Hylton31bb8ce1998-08-13 19:57:46 +0000688 def sendmail(self, from_addr, to_addrs, msg, mail_options=[],
Tim Peters495ad3c2001-01-15 01:36:40 +0000689 rcpt_options=[]):
690 """This command performs an entire mail transaction.
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000691
Tim Peters495ad3c2001-01-15 01:36:40 +0000692 The arguments are:
Barry Warsaw4c4bec81998-12-22 03:02:20 +0000693 - from_addr : The address sending this mail.
694 - to_addrs : A list of addresses to send this mail to. A bare
695 string will be treated as a list with 1 address.
Tim Peters495ad3c2001-01-15 01:36:40 +0000696 - msg : The message to send.
Barry Warsaw4c4bec81998-12-22 03:02:20 +0000697 - mail_options : List of ESMTP options (such as 8bitmime) for the
698 mail command.
699 - rcpt_options : List of ESMTP options (such as DSN commands) for
700 all the rcpt commands.
701
R. David Murray7dff9e02010-11-08 17:15:13 +0000702 msg may be a string containing characters in the ASCII range, or a byte
703 string. A string is encoded to bytes using the ascii codec, and lone
R David Murrayac4e5ab2011-07-02 21:03:19 -0400704 \\r and \\n characters are converted to \\r\\n characters.
R. David Murray7dff9e02010-11-08 17:15:13 +0000705
Barry Warsaw4c4bec81998-12-22 03:02:20 +0000706 If there has been no previous EHLO or HELO command this session, this
707 method tries ESMTP EHLO first. If the server does ESMTP, message size
708 and each of the specified options will be passed to it. If EHLO
709 fails, HELO will be tried and ESMTP options suppressed.
710
711 This method will return normally if the mail is accepted for at least
Barry Warsawd25c1b71999-11-28 17:11:06 +0000712 one recipient. It returns a dictionary, with one entry for each
713 recipient that was refused. Each entry contains a tuple of the SMTP
714 error code and the accompanying error message sent by the server.
Guido van Rossum296e1431999-04-07 15:03:39 +0000715
716 This method may raise the following exceptions:
717
718 SMTPHeloError The server didn't reply properly to
Tim Peters495ad3c2001-01-15 01:36:40 +0000719 the helo greeting.
Barry Warsawd25c1b71999-11-28 17:11:06 +0000720 SMTPRecipientsRefused The server rejected ALL recipients
Guido van Rossum296e1431999-04-07 15:03:39 +0000721 (no mail was sent).
722 SMTPSenderRefused The server didn't accept the from_addr.
723 SMTPDataError The server replied with an unexpected
724 error code (other than a refusal of
725 a recipient).
726
727 Note: the connection will be open even after an exception is raised.
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000728
Guido van Rossum95e6f701998-06-25 02:15:50 +0000729 Example:
Tim Peters495ad3c2001-01-15 01:36:40 +0000730
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000731 >>> import smtplib
732 >>> s=smtplib.SMTP("localhost")
Guido van Rossumfc40a831998-01-29 17:26:45 +0000733 >>> tolist=["one@one.org","two@two.org","three@three.org","four@four.org"]
Martin v. Löwis301b1cd2002-07-28 16:52:01 +0000734 >>> msg = '''\\
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000735 ... From: Me@my.org
736 ... Subject: testin'...
737 ...
738 ... This is a test '''
739 >>> s.sendmail("me@my.org",tolist,msg)
740 { "three@three.org" : ( 550 ,"User unknown" ) }
741 >>> s.quit()
Tim Peters495ad3c2001-01-15 01:36:40 +0000742
Barry Warsaw4c4bec81998-12-22 03:02:20 +0000743 In the above example, the message was accepted for delivery to three
744 of the four addresses, and one was rejected, with the error code
Barry Warsawd25c1b71999-11-28 17:11:06 +0000745 550. If all addresses are accepted, then the method will return an
Barry Warsaw4c4bec81998-12-22 03:02:20 +0000746 empty dictionary.
747
748 """
Christian Heimes679db4a2008-01-18 09:56:22 +0000749 self.ehlo_or_helo_if_needed()
Guido van Rossum95e6f701998-06-25 02:15:50 +0000750 esmtp_opts = []
R. David Murray7dff9e02010-11-08 17:15:13 +0000751 if isinstance(msg, str):
752 msg = _fix_eols(msg).encode('ascii')
Guido van Rossumfcfb6321998-08-04 15:29:54 +0000753 if self.does_esmtp:
754 # Hmmm? what's this? -ddm
755 # self.esmtp_features['7bit']=""
756 if self.has_extn('size'):
Walter Dörwald70a6b492004-02-12 17:35:32 +0000757 esmtp_opts.append("size=%d" % len(msg))
Guido van Rossumfcfb6321998-08-04 15:29:54 +0000758 for option in mail_options:
Guido van Rossum95e6f701998-06-25 02:15:50 +0000759 esmtp_opts.append(option)
Giampaolo Rodolàbd258bd2011-02-22 15:56:20 +0000760 (code, resp) = self.mail(from_addr, esmtp_opts)
Fred Drake8152d322000-12-12 23:20:45 +0000761 if code != 250:
R David Murrayd312c742013-03-20 20:36:14 -0400762 if code == 421:
763 self.close()
764 else:
765 self.rset()
Guido van Rossum296e1431999-04-07 15:03:39 +0000766 raise SMTPSenderRefused(code, resp, from_addr)
Giampaolo Rodolàbd258bd2011-02-22 15:56:20 +0000767 senderrs = {}
Guido van Rossum3172c5d2007-10-16 18:12:55 +0000768 if isinstance(to_addrs, str):
Jeremy Hylton31bb8ce1998-08-13 19:57:46 +0000769 to_addrs = [to_addrs]
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000770 for each in to_addrs:
Giampaolo Rodolàbd258bd2011-02-22 15:56:20 +0000771 (code, resp) = self.rcpt(each, rcpt_options)
Fred Drake8152d322000-12-12 23:20:45 +0000772 if (code != 250) and (code != 251):
Giampaolo Rodolàbd258bd2011-02-22 15:56:20 +0000773 senderrs[each] = (code, resp)
R David Murrayd312c742013-03-20 20:36:14 -0400774 if code == 421:
775 self.close()
776 raise SMTPRecipientsRefused(senderrs)
Giampaolo Rodolàbd258bd2011-02-22 15:56:20 +0000777 if len(senderrs) == len(to_addrs):
Guido van Rossum95e6f701998-06-25 02:15:50 +0000778 # the server refused all our recipients
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000779 self.rset()
Guido van Rossum296e1431999-04-07 15:03:39 +0000780 raise SMTPRecipientsRefused(senderrs)
Giampaolo Rodolàbd258bd2011-02-22 15:56:20 +0000781 (code, resp) = self.data(msg)
Fred Drake8152d322000-12-12 23:20:45 +0000782 if code != 250:
R David Murrayd312c742013-03-20 20:36:14 -0400783 if code == 421:
784 self.close()
785 else:
786 self.rset()
Guido van Rossum296e1431999-04-07 15:03:39 +0000787 raise SMTPDataError(code, resp)
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000788 #if we got here then somebody got our mail
Tim Peters495ad3c2001-01-15 01:36:40 +0000789 return senderrs
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000790
R. David Murray7dff9e02010-11-08 17:15:13 +0000791 def send_message(self, msg, from_addr=None, to_addrs=None,
792 mail_options=[], rcpt_options={}):
793 """Converts message to a bytestring and passes it to sendmail.
794
795 The arguments are as for sendmail, except that msg is an
R David Murrayac4e5ab2011-07-02 21:03:19 -0400796 email.message.Message object. If from_addr is None or to_addrs is
797 None, these arguments are taken from the headers of the Message as
798 described in RFC 2822 (a ValueError is raised if there is more than
799 one set of 'Resent-' headers). Regardless of the values of from_addr and
800 to_addr, any Bcc field (or Resent-Bcc field, when the Message is a
801 resent) of the Message object won't be transmitted. The Message
802 object is then serialized using email.generator.BytesGenerator and
803 sendmail is called to transmit the message.
804
R. David Murray7dff9e02010-11-08 17:15:13 +0000805 """
R David Murrayac4e5ab2011-07-02 21:03:19 -0400806 # 'Resent-Date' is a mandatory field if the Message is resent (RFC 2822
807 # Section 3.6.6). In such a case, we use the 'Resent-*' fields. However,
808 # if there is more than one 'Resent-' block there's no way to
809 # unambiguously determine which one is the most recent in all cases,
810 # so rather than guess we raise a ValueError in that case.
811 #
812 # TODO implement heuristics to guess the correct Resent-* block with an
813 # option allowing the user to enable the heuristics. (It should be
814 # possible to guess correctly almost all of the time.)
Senthil Kumaranb351a482011-07-31 09:14:17 +0800815
816 resent = msg.get_all('Resent-Date')
R David Murrayac4e5ab2011-07-02 21:03:19 -0400817 if resent is None:
818 header_prefix = ''
819 elif len(resent) == 1:
820 header_prefix = 'Resent-'
821 else:
822 raise ValueError("message has more than one 'Resent-' header block")
R. David Murray7dff9e02010-11-08 17:15:13 +0000823 if from_addr is None:
R David Murrayac4e5ab2011-07-02 21:03:19 -0400824 # Prefer the sender field per RFC 2822:3.6.2.
Senthil Kumaranb351a482011-07-31 09:14:17 +0800825 from_addr = (msg[header_prefix + 'Sender']
826 if (header_prefix + 'Sender') in msg
827 else msg[header_prefix + 'From'])
R. David Murray7dff9e02010-11-08 17:15:13 +0000828 if to_addrs is None:
Senthil Kumaranb351a482011-07-31 09:14:17 +0800829 addr_fields = [f for f in (msg[header_prefix + 'To'],
830 msg[header_prefix + 'Bcc'],
831 msg[header_prefix + 'Cc']) if f is not None]
R. David Murray7dff9e02010-11-08 17:15:13 +0000832 to_addrs = [a[1] for a in email.utils.getaddresses(addr_fields)]
R David Murrayac4e5ab2011-07-02 21:03:19 -0400833 # Make a local copy so we can delete the bcc headers.
834 msg_copy = copy.copy(msg)
835 del msg_copy['Bcc']
836 del msg_copy['Resent-Bcc']
R. David Murray7dff9e02010-11-08 17:15:13 +0000837 with io.BytesIO() as bytesmsg:
838 g = email.generator.BytesGenerator(bytesmsg)
R David Murrayac4e5ab2011-07-02 21:03:19 -0400839 g.flatten(msg_copy, linesep='\r\n')
R. David Murray7dff9e02010-11-08 17:15:13 +0000840 flatmsg = bytesmsg.getvalue()
841 return self.sendmail(from_addr, to_addrs, flatmsg, mail_options,
842 rcpt_options)
843
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000844 def close(self):
845 """Close the connection to the SMTP server."""
846 if self.file:
847 self.file.close()
848 self.file = None
849 if self.sock:
850 self.sock.close()
851 self.sock = None
852
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000853 def quit(self):
Guido van Rossum95e6f701998-06-25 02:15:50 +0000854 """Terminate the SMTP session."""
Christian Heimesba4af492008-03-28 00:55:15 +0000855 res = self.docmd("quit")
Guido van Rossum45e2fbc1998-03-26 21:13:24 +0000856 self.close()
Christian Heimesba4af492008-03-28 00:55:15 +0000857 return res
Guido van Rossum95e6f701998-06-25 02:15:50 +0000858
Thomas Wouters47b49bf2007-08-30 22:15:33 +0000859if _have_ssl:
Thomas Wouters89f507f2006-12-13 04:49:30 +0000860
Thomas Wouters47b49bf2007-08-30 22:15:33 +0000861 class SMTP_SSL(SMTP):
R David Murray021362d2013-06-23 16:05:44 -0400862 """ This is a subclass derived from SMTP that connects over an SSL
863 encrypted socket (to use this class you need a socket module that was
864 compiled with SSL support). If host is not specified, '' (the local
865 host) is used. If port is omitted, the standard SMTP-over-SSL port
866 (465) is used. local_hostname and source_address have the same meaning
867 as they do in the SMTP class. keyfile and certfile are also optional -
868 they can contain a PEM formatted private key and certificate chain file
869 for the SSL connection. context also optional, can contain a
870 SSLContext, and is an alternative to keyfile and certfile; If it is
871 specified both keyfile and certfile must be None.
872
Thomas Wouters47b49bf2007-08-30 22:15:33 +0000873 """
Antoine Pitrouc1d52062011-05-07 19:39:37 +0200874
875 default_port = SMTP_SSL_PORT
876
Thomas Wouters47b49bf2007-08-30 22:15:33 +0000877 def __init__(self, host='', port=0, local_hostname=None,
Georg Brandlf78e02b2008-06-10 17:40:04 +0000878 keyfile=None, certfile=None,
Senthil Kumaran3d23fd62011-07-30 10:56:50 +0800879 timeout=socket._GLOBAL_DEFAULT_TIMEOUT,
880 source_address=None, context=None):
Antoine Pitroue0650202011-05-18 18:03:09 +0200881 if context is not None and keyfile is not None:
882 raise ValueError("context and keyfile arguments are mutually "
883 "exclusive")
884 if context is not None and certfile is not None:
885 raise ValueError("context and certfile arguments are mutually "
886 "exclusive")
Thomas Wouters47b49bf2007-08-30 22:15:33 +0000887 self.keyfile = keyfile
888 self.certfile = certfile
Christian Heimes67986f92013-11-23 22:43:47 +0100889 if context is None:
890 context = ssl._create_stdlib_context(certfile=certfile,
891 keyfile=keyfile)
Antoine Pitroue0650202011-05-18 18:03:09 +0200892 self.context = context
Senthil Kumaran3d23fd62011-07-30 10:56:50 +0800893 SMTP.__init__(self, host, port, local_hostname, timeout,
894 source_address)
Thomas Wouters47b49bf2007-08-30 22:15:33 +0000895
896 def _get_socket(self, host, port, timeout):
Giampaolo Rodolàbd258bd2011-02-22 15:56:20 +0000897 if self.debuglevel > 0:
898 print('connect:', (host, port), file=stderr)
Senthil Kumaran3d23fd62011-07-30 10:56:50 +0800899 new_socket = socket.create_connection((host, port), timeout,
900 self.source_address)
Christian Heimesa5768f72013-12-02 20:44:17 +0100901 server_hostname = self._host if ssl.HAS_SNI else None
902 new_socket = self.context.wrap_socket(new_socket,
903 server_hostname=server_hostname)
R. David Murray87e20742009-05-23 01:30:26 +0000904 return new_socket
Thomas Wouters47b49bf2007-08-30 22:15:33 +0000905
906 __all__.append("SMTP_SSL")
Barry Warsaw4c4bec81998-12-22 03:02:20 +0000907
Guido van Rossumd8faa362007-04-27 19:54:29 +0000908#
909# LMTP extension
910#
911LMTP_PORT = 2003
912
913class LMTP(SMTP):
914 """LMTP - Local Mail Transfer Protocol
915
916 The LMTP protocol, which is very similar to ESMTP, is heavily based
R David Murray021362d2013-06-23 16:05:44 -0400917 on the standard SMTP client. It's common to use Unix sockets for
918 LMTP, so our connect() method must support that as well as a regular
R David Murray36beb662013-06-23 15:47:50 -0400919 host:port server. local_hostname and source_address have the same
R David Murray021362d2013-06-23 16:05:44 -0400920 meaning as they do in the SMTP class. To specify a Unix socket,
921 you must use an absolute path as the host, starting with a '/'.
Guido van Rossumd8faa362007-04-27 19:54:29 +0000922
923 Authentication is supported, using the regular SMTP mechanism. When
924 using a Unix socket, LMTP generally don't support or require any
925 authentication, but your mileage might vary."""
926
927 ehlo_msg = "lhlo"
928
Senthil Kumaran3d23fd62011-07-30 10:56:50 +0800929 def __init__(self, host='', port=LMTP_PORT, local_hostname=None,
930 source_address=None):
Guido van Rossumd8faa362007-04-27 19:54:29 +0000931 """Initialize a new instance."""
Senthil Kumaranb351a482011-07-31 09:14:17 +0800932 SMTP.__init__(self, host, port, local_hostname=local_hostname,
933 source_address=source_address)
Guido van Rossumd8faa362007-04-27 19:54:29 +0000934
Senthil Kumaran3d23fd62011-07-30 10:56:50 +0800935 def connect(self, host='localhost', port=0, source_address=None):
Guido van Rossumd8faa362007-04-27 19:54:29 +0000936 """Connect to the LMTP daemon, on either a Unix or a TCP socket."""
937 if host[0] != '/':
Senthil Kumaranb351a482011-07-31 09:14:17 +0800938 return SMTP.connect(self, host, port, source_address=source_address)
Guido van Rossumd8faa362007-04-27 19:54:29 +0000939
940 # Handle Unix-domain sockets.
941 try:
942 self.sock = socket.socket(socket.AF_UNIX, socket.SOCK_STREAM)
Antoine Pitrouf068ab82011-06-06 19:17:09 +0200943 self.file = None
Guido van Rossumd8faa362007-04-27 19:54:29 +0000944 self.sock.connect(host)
Andrew Svetlov2ade6f22012-12-17 18:57:16 +0200945 except OSError:
Giampaolo Rodolàbd258bd2011-02-22 15:56:20 +0000946 if self.debuglevel > 0:
947 print('connect fail:', host, file=stderr)
Guido van Rossumd8faa362007-04-27 19:54:29 +0000948 if self.sock:
949 self.sock.close()
950 self.sock = None
Andrew Svetlovb6693c42012-12-17 18:54:53 +0200951 raise
Guido van Rossumd8faa362007-04-27 19:54:29 +0000952 (code, msg) = self.getreply()
Giampaolo Rodolàbd258bd2011-02-22 15:56:20 +0000953 if self.debuglevel > 0:
954 print('connect:', msg, file=stderr)
Guido van Rossumd8faa362007-04-27 19:54:29 +0000955 return (code, msg)
956
957
Guido van Rossum95e6f701998-06-25 02:15:50 +0000958# Test the sendmail method, which tests most of the others.
959# Note: This always sends to localhost.
960if __name__ == '__main__':
Andrew M. Kuchling6be424f2001-08-13 14:41:39 +0000961 import sys
Guido van Rossum95e6f701998-06-25 02:15:50 +0000962
963 def prompt(prompt):
964 sys.stdout.write(prompt + ": ")
Ezio Melotti6bfecd12011-10-18 13:20:07 +0300965 sys.stdout.flush()
Eric S. Raymondc013f302001-02-09 05:40:38 +0000966 return sys.stdin.readline().strip()
Guido van Rossum95e6f701998-06-25 02:15:50 +0000967
968 fromaddr = prompt("From")
Giampaolo Rodolàbd258bd2011-02-22 15:56:20 +0000969 toaddrs = prompt("To").split(',')
Guido van Rossumbe19ed72007-02-09 05:37:30 +0000970 print("Enter message, end with ^D:")
Guido van Rossum95e6f701998-06-25 02:15:50 +0000971 msg = ''
972 while 1:
973 line = sys.stdin.readline()
974 if not line:
975 break
976 msg = msg + line
Guido van Rossumbe19ed72007-02-09 05:37:30 +0000977 print("Message length is %d" % len(msg))
Guido van Rossum95e6f701998-06-25 02:15:50 +0000978
979 server = SMTP('localhost')
980 server.set_debuglevel(1)
981 server.sendmail(fromaddr, toaddrs, msg)
982 server.quit()