blob: a4c0d89774da055989b6e44b837dd42842e11c77 [file] [log] [blame]
Benjamin Peterson90f5ba52010-03-11 22:53:45 +00001#! /usr/bin/env python3
Barry Warsaw4c4bec81998-12-22 03:02:20 +00002
Barry Warsawa1ae8842000-07-09 21:24:31 +00003'''SMTP/ESMTP client class.
Guido van Rossumbbe323e1998-01-29 17:24:40 +00004
Guido van Rossumf7fcf5e2001-09-14 16:08:44 +00005This should follow RFC 821 (SMTP), RFC 1869 (ESMTP), RFC 2554 (SMTP
6Authentication) and RFC 2487 (Secure SMTP over TLS).
Guido van Rossumbbe323e1998-01-29 17:24:40 +00007
Guido van Rossumfcfb6321998-08-04 15:29:54 +00008Notes:
9
10Please remember, when doing ESMTP, that the names of the SMTP service
Barry Warsaw4c4bec81998-12-22 03:02:20 +000011extensions are NOT the same thing as the option keywords for the RCPT
Guido van Rossumfcfb6321998-08-04 15:29:54 +000012and MAIL commands!
13
Guido van Rossumbbe323e1998-01-29 17:24:40 +000014Example:
15
Barry Warsawa7d9bdf1998-12-22 03:24:27 +000016 >>> import smtplib
17 >>> s=smtplib.SMTP("localhost")
Guido van Rossum7131f842007-02-09 20:13:25 +000018 >>> print(s.help())
Barry Warsawa7d9bdf1998-12-22 03:24:27 +000019 This is Sendmail version 8.8.4
20 Topics:
21 HELO EHLO MAIL RCPT DATA
22 RSET NOOP QUIT HELP VRFY
23 EXPN VERB ETRN DSN
24 For more info use "HELP <topic>".
25 To report bugs in the implementation send email to
26 sendmail-bugs@sendmail.org.
27 For local information send email to Postmaster at your site.
28 End of HELP info
29 >>> s.putcmd("vrfy","someone@here")
30 >>> s.getreply()
31 (250, "Somebody OverHere <somebody@here.my.org>")
32 >>> s.quit()
Barry Warsawa1ae8842000-07-09 21:24:31 +000033'''
Guido van Rossumbbe323e1998-01-29 17:24:40 +000034
Guido van Rossum98d9fd32000-02-28 15:12:25 +000035# Author: The Dragon De Monsyne <dragondm@integral.org>
36# ESMTP support, test code and doc fixes added by
37# Eric S. Raymond <esr@thyrsus.com>
38# Better RFC 821 compliance (MAIL and RCPT, and CRLF in data)
39# by Carey Evans <c.evans@clear.net.nz>, for picky mail servers.
Guido van Rossumae010462001-09-11 15:57:46 +000040# RFC 2554 (authentication) support by Gerhard Haering <gerhard@bigfoot.de>.
Tim Peters495ad3c2001-01-15 01:36:40 +000041#
Guido van Rossum98d9fd32000-02-28 15:12:25 +000042# This was modified from the Python 1.5 library HTTP lib.
43
Guido van Rossumbbe323e1998-01-29 17:24:40 +000044import socket
R. David Murray7dff9e02010-11-08 17:15:13 +000045import io
Barry Warsaw07201771998-12-22 20:37:36 +000046import re
Thomas Woutersb2137042007-02-01 18:02:27 +000047import email.utils
R. David Murray7dff9e02010-11-08 17:15:13 +000048import email.message
49import email.generator
Guido van Rossumae010462001-09-11 15:57:46 +000050import base64
51import hmac
R David Murrayac4e5ab2011-07-02 21:03:19 -040052import copy
Barry Warsaw2cc1f6d2007-08-30 14:28:55 +000053from email.base64mime import body_encode as encode_base64
Brett Cannone6f8a892004-07-10 23:14:30 +000054from sys import stderr
Guido van Rossumbbe323e1998-01-29 17:24:40 +000055
Giampaolo Rodolàbd258bd2011-02-22 15:56:20 +000056__all__ = ["SMTPException", "SMTPServerDisconnected", "SMTPResponseException",
57 "SMTPSenderRefused", "SMTPRecipientsRefused", "SMTPDataError",
58 "SMTPConnectError", "SMTPHeloError", "SMTPAuthenticationError",
59 "quoteaddr", "quotedata", "SMTP"]
Skip Montanaro0de65802001-02-15 22:15:14 +000060
Guido van Rossumbbe323e1998-01-29 17:24:40 +000061SMTP_PORT = 25
Thomas Wouters89f507f2006-12-13 04:49:30 +000062SMTP_SSL_PORT = 465
Giampaolo Rodolàbd258bd2011-02-22 15:56:20 +000063CRLF = "\r\n"
64bCRLF = b"\r\n"
Guido van Rossumbbe323e1998-01-29 17:24:40 +000065
Piers Lauder385a77a2002-07-27 00:38:30 +000066OLDSTYLE_AUTH = re.compile(r"auth=(.*)", re.I)
67
Tim Peters495ad3c2001-01-15 01:36:40 +000068# Exception classes used by this module.
Guido van Rossum296e1431999-04-07 15:03:39 +000069class SMTPException(Exception):
70 """Base class for all exceptions raised by this module."""
71
72class SMTPServerDisconnected(SMTPException):
73 """Not connected to any SMTP server.
74
75 This exception is raised when the server unexpectedly disconnects,
76 or when an attempt is made to use the SMTP instance before
77 connecting it to a server.
78 """
79
80class SMTPResponseException(SMTPException):
81 """Base class for all exceptions that include an SMTP error code.
82
83 These exceptions are generated in some instances when the SMTP
84 server returns an error code. The error code is stored in the
85 `smtp_code' attribute of the error, and the `smtp_error' attribute
86 is set to the error message.
87 """
88
89 def __init__(self, code, msg):
90 self.smtp_code = code
91 self.smtp_error = msg
92 self.args = (code, msg)
93
94class SMTPSenderRefused(SMTPResponseException):
95 """Sender address refused.
Guido van Rossumae010462001-09-11 15:57:46 +000096
Guido van Rossum296e1431999-04-07 15:03:39 +000097 In addition to the attributes set by on all SMTPResponseException
Barry Warsawd25c1b71999-11-28 17:11:06 +000098 exceptions, this sets `sender' to the string that the SMTP refused.
Guido van Rossum296e1431999-04-07 15:03:39 +000099 """
100
101 def __init__(self, code, msg, sender):
102 self.smtp_code = code
103 self.smtp_error = msg
104 self.sender = sender
105 self.args = (code, msg, sender)
106
Guido van Rossum20c92281999-04-21 16:52:20 +0000107class SMTPRecipientsRefused(SMTPException):
Barry Warsawd25c1b71999-11-28 17:11:06 +0000108 """All recipient addresses refused.
Guido van Rossumae010462001-09-11 15:57:46 +0000109
Thomas Wouters7e474022000-07-16 12:04:32 +0000110 The errors for each recipient are accessible through the attribute
Tim Peters495ad3c2001-01-15 01:36:40 +0000111 'recipients', which is a dictionary of exactly the same sort as
112 SMTP.sendmail() returns.
Guido van Rossum296e1431999-04-07 15:03:39 +0000113 """
114
115 def __init__(self, recipients):
116 self.recipients = recipients
Giampaolo Rodolàbd258bd2011-02-22 15:56:20 +0000117 self.args = (recipients,)
Guido van Rossum296e1431999-04-07 15:03:39 +0000118
119
Guido van Rossum296e1431999-04-07 15:03:39 +0000120class SMTPDataError(SMTPResponseException):
121 """The SMTP server didn't accept the data."""
122
123class SMTPConnectError(SMTPResponseException):
Barry Warsawd25c1b71999-11-28 17:11:06 +0000124 """Error during connection establishment."""
Guido van Rossum296e1431999-04-07 15:03:39 +0000125
126class SMTPHeloError(SMTPResponseException):
Barry Warsawd25c1b71999-11-28 17:11:06 +0000127 """The server refused our HELO reply."""
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000128
Guido van Rossumae010462001-09-11 15:57:46 +0000129class SMTPAuthenticationError(SMTPResponseException):
130 """Authentication error.
131
132 Most probably the server didn't accept the username/password
133 combination provided.
134 """
Peter Schneider-Kamp7bc82bb2000-08-10 14:02:23 +0000135
R David Murray4c14bba2011-07-18 21:59:53 -0400136def quoteaddr(addrstring):
Guido van Rossum69a79bc1998-07-13 15:18:49 +0000137 """Quote a subset of the email addresses defined by RFC 821.
138
Georg Brandl9f0f9602008-06-12 22:23:59 +0000139 Should be able to handle anything email.utils.parseaddr can handle.
Barry Warsawa7d9bdf1998-12-22 03:24:27 +0000140 """
R David Murray4c14bba2011-07-18 21:59:53 -0400141 displayname, addr = email.utils.parseaddr(addrstring)
142 if (displayname, addr) == ('', ''):
143 # parseaddr couldn't parse it, use it as is and hope for the best.
144 if addrstring.strip().startswith('<'):
145 return addrstring
146 return "<%s>" % addrstring
147 return "<%s>" % addr
Guido van Rossum69a79bc1998-07-13 15:18:49 +0000148
R David Murray46346762011-07-18 21:38:54 -0400149def _addr_only(addrstring):
150 displayname, addr = email.utils.parseaddr(addrstring)
151 if (displayname, addr) == ('', ''):
152 # parseaddr couldn't parse it, so use it as is.
153 return addrstring
154 return addr
155
R. David Murray7dff9e02010-11-08 17:15:13 +0000156# Legacy method kept for backward compatibility.
Guido van Rossum69a79bc1998-07-13 15:18:49 +0000157def quotedata(data):
158 """Quote data for email.
159
Barry Warsawd25c1b71999-11-28 17:11:06 +0000160 Double leading '.', and change Unix newline '\\n', or Mac '\\r' into
Barry Warsawa7d9bdf1998-12-22 03:24:27 +0000161 Internet CRLF end-of-line.
162 """
Guido van Rossum69a79bc1998-07-13 15:18:49 +0000163 return re.sub(r'(?m)^\.', '..',
Guido van Rossumfcfb6321998-08-04 15:29:54 +0000164 re.sub(r'(?:\r\n|\n|\r(?!\n))', CRLF, data))
Guido van Rossum69a79bc1998-07-13 15:18:49 +0000165
R. David Murray7dff9e02010-11-08 17:15:13 +0000166def _quote_periods(bindata):
R David Murray0f663d02011-06-09 15:05:57 -0400167 return re.sub(br'(?m)^\.', b'..', bindata)
R. David Murray7dff9e02010-11-08 17:15:13 +0000168
169def _fix_eols(data):
170 return re.sub(r'(?:\r\n|\n|\r(?!\n))', CRLF, data)
171
Thomas Wouters47b49bf2007-08-30 22:15:33 +0000172try:
173 import ssl
174except ImportError:
175 _have_ssl = False
176else:
Thomas Wouters47b49bf2007-08-30 22:15:33 +0000177 _have_ssl = True
178
Peter Schneider-Kamp7bc82bb2000-08-10 14:02:23 +0000179
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000180class SMTP:
Guido van Rossumfcfb6321998-08-04 15:29:54 +0000181 """This class manages a connection to an SMTP or ESMTP server.
182 SMTP Objects:
Tim Peters495ad3c2001-01-15 01:36:40 +0000183 SMTP objects have the following attributes:
184 helo_resp
185 This is the message given by the server in response to the
Guido van Rossumfcfb6321998-08-04 15:29:54 +0000186 most recent HELO command.
Tim Peters495ad3c2001-01-15 01:36:40 +0000187
Guido van Rossumfcfb6321998-08-04 15:29:54 +0000188 ehlo_resp
Tim Peters495ad3c2001-01-15 01:36:40 +0000189 This is the message given by the server in response to the
Guido van Rossumfcfb6321998-08-04 15:29:54 +0000190 most recent EHLO command. This is usually multiline.
191
Tim Peters495ad3c2001-01-15 01:36:40 +0000192 does_esmtp
Guido van Rossumfcfb6321998-08-04 15:29:54 +0000193 This is a True value _after you do an EHLO command_, if the
194 server supports ESMTP.
195
Tim Peters495ad3c2001-01-15 01:36:40 +0000196 esmtp_features
Guido van Rossumfcfb6321998-08-04 15:29:54 +0000197 This is a dictionary, which, if the server supports ESMTP,
Barry Warsawd25c1b71999-11-28 17:11:06 +0000198 will _after you do an EHLO command_, contain the names of the
199 SMTP service extensions this server supports, and their
Guido van Rossumfcfb6321998-08-04 15:29:54 +0000200 parameters (if any).
Barry Warsawd25c1b71999-11-28 17:11:06 +0000201
Tim Peters495ad3c2001-01-15 01:36:40 +0000202 Note, all extension names are mapped to lower case in the
203 dictionary.
Guido van Rossumfcfb6321998-08-04 15:29:54 +0000204
Barry Warsawd25c1b71999-11-28 17:11:06 +0000205 See each method's docstrings for details. In general, there is a
206 method of the same name to perform each SMTP command. There is also a
207 method called 'sendmail' that will do an entire mail transaction.
208 """
Guido van Rossum95e6f701998-06-25 02:15:50 +0000209 debuglevel = 0
210 file = None
211 helo_resp = None
Guido van Rossumd8faa362007-04-27 19:54:29 +0000212 ehlo_msg = "ehlo"
Guido van Rossum95e6f701998-06-25 02:15:50 +0000213 ehlo_resp = None
Guido van Rossumfcfb6321998-08-04 15:29:54 +0000214 does_esmtp = 0
Antoine Pitrouc1d52062011-05-07 19:39:37 +0200215 default_port = SMTP_PORT
Guido van Rossum95e6f701998-06-25 02:15:50 +0000216
Georg Brandlf78e02b2008-06-10 17:40:04 +0000217 def __init__(self, host='', port=0, local_hostname=None,
Senthil Kumaran3d23fd62011-07-30 10:56:50 +0800218 timeout=socket._GLOBAL_DEFAULT_TIMEOUT,
219 source_address=None):
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000220 """Initialize a new instance.
221
Barry Warsawa7d9bdf1998-12-22 03:24:27 +0000222 If specified, `host' is the name of the remote host to which to
223 connect. If specified, `port' specifies the port to which to connect.
Barry Warsawd25c1b71999-11-28 17:11:06 +0000224 By default, smtplib.SMTP_PORT is used. An SMTPConnectError is raised
Neil Schemenauer6730f262002-03-24 15:30:40 +0000225 if the specified `host' doesn't respond correctly. If specified,
Tim Peters863ac442002-04-16 01:38:40 +0000226 `local_hostname` is used as the FQDN of the local host. By default,
Senthil Kumaran3d23fd62011-07-30 10:56:50 +0800227 the local hostname is found using socket.getfqdn(). The
228 `source_address` parameter takes a 2-tuple (host, port) for the socket
229 to bind to as its source address before connecting. If the host is ''
230 and port is 0, the OS default behavior will be used.
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000231
232 """
Guido van Rossumd8faa362007-04-27 19:54:29 +0000233 self.timeout = timeout
Guido van Rossumfcfb6321998-08-04 15:29:54 +0000234 self.esmtp_features = {}
Senthil Kumaran3d23fd62011-07-30 10:56:50 +0800235 self.source_address = source_address
236
Guido van Rossum296e1431999-04-07 15:03:39 +0000237 if host:
238 (code, msg) = self.connect(host, port)
239 if code != 220:
240 raise SMTPConnectError(code, msg)
Raymond Hettingerf13eb552002-06-02 00:40:05 +0000241 if local_hostname is not None:
Barry Warsaw13e34f72002-03-26 20:27:35 +0000242 self.local_hostname = local_hostname
Neil Schemenauer6730f262002-03-24 15:30:40 +0000243 else:
Barry Warsaw13e34f72002-03-26 20:27:35 +0000244 # RFC 2821 says we should use the fqdn in the EHLO/HELO verb, and
245 # if that can't be calculated, that we should use a domain literal
246 # instead (essentially an encoded IP address like [A.B.C.D]).
247 fqdn = socket.getfqdn()
248 if '.' in fqdn:
249 self.local_hostname = fqdn
250 else:
251 # We can't find an fqdn hostname, so use a domain literal
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000252 addr = '127.0.0.1'
253 try:
254 addr = socket.gethostbyname(socket.gethostname())
255 except socket.gaierror:
256 pass
Barry Warsaw13e34f72002-03-26 20:27:35 +0000257 self.local_hostname = '[%s]' % addr
Tim Peters495ad3c2001-01-15 01:36:40 +0000258
Barry Warsaw1f5c9582011-03-15 15:04:44 -0400259 def __enter__(self):
260 return self
261
262 def __exit__(self, *args):
263 try:
264 code, message = self.docmd("QUIT")
265 if code != 221:
266 raise SMTPResponseException(code, message)
267 except SMTPServerDisconnected:
268 pass
269 finally:
270 self.close()
271
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000272 def set_debuglevel(self, debuglevel):
273 """Set the debug output level.
274
Barry Warsawa7d9bdf1998-12-22 03:24:27 +0000275 A non-false value results in debug messages for connection and for all
276 messages sent to and received from the server.
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000277
278 """
279 self.debuglevel = debuglevel
280
Barry Warsawc9181712008-03-19 14:25:51 +0000281 def _get_socket(self, host, port, timeout):
Thomas Wouters89f507f2006-12-13 04:49:30 +0000282 # This makes it simpler for SMTP_SSL to use the SMTP connect code
283 # and just alter the socket connection bit.
Giampaolo Rodolàbd258bd2011-02-22 15:56:20 +0000284 if self.debuglevel > 0:
Senthil Kumaranb351a482011-07-31 09:14:17 +0800285 print('connect: to', (host, port), self.source_address,
286 file=stderr)
Senthil Kumaran3d23fd62011-07-30 10:56:50 +0800287 return socket.create_connection((host, port), timeout,
288 self.source_address)
Thomas Wouters89f507f2006-12-13 04:49:30 +0000289
Senthil Kumaran3d23fd62011-07-30 10:56:50 +0800290 def connect(self, host='localhost', port=0, source_address=None):
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000291 """Connect to a host on a given port.
Guido van Rossum95e6f701998-06-25 02:15:50 +0000292
Barry Warsaw4c4bec81998-12-22 03:02:20 +0000293 If the hostname ends with a colon (`:') followed by a number, and
294 there is no port specified, that suffix will be stripped off and the
295 number interpreted as the port number to use.
Guido van Rossum95e6f701998-06-25 02:15:50 +0000296
Barry Warsawa7d9bdf1998-12-22 03:24:27 +0000297 Note: This method is automatically invoked by __init__, if a host is
298 specified during instantiation.
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000299
300 """
Senthil Kumaranb351a482011-07-31 09:14:17 +0800301
302 if source_address:
303 self.source_address = source_address
304
Martin v. Löwis4eb59402001-07-26 13:37:33 +0000305 if not port and (host.find(':') == host.rfind(':')):
Martin v. Löwisa43c2f82001-07-24 20:34:08 +0000306 i = host.rfind(':')
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000307 if i >= 0:
Giampaolo Rodolàbd258bd2011-02-22 15:56:20 +0000308 host, port = host[:i], host[i + 1:]
309 try:
310 port = int(port)
Eric S. Raymond8d876032001-02-09 10:14:53 +0000311 except ValueError:
Guido van Rossumd8faa362007-04-27 19:54:29 +0000312 raise socket.error("nonnumeric port")
Giampaolo Rodolàbd258bd2011-02-22 15:56:20 +0000313 if not port:
314 port = self.default_port
315 if self.debuglevel > 0:
316 print('connect:', (host, port), file=stderr)
Guido van Rossumd8faa362007-04-27 19:54:29 +0000317 self.sock = self._get_socket(host, port, self.timeout)
Antoine Pitrouf068ab82011-06-06 19:17:09 +0200318 self.file = None
Martin v. Löwisa43c2f82001-07-24 20:34:08 +0000319 (code, msg) = self.getreply()
Giampaolo Rodolàbd258bd2011-02-22 15:56:20 +0000320 if self.debuglevel > 0:
321 print("connect:", msg, file=stderr)
Martin v. Löwisa43c2f82001-07-24 20:34:08 +0000322 return (code, msg)
Tim Peters495ad3c2001-01-15 01:36:40 +0000323
Guido van Rossum8a392d72007-11-21 22:09:45 +0000324 def send(self, s):
325 """Send `s' to the server."""
Giampaolo Rodolàbd258bd2011-02-22 15:56:20 +0000326 if self.debuglevel > 0:
327 print('send:', repr(s), file=stderr)
Christian Heimes90c3d9b2008-02-23 13:18:03 +0000328 if hasattr(self, 'sock') and self.sock:
Guido van Rossum8a392d72007-11-21 22:09:45 +0000329 if isinstance(s, str):
330 s = s.encode("ascii")
Guido van Rossum2880f6e1998-08-10 20:07:00 +0000331 try:
Guido van Rossum8a392d72007-11-21 22:09:45 +0000332 self.sock.sendall(s)
Guido van Rossum2880f6e1998-08-10 20:07:00 +0000333 except socket.error:
Barry Warsaw76750972001-12-14 20:34:20 +0000334 self.close()
Guido van Rossum40233ea1999-01-15 03:23:55 +0000335 raise SMTPServerDisconnected('Server not connected')
Guido van Rossumfc40a831998-01-29 17:26:45 +0000336 else:
Guido van Rossum40233ea1999-01-15 03:23:55 +0000337 raise SMTPServerDisconnected('please run connect() first')
Tim Peters495ad3c2001-01-15 01:36:40 +0000338
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000339 def putcmd(self, cmd, args=""):
Barry Warsawa7d9bdf1998-12-22 03:24:27 +0000340 """Send a command to the server."""
Guido van Rossumdb23d3d1999-06-09 15:13:10 +0000341 if args == "":
342 str = '%s%s' % (cmd, CRLF)
343 else:
344 str = '%s %s%s' % (cmd, args, CRLF)
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000345 self.send(str)
Tim Peters495ad3c2001-01-15 01:36:40 +0000346
Guido van Rossumfcfb6321998-08-04 15:29:54 +0000347 def getreply(self):
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000348 """Get a reply from the server.
Tim Peters495ad3c2001-01-15 01:36:40 +0000349
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000350 Returns a tuple consisting of:
Barry Warsawa7d9bdf1998-12-22 03:24:27 +0000351
352 - server response code (e.g. '250', or such, if all goes well)
353 Note: returns -1 if it can't read response code.
354
355 - server response string corresponding to response code (multiline
356 responses are converted to a single, multiline string).
Guido van Rossumf123f841999-03-29 20:33:21 +0000357
358 Raises SMTPServerDisconnected if end-of-file is reached.
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000359 """
Giampaolo Rodolàbd258bd2011-02-22 15:56:20 +0000360 resp = []
Guido van Rossum296e1431999-04-07 15:03:39 +0000361 if self.file is None:
362 self.file = self.sock.makefile('rb')
Guido van Rossum45e2fbc1998-03-26 21:13:24 +0000363 while 1:
Benjamin Petersone1cdfd72009-01-18 21:02:37 +0000364 try:
365 line = self.file.readline()
366 except socket.error:
367 line = ''
Guido van Rossum806c2462007-08-06 23:33:07 +0000368 if not line:
Guido van Rossum296e1431999-04-07 15:03:39 +0000369 self.close()
370 raise SMTPServerDisconnected("Connection unexpectedly closed")
Giampaolo Rodolàbd258bd2011-02-22 15:56:20 +0000371 if self.debuglevel > 0:
372 print('reply:', repr(line), file=stderr)
Guido van Rossum806c2462007-08-06 23:33:07 +0000373 resp.append(line[4:].strip(b' \t\r\n'))
Giampaolo Rodolàbd258bd2011-02-22 15:56:20 +0000374 code = line[:3]
Guido van Rossum296e1431999-04-07 15:03:39 +0000375 # Check that the error code is syntactically correct.
376 # Don't attempt to read a continuation line if it is broken.
377 try:
Eric S. Raymondc013f302001-02-09 05:40:38 +0000378 errcode = int(code)
Guido van Rossum296e1431999-04-07 15:03:39 +0000379 except ValueError:
380 errcode = -1
381 break
Guido van Rossumf123f841999-03-29 20:33:21 +0000382 # Check if multiline response.
Guido van Rossum806c2462007-08-06 23:33:07 +0000383 if line[3:4] != b"-":
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000384 break
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000385
Guido van Rossumc43e79f2007-06-18 18:26:36 +0000386 errmsg = b"\n".join(resp)
Tim Peters495ad3c2001-01-15 01:36:40 +0000387 if self.debuglevel > 0:
Senthil Kumaranb351a482011-07-31 09:14:17 +0800388 print('reply: retcode (%s); Msg: %s' % (errcode, errmsg),
389 file=stderr)
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000390 return errcode, errmsg
Tim Peters495ad3c2001-01-15 01:36:40 +0000391
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000392 def docmd(self, cmd, args=""):
Barry Warsawa7d9bdf1998-12-22 03:24:27 +0000393 """Send a command, and return its response code."""
Giampaolo Rodolàbd258bd2011-02-22 15:56:20 +0000394 self.putcmd(cmd, args)
Guido van Rossum296e1431999-04-07 15:03:39 +0000395 return self.getreply()
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000396
Barry Warsawa7d9bdf1998-12-22 03:24:27 +0000397 # std smtp commands
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000398 def helo(self, name=''):
Barry Warsawa7d9bdf1998-12-22 03:24:27 +0000399 """SMTP 'helo' command.
400 Hostname to send for this command defaults to the FQDN of the local
401 host.
402 """
Neil Schemenauer6730f262002-03-24 15:30:40 +0000403 self.putcmd("helo", name or self.local_hostname)
Giampaolo Rodolàbd258bd2011-02-22 15:56:20 +0000404 (code, msg) = self.getreply()
405 self.helo_resp = msg
406 return (code, msg)
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000407
Guido van Rossum95e6f701998-06-25 02:15:50 +0000408 def ehlo(self, name=''):
Barry Warsawa7d9bdf1998-12-22 03:24:27 +0000409 """ SMTP 'ehlo' command.
410 Hostname to send for this command defaults to the FQDN of the local
411 host.
412 """
Guido van Rossumf7fcf5e2001-09-14 16:08:44 +0000413 self.esmtp_features = {}
Guido van Rossumd8faa362007-04-27 19:54:29 +0000414 self.putcmd(self.ehlo_msg, name or self.local_hostname)
Giampaolo Rodolàbd258bd2011-02-22 15:56:20 +0000415 (code, msg) = self.getreply()
Tim Peters495ad3c2001-01-15 01:36:40 +0000416 # According to RFC1869 some (badly written)
417 # MTA's will disconnect on an ehlo. Toss an exception if
Guido van Rossumfcfb6321998-08-04 15:29:54 +0000418 # that happens -ddm
419 if code == -1 and len(msg) == 0:
Barry Warsaw76750972001-12-14 20:34:20 +0000420 self.close()
Guido van Rossum40233ea1999-01-15 03:23:55 +0000421 raise SMTPServerDisconnected("Server not connected")
Giampaolo Rodolàbd258bd2011-02-22 15:56:20 +0000422 self.ehlo_resp = msg
Fred Drake8152d322000-12-12 23:20:45 +0000423 if code != 250:
Giampaolo Rodolàbd258bd2011-02-22 15:56:20 +0000424 return (code, msg)
425 self.does_esmtp = 1
Thomas Wouters7e474022000-07-16 12:04:32 +0000426 #parse the ehlo response -ddm
Guido van Rossum04110fb2007-08-24 16:32:05 +0000427 assert isinstance(self.ehlo_resp, bytes), repr(self.ehlo_resp)
Giampaolo Rodolàbd258bd2011-02-22 15:56:20 +0000428 resp = self.ehlo_resp.decode("latin-1").split('\n')
Guido van Rossumfcfb6321998-08-04 15:29:54 +0000429 del resp[0]
Guido van Rossum2880f6e1998-08-10 20:07:00 +0000430 for each in resp:
Piers Lauder385a77a2002-07-27 00:38:30 +0000431 # To be able to communicate with as many SMTP servers as possible,
432 # we have to take the old-style auth advertisement into account,
433 # because:
434 # 1) Else our SMTP feature parser gets confused.
435 # 2) There are some servers that only advertise the auth methods we
436 # support using the old style.
437 auth_match = OLDSTYLE_AUTH.match(each)
438 if auth_match:
439 # This doesn't remove duplicates, but that's no problem
440 self.esmtp_features["auth"] = self.esmtp_features.get("auth", "") \
441 + " " + auth_match.groups(0)[0]
442 continue
443
Barry Warsawbe22ae62002-04-15 20:03:30 +0000444 # RFC 1869 requires a space between ehlo keyword and parameters.
445 # It's actually stricter, in that only spaces are allowed between
446 # parameters, but were not going to check for that here. Note
447 # that the space isn't present if there are no parameters.
Giampaolo Rodolàbd258bd2011-02-22 15:56:20 +0000448 m = re.match(r'(?P<feature>[A-Za-z0-9][A-Za-z0-9\-]*) ?', each)
Guido van Rossumfcfb6321998-08-04 15:29:54 +0000449 if m:
Giampaolo Rodolàbd258bd2011-02-22 15:56:20 +0000450 feature = m.group("feature").lower()
451 params = m.string[m.end("feature"):].strip()
Piers Lauder385a77a2002-07-27 00:38:30 +0000452 if feature == "auth":
453 self.esmtp_features[feature] = self.esmtp_features.get(feature, "") \
454 + " " + params
455 else:
Giampaolo Rodolàbd258bd2011-02-22 15:56:20 +0000456 self.esmtp_features[feature] = params
457 return (code, msg)
Guido van Rossum95e6f701998-06-25 02:15:50 +0000458
Guido van Rossumfcfb6321998-08-04 15:29:54 +0000459 def has_extn(self, opt):
460 """Does the server support a given SMTP service extension?"""
Raymond Hettinger54f02222002-06-01 14:18:47 +0000461 return opt.lower() in self.esmtp_features
Guido van Rossum95e6f701998-06-25 02:15:50 +0000462
Guido van Rossum18586f41998-04-03 17:03:13 +0000463 def help(self, args=''):
Barry Warsawa7d9bdf1998-12-22 03:24:27 +0000464 """SMTP 'help' command.
465 Returns help text from server."""
Guido van Rossum18586f41998-04-03 17:03:13 +0000466 self.putcmd("help", args)
Kurt B. Kaiser58bd1902005-06-26 18:27:36 +0000467 return self.getreply()[1]
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000468
469 def rset(self):
Barry Warsawa7d9bdf1998-12-22 03:24:27 +0000470 """SMTP 'rset' command -- resets session."""
Guido van Rossum296e1431999-04-07 15:03:39 +0000471 return self.docmd("rset")
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000472
473 def noop(self):
Barry Warsawa7d9bdf1998-12-22 03:24:27 +0000474 """SMTP 'noop' command -- doesn't do anything :>"""
Guido van Rossum296e1431999-04-07 15:03:39 +0000475 return self.docmd("noop")
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000476
Giampaolo Rodolàbd258bd2011-02-22 15:56:20 +0000477 def mail(self, sender, options=[]):
Barry Warsawa7d9bdf1998-12-22 03:24:27 +0000478 """SMTP 'mail' command -- begins mail xfer session."""
Guido van Rossumfcfb6321998-08-04 15:29:54 +0000479 optionlist = ''
480 if options and self.does_esmtp:
Eric S. Raymondc013f302001-02-09 05:40:38 +0000481 optionlist = ' ' + ' '.join(options)
Giampaolo Rodolàbd258bd2011-02-22 15:56:20 +0000482 self.putcmd("mail", "FROM:%s%s" % (quoteaddr(sender), optionlist))
Guido van Rossum45e2fbc1998-03-26 21:13:24 +0000483 return self.getreply()
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000484
Giampaolo Rodolàbd258bd2011-02-22 15:56:20 +0000485 def rcpt(self, recip, options=[]):
Barry Warsawa7d9bdf1998-12-22 03:24:27 +0000486 """SMTP 'rcpt' command -- indicates 1 recipient for this mail."""
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("rcpt", "TO:%s%s" % (quoteaddr(recip), 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 data(self, msg):
Tim Peters495ad3c2001-01-15 01:36:40 +0000494 """SMTP 'DATA' command -- sends message data to server.
Guido van Rossum296e1431999-04-07 15:03:39 +0000495
Barry Warsaw4c4bec81998-12-22 03:02:20 +0000496 Automatically quotes lines beginning with a period per rfc821.
Guido van Rossum296e1431999-04-07 15:03:39 +0000497 Raises SMTPDataError if there is an unexpected reply to the
498 DATA command; the return value from this method is the final
R. David Murray7dff9e02010-11-08 17:15:13 +0000499 response code received when the all data is sent. If msg
500 is a string, lone '\r' and '\n' characters are converted to
501 '\r\n' characters. If msg is bytes, it is transmitted as is.
Barry Warsaw4c4bec81998-12-22 03:02:20 +0000502 """
Guido van Rossum45e2fbc1998-03-26 21:13:24 +0000503 self.putcmd("data")
Giampaolo Rodolàbd258bd2011-02-22 15:56:20 +0000504 (code, repl) = self.getreply()
505 if self.debuglevel > 0:
506 print("data:", (code, repl), file=stderr)
Fred Drake8152d322000-12-12 23:20:45 +0000507 if code != 354:
Giampaolo Rodolàbd258bd2011-02-22 15:56:20 +0000508 raise SMTPDataError(code, repl)
Guido van Rossum45e2fbc1998-03-26 21:13:24 +0000509 else:
R. David Murray7dff9e02010-11-08 17:15:13 +0000510 if isinstance(msg, str):
511 msg = _fix_eols(msg).encode('ascii')
512 q = _quote_periods(msg)
513 if q[-2:] != bCRLF:
514 q = q + bCRLF
515 q = q + b"." + bCRLF
Guido van Rossum20c92281999-04-21 16:52:20 +0000516 self.send(q)
Giampaolo Rodolàbd258bd2011-02-22 15:56:20 +0000517 (code, msg) = self.getreply()
518 if self.debuglevel > 0:
519 print("data:", (code, msg), file=stderr)
520 return (code, msg)
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000521
Guido van Rossumfcfb6321998-08-04 15:29:54 +0000522 def verify(self, address):
Barry Warsawa7d9bdf1998-12-22 03:24:27 +0000523 """SMTP 'verify' command -- checks for address validity."""
R David Murray46346762011-07-18 21:38:54 -0400524 self.putcmd("vrfy", _addr_only(address))
Guido van Rossumfcfb6321998-08-04 15:29:54 +0000525 return self.getreply()
Barry Warsaw4c4bec81998-12-22 03:02:20 +0000526 # a.k.a.
Giampaolo Rodolàbd258bd2011-02-22 15:56:20 +0000527 vrfy = verify
Guido van Rossumfcfb6321998-08-04 15:29:54 +0000528
529 def expn(self, address):
Christian Heimes90c3d9b2008-02-23 13:18:03 +0000530 """SMTP 'expn' command -- expands a mailing list."""
R David Murray46346762011-07-18 21:38:54 -0400531 self.putcmd("expn", _addr_only(address))
Guido van Rossumfcfb6321998-08-04 15:29:54 +0000532 return self.getreply()
533
Barry Warsaw4c4bec81998-12-22 03:02:20 +0000534 # some useful methods
Guido van Rossumae010462001-09-11 15:57:46 +0000535
Christian Heimes679db4a2008-01-18 09:56:22 +0000536 def ehlo_or_helo_if_needed(self):
537 """Call self.ehlo() and/or self.helo() if needed.
538
539 If there has been no previous EHLO or HELO command this session, this
540 method tries ESMTP EHLO first.
541
542 This method may raise the following exceptions:
543
544 SMTPHeloError The server didn't reply properly to
545 the helo greeting.
546 """
547 if self.helo_resp is None and self.ehlo_resp is None:
548 if not (200 <= self.ehlo()[0] <= 299):
549 (code, resp) = self.helo()
550 if not (200 <= code <= 299):
551 raise SMTPHeloError(code, resp)
552
Guido van Rossumae010462001-09-11 15:57:46 +0000553 def login(self, user, password):
554 """Log in on an SMTP server that requires authentication.
555
556 The arguments are:
557 - user: The user name to authenticate with.
558 - password: The password for the authentication.
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 will return normally if the authentication was successful.
564
565 This method may raise the following exceptions:
566
567 SMTPHeloError The server didn't reply properly to
568 the helo greeting.
569 SMTPAuthenticationError The server didn't accept the username/
570 password combination.
Fred Drake2f8f4d32001-10-13 18:35:32 +0000571 SMTPException No suitable authentication method was
Guido van Rossumae010462001-09-11 15:57:46 +0000572 found.
573 """
574
575 def encode_cram_md5(challenge, user, password):
Georg Brandl706824f2009-06-04 09:42:55 +0000576 challenge = base64.decodebytes(challenge)
R. David Murrayfb123912009-05-28 18:19:00 +0000577 response = user + " " + hmac.HMAC(password.encode('ascii'),
578 challenge).hexdigest()
579 return encode_base64(response.encode('ascii'), eol='')
Guido van Rossumae010462001-09-11 15:57:46 +0000580
581 def encode_plain(user, password):
R. David Murraycaa27b72009-05-23 18:49:56 +0000582 s = "\0%s\0%s" % (user, password)
583 return encode_base64(s.encode('ascii'), eol='')
Tim Peters469cdad2002-08-08 20:19:19 +0000584
Guido van Rossumae010462001-09-11 15:57:46 +0000585 AUTH_PLAIN = "PLAIN"
586 AUTH_CRAM_MD5 = "CRAM-MD5"
Piers Lauder385a77a2002-07-27 00:38:30 +0000587 AUTH_LOGIN = "LOGIN"
Guido van Rossumae010462001-09-11 15:57:46 +0000588
Christian Heimes679db4a2008-01-18 09:56:22 +0000589 self.ehlo_or_helo_if_needed()
Guido van Rossumae010462001-09-11 15:57:46 +0000590
591 if not self.has_extn("auth"):
592 raise SMTPException("SMTP AUTH extension not supported by server.")
593
Gerhard Häring1c5471f2010-08-05 14:08:44 +0000594 # Authentication methods the server claims to support
595 advertised_authlist = self.esmtp_features["auth"].split()
Guido van Rossumae010462001-09-11 15:57:46 +0000596
597 # List of authentication methods we support: from preferred to
598 # less preferred methods. Except for the purpose of testing the weaker
599 # ones, we prefer stronger methods like CRAM-MD5:
Piers Lauder385a77a2002-07-27 00:38:30 +0000600 preferred_auths = [AUTH_CRAM_MD5, AUTH_PLAIN, AUTH_LOGIN]
Guido van Rossumae010462001-09-11 15:57:46 +0000601
Gerhard Häring1c5471f2010-08-05 14:08:44 +0000602 # We try the authentication methods the server advertises, but only the
603 # ones *we* support. And in our preferred order.
604 authlist = [auth for auth in preferred_auths if auth in advertised_authlist]
605 if not authlist:
Fred Drake2f8f4d32001-10-13 18:35:32 +0000606 raise SMTPException("No suitable authentication method found.")
Gerhard Häring1c5471f2010-08-05 14:08:44 +0000607
608 # Some servers advertise authentication methods they don't really
609 # support, so if authentication fails, we continue until we've tried
610 # all methods.
611 for authmethod in authlist:
612 if authmethod == AUTH_CRAM_MD5:
613 (code, resp) = self.docmd("AUTH", AUTH_CRAM_MD5)
614 if code == 334:
615 (code, resp) = self.docmd(encode_cram_md5(resp, user, password))
616 elif authmethod == AUTH_PLAIN:
617 (code, resp) = self.docmd("AUTH",
618 AUTH_PLAIN + " " + encode_plain(user, password))
619 elif authmethod == AUTH_LOGIN:
620 (code, resp) = self.docmd("AUTH",
621 "%s %s" % (AUTH_LOGIN, encode_base64(user.encode('ascii'), eol='')))
622 if code == 334:
623 (code, resp) = self.docmd(encode_base64(password.encode('ascii'), eol=''))
624
Guido van Rossumae010462001-09-11 15:57:46 +0000625 # 235 == 'Authentication successful'
626 # 503 == 'Error: already authenticated'
Gerhard Häring1c5471f2010-08-05 14:08:44 +0000627 if code in (235, 503):
628 return (code, resp)
629
630 # We could not login sucessfully. Return result of last attempt.
631 raise SMTPAuthenticationError(code, resp)
Guido van Rossumae010462001-09-11 15:57:46 +0000632
Antoine Pitroue0650202011-05-18 18:03:09 +0200633 def starttls(self, keyfile=None, certfile=None, context=None):
Guido van Rossumf7fcf5e2001-09-14 16:08:44 +0000634 """Puts the connection to the SMTP server into TLS mode.
Tim Petersb64bec32001-09-18 02:26:39 +0000635
Christian Heimes679db4a2008-01-18 09:56:22 +0000636 If there has been no previous EHLO or HELO command this session, this
637 method tries ESMTP EHLO first.
638
Guido van Rossumf7fcf5e2001-09-14 16:08:44 +0000639 If the server supports TLS, this will encrypt the rest of the SMTP
640 session. If you provide the keyfile and certfile parameters,
641 the identity of the SMTP server and client can be checked. This,
642 however, depends on whether the socket module really checks the
643 certificates.
Christian Heimes679db4a2008-01-18 09:56:22 +0000644
645 This method may raise the following exceptions:
646
647 SMTPHeloError The server didn't reply properly to
648 the helo greeting.
Guido van Rossumf7fcf5e2001-09-14 16:08:44 +0000649 """
Christian Heimes679db4a2008-01-18 09:56:22 +0000650 self.ehlo_or_helo_if_needed()
651 if not self.has_extn("starttls"):
652 raise SMTPException("STARTTLS extension not supported by server.")
Tim Petersb64bec32001-09-18 02:26:39 +0000653 (resp, reply) = self.docmd("STARTTLS")
Guido van Rossumf7fcf5e2001-09-14 16:08:44 +0000654 if resp == 220:
Thomas Wouters47b49bf2007-08-30 22:15:33 +0000655 if not _have_ssl:
656 raise RuntimeError("No SSL support included in this Python")
Antoine Pitroue0650202011-05-18 18:03:09 +0200657 if context is not None and keyfile is not None:
658 raise ValueError("context and keyfile arguments are mutually "
659 "exclusive")
660 if context is not None and certfile is not None:
661 raise ValueError("context and certfile arguments are mutually "
662 "exclusive")
663 if context is not None:
664 self.sock = context.wrap_socket(self.sock)
665 else:
666 self.sock = ssl.wrap_socket(self.sock, keyfile, certfile)
Antoine Pitrouf068ab82011-06-06 19:17:09 +0200667 self.file = None
Christian Heimes679db4a2008-01-18 09:56:22 +0000668 # RFC 3207:
669 # The client MUST discard any knowledge obtained from
670 # the server, such as the list of SMTP service extensions,
671 # which was not obtained from the TLS negotiation itself.
672 self.helo_resp = None
673 self.ehlo_resp = None
674 self.esmtp_features = {}
675 self.does_esmtp = 0
Guido van Rossumf7fcf5e2001-09-14 16:08:44 +0000676 return (resp, reply)
Tim Petersb64bec32001-09-18 02:26:39 +0000677
Jeremy Hylton31bb8ce1998-08-13 19:57:46 +0000678 def sendmail(self, from_addr, to_addrs, msg, mail_options=[],
Tim Peters495ad3c2001-01-15 01:36:40 +0000679 rcpt_options=[]):
680 """This command performs an entire mail transaction.
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000681
Tim Peters495ad3c2001-01-15 01:36:40 +0000682 The arguments are:
Barry Warsaw4c4bec81998-12-22 03:02:20 +0000683 - from_addr : The address sending this mail.
684 - to_addrs : A list of addresses to send this mail to. A bare
685 string will be treated as a list with 1 address.
Tim Peters495ad3c2001-01-15 01:36:40 +0000686 - msg : The message to send.
Barry Warsaw4c4bec81998-12-22 03:02:20 +0000687 - mail_options : List of ESMTP options (such as 8bitmime) for the
688 mail command.
689 - rcpt_options : List of ESMTP options (such as DSN commands) for
690 all the rcpt commands.
691
R. David Murray7dff9e02010-11-08 17:15:13 +0000692 msg may be a string containing characters in the ASCII range, or a byte
693 string. A string is encoded to bytes using the ascii codec, and lone
R David Murrayac4e5ab2011-07-02 21:03:19 -0400694 \\r and \\n characters are converted to \\r\\n characters.
R. David Murray7dff9e02010-11-08 17:15:13 +0000695
Barry Warsaw4c4bec81998-12-22 03:02:20 +0000696 If there has been no previous EHLO or HELO command this session, this
697 method tries ESMTP EHLO first. If the server does ESMTP, message size
698 and each of the specified options will be passed to it. If EHLO
699 fails, HELO will be tried and ESMTP options suppressed.
700
701 This method will return normally if the mail is accepted for at least
Barry Warsawd25c1b71999-11-28 17:11:06 +0000702 one recipient. It returns a dictionary, with one entry for each
703 recipient that was refused. Each entry contains a tuple of the SMTP
704 error code and the accompanying error message sent by the server.
Guido van Rossum296e1431999-04-07 15:03:39 +0000705
706 This method may raise the following exceptions:
707
708 SMTPHeloError The server didn't reply properly to
Tim Peters495ad3c2001-01-15 01:36:40 +0000709 the helo greeting.
Barry Warsawd25c1b71999-11-28 17:11:06 +0000710 SMTPRecipientsRefused The server rejected ALL recipients
Guido van Rossum296e1431999-04-07 15:03:39 +0000711 (no mail was sent).
712 SMTPSenderRefused The server didn't accept the from_addr.
713 SMTPDataError The server replied with an unexpected
714 error code (other than a refusal of
715 a recipient).
716
717 Note: the connection will be open even after an exception is raised.
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000718
Guido van Rossum95e6f701998-06-25 02:15:50 +0000719 Example:
Tim Peters495ad3c2001-01-15 01:36:40 +0000720
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000721 >>> import smtplib
722 >>> s=smtplib.SMTP("localhost")
Guido van Rossumfc40a831998-01-29 17:26:45 +0000723 >>> tolist=["one@one.org","two@two.org","three@three.org","four@four.org"]
Martin v. Löwis301b1cd2002-07-28 16:52:01 +0000724 >>> msg = '''\\
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000725 ... From: Me@my.org
726 ... Subject: testin'...
727 ...
728 ... This is a test '''
729 >>> s.sendmail("me@my.org",tolist,msg)
730 { "three@three.org" : ( 550 ,"User unknown" ) }
731 >>> s.quit()
Tim Peters495ad3c2001-01-15 01:36:40 +0000732
Barry Warsaw4c4bec81998-12-22 03:02:20 +0000733 In the above example, the message was accepted for delivery to three
734 of the four addresses, and one was rejected, with the error code
Barry Warsawd25c1b71999-11-28 17:11:06 +0000735 550. If all addresses are accepted, then the method will return an
Barry Warsaw4c4bec81998-12-22 03:02:20 +0000736 empty dictionary.
737
738 """
Christian Heimes679db4a2008-01-18 09:56:22 +0000739 self.ehlo_or_helo_if_needed()
Guido van Rossum95e6f701998-06-25 02:15:50 +0000740 esmtp_opts = []
R. David Murray7dff9e02010-11-08 17:15:13 +0000741 if isinstance(msg, str):
742 msg = _fix_eols(msg).encode('ascii')
Guido van Rossumfcfb6321998-08-04 15:29:54 +0000743 if self.does_esmtp:
744 # Hmmm? what's this? -ddm
745 # self.esmtp_features['7bit']=""
746 if self.has_extn('size'):
Walter Dörwald70a6b492004-02-12 17:35:32 +0000747 esmtp_opts.append("size=%d" % len(msg))
Guido van Rossumfcfb6321998-08-04 15:29:54 +0000748 for option in mail_options:
Guido van Rossum95e6f701998-06-25 02:15:50 +0000749 esmtp_opts.append(option)
Giampaolo Rodolàbd258bd2011-02-22 15:56:20 +0000750 (code, resp) = self.mail(from_addr, esmtp_opts)
Fred Drake8152d322000-12-12 23:20:45 +0000751 if code != 250:
Guido van Rossum45e2fbc1998-03-26 21:13:24 +0000752 self.rset()
Guido van Rossum296e1431999-04-07 15:03:39 +0000753 raise SMTPSenderRefused(code, resp, from_addr)
Giampaolo Rodolàbd258bd2011-02-22 15:56:20 +0000754 senderrs = {}
Guido van Rossum3172c5d2007-10-16 18:12:55 +0000755 if isinstance(to_addrs, str):
Jeremy Hylton31bb8ce1998-08-13 19:57:46 +0000756 to_addrs = [to_addrs]
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000757 for each in to_addrs:
Giampaolo Rodolàbd258bd2011-02-22 15:56:20 +0000758 (code, resp) = self.rcpt(each, rcpt_options)
Fred Drake8152d322000-12-12 23:20:45 +0000759 if (code != 250) and (code != 251):
Giampaolo Rodolàbd258bd2011-02-22 15:56:20 +0000760 senderrs[each] = (code, resp)
761 if len(senderrs) == len(to_addrs):
Guido van Rossum95e6f701998-06-25 02:15:50 +0000762 # the server refused all our recipients
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000763 self.rset()
Guido van Rossum296e1431999-04-07 15:03:39 +0000764 raise SMTPRecipientsRefused(senderrs)
Giampaolo Rodolàbd258bd2011-02-22 15:56:20 +0000765 (code, resp) = self.data(msg)
Fred Drake8152d322000-12-12 23:20:45 +0000766 if code != 250:
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000767 self.rset()
Guido van Rossum296e1431999-04-07 15:03:39 +0000768 raise SMTPDataError(code, resp)
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000769 #if we got here then somebody got our mail
Tim Peters495ad3c2001-01-15 01:36:40 +0000770 return senderrs
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000771
R. David Murray7dff9e02010-11-08 17:15:13 +0000772 def send_message(self, msg, from_addr=None, to_addrs=None,
773 mail_options=[], rcpt_options={}):
774 """Converts message to a bytestring and passes it to sendmail.
775
776 The arguments are as for sendmail, except that msg is an
R David Murrayac4e5ab2011-07-02 21:03:19 -0400777 email.message.Message object. If from_addr is None or to_addrs is
778 None, these arguments are taken from the headers of the Message as
779 described in RFC 2822 (a ValueError is raised if there is more than
780 one set of 'Resent-' headers). Regardless of the values of from_addr and
781 to_addr, any Bcc field (or Resent-Bcc field, when the Message is a
782 resent) of the Message object won't be transmitted. The Message
783 object is then serialized using email.generator.BytesGenerator and
784 sendmail is called to transmit the message.
785
R. David Murray7dff9e02010-11-08 17:15:13 +0000786 """
R David Murrayac4e5ab2011-07-02 21:03:19 -0400787 # 'Resent-Date' is a mandatory field if the Message is resent (RFC 2822
788 # Section 3.6.6). In such a case, we use the 'Resent-*' fields. However,
789 # if there is more than one 'Resent-' block there's no way to
790 # unambiguously determine which one is the most recent in all cases,
791 # so rather than guess we raise a ValueError in that case.
792 #
793 # TODO implement heuristics to guess the correct Resent-* block with an
794 # option allowing the user to enable the heuristics. (It should be
795 # possible to guess correctly almost all of the time.)
Senthil Kumaranb351a482011-07-31 09:14:17 +0800796
797 resent = msg.get_all('Resent-Date')
R David Murrayac4e5ab2011-07-02 21:03:19 -0400798 if resent is None:
799 header_prefix = ''
800 elif len(resent) == 1:
801 header_prefix = 'Resent-'
802 else:
803 raise ValueError("message has more than one 'Resent-' header block")
R. David Murray7dff9e02010-11-08 17:15:13 +0000804 if from_addr is None:
R David Murrayac4e5ab2011-07-02 21:03:19 -0400805 # Prefer the sender field per RFC 2822:3.6.2.
Senthil Kumaranb351a482011-07-31 09:14:17 +0800806 from_addr = (msg[header_prefix + 'Sender']
807 if (header_prefix + 'Sender') in msg
808 else msg[header_prefix + 'From'])
R. David Murray7dff9e02010-11-08 17:15:13 +0000809 if to_addrs is None:
Senthil Kumaranb351a482011-07-31 09:14:17 +0800810 addr_fields = [f for f in (msg[header_prefix + 'To'],
811 msg[header_prefix + 'Bcc'],
812 msg[header_prefix + 'Cc']) if f is not None]
R. David Murray7dff9e02010-11-08 17:15:13 +0000813 to_addrs = [a[1] for a in email.utils.getaddresses(addr_fields)]
R David Murrayac4e5ab2011-07-02 21:03:19 -0400814 # Make a local copy so we can delete the bcc headers.
815 msg_copy = copy.copy(msg)
816 del msg_copy['Bcc']
817 del msg_copy['Resent-Bcc']
R. David Murray7dff9e02010-11-08 17:15:13 +0000818 with io.BytesIO() as bytesmsg:
819 g = email.generator.BytesGenerator(bytesmsg)
R David Murrayac4e5ab2011-07-02 21:03:19 -0400820 g.flatten(msg_copy, linesep='\r\n')
R. David Murray7dff9e02010-11-08 17:15:13 +0000821 flatmsg = bytesmsg.getvalue()
822 return self.sendmail(from_addr, to_addrs, flatmsg, mail_options,
823 rcpt_options)
824
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000825 def close(self):
826 """Close the connection to the SMTP server."""
827 if self.file:
828 self.file.close()
829 self.file = None
830 if self.sock:
831 self.sock.close()
832 self.sock = None
833
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000834 def quit(self):
Guido van Rossum95e6f701998-06-25 02:15:50 +0000835 """Terminate the SMTP session."""
Christian Heimesba4af492008-03-28 00:55:15 +0000836 res = self.docmd("quit")
Guido van Rossum45e2fbc1998-03-26 21:13:24 +0000837 self.close()
Christian Heimesba4af492008-03-28 00:55:15 +0000838 return res
Guido van Rossum95e6f701998-06-25 02:15:50 +0000839
Thomas Wouters47b49bf2007-08-30 22:15:33 +0000840if _have_ssl:
Thomas Wouters89f507f2006-12-13 04:49:30 +0000841
Thomas Wouters47b49bf2007-08-30 22:15:33 +0000842 class SMTP_SSL(SMTP):
843 """ This is a subclass derived from SMTP that connects over an SSL encrypted
844 socket (to use this class you need a socket module that was compiled with SSL
845 support). If host is not specified, '' (the local host) is used. If port is
Senthil Kumaran3d23fd62011-07-30 10:56:50 +0800846 omitted, the standard SMTP-over-SSL port (465) is used. The optional
847 source_address takes a two-tuple (host,port) for socket to bind to. keyfile and certfile
Thomas Wouters47b49bf2007-08-30 22:15:33 +0000848 are also optional - they can contain a PEM formatted private key and
Antoine Pitroue0650202011-05-18 18:03:09 +0200849 certificate chain file for the SSL connection. context also optional, can contain
850 a SSLContext, and is an alternative to keyfile and certfile; If it is specified both
851 keyfile and certfile must be None.
Thomas Wouters47b49bf2007-08-30 22:15:33 +0000852 """
Antoine Pitrouc1d52062011-05-07 19:39:37 +0200853
854 default_port = SMTP_SSL_PORT
855
Thomas Wouters47b49bf2007-08-30 22:15:33 +0000856 def __init__(self, host='', port=0, local_hostname=None,
Georg Brandlf78e02b2008-06-10 17:40:04 +0000857 keyfile=None, certfile=None,
Senthil Kumaran3d23fd62011-07-30 10:56:50 +0800858 timeout=socket._GLOBAL_DEFAULT_TIMEOUT,
859 source_address=None, context=None):
Antoine Pitroue0650202011-05-18 18:03:09 +0200860 if context is not None and keyfile is not None:
861 raise ValueError("context and keyfile arguments are mutually "
862 "exclusive")
863 if context is not None and certfile is not None:
864 raise ValueError("context and certfile arguments are mutually "
865 "exclusive")
Thomas Wouters47b49bf2007-08-30 22:15:33 +0000866 self.keyfile = keyfile
867 self.certfile = certfile
Antoine Pitroue0650202011-05-18 18:03:09 +0200868 self.context = context
Senthil Kumaran3d23fd62011-07-30 10:56:50 +0800869 SMTP.__init__(self, host, port, local_hostname, timeout,
870 source_address)
Thomas Wouters47b49bf2007-08-30 22:15:33 +0000871
872 def _get_socket(self, host, port, timeout):
Giampaolo Rodolàbd258bd2011-02-22 15:56:20 +0000873 if self.debuglevel > 0:
874 print('connect:', (host, port), file=stderr)
Senthil Kumaran3d23fd62011-07-30 10:56:50 +0800875 new_socket = socket.create_connection((host, port), timeout,
876 self.source_address)
Antoine Pitroue0650202011-05-18 18:03:09 +0200877 if self.context is not None:
878 new_socket = self.context.wrap_socket(new_socket)
879 else:
880 new_socket = ssl.wrap_socket(new_socket, self.keyfile, self.certfile)
R. David Murray87e20742009-05-23 01:30:26 +0000881 return new_socket
Thomas Wouters47b49bf2007-08-30 22:15:33 +0000882
883 __all__.append("SMTP_SSL")
Barry Warsaw4c4bec81998-12-22 03:02:20 +0000884
Guido van Rossumd8faa362007-04-27 19:54:29 +0000885#
886# LMTP extension
887#
888LMTP_PORT = 2003
889
890class LMTP(SMTP):
891 """LMTP - Local Mail Transfer Protocol
892
893 The LMTP protocol, which is very similar to ESMTP, is heavily based
894 on the standard SMTP client. It's common to use Unix sockets for LMTP,
895 so our connect() method must support that as well as a regular
896 host:port server. To specify a Unix socket, you must use an absolute
897 path as the host, starting with a '/'.
898
899 Authentication is supported, using the regular SMTP mechanism. When
900 using a Unix socket, LMTP generally don't support or require any
901 authentication, but your mileage might vary."""
902
903 ehlo_msg = "lhlo"
904
Senthil Kumaran3d23fd62011-07-30 10:56:50 +0800905 def __init__(self, host='', port=LMTP_PORT, local_hostname=None,
906 source_address=None):
Guido van Rossumd8faa362007-04-27 19:54:29 +0000907 """Initialize a new instance."""
Senthil Kumaranb351a482011-07-31 09:14:17 +0800908 SMTP.__init__(self, host, port, local_hostname=local_hostname,
909 source_address=source_address)
Guido van Rossumd8faa362007-04-27 19:54:29 +0000910
Senthil Kumaran3d23fd62011-07-30 10:56:50 +0800911 def connect(self, host='localhost', port=0, source_address=None):
Guido van Rossumd8faa362007-04-27 19:54:29 +0000912 """Connect to the LMTP daemon, on either a Unix or a TCP socket."""
913 if host[0] != '/':
Senthil Kumaranb351a482011-07-31 09:14:17 +0800914 return SMTP.connect(self, host, port, source_address=source_address)
Guido van Rossumd8faa362007-04-27 19:54:29 +0000915
916 # Handle Unix-domain sockets.
917 try:
918 self.sock = socket.socket(socket.AF_UNIX, socket.SOCK_STREAM)
Antoine Pitrouf068ab82011-06-06 19:17:09 +0200919 self.file = None
Guido van Rossumd8faa362007-04-27 19:54:29 +0000920 self.sock.connect(host)
921 except socket.error as msg:
Giampaolo Rodolàbd258bd2011-02-22 15:56:20 +0000922 if self.debuglevel > 0:
923 print('connect fail:', host, file=stderr)
Guido van Rossumd8faa362007-04-27 19:54:29 +0000924 if self.sock:
925 self.sock.close()
926 self.sock = None
927 raise socket.error(msg)
928 (code, msg) = self.getreply()
Giampaolo Rodolàbd258bd2011-02-22 15:56:20 +0000929 if self.debuglevel > 0:
930 print('connect:', msg, file=stderr)
Guido van Rossumd8faa362007-04-27 19:54:29 +0000931 return (code, msg)
932
933
Guido van Rossum95e6f701998-06-25 02:15:50 +0000934# Test the sendmail method, which tests most of the others.
935# Note: This always sends to localhost.
936if __name__ == '__main__':
Andrew M. Kuchling6be424f2001-08-13 14:41:39 +0000937 import sys
Guido van Rossum95e6f701998-06-25 02:15:50 +0000938
939 def prompt(prompt):
940 sys.stdout.write(prompt + ": ")
Eric S. Raymondc013f302001-02-09 05:40:38 +0000941 return sys.stdin.readline().strip()
Guido van Rossum95e6f701998-06-25 02:15:50 +0000942
943 fromaddr = prompt("From")
Giampaolo Rodolàbd258bd2011-02-22 15:56:20 +0000944 toaddrs = prompt("To").split(',')
Guido van Rossumbe19ed72007-02-09 05:37:30 +0000945 print("Enter message, end with ^D:")
Guido van Rossum95e6f701998-06-25 02:15:50 +0000946 msg = ''
947 while 1:
948 line = sys.stdin.readline()
949 if not line:
950 break
951 msg = msg + line
Guido van Rossumbe19ed72007-02-09 05:37:30 +0000952 print("Message length is %d" % len(msg))
Guido van Rossum95e6f701998-06-25 02:15:50 +0000953
954 server = SMTP('localhost')
955 server.set_debuglevel(1)
956 server.sendmail(fromaddr, toaddrs, msg)
957 server.quit()