blob: 99ffdeeb358ff2e826d765e83b9a3ee8e2398a2f [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:
Senthil Kumaran4ce118e2014-06-03 07:24:54 -0700380 self.close()
Georg Brandlb38b5c42014-02-10 22:11:21 +0100381 raise SMTPResponseException(500, "Line too long.")
Guido van Rossum806c2462007-08-06 23:33:07 +0000382 resp.append(line[4:].strip(b' \t\r\n'))
Giampaolo Rodolàbd258bd2011-02-22 15:56:20 +0000383 code = line[:3]
Guido van Rossum296e1431999-04-07 15:03:39 +0000384 # Check that the error code is syntactically correct.
385 # Don't attempt to read a continuation line if it is broken.
386 try:
Eric S. Raymondc013f302001-02-09 05:40:38 +0000387 errcode = int(code)
Guido van Rossum296e1431999-04-07 15:03:39 +0000388 except ValueError:
389 errcode = -1
390 break
Guido van Rossumf123f841999-03-29 20:33:21 +0000391 # Check if multiline response.
Guido van Rossum806c2462007-08-06 23:33:07 +0000392 if line[3:4] != b"-":
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000393 break
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000394
Guido van Rossumc43e79f2007-06-18 18:26:36 +0000395 errmsg = b"\n".join(resp)
Tim Peters495ad3c2001-01-15 01:36:40 +0000396 if self.debuglevel > 0:
Senthil Kumaranb351a482011-07-31 09:14:17 +0800397 print('reply: retcode (%s); Msg: %s' % (errcode, errmsg),
398 file=stderr)
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000399 return errcode, errmsg
Tim Peters495ad3c2001-01-15 01:36:40 +0000400
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000401 def docmd(self, cmd, args=""):
Barry Warsawa7d9bdf1998-12-22 03:24:27 +0000402 """Send a command, and return its response code."""
Giampaolo Rodolàbd258bd2011-02-22 15:56:20 +0000403 self.putcmd(cmd, args)
Guido van Rossum296e1431999-04-07 15:03:39 +0000404 return self.getreply()
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000405
Barry Warsawa7d9bdf1998-12-22 03:24:27 +0000406 # std smtp commands
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000407 def helo(self, name=''):
Barry Warsawa7d9bdf1998-12-22 03:24:27 +0000408 """SMTP 'helo' command.
409 Hostname to send for this command defaults to the FQDN of the local
410 host.
411 """
Neil Schemenauer6730f262002-03-24 15:30:40 +0000412 self.putcmd("helo", name or self.local_hostname)
Giampaolo Rodolàbd258bd2011-02-22 15:56:20 +0000413 (code, msg) = self.getreply()
414 self.helo_resp = msg
415 return (code, msg)
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000416
Guido van Rossum95e6f701998-06-25 02:15:50 +0000417 def ehlo(self, name=''):
Barry Warsawa7d9bdf1998-12-22 03:24:27 +0000418 """ SMTP 'ehlo' command.
419 Hostname to send for this command defaults to the FQDN of the local
420 host.
421 """
Guido van Rossumf7fcf5e2001-09-14 16:08:44 +0000422 self.esmtp_features = {}
Guido van Rossumd8faa362007-04-27 19:54:29 +0000423 self.putcmd(self.ehlo_msg, name or self.local_hostname)
Giampaolo Rodolàbd258bd2011-02-22 15:56:20 +0000424 (code, msg) = self.getreply()
Tim Peters495ad3c2001-01-15 01:36:40 +0000425 # According to RFC1869 some (badly written)
426 # MTA's will disconnect on an ehlo. Toss an exception if
Guido van Rossumfcfb6321998-08-04 15:29:54 +0000427 # that happens -ddm
428 if code == -1 and len(msg) == 0:
Barry Warsaw76750972001-12-14 20:34:20 +0000429 self.close()
Guido van Rossum40233ea1999-01-15 03:23:55 +0000430 raise SMTPServerDisconnected("Server not connected")
Giampaolo Rodolàbd258bd2011-02-22 15:56:20 +0000431 self.ehlo_resp = msg
Fred Drake8152d322000-12-12 23:20:45 +0000432 if code != 250:
Giampaolo Rodolàbd258bd2011-02-22 15:56:20 +0000433 return (code, msg)
434 self.does_esmtp = 1
Thomas Wouters7e474022000-07-16 12:04:32 +0000435 #parse the ehlo response -ddm
Guido van Rossum04110fb2007-08-24 16:32:05 +0000436 assert isinstance(self.ehlo_resp, bytes), repr(self.ehlo_resp)
Giampaolo Rodolàbd258bd2011-02-22 15:56:20 +0000437 resp = self.ehlo_resp.decode("latin-1").split('\n')
Guido van Rossumfcfb6321998-08-04 15:29:54 +0000438 del resp[0]
Guido van Rossum2880f6e1998-08-10 20:07:00 +0000439 for each in resp:
Piers Lauder385a77a2002-07-27 00:38:30 +0000440 # To be able to communicate with as many SMTP servers as possible,
441 # we have to take the old-style auth advertisement into account,
442 # because:
443 # 1) Else our SMTP feature parser gets confused.
444 # 2) There are some servers that only advertise the auth methods we
445 # support using the old style.
446 auth_match = OLDSTYLE_AUTH.match(each)
447 if auth_match:
448 # This doesn't remove duplicates, but that's no problem
449 self.esmtp_features["auth"] = self.esmtp_features.get("auth", "") \
450 + " " + auth_match.groups(0)[0]
451 continue
452
Barry Warsawbe22ae62002-04-15 20:03:30 +0000453 # RFC 1869 requires a space between ehlo keyword and parameters.
454 # It's actually stricter, in that only spaces are allowed between
455 # parameters, but were not going to check for that here. Note
456 # that the space isn't present if there are no parameters.
Giampaolo Rodolàbd258bd2011-02-22 15:56:20 +0000457 m = re.match(r'(?P<feature>[A-Za-z0-9][A-Za-z0-9\-]*) ?', each)
Guido van Rossumfcfb6321998-08-04 15:29:54 +0000458 if m:
Giampaolo Rodolàbd258bd2011-02-22 15:56:20 +0000459 feature = m.group("feature").lower()
460 params = m.string[m.end("feature"):].strip()
Piers Lauder385a77a2002-07-27 00:38:30 +0000461 if feature == "auth":
462 self.esmtp_features[feature] = self.esmtp_features.get(feature, "") \
463 + " " + params
464 else:
Giampaolo Rodolàbd258bd2011-02-22 15:56:20 +0000465 self.esmtp_features[feature] = params
466 return (code, msg)
Guido van Rossum95e6f701998-06-25 02:15:50 +0000467
Guido van Rossumfcfb6321998-08-04 15:29:54 +0000468 def has_extn(self, opt):
469 """Does the server support a given SMTP service extension?"""
Raymond Hettinger54f02222002-06-01 14:18:47 +0000470 return opt.lower() in self.esmtp_features
Guido van Rossum95e6f701998-06-25 02:15:50 +0000471
Guido van Rossum18586f41998-04-03 17:03:13 +0000472 def help(self, args=''):
Barry Warsawa7d9bdf1998-12-22 03:24:27 +0000473 """SMTP 'help' command.
474 Returns help text from server."""
Guido van Rossum18586f41998-04-03 17:03:13 +0000475 self.putcmd("help", args)
Kurt B. Kaiser58bd1902005-06-26 18:27:36 +0000476 return self.getreply()[1]
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000477
478 def rset(self):
Barry Warsawa7d9bdf1998-12-22 03:24:27 +0000479 """SMTP 'rset' command -- resets session."""
Guido van Rossum296e1431999-04-07 15:03:39 +0000480 return self.docmd("rset")
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000481
R David Murrayafb151a2014-04-14 18:21:38 -0400482 def _rset(self):
483 """Internal 'rset' command which ignores any SMTPServerDisconnected error.
484
485 Used internally in the library, since the server disconnected error
486 should appear to the application when the *next* command is issued, if
487 we are doing an internal "safety" reset.
488 """
489 try:
490 self.rset()
491 except SMTPServerDisconnected:
492 pass
493
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000494 def noop(self):
Barry Warsawa7d9bdf1998-12-22 03:24:27 +0000495 """SMTP 'noop' command -- doesn't do anything :>"""
Guido van Rossum296e1431999-04-07 15:03:39 +0000496 return self.docmd("noop")
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000497
Giampaolo Rodolàbd258bd2011-02-22 15:56:20 +0000498 def mail(self, sender, options=[]):
Barry Warsawa7d9bdf1998-12-22 03:24:27 +0000499 """SMTP 'mail' command -- begins mail xfer session."""
Guido van Rossumfcfb6321998-08-04 15:29:54 +0000500 optionlist = ''
501 if options and self.does_esmtp:
Eric S. Raymondc013f302001-02-09 05:40:38 +0000502 optionlist = ' ' + ' '.join(options)
Giampaolo Rodolàbd258bd2011-02-22 15:56:20 +0000503 self.putcmd("mail", "FROM:%s%s" % (quoteaddr(sender), optionlist))
Guido van Rossum45e2fbc1998-03-26 21:13:24 +0000504 return self.getreply()
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000505
Giampaolo Rodolàbd258bd2011-02-22 15:56:20 +0000506 def rcpt(self, recip, options=[]):
Barry Warsawa7d9bdf1998-12-22 03:24:27 +0000507 """SMTP 'rcpt' command -- indicates 1 recipient for this mail."""
Guido van Rossumfcfb6321998-08-04 15:29:54 +0000508 optionlist = ''
509 if options and self.does_esmtp:
Eric S. Raymondc013f302001-02-09 05:40:38 +0000510 optionlist = ' ' + ' '.join(options)
Giampaolo Rodolàbd258bd2011-02-22 15:56:20 +0000511 self.putcmd("rcpt", "TO:%s%s" % (quoteaddr(recip), optionlist))
Guido van Rossum45e2fbc1998-03-26 21:13:24 +0000512 return self.getreply()
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000513
Giampaolo Rodolàbd258bd2011-02-22 15:56:20 +0000514 def data(self, msg):
Tim Peters495ad3c2001-01-15 01:36:40 +0000515 """SMTP 'DATA' command -- sends message data to server.
Guido van Rossum296e1431999-04-07 15:03:39 +0000516
Barry Warsaw4c4bec81998-12-22 03:02:20 +0000517 Automatically quotes lines beginning with a period per rfc821.
Guido van Rossum296e1431999-04-07 15:03:39 +0000518 Raises SMTPDataError if there is an unexpected reply to the
519 DATA command; the return value from this method is the final
R. David Murray7dff9e02010-11-08 17:15:13 +0000520 response code received when the all data is sent. If msg
Serhiy Storchaka9f8a8912015-04-03 18:12:41 +0300521 is a string, lone '\\r' and '\\n' characters are converted to
522 '\\r\\n' characters. If msg is bytes, it is transmitted as is.
Barry Warsaw4c4bec81998-12-22 03:02:20 +0000523 """
Guido van Rossum45e2fbc1998-03-26 21:13:24 +0000524 self.putcmd("data")
Giampaolo Rodolàbd258bd2011-02-22 15:56:20 +0000525 (code, repl) = self.getreply()
526 if self.debuglevel > 0:
527 print("data:", (code, repl), file=stderr)
Fred Drake8152d322000-12-12 23:20:45 +0000528 if code != 354:
Giampaolo Rodolàbd258bd2011-02-22 15:56:20 +0000529 raise SMTPDataError(code, repl)
Guido van Rossum45e2fbc1998-03-26 21:13:24 +0000530 else:
R. David Murray7dff9e02010-11-08 17:15:13 +0000531 if isinstance(msg, str):
532 msg = _fix_eols(msg).encode('ascii')
533 q = _quote_periods(msg)
534 if q[-2:] != bCRLF:
535 q = q + bCRLF
536 q = q + b"." + bCRLF
Guido van Rossum20c92281999-04-21 16:52:20 +0000537 self.send(q)
Giampaolo Rodolàbd258bd2011-02-22 15:56:20 +0000538 (code, msg) = self.getreply()
539 if self.debuglevel > 0:
540 print("data:", (code, msg), file=stderr)
541 return (code, msg)
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000542
Guido van Rossumfcfb6321998-08-04 15:29:54 +0000543 def verify(self, address):
Barry Warsawa7d9bdf1998-12-22 03:24:27 +0000544 """SMTP 'verify' command -- checks for address validity."""
R David Murray46346762011-07-18 21:38:54 -0400545 self.putcmd("vrfy", _addr_only(address))
Guido van Rossumfcfb6321998-08-04 15:29:54 +0000546 return self.getreply()
Barry Warsaw4c4bec81998-12-22 03:02:20 +0000547 # a.k.a.
Giampaolo Rodolàbd258bd2011-02-22 15:56:20 +0000548 vrfy = verify
Guido van Rossumfcfb6321998-08-04 15:29:54 +0000549
550 def expn(self, address):
Christian Heimes90c3d9b2008-02-23 13:18:03 +0000551 """SMTP 'expn' command -- expands a mailing list."""
R David Murray46346762011-07-18 21:38:54 -0400552 self.putcmd("expn", _addr_only(address))
Guido van Rossumfcfb6321998-08-04 15:29:54 +0000553 return self.getreply()
554
Barry Warsaw4c4bec81998-12-22 03:02:20 +0000555 # some useful methods
Guido van Rossumae010462001-09-11 15:57:46 +0000556
Christian Heimes679db4a2008-01-18 09:56:22 +0000557 def ehlo_or_helo_if_needed(self):
558 """Call self.ehlo() and/or self.helo() if needed.
559
560 If there has been no previous EHLO or HELO command this session, this
561 method tries ESMTP EHLO first.
562
563 This method may raise the following exceptions:
564
565 SMTPHeloError The server didn't reply properly to
566 the helo greeting.
567 """
568 if self.helo_resp is None and self.ehlo_resp is None:
569 if not (200 <= self.ehlo()[0] <= 299):
570 (code, resp) = self.helo()
571 if not (200 <= code <= 299):
572 raise SMTPHeloError(code, resp)
573
Guido van Rossumae010462001-09-11 15:57:46 +0000574 def login(self, user, password):
575 """Log in on an SMTP server that requires authentication.
576
577 The arguments are:
578 - user: The user name to authenticate with.
579 - password: The password for the authentication.
580
581 If there has been no previous EHLO or HELO command this session, this
582 method tries ESMTP EHLO first.
583
584 This method will return normally if the authentication was successful.
585
586 This method may raise the following exceptions:
587
588 SMTPHeloError The server didn't reply properly to
589 the helo greeting.
590 SMTPAuthenticationError The server didn't accept the username/
591 password combination.
Fred Drake2f8f4d32001-10-13 18:35:32 +0000592 SMTPException No suitable authentication method was
Guido van Rossumae010462001-09-11 15:57:46 +0000593 found.
594 """
595
596 def encode_cram_md5(challenge, user, password):
Georg Brandl706824f2009-06-04 09:42:55 +0000597 challenge = base64.decodebytes(challenge)
R. David Murrayfb123912009-05-28 18:19:00 +0000598 response = user + " " + hmac.HMAC(password.encode('ascii'),
Christian Heimes634919a2013-11-20 17:23:06 +0100599 challenge, 'md5').hexdigest()
R. David Murrayfb123912009-05-28 18:19:00 +0000600 return encode_base64(response.encode('ascii'), eol='')
Guido van Rossumae010462001-09-11 15:57:46 +0000601
602 def encode_plain(user, password):
R. David Murraycaa27b72009-05-23 18:49:56 +0000603 s = "\0%s\0%s" % (user, password)
604 return encode_base64(s.encode('ascii'), eol='')
Tim Peters469cdad2002-08-08 20:19:19 +0000605
Guido van Rossumae010462001-09-11 15:57:46 +0000606 AUTH_PLAIN = "PLAIN"
607 AUTH_CRAM_MD5 = "CRAM-MD5"
Piers Lauder385a77a2002-07-27 00:38:30 +0000608 AUTH_LOGIN = "LOGIN"
Guido van Rossumae010462001-09-11 15:57:46 +0000609
Christian Heimes679db4a2008-01-18 09:56:22 +0000610 self.ehlo_or_helo_if_needed()
Guido van Rossumae010462001-09-11 15:57:46 +0000611
612 if not self.has_extn("auth"):
613 raise SMTPException("SMTP AUTH extension not supported by server.")
614
Gerhard Häring1c5471f2010-08-05 14:08:44 +0000615 # Authentication methods the server claims to support
616 advertised_authlist = self.esmtp_features["auth"].split()
Guido van Rossumae010462001-09-11 15:57:46 +0000617
618 # List of authentication methods we support: from preferred to
619 # less preferred methods. Except for the purpose of testing the weaker
620 # ones, we prefer stronger methods like CRAM-MD5:
Piers Lauder385a77a2002-07-27 00:38:30 +0000621 preferred_auths = [AUTH_CRAM_MD5, AUTH_PLAIN, AUTH_LOGIN]
Guido van Rossumae010462001-09-11 15:57:46 +0000622
Gerhard Häring1c5471f2010-08-05 14:08:44 +0000623 # We try the authentication methods the server advertises, but only the
624 # ones *we* support. And in our preferred order.
625 authlist = [auth for auth in preferred_auths if auth in advertised_authlist]
626 if not authlist:
Fred Drake2f8f4d32001-10-13 18:35:32 +0000627 raise SMTPException("No suitable authentication method found.")
Gerhard Häring1c5471f2010-08-05 14:08:44 +0000628
629 # Some servers advertise authentication methods they don't really
630 # support, so if authentication fails, we continue until we've tried
631 # all methods.
632 for authmethod in authlist:
633 if authmethod == AUTH_CRAM_MD5:
634 (code, resp) = self.docmd("AUTH", AUTH_CRAM_MD5)
635 if code == 334:
636 (code, resp) = self.docmd(encode_cram_md5(resp, user, password))
637 elif authmethod == AUTH_PLAIN:
638 (code, resp) = self.docmd("AUTH",
639 AUTH_PLAIN + " " + encode_plain(user, password))
640 elif authmethod == AUTH_LOGIN:
641 (code, resp) = self.docmd("AUTH",
642 "%s %s" % (AUTH_LOGIN, encode_base64(user.encode('ascii'), eol='')))
643 if code == 334:
644 (code, resp) = self.docmd(encode_base64(password.encode('ascii'), eol=''))
645
Guido van Rossumae010462001-09-11 15:57:46 +0000646 # 235 == 'Authentication successful'
647 # 503 == 'Error: already authenticated'
Gerhard Häring1c5471f2010-08-05 14:08:44 +0000648 if code in (235, 503):
649 return (code, resp)
650
651 # We could not login sucessfully. Return result of last attempt.
652 raise SMTPAuthenticationError(code, resp)
Guido van Rossumae010462001-09-11 15:57:46 +0000653
Antoine Pitroue0650202011-05-18 18:03:09 +0200654 def starttls(self, keyfile=None, certfile=None, context=None):
Guido van Rossumf7fcf5e2001-09-14 16:08:44 +0000655 """Puts the connection to the SMTP server into TLS mode.
Tim Petersb64bec32001-09-18 02:26:39 +0000656
Christian Heimes679db4a2008-01-18 09:56:22 +0000657 If there has been no previous EHLO or HELO command this session, this
658 method tries ESMTP EHLO first.
659
Guido van Rossumf7fcf5e2001-09-14 16:08:44 +0000660 If the server supports TLS, this will encrypt the rest of the SMTP
661 session. If you provide the keyfile and certfile parameters,
662 the identity of the SMTP server and client can be checked. This,
663 however, depends on whether the socket module really checks the
664 certificates.
Christian Heimes679db4a2008-01-18 09:56:22 +0000665
666 This method may raise the following exceptions:
667
668 SMTPHeloError The server didn't reply properly to
669 the helo greeting.
Guido van Rossumf7fcf5e2001-09-14 16:08:44 +0000670 """
Christian Heimes679db4a2008-01-18 09:56:22 +0000671 self.ehlo_or_helo_if_needed()
672 if not self.has_extn("starttls"):
673 raise SMTPException("STARTTLS extension not supported by server.")
Tim Petersb64bec32001-09-18 02:26:39 +0000674 (resp, reply) = self.docmd("STARTTLS")
Guido van Rossumf7fcf5e2001-09-14 16:08:44 +0000675 if resp == 220:
Thomas Wouters47b49bf2007-08-30 22:15:33 +0000676 if not _have_ssl:
677 raise RuntimeError("No SSL support included in this Python")
Antoine Pitroue0650202011-05-18 18:03:09 +0200678 if context is not None and keyfile is not None:
679 raise ValueError("context and keyfile arguments are mutually "
680 "exclusive")
681 if context is not None and certfile is not None:
682 raise ValueError("context and certfile arguments are mutually "
683 "exclusive")
Christian Heimes67986f92013-11-23 22:43:47 +0100684 if context is None:
685 context = ssl._create_stdlib_context(certfile=certfile,
686 keyfile=keyfile)
Christian Heimesa5768f72013-12-02 20:44:17 +0100687 self.sock = context.wrap_socket(self.sock,
Benjamin Peterson7243b572014-11-23 17:04:34 -0600688 server_hostname=self._host)
Antoine Pitrouf068ab82011-06-06 19:17:09 +0200689 self.file = None
Christian Heimes679db4a2008-01-18 09:56:22 +0000690 # RFC 3207:
691 # The client MUST discard any knowledge obtained from
692 # the server, such as the list of SMTP service extensions,
693 # which was not obtained from the TLS negotiation itself.
694 self.helo_resp = None
695 self.ehlo_resp = None
696 self.esmtp_features = {}
697 self.does_esmtp = 0
Guido van Rossumf7fcf5e2001-09-14 16:08:44 +0000698 return (resp, reply)
Tim Petersb64bec32001-09-18 02:26:39 +0000699
Jeremy Hylton31bb8ce1998-08-13 19:57:46 +0000700 def sendmail(self, from_addr, to_addrs, msg, mail_options=[],
Tim Peters495ad3c2001-01-15 01:36:40 +0000701 rcpt_options=[]):
702 """This command performs an entire mail transaction.
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000703
Tim Peters495ad3c2001-01-15 01:36:40 +0000704 The arguments are:
Barry Warsaw4c4bec81998-12-22 03:02:20 +0000705 - from_addr : The address sending this mail.
706 - to_addrs : A list of addresses to send this mail to. A bare
707 string will be treated as a list with 1 address.
Tim Peters495ad3c2001-01-15 01:36:40 +0000708 - msg : The message to send.
Barry Warsaw4c4bec81998-12-22 03:02:20 +0000709 - mail_options : List of ESMTP options (such as 8bitmime) for the
710 mail command.
711 - rcpt_options : List of ESMTP options (such as DSN commands) for
712 all the rcpt commands.
713
R. David Murray7dff9e02010-11-08 17:15:13 +0000714 msg may be a string containing characters in the ASCII range, or a byte
715 string. A string is encoded to bytes using the ascii codec, and lone
R David Murrayac4e5ab2011-07-02 21:03:19 -0400716 \\r and \\n characters are converted to \\r\\n characters.
R. David Murray7dff9e02010-11-08 17:15:13 +0000717
Barry Warsaw4c4bec81998-12-22 03:02:20 +0000718 If there has been no previous EHLO or HELO command this session, this
719 method tries ESMTP EHLO first. If the server does ESMTP, message size
720 and each of the specified options will be passed to it. If EHLO
721 fails, HELO will be tried and ESMTP options suppressed.
722
723 This method will return normally if the mail is accepted for at least
Barry Warsawd25c1b71999-11-28 17:11:06 +0000724 one recipient. It returns a dictionary, with one entry for each
725 recipient that was refused. Each entry contains a tuple of the SMTP
726 error code and the accompanying error message sent by the server.
Guido van Rossum296e1431999-04-07 15:03:39 +0000727
728 This method may raise the following exceptions:
729
730 SMTPHeloError The server didn't reply properly to
Tim Peters495ad3c2001-01-15 01:36:40 +0000731 the helo greeting.
Barry Warsawd25c1b71999-11-28 17:11:06 +0000732 SMTPRecipientsRefused The server rejected ALL recipients
Guido van Rossum296e1431999-04-07 15:03:39 +0000733 (no mail was sent).
734 SMTPSenderRefused The server didn't accept the from_addr.
735 SMTPDataError The server replied with an unexpected
736 error code (other than a refusal of
737 a recipient).
738
739 Note: the connection will be open even after an exception is raised.
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000740
Guido van Rossum95e6f701998-06-25 02:15:50 +0000741 Example:
Tim Peters495ad3c2001-01-15 01:36:40 +0000742
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000743 >>> import smtplib
744 >>> s=smtplib.SMTP("localhost")
Guido van Rossumfc40a831998-01-29 17:26:45 +0000745 >>> tolist=["one@one.org","two@two.org","three@three.org","four@four.org"]
Martin v. Löwis301b1cd2002-07-28 16:52:01 +0000746 >>> msg = '''\\
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000747 ... From: Me@my.org
748 ... Subject: testin'...
749 ...
750 ... This is a test '''
751 >>> s.sendmail("me@my.org",tolist,msg)
752 { "three@three.org" : ( 550 ,"User unknown" ) }
753 >>> s.quit()
Tim Peters495ad3c2001-01-15 01:36:40 +0000754
Barry Warsaw4c4bec81998-12-22 03:02:20 +0000755 In the above example, the message was accepted for delivery to three
756 of the four addresses, and one was rejected, with the error code
Barry Warsawd25c1b71999-11-28 17:11:06 +0000757 550. If all addresses are accepted, then the method will return an
Barry Warsaw4c4bec81998-12-22 03:02:20 +0000758 empty dictionary.
759
760 """
Christian Heimes679db4a2008-01-18 09:56:22 +0000761 self.ehlo_or_helo_if_needed()
Guido van Rossum95e6f701998-06-25 02:15:50 +0000762 esmtp_opts = []
R. David Murray7dff9e02010-11-08 17:15:13 +0000763 if isinstance(msg, str):
764 msg = _fix_eols(msg).encode('ascii')
Guido van Rossumfcfb6321998-08-04 15:29:54 +0000765 if self.does_esmtp:
766 # Hmmm? what's this? -ddm
767 # self.esmtp_features['7bit']=""
768 if self.has_extn('size'):
Walter Dörwald70a6b492004-02-12 17:35:32 +0000769 esmtp_opts.append("size=%d" % len(msg))
Guido van Rossumfcfb6321998-08-04 15:29:54 +0000770 for option in mail_options:
Guido van Rossum95e6f701998-06-25 02:15:50 +0000771 esmtp_opts.append(option)
Giampaolo Rodolàbd258bd2011-02-22 15:56:20 +0000772 (code, resp) = self.mail(from_addr, esmtp_opts)
Fred Drake8152d322000-12-12 23:20:45 +0000773 if code != 250:
R David Murrayd312c742013-03-20 20:36:14 -0400774 if code == 421:
775 self.close()
776 else:
R David Murrayafb151a2014-04-14 18:21:38 -0400777 self._rset()
Guido van Rossum296e1431999-04-07 15:03:39 +0000778 raise SMTPSenderRefused(code, resp, from_addr)
Giampaolo Rodolàbd258bd2011-02-22 15:56:20 +0000779 senderrs = {}
Guido van Rossum3172c5d2007-10-16 18:12:55 +0000780 if isinstance(to_addrs, str):
Jeremy Hylton31bb8ce1998-08-13 19:57:46 +0000781 to_addrs = [to_addrs]
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000782 for each in to_addrs:
Giampaolo Rodolàbd258bd2011-02-22 15:56:20 +0000783 (code, resp) = self.rcpt(each, rcpt_options)
Fred Drake8152d322000-12-12 23:20:45 +0000784 if (code != 250) and (code != 251):
Giampaolo Rodolàbd258bd2011-02-22 15:56:20 +0000785 senderrs[each] = (code, resp)
R David Murrayd312c742013-03-20 20:36:14 -0400786 if code == 421:
787 self.close()
788 raise SMTPRecipientsRefused(senderrs)
Giampaolo Rodolàbd258bd2011-02-22 15:56:20 +0000789 if len(senderrs) == len(to_addrs):
Guido van Rossum95e6f701998-06-25 02:15:50 +0000790 # the server refused all our recipients
R David Murrayafb151a2014-04-14 18:21:38 -0400791 self._rset()
Guido van Rossum296e1431999-04-07 15:03:39 +0000792 raise SMTPRecipientsRefused(senderrs)
Giampaolo Rodolàbd258bd2011-02-22 15:56:20 +0000793 (code, resp) = self.data(msg)
Fred Drake8152d322000-12-12 23:20:45 +0000794 if code != 250:
R David Murrayd312c742013-03-20 20:36:14 -0400795 if code == 421:
796 self.close()
797 else:
R David Murrayafb151a2014-04-14 18:21:38 -0400798 self._rset()
Guido van Rossum296e1431999-04-07 15:03:39 +0000799 raise SMTPDataError(code, resp)
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000800 #if we got here then somebody got our mail
Tim Peters495ad3c2001-01-15 01:36:40 +0000801 return senderrs
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000802
R. David Murray7dff9e02010-11-08 17:15:13 +0000803 def send_message(self, msg, from_addr=None, to_addrs=None,
804 mail_options=[], rcpt_options={}):
805 """Converts message to a bytestring and passes it to sendmail.
806
807 The arguments are as for sendmail, except that msg is an
R David Murrayac4e5ab2011-07-02 21:03:19 -0400808 email.message.Message object. If from_addr is None or to_addrs is
809 None, these arguments are taken from the headers of the Message as
810 described in RFC 2822 (a ValueError is raised if there is more than
811 one set of 'Resent-' headers). Regardless of the values of from_addr and
812 to_addr, any Bcc field (or Resent-Bcc field, when the Message is a
813 resent) of the Message object won't be transmitted. The Message
814 object is then serialized using email.generator.BytesGenerator and
815 sendmail is called to transmit the message.
816
R. David Murray7dff9e02010-11-08 17:15:13 +0000817 """
R David Murrayac4e5ab2011-07-02 21:03:19 -0400818 # 'Resent-Date' is a mandatory field if the Message is resent (RFC 2822
819 # Section 3.6.6). In such a case, we use the 'Resent-*' fields. However,
820 # if there is more than one 'Resent-' block there's no way to
821 # unambiguously determine which one is the most recent in all cases,
822 # so rather than guess we raise a ValueError in that case.
823 #
824 # TODO implement heuristics to guess the correct Resent-* block with an
825 # option allowing the user to enable the heuristics. (It should be
826 # possible to guess correctly almost all of the time.)
Senthil Kumaranb351a482011-07-31 09:14:17 +0800827
828 resent = msg.get_all('Resent-Date')
R David Murrayac4e5ab2011-07-02 21:03:19 -0400829 if resent is None:
830 header_prefix = ''
831 elif len(resent) == 1:
832 header_prefix = 'Resent-'
833 else:
834 raise ValueError("message has more than one 'Resent-' header block")
R. David Murray7dff9e02010-11-08 17:15:13 +0000835 if from_addr is None:
R David Murrayac4e5ab2011-07-02 21:03:19 -0400836 # Prefer the sender field per RFC 2822:3.6.2.
Senthil Kumaranb351a482011-07-31 09:14:17 +0800837 from_addr = (msg[header_prefix + 'Sender']
838 if (header_prefix + 'Sender') in msg
839 else msg[header_prefix + 'From'])
R. David Murray7dff9e02010-11-08 17:15:13 +0000840 if to_addrs is None:
Senthil Kumaranb351a482011-07-31 09:14:17 +0800841 addr_fields = [f for f in (msg[header_prefix + 'To'],
842 msg[header_prefix + 'Bcc'],
843 msg[header_prefix + 'Cc']) if f is not None]
R. David Murray7dff9e02010-11-08 17:15:13 +0000844 to_addrs = [a[1] for a in email.utils.getaddresses(addr_fields)]
R David Murrayac4e5ab2011-07-02 21:03:19 -0400845 # Make a local copy so we can delete the bcc headers.
846 msg_copy = copy.copy(msg)
847 del msg_copy['Bcc']
848 del msg_copy['Resent-Bcc']
R. David Murray7dff9e02010-11-08 17:15:13 +0000849 with io.BytesIO() as bytesmsg:
850 g = email.generator.BytesGenerator(bytesmsg)
R David Murrayac4e5ab2011-07-02 21:03:19 -0400851 g.flatten(msg_copy, linesep='\r\n')
R. David Murray7dff9e02010-11-08 17:15:13 +0000852 flatmsg = bytesmsg.getvalue()
853 return self.sendmail(from_addr, to_addrs, flatmsg, mail_options,
854 rcpt_options)
855
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000856 def close(self):
857 """Close the connection to the SMTP server."""
858 if self.file:
859 self.file.close()
860 self.file = None
861 if self.sock:
862 self.sock.close()
863 self.sock = None
864
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000865 def quit(self):
Guido van Rossum95e6f701998-06-25 02:15:50 +0000866 """Terminate the SMTP session."""
Christian Heimesba4af492008-03-28 00:55:15 +0000867 res = self.docmd("quit")
R David Murray0cff49f2014-08-30 16:51:59 -0400868 # A new EHLO is required after reconnecting with connect()
869 self.ehlo_resp = self.helo_resp = None
870 self.esmtp_features = {}
871 self.does_esmtp = False
Guido van Rossum45e2fbc1998-03-26 21:13:24 +0000872 self.close()
Christian Heimesba4af492008-03-28 00:55:15 +0000873 return res
Guido van Rossum95e6f701998-06-25 02:15:50 +0000874
Thomas Wouters47b49bf2007-08-30 22:15:33 +0000875if _have_ssl:
Thomas Wouters89f507f2006-12-13 04:49:30 +0000876
Thomas Wouters47b49bf2007-08-30 22:15:33 +0000877 class SMTP_SSL(SMTP):
R David Murray021362d2013-06-23 16:05:44 -0400878 """ This is a subclass derived from SMTP that connects over an SSL
879 encrypted socket (to use this class you need a socket module that was
880 compiled with SSL support). If host is not specified, '' (the local
881 host) is used. If port is omitted, the standard SMTP-over-SSL port
882 (465) is used. local_hostname and source_address have the same meaning
883 as they do in the SMTP class. keyfile and certfile are also optional -
884 they can contain a PEM formatted private key and certificate chain file
885 for the SSL connection. context also optional, can contain a
886 SSLContext, and is an alternative to keyfile and certfile; If it is
887 specified both keyfile and certfile must be None.
888
Thomas Wouters47b49bf2007-08-30 22:15:33 +0000889 """
Antoine Pitrouc1d52062011-05-07 19:39:37 +0200890
891 default_port = SMTP_SSL_PORT
892
Thomas Wouters47b49bf2007-08-30 22:15:33 +0000893 def __init__(self, host='', port=0, local_hostname=None,
Georg Brandlf78e02b2008-06-10 17:40:04 +0000894 keyfile=None, certfile=None,
Senthil Kumaran3d23fd62011-07-30 10:56:50 +0800895 timeout=socket._GLOBAL_DEFAULT_TIMEOUT,
896 source_address=None, context=None):
Antoine Pitroue0650202011-05-18 18:03:09 +0200897 if context is not None and keyfile is not None:
898 raise ValueError("context and keyfile arguments are mutually "
899 "exclusive")
900 if context is not None and certfile is not None:
901 raise ValueError("context and certfile arguments are mutually "
902 "exclusive")
Thomas Wouters47b49bf2007-08-30 22:15:33 +0000903 self.keyfile = keyfile
904 self.certfile = certfile
Christian Heimes67986f92013-11-23 22:43:47 +0100905 if context is None:
906 context = ssl._create_stdlib_context(certfile=certfile,
907 keyfile=keyfile)
Antoine Pitroue0650202011-05-18 18:03:09 +0200908 self.context = context
Senthil Kumaran3d23fd62011-07-30 10:56:50 +0800909 SMTP.__init__(self, host, port, local_hostname, timeout,
910 source_address)
Thomas Wouters47b49bf2007-08-30 22:15:33 +0000911
912 def _get_socket(self, host, port, timeout):
Giampaolo Rodolàbd258bd2011-02-22 15:56:20 +0000913 if self.debuglevel > 0:
914 print('connect:', (host, port), file=stderr)
Senthil Kumaran3d23fd62011-07-30 10:56:50 +0800915 new_socket = socket.create_connection((host, port), timeout,
916 self.source_address)
Christian Heimesa5768f72013-12-02 20:44:17 +0100917 new_socket = self.context.wrap_socket(new_socket,
Benjamin Peterson7243b572014-11-23 17:04:34 -0600918 server_hostname=self._host)
R. David Murray87e20742009-05-23 01:30:26 +0000919 return new_socket
Thomas Wouters47b49bf2007-08-30 22:15:33 +0000920
921 __all__.append("SMTP_SSL")
Barry Warsaw4c4bec81998-12-22 03:02:20 +0000922
Guido van Rossumd8faa362007-04-27 19:54:29 +0000923#
924# LMTP extension
925#
926LMTP_PORT = 2003
927
928class LMTP(SMTP):
929 """LMTP - Local Mail Transfer Protocol
930
931 The LMTP protocol, which is very similar to ESMTP, is heavily based
R David Murray021362d2013-06-23 16:05:44 -0400932 on the standard SMTP client. It's common to use Unix sockets for
933 LMTP, so our connect() method must support that as well as a regular
R David Murray36beb662013-06-23 15:47:50 -0400934 host:port server. local_hostname and source_address have the same
R David Murray021362d2013-06-23 16:05:44 -0400935 meaning as they do in the SMTP class. To specify a Unix socket,
936 you must use an absolute path as the host, starting with a '/'.
Guido van Rossumd8faa362007-04-27 19:54:29 +0000937
938 Authentication is supported, using the regular SMTP mechanism. When
939 using a Unix socket, LMTP generally don't support or require any
940 authentication, but your mileage might vary."""
941
942 ehlo_msg = "lhlo"
943
Senthil Kumaran3d23fd62011-07-30 10:56:50 +0800944 def __init__(self, host='', port=LMTP_PORT, local_hostname=None,
945 source_address=None):
Guido van Rossumd8faa362007-04-27 19:54:29 +0000946 """Initialize a new instance."""
Senthil Kumaranb351a482011-07-31 09:14:17 +0800947 SMTP.__init__(self, host, port, local_hostname=local_hostname,
948 source_address=source_address)
Guido van Rossumd8faa362007-04-27 19:54:29 +0000949
Senthil Kumaran3d23fd62011-07-30 10:56:50 +0800950 def connect(self, host='localhost', port=0, source_address=None):
Guido van Rossumd8faa362007-04-27 19:54:29 +0000951 """Connect to the LMTP daemon, on either a Unix or a TCP socket."""
952 if host[0] != '/':
Senthil Kumaranb351a482011-07-31 09:14:17 +0800953 return SMTP.connect(self, host, port, source_address=source_address)
Guido van Rossumd8faa362007-04-27 19:54:29 +0000954
955 # Handle Unix-domain sockets.
956 try:
957 self.sock = socket.socket(socket.AF_UNIX, socket.SOCK_STREAM)
Antoine Pitrouf068ab82011-06-06 19:17:09 +0200958 self.file = None
Guido van Rossumd8faa362007-04-27 19:54:29 +0000959 self.sock.connect(host)
Andrew Svetlov2ade6f22012-12-17 18:57:16 +0200960 except OSError:
Giampaolo Rodolàbd258bd2011-02-22 15:56:20 +0000961 if self.debuglevel > 0:
962 print('connect fail:', host, file=stderr)
Guido van Rossumd8faa362007-04-27 19:54:29 +0000963 if self.sock:
964 self.sock.close()
965 self.sock = None
Andrew Svetlovb6693c42012-12-17 18:54:53 +0200966 raise
Guido van Rossumd8faa362007-04-27 19:54:29 +0000967 (code, msg) = self.getreply()
Giampaolo Rodolàbd258bd2011-02-22 15:56:20 +0000968 if self.debuglevel > 0:
969 print('connect:', msg, file=stderr)
Guido van Rossumd8faa362007-04-27 19:54:29 +0000970 return (code, msg)
971
972
Guido van Rossum95e6f701998-06-25 02:15:50 +0000973# Test the sendmail method, which tests most of the others.
974# Note: This always sends to localhost.
975if __name__ == '__main__':
Andrew M. Kuchling6be424f2001-08-13 14:41:39 +0000976 import sys
Guido van Rossum95e6f701998-06-25 02:15:50 +0000977
978 def prompt(prompt):
979 sys.stdout.write(prompt + ": ")
Ezio Melotti6bfecd12011-10-18 13:20:07 +0300980 sys.stdout.flush()
Eric S. Raymondc013f302001-02-09 05:40:38 +0000981 return sys.stdin.readline().strip()
Guido van Rossum95e6f701998-06-25 02:15:50 +0000982
983 fromaddr = prompt("From")
Giampaolo Rodolàbd258bd2011-02-22 15:56:20 +0000984 toaddrs = prompt("To").split(',')
Guido van Rossumbe19ed72007-02-09 05:37:30 +0000985 print("Enter message, end with ^D:")
Guido van Rossum95e6f701998-06-25 02:15:50 +0000986 msg = ''
987 while 1:
988 line = sys.stdin.readline()
989 if not line:
990 break
991 msg = msg + line
Guido van Rossumbe19ed72007-02-09 05:37:30 +0000992 print("Message length is %d" % len(msg))
Guido van Rossum95e6f701998-06-25 02:15:50 +0000993
994 server = SMTP('localhost')
995 server.set_debuglevel(1)
996 server.sendmail(fromaddr, toaddrs, msg)
997 server.quit()