blob: 55935d241eaa7898df5b5cc97fbd6c27610a8ea6 [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
Guido van Rossum69a79bc1998-07-13 15:18:49 +0000136def quoteaddr(addr):
137 """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 """
Raymond Hettinger342456d2002-09-05 01:14:07 +0000141 m = (None, None)
Guido van Rossum69a79bc1998-07-13 15:18:49 +0000142 try:
Thomas Woutersb2137042007-02-01 18:02:27 +0000143 m = email.utils.parseaddr(addr)[1]
Guido van Rossumfcfb6321998-08-04 15:29:54 +0000144 except AttributeError:
145 pass
Giampaolo Rodolàbd258bd2011-02-22 15:56:20 +0000146 if m == (None, None): # Indicates parse failure or AttributeError
Georg Brandlbd3bc4d2006-02-17 09:52:53 +0000147 # something weird here.. punt -ddm
Raymond Hettinger342456d2002-09-05 01:14:07 +0000148 return "<%s>" % addr
Georg Brandlbd3bc4d2006-02-17 09:52:53 +0000149 elif m is None:
150 # the sender wants an empty return address
151 return "<>"
Guido van Rossumfcfb6321998-08-04 15:29:54 +0000152 else:
153 return "<%s>" % m
Guido van Rossum69a79bc1998-07-13 15:18:49 +0000154
R David Murray46346762011-07-18 21:38:54 -0400155def _addr_only(addrstring):
156 displayname, addr = email.utils.parseaddr(addrstring)
157 if (displayname, addr) == ('', ''):
158 # parseaddr couldn't parse it, so use it as is.
159 return addrstring
160 return addr
161
R. David Murray7dff9e02010-11-08 17:15:13 +0000162# Legacy method kept for backward compatibility.
Guido van Rossum69a79bc1998-07-13 15:18:49 +0000163def quotedata(data):
164 """Quote data for email.
165
Barry Warsawd25c1b71999-11-28 17:11:06 +0000166 Double leading '.', and change Unix newline '\\n', or Mac '\\r' into
Barry Warsawa7d9bdf1998-12-22 03:24:27 +0000167 Internet CRLF end-of-line.
168 """
Guido van Rossum69a79bc1998-07-13 15:18:49 +0000169 return re.sub(r'(?m)^\.', '..',
Guido van Rossumfcfb6321998-08-04 15:29:54 +0000170 re.sub(r'(?:\r\n|\n|\r(?!\n))', CRLF, data))
Guido van Rossum69a79bc1998-07-13 15:18:49 +0000171
R. David Murray7dff9e02010-11-08 17:15:13 +0000172def _quote_periods(bindata):
R David Murray0f663d02011-06-09 15:05:57 -0400173 return re.sub(br'(?m)^\.', b'..', bindata)
R. David Murray7dff9e02010-11-08 17:15:13 +0000174
175def _fix_eols(data):
176 return re.sub(r'(?:\r\n|\n|\r(?!\n))', CRLF, data)
177
Thomas Wouters47b49bf2007-08-30 22:15:33 +0000178try:
179 import ssl
180except ImportError:
181 _have_ssl = False
182else:
Thomas Wouters47b49bf2007-08-30 22:15:33 +0000183 _have_ssl = True
184
Peter Schneider-Kamp7bc82bb2000-08-10 14:02:23 +0000185
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000186class SMTP:
Guido van Rossumfcfb6321998-08-04 15:29:54 +0000187 """This class manages a connection to an SMTP or ESMTP server.
188 SMTP Objects:
Tim Peters495ad3c2001-01-15 01:36:40 +0000189 SMTP objects have the following attributes:
190 helo_resp
191 This is the message given by the server in response to the
Guido van Rossumfcfb6321998-08-04 15:29:54 +0000192 most recent HELO command.
Tim Peters495ad3c2001-01-15 01:36:40 +0000193
Guido van Rossumfcfb6321998-08-04 15:29:54 +0000194 ehlo_resp
Tim Peters495ad3c2001-01-15 01:36:40 +0000195 This is the message given by the server in response to the
Guido van Rossumfcfb6321998-08-04 15:29:54 +0000196 most recent EHLO command. This is usually multiline.
197
Tim Peters495ad3c2001-01-15 01:36:40 +0000198 does_esmtp
Guido van Rossumfcfb6321998-08-04 15:29:54 +0000199 This is a True value _after you do an EHLO command_, if the
200 server supports ESMTP.
201
Tim Peters495ad3c2001-01-15 01:36:40 +0000202 esmtp_features
Guido van Rossumfcfb6321998-08-04 15:29:54 +0000203 This is a dictionary, which, if the server supports ESMTP,
Barry Warsawd25c1b71999-11-28 17:11:06 +0000204 will _after you do an EHLO command_, contain the names of the
205 SMTP service extensions this server supports, and their
Guido van Rossumfcfb6321998-08-04 15:29:54 +0000206 parameters (if any).
Barry Warsawd25c1b71999-11-28 17:11:06 +0000207
Tim Peters495ad3c2001-01-15 01:36:40 +0000208 Note, all extension names are mapped to lower case in the
209 dictionary.
Guido van Rossumfcfb6321998-08-04 15:29:54 +0000210
Barry Warsawd25c1b71999-11-28 17:11:06 +0000211 See each method's docstrings for details. In general, there is a
212 method of the same name to perform each SMTP command. There is also a
213 method called 'sendmail' that will do an entire mail transaction.
214 """
Guido van Rossum95e6f701998-06-25 02:15:50 +0000215 debuglevel = 0
216 file = None
217 helo_resp = None
Guido van Rossumd8faa362007-04-27 19:54:29 +0000218 ehlo_msg = "ehlo"
Guido van Rossum95e6f701998-06-25 02:15:50 +0000219 ehlo_resp = None
Guido van Rossumfcfb6321998-08-04 15:29:54 +0000220 does_esmtp = 0
Antoine Pitrouc1d52062011-05-07 19:39:37 +0200221 default_port = SMTP_PORT
Guido van Rossum95e6f701998-06-25 02:15:50 +0000222
Georg Brandlf78e02b2008-06-10 17:40:04 +0000223 def __init__(self, host='', port=0, local_hostname=None,
224 timeout=socket._GLOBAL_DEFAULT_TIMEOUT):
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000225 """Initialize a new instance.
226
Barry Warsawa7d9bdf1998-12-22 03:24:27 +0000227 If specified, `host' is the name of the remote host to which to
228 connect. If specified, `port' specifies the port to which to connect.
Barry Warsawd25c1b71999-11-28 17:11:06 +0000229 By default, smtplib.SMTP_PORT is used. An SMTPConnectError is raised
Neil Schemenauer6730f262002-03-24 15:30:40 +0000230 if the specified `host' doesn't respond correctly. If specified,
Tim Peters863ac442002-04-16 01:38:40 +0000231 `local_hostname` is used as the FQDN of the local host. By default,
232 the local hostname is found using socket.getfqdn().
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000233
234 """
Guido van Rossumd8faa362007-04-27 19:54:29 +0000235 self.timeout = timeout
Guido van Rossumfcfb6321998-08-04 15:29:54 +0000236 self.esmtp_features = {}
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:
285 print('connect:', (host, port), file=stderr)
Barry Warsawc9181712008-03-19 14:25:51 +0000286 return socket.create_connection((host, port), timeout)
Thomas Wouters89f507f2006-12-13 04:49:30 +0000287
Giampaolo Rodolàbd258bd2011-02-22 15:56:20 +0000288 def connect(self, host='localhost', port=0):
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000289 """Connect to a host on a given port.
Guido van Rossum95e6f701998-06-25 02:15:50 +0000290
Barry Warsaw4c4bec81998-12-22 03:02:20 +0000291 If the hostname ends with a colon (`:') followed by a number, and
292 there is no port specified, that suffix will be stripped off and the
293 number interpreted as the port number to use.
Guido van Rossum95e6f701998-06-25 02:15:50 +0000294
Barry Warsawa7d9bdf1998-12-22 03:24:27 +0000295 Note: This method is automatically invoked by __init__, if a host is
296 specified during instantiation.
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000297
298 """
Martin v. Löwis4eb59402001-07-26 13:37:33 +0000299 if not port and (host.find(':') == host.rfind(':')):
Martin v. Löwisa43c2f82001-07-24 20:34:08 +0000300 i = host.rfind(':')
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000301 if i >= 0:
Giampaolo Rodolàbd258bd2011-02-22 15:56:20 +0000302 host, port = host[:i], host[i + 1:]
303 try:
304 port = int(port)
Eric S. Raymond8d876032001-02-09 10:14:53 +0000305 except ValueError:
Guido van Rossumd8faa362007-04-27 19:54:29 +0000306 raise socket.error("nonnumeric port")
Giampaolo Rodolàbd258bd2011-02-22 15:56:20 +0000307 if not port:
308 port = self.default_port
309 if self.debuglevel > 0:
310 print('connect:', (host, port), file=stderr)
Guido van Rossumd8faa362007-04-27 19:54:29 +0000311 self.sock = self._get_socket(host, port, self.timeout)
Antoine Pitrouf068ab82011-06-06 19:17:09 +0200312 self.file = None
Martin v. Löwisa43c2f82001-07-24 20:34:08 +0000313 (code, msg) = self.getreply()
Giampaolo Rodolàbd258bd2011-02-22 15:56:20 +0000314 if self.debuglevel > 0:
315 print("connect:", msg, file=stderr)
Martin v. Löwisa43c2f82001-07-24 20:34:08 +0000316 return (code, msg)
Tim Peters495ad3c2001-01-15 01:36:40 +0000317
Guido van Rossum8a392d72007-11-21 22:09:45 +0000318 def send(self, s):
319 """Send `s' to the server."""
Giampaolo Rodolàbd258bd2011-02-22 15:56:20 +0000320 if self.debuglevel > 0:
321 print('send:', repr(s), file=stderr)
Christian Heimes90c3d9b2008-02-23 13:18:03 +0000322 if hasattr(self, 'sock') and self.sock:
Guido van Rossum8a392d72007-11-21 22:09:45 +0000323 if isinstance(s, str):
324 s = s.encode("ascii")
Guido van Rossum2880f6e1998-08-10 20:07:00 +0000325 try:
Guido van Rossum8a392d72007-11-21 22:09:45 +0000326 self.sock.sendall(s)
Guido van Rossum2880f6e1998-08-10 20:07:00 +0000327 except socket.error:
Barry Warsaw76750972001-12-14 20:34:20 +0000328 self.close()
Guido van Rossum40233ea1999-01-15 03:23:55 +0000329 raise SMTPServerDisconnected('Server not connected')
Guido van Rossumfc40a831998-01-29 17:26:45 +0000330 else:
Guido van Rossum40233ea1999-01-15 03:23:55 +0000331 raise SMTPServerDisconnected('please run connect() first')
Tim Peters495ad3c2001-01-15 01:36:40 +0000332
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000333 def putcmd(self, cmd, args=""):
Barry Warsawa7d9bdf1998-12-22 03:24:27 +0000334 """Send a command to the server."""
Guido van Rossumdb23d3d1999-06-09 15:13:10 +0000335 if args == "":
336 str = '%s%s' % (cmd, CRLF)
337 else:
338 str = '%s %s%s' % (cmd, args, CRLF)
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000339 self.send(str)
Tim Peters495ad3c2001-01-15 01:36:40 +0000340
Guido van Rossumfcfb6321998-08-04 15:29:54 +0000341 def getreply(self):
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000342 """Get a reply from the server.
Tim Peters495ad3c2001-01-15 01:36:40 +0000343
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000344 Returns a tuple consisting of:
Barry Warsawa7d9bdf1998-12-22 03:24:27 +0000345
346 - server response code (e.g. '250', or such, if all goes well)
347 Note: returns -1 if it can't read response code.
348
349 - server response string corresponding to response code (multiline
350 responses are converted to a single, multiline string).
Guido van Rossumf123f841999-03-29 20:33:21 +0000351
352 Raises SMTPServerDisconnected if end-of-file is reached.
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000353 """
Giampaolo Rodolàbd258bd2011-02-22 15:56:20 +0000354 resp = []
Guido van Rossum296e1431999-04-07 15:03:39 +0000355 if self.file is None:
356 self.file = self.sock.makefile('rb')
Guido van Rossum45e2fbc1998-03-26 21:13:24 +0000357 while 1:
Benjamin Petersone1cdfd72009-01-18 21:02:37 +0000358 try:
359 line = self.file.readline()
360 except socket.error:
361 line = ''
Guido van Rossum806c2462007-08-06 23:33:07 +0000362 if not line:
Guido van Rossum296e1431999-04-07 15:03:39 +0000363 self.close()
364 raise SMTPServerDisconnected("Connection unexpectedly closed")
Giampaolo Rodolàbd258bd2011-02-22 15:56:20 +0000365 if self.debuglevel > 0:
366 print('reply:', repr(line), file=stderr)
Guido van Rossum806c2462007-08-06 23:33:07 +0000367 resp.append(line[4:].strip(b' \t\r\n'))
Giampaolo Rodolàbd258bd2011-02-22 15:56:20 +0000368 code = line[:3]
Guido van Rossum296e1431999-04-07 15:03:39 +0000369 # Check that the error code is syntactically correct.
370 # Don't attempt to read a continuation line if it is broken.
371 try:
Eric S. Raymondc013f302001-02-09 05:40:38 +0000372 errcode = int(code)
Guido van Rossum296e1431999-04-07 15:03:39 +0000373 except ValueError:
374 errcode = -1
375 break
Guido van Rossumf123f841999-03-29 20:33:21 +0000376 # Check if multiline response.
Guido van Rossum806c2462007-08-06 23:33:07 +0000377 if line[3:4] != b"-":
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000378 break
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000379
Guido van Rossumc43e79f2007-06-18 18:26:36 +0000380 errmsg = b"\n".join(resp)
Tim Peters495ad3c2001-01-15 01:36:40 +0000381 if self.debuglevel > 0:
Giampaolo Rodolàbd258bd2011-02-22 15:56:20 +0000382 print('reply: retcode (%s); Msg: %s' % (errcode, errmsg), file=stderr)
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000383 return errcode, errmsg
Tim Peters495ad3c2001-01-15 01:36:40 +0000384
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000385 def docmd(self, cmd, args=""):
Barry Warsawa7d9bdf1998-12-22 03:24:27 +0000386 """Send a command, and return its response code."""
Giampaolo Rodolàbd258bd2011-02-22 15:56:20 +0000387 self.putcmd(cmd, args)
Guido van Rossum296e1431999-04-07 15:03:39 +0000388 return self.getreply()
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000389
Barry Warsawa7d9bdf1998-12-22 03:24:27 +0000390 # std smtp commands
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000391 def helo(self, name=''):
Barry Warsawa7d9bdf1998-12-22 03:24:27 +0000392 """SMTP 'helo' command.
393 Hostname to send for this command defaults to the FQDN of the local
394 host.
395 """
Neil Schemenauer6730f262002-03-24 15:30:40 +0000396 self.putcmd("helo", name or self.local_hostname)
Giampaolo Rodolàbd258bd2011-02-22 15:56:20 +0000397 (code, msg) = self.getreply()
398 self.helo_resp = msg
399 return (code, msg)
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000400
Guido van Rossum95e6f701998-06-25 02:15:50 +0000401 def ehlo(self, name=''):
Barry Warsawa7d9bdf1998-12-22 03:24:27 +0000402 """ SMTP 'ehlo' command.
403 Hostname to send for this command defaults to the FQDN of the local
404 host.
405 """
Guido van Rossumf7fcf5e2001-09-14 16:08:44 +0000406 self.esmtp_features = {}
Guido van Rossumd8faa362007-04-27 19:54:29 +0000407 self.putcmd(self.ehlo_msg, name or self.local_hostname)
Giampaolo Rodolàbd258bd2011-02-22 15:56:20 +0000408 (code, msg) = self.getreply()
Tim Peters495ad3c2001-01-15 01:36:40 +0000409 # According to RFC1869 some (badly written)
410 # MTA's will disconnect on an ehlo. Toss an exception if
Guido van Rossumfcfb6321998-08-04 15:29:54 +0000411 # that happens -ddm
412 if code == -1 and len(msg) == 0:
Barry Warsaw76750972001-12-14 20:34:20 +0000413 self.close()
Guido van Rossum40233ea1999-01-15 03:23:55 +0000414 raise SMTPServerDisconnected("Server not connected")
Giampaolo Rodolàbd258bd2011-02-22 15:56:20 +0000415 self.ehlo_resp = msg
Fred Drake8152d322000-12-12 23:20:45 +0000416 if code != 250:
Giampaolo Rodolàbd258bd2011-02-22 15:56:20 +0000417 return (code, msg)
418 self.does_esmtp = 1
Thomas Wouters7e474022000-07-16 12:04:32 +0000419 #parse the ehlo response -ddm
Guido van Rossum04110fb2007-08-24 16:32:05 +0000420 assert isinstance(self.ehlo_resp, bytes), repr(self.ehlo_resp)
Giampaolo Rodolàbd258bd2011-02-22 15:56:20 +0000421 resp = self.ehlo_resp.decode("latin-1").split('\n')
Guido van Rossumfcfb6321998-08-04 15:29:54 +0000422 del resp[0]
Guido van Rossum2880f6e1998-08-10 20:07:00 +0000423 for each in resp:
Piers Lauder385a77a2002-07-27 00:38:30 +0000424 # To be able to communicate with as many SMTP servers as possible,
425 # we have to take the old-style auth advertisement into account,
426 # because:
427 # 1) Else our SMTP feature parser gets confused.
428 # 2) There are some servers that only advertise the auth methods we
429 # support using the old style.
430 auth_match = OLDSTYLE_AUTH.match(each)
431 if auth_match:
432 # This doesn't remove duplicates, but that's no problem
433 self.esmtp_features["auth"] = self.esmtp_features.get("auth", "") \
434 + " " + auth_match.groups(0)[0]
435 continue
436
Barry Warsawbe22ae62002-04-15 20:03:30 +0000437 # RFC 1869 requires a space between ehlo keyword and parameters.
438 # It's actually stricter, in that only spaces are allowed between
439 # parameters, but were not going to check for that here. Note
440 # that the space isn't present if there are no parameters.
Giampaolo Rodolàbd258bd2011-02-22 15:56:20 +0000441 m = re.match(r'(?P<feature>[A-Za-z0-9][A-Za-z0-9\-]*) ?', each)
Guido van Rossumfcfb6321998-08-04 15:29:54 +0000442 if m:
Giampaolo Rodolàbd258bd2011-02-22 15:56:20 +0000443 feature = m.group("feature").lower()
444 params = m.string[m.end("feature"):].strip()
Piers Lauder385a77a2002-07-27 00:38:30 +0000445 if feature == "auth":
446 self.esmtp_features[feature] = self.esmtp_features.get(feature, "") \
447 + " " + params
448 else:
Giampaolo Rodolàbd258bd2011-02-22 15:56:20 +0000449 self.esmtp_features[feature] = params
450 return (code, msg)
Guido van Rossum95e6f701998-06-25 02:15:50 +0000451
Guido van Rossumfcfb6321998-08-04 15:29:54 +0000452 def has_extn(self, opt):
453 """Does the server support a given SMTP service extension?"""
Raymond Hettinger54f02222002-06-01 14:18:47 +0000454 return opt.lower() in self.esmtp_features
Guido van Rossum95e6f701998-06-25 02:15:50 +0000455
Guido van Rossum18586f41998-04-03 17:03:13 +0000456 def help(self, args=''):
Barry Warsawa7d9bdf1998-12-22 03:24:27 +0000457 """SMTP 'help' command.
458 Returns help text from server."""
Guido van Rossum18586f41998-04-03 17:03:13 +0000459 self.putcmd("help", args)
Kurt B. Kaiser58bd1902005-06-26 18:27:36 +0000460 return self.getreply()[1]
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000461
462 def rset(self):
Barry Warsawa7d9bdf1998-12-22 03:24:27 +0000463 """SMTP 'rset' command -- resets session."""
Guido van Rossum296e1431999-04-07 15:03:39 +0000464 return self.docmd("rset")
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000465
466 def noop(self):
Barry Warsawa7d9bdf1998-12-22 03:24:27 +0000467 """SMTP 'noop' command -- doesn't do anything :>"""
Guido van Rossum296e1431999-04-07 15:03:39 +0000468 return self.docmd("noop")
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000469
Giampaolo Rodolàbd258bd2011-02-22 15:56:20 +0000470 def mail(self, sender, options=[]):
Barry Warsawa7d9bdf1998-12-22 03:24:27 +0000471 """SMTP 'mail' command -- begins mail xfer session."""
Guido van Rossumfcfb6321998-08-04 15:29:54 +0000472 optionlist = ''
473 if options and self.does_esmtp:
Eric S. Raymondc013f302001-02-09 05:40:38 +0000474 optionlist = ' ' + ' '.join(options)
Giampaolo Rodolàbd258bd2011-02-22 15:56:20 +0000475 self.putcmd("mail", "FROM:%s%s" % (quoteaddr(sender), optionlist))
Guido van Rossum45e2fbc1998-03-26 21:13:24 +0000476 return self.getreply()
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000477
Giampaolo Rodolàbd258bd2011-02-22 15:56:20 +0000478 def rcpt(self, recip, options=[]):
Barry Warsawa7d9bdf1998-12-22 03:24:27 +0000479 """SMTP 'rcpt' command -- indicates 1 recipient for this mail."""
Guido van Rossumfcfb6321998-08-04 15:29:54 +0000480 optionlist = ''
481 if options and self.does_esmtp:
Eric S. Raymondc013f302001-02-09 05:40:38 +0000482 optionlist = ' ' + ' '.join(options)
Giampaolo Rodolàbd258bd2011-02-22 15:56:20 +0000483 self.putcmd("rcpt", "TO:%s%s" % (quoteaddr(recip), optionlist))
Guido van Rossum45e2fbc1998-03-26 21:13:24 +0000484 return self.getreply()
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000485
Giampaolo Rodolàbd258bd2011-02-22 15:56:20 +0000486 def data(self, msg):
Tim Peters495ad3c2001-01-15 01:36:40 +0000487 """SMTP 'DATA' command -- sends message data to server.
Guido van Rossum296e1431999-04-07 15:03:39 +0000488
Barry Warsaw4c4bec81998-12-22 03:02:20 +0000489 Automatically quotes lines beginning with a period per rfc821.
Guido van Rossum296e1431999-04-07 15:03:39 +0000490 Raises SMTPDataError if there is an unexpected reply to the
491 DATA command; the return value from this method is the final
R. David Murray7dff9e02010-11-08 17:15:13 +0000492 response code received when the all data is sent. If msg
493 is a string, lone '\r' and '\n' characters are converted to
494 '\r\n' characters. If msg is bytes, it is transmitted as is.
Barry Warsaw4c4bec81998-12-22 03:02:20 +0000495 """
Guido van Rossum45e2fbc1998-03-26 21:13:24 +0000496 self.putcmd("data")
Giampaolo Rodolàbd258bd2011-02-22 15:56:20 +0000497 (code, repl) = self.getreply()
498 if self.debuglevel > 0:
499 print("data:", (code, repl), file=stderr)
Fred Drake8152d322000-12-12 23:20:45 +0000500 if code != 354:
Giampaolo Rodolàbd258bd2011-02-22 15:56:20 +0000501 raise SMTPDataError(code, repl)
Guido van Rossum45e2fbc1998-03-26 21:13:24 +0000502 else:
R. David Murray7dff9e02010-11-08 17:15:13 +0000503 if isinstance(msg, str):
504 msg = _fix_eols(msg).encode('ascii')
505 q = _quote_periods(msg)
506 if q[-2:] != bCRLF:
507 q = q + bCRLF
508 q = q + b"." + bCRLF
Guido van Rossum20c92281999-04-21 16:52:20 +0000509 self.send(q)
Giampaolo Rodolàbd258bd2011-02-22 15:56:20 +0000510 (code, msg) = self.getreply()
511 if self.debuglevel > 0:
512 print("data:", (code, msg), file=stderr)
513 return (code, msg)
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000514
Guido van Rossumfcfb6321998-08-04 15:29:54 +0000515 def verify(self, address):
Barry Warsawa7d9bdf1998-12-22 03:24:27 +0000516 """SMTP 'verify' command -- checks for address validity."""
R David Murray46346762011-07-18 21:38:54 -0400517 self.putcmd("vrfy", _addr_only(address))
Guido van Rossumfcfb6321998-08-04 15:29:54 +0000518 return self.getreply()
Barry Warsaw4c4bec81998-12-22 03:02:20 +0000519 # a.k.a.
Giampaolo Rodolàbd258bd2011-02-22 15:56:20 +0000520 vrfy = verify
Guido van Rossumfcfb6321998-08-04 15:29:54 +0000521
522 def expn(self, address):
Christian Heimes90c3d9b2008-02-23 13:18:03 +0000523 """SMTP 'expn' command -- expands a mailing list."""
R David Murray46346762011-07-18 21:38:54 -0400524 self.putcmd("expn", _addr_only(address))
Guido van Rossumfcfb6321998-08-04 15:29:54 +0000525 return self.getreply()
526
Barry Warsaw4c4bec81998-12-22 03:02:20 +0000527 # some useful methods
Guido van Rossumae010462001-09-11 15:57:46 +0000528
Christian Heimes679db4a2008-01-18 09:56:22 +0000529 def ehlo_or_helo_if_needed(self):
530 """Call self.ehlo() and/or self.helo() if needed.
531
532 If there has been no previous EHLO or HELO command this session, this
533 method tries ESMTP EHLO first.
534
535 This method may raise the following exceptions:
536
537 SMTPHeloError The server didn't reply properly to
538 the helo greeting.
539 """
540 if self.helo_resp is None and self.ehlo_resp is None:
541 if not (200 <= self.ehlo()[0] <= 299):
542 (code, resp) = self.helo()
543 if not (200 <= code <= 299):
544 raise SMTPHeloError(code, resp)
545
Guido van Rossumae010462001-09-11 15:57:46 +0000546 def login(self, user, password):
547 """Log in on an SMTP server that requires authentication.
548
549 The arguments are:
550 - user: The user name to authenticate with.
551 - password: The password for the authentication.
552
553 If there has been no previous EHLO or HELO command this session, this
554 method tries ESMTP EHLO first.
555
556 This method will return normally if the authentication was successful.
557
558 This method may raise the following exceptions:
559
560 SMTPHeloError The server didn't reply properly to
561 the helo greeting.
562 SMTPAuthenticationError The server didn't accept the username/
563 password combination.
Fred Drake2f8f4d32001-10-13 18:35:32 +0000564 SMTPException No suitable authentication method was
Guido van Rossumae010462001-09-11 15:57:46 +0000565 found.
566 """
567
568 def encode_cram_md5(challenge, user, password):
Georg Brandl706824f2009-06-04 09:42:55 +0000569 challenge = base64.decodebytes(challenge)
R. David Murrayfb123912009-05-28 18:19:00 +0000570 response = user + " " + hmac.HMAC(password.encode('ascii'),
571 challenge).hexdigest()
572 return encode_base64(response.encode('ascii'), eol='')
Guido van Rossumae010462001-09-11 15:57:46 +0000573
574 def encode_plain(user, password):
R. David Murraycaa27b72009-05-23 18:49:56 +0000575 s = "\0%s\0%s" % (user, password)
576 return encode_base64(s.encode('ascii'), eol='')
Tim Peters469cdad2002-08-08 20:19:19 +0000577
Guido van Rossumae010462001-09-11 15:57:46 +0000578 AUTH_PLAIN = "PLAIN"
579 AUTH_CRAM_MD5 = "CRAM-MD5"
Piers Lauder385a77a2002-07-27 00:38:30 +0000580 AUTH_LOGIN = "LOGIN"
Guido van Rossumae010462001-09-11 15:57:46 +0000581
Christian Heimes679db4a2008-01-18 09:56:22 +0000582 self.ehlo_or_helo_if_needed()
Guido van Rossumae010462001-09-11 15:57:46 +0000583
584 if not self.has_extn("auth"):
585 raise SMTPException("SMTP AUTH extension not supported by server.")
586
Gerhard Häring1c5471f2010-08-05 14:08:44 +0000587 # Authentication methods the server claims to support
588 advertised_authlist = self.esmtp_features["auth"].split()
Guido van Rossumae010462001-09-11 15:57:46 +0000589
590 # List of authentication methods we support: from preferred to
591 # less preferred methods. Except for the purpose of testing the weaker
592 # ones, we prefer stronger methods like CRAM-MD5:
Piers Lauder385a77a2002-07-27 00:38:30 +0000593 preferred_auths = [AUTH_CRAM_MD5, AUTH_PLAIN, AUTH_LOGIN]
Guido van Rossumae010462001-09-11 15:57:46 +0000594
Gerhard Häring1c5471f2010-08-05 14:08:44 +0000595 # We try the authentication methods the server advertises, but only the
596 # ones *we* support. And in our preferred order.
597 authlist = [auth for auth in preferred_auths if auth in advertised_authlist]
598 if not authlist:
Fred Drake2f8f4d32001-10-13 18:35:32 +0000599 raise SMTPException("No suitable authentication method found.")
Gerhard Häring1c5471f2010-08-05 14:08:44 +0000600
601 # Some servers advertise authentication methods they don't really
602 # support, so if authentication fails, we continue until we've tried
603 # all methods.
604 for authmethod in authlist:
605 if authmethod == AUTH_CRAM_MD5:
606 (code, resp) = self.docmd("AUTH", AUTH_CRAM_MD5)
607 if code == 334:
608 (code, resp) = self.docmd(encode_cram_md5(resp, user, password))
609 elif authmethod == AUTH_PLAIN:
610 (code, resp) = self.docmd("AUTH",
611 AUTH_PLAIN + " " + encode_plain(user, password))
612 elif authmethod == AUTH_LOGIN:
613 (code, resp) = self.docmd("AUTH",
614 "%s %s" % (AUTH_LOGIN, encode_base64(user.encode('ascii'), eol='')))
615 if code == 334:
616 (code, resp) = self.docmd(encode_base64(password.encode('ascii'), eol=''))
617
Guido van Rossumae010462001-09-11 15:57:46 +0000618 # 235 == 'Authentication successful'
619 # 503 == 'Error: already authenticated'
Gerhard Häring1c5471f2010-08-05 14:08:44 +0000620 if code in (235, 503):
621 return (code, resp)
622
623 # We could not login sucessfully. Return result of last attempt.
624 raise SMTPAuthenticationError(code, resp)
Guido van Rossumae010462001-09-11 15:57:46 +0000625
Antoine Pitroue0650202011-05-18 18:03:09 +0200626 def starttls(self, keyfile=None, certfile=None, context=None):
Guido van Rossumf7fcf5e2001-09-14 16:08:44 +0000627 """Puts the connection to the SMTP server into TLS mode.
Tim Petersb64bec32001-09-18 02:26:39 +0000628
Christian Heimes679db4a2008-01-18 09:56:22 +0000629 If there has been no previous EHLO or HELO command this session, this
630 method tries ESMTP EHLO first.
631
Guido van Rossumf7fcf5e2001-09-14 16:08:44 +0000632 If the server supports TLS, this will encrypt the rest of the SMTP
633 session. If you provide the keyfile and certfile parameters,
634 the identity of the SMTP server and client can be checked. This,
635 however, depends on whether the socket module really checks the
636 certificates.
Christian Heimes679db4a2008-01-18 09:56:22 +0000637
638 This method may raise the following exceptions:
639
640 SMTPHeloError The server didn't reply properly to
641 the helo greeting.
Guido van Rossumf7fcf5e2001-09-14 16:08:44 +0000642 """
Christian Heimes679db4a2008-01-18 09:56:22 +0000643 self.ehlo_or_helo_if_needed()
644 if not self.has_extn("starttls"):
645 raise SMTPException("STARTTLS extension not supported by server.")
Tim Petersb64bec32001-09-18 02:26:39 +0000646 (resp, reply) = self.docmd("STARTTLS")
Guido van Rossumf7fcf5e2001-09-14 16:08:44 +0000647 if resp == 220:
Thomas Wouters47b49bf2007-08-30 22:15:33 +0000648 if not _have_ssl:
649 raise RuntimeError("No SSL support included in this Python")
Antoine Pitroue0650202011-05-18 18:03:09 +0200650 if context is not None and keyfile is not None:
651 raise ValueError("context and keyfile arguments are mutually "
652 "exclusive")
653 if context is not None and certfile is not None:
654 raise ValueError("context and certfile arguments are mutually "
655 "exclusive")
656 if context is not None:
657 self.sock = context.wrap_socket(self.sock)
658 else:
659 self.sock = ssl.wrap_socket(self.sock, keyfile, certfile)
Antoine Pitrouf068ab82011-06-06 19:17:09 +0200660 self.file = None
Christian Heimes679db4a2008-01-18 09:56:22 +0000661 # RFC 3207:
662 # The client MUST discard any knowledge obtained from
663 # the server, such as the list of SMTP service extensions,
664 # which was not obtained from the TLS negotiation itself.
665 self.helo_resp = None
666 self.ehlo_resp = None
667 self.esmtp_features = {}
668 self.does_esmtp = 0
Guido van Rossumf7fcf5e2001-09-14 16:08:44 +0000669 return (resp, reply)
Tim Petersb64bec32001-09-18 02:26:39 +0000670
Jeremy Hylton31bb8ce1998-08-13 19:57:46 +0000671 def sendmail(self, from_addr, to_addrs, msg, mail_options=[],
Tim Peters495ad3c2001-01-15 01:36:40 +0000672 rcpt_options=[]):
673 """This command performs an entire mail transaction.
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000674
Tim Peters495ad3c2001-01-15 01:36:40 +0000675 The arguments are:
Barry Warsaw4c4bec81998-12-22 03:02:20 +0000676 - from_addr : The address sending this mail.
677 - to_addrs : A list of addresses to send this mail to. A bare
678 string will be treated as a list with 1 address.
Tim Peters495ad3c2001-01-15 01:36:40 +0000679 - msg : The message to send.
Barry Warsaw4c4bec81998-12-22 03:02:20 +0000680 - mail_options : List of ESMTP options (such as 8bitmime) for the
681 mail command.
682 - rcpt_options : List of ESMTP options (such as DSN commands) for
683 all the rcpt commands.
684
R. David Murray7dff9e02010-11-08 17:15:13 +0000685 msg may be a string containing characters in the ASCII range, or a byte
686 string. A string is encoded to bytes using the ascii codec, and lone
R David Murrayac4e5ab2011-07-02 21:03:19 -0400687 \\r and \\n characters are converted to \\r\\n characters.
R. David Murray7dff9e02010-11-08 17:15:13 +0000688
Barry Warsaw4c4bec81998-12-22 03:02:20 +0000689 If there has been no previous EHLO or HELO command this session, this
690 method tries ESMTP EHLO first. If the server does ESMTP, message size
691 and each of the specified options will be passed to it. If EHLO
692 fails, HELO will be tried and ESMTP options suppressed.
693
694 This method will return normally if the mail is accepted for at least
Barry Warsawd25c1b71999-11-28 17:11:06 +0000695 one recipient. It returns a dictionary, with one entry for each
696 recipient that was refused. Each entry contains a tuple of the SMTP
697 error code and the accompanying error message sent by the server.
Guido van Rossum296e1431999-04-07 15:03:39 +0000698
699 This method may raise the following exceptions:
700
701 SMTPHeloError The server didn't reply properly to
Tim Peters495ad3c2001-01-15 01:36:40 +0000702 the helo greeting.
Barry Warsawd25c1b71999-11-28 17:11:06 +0000703 SMTPRecipientsRefused The server rejected ALL recipients
Guido van Rossum296e1431999-04-07 15:03:39 +0000704 (no mail was sent).
705 SMTPSenderRefused The server didn't accept the from_addr.
706 SMTPDataError The server replied with an unexpected
707 error code (other than a refusal of
708 a recipient).
709
710 Note: the connection will be open even after an exception is raised.
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000711
Guido van Rossum95e6f701998-06-25 02:15:50 +0000712 Example:
Tim Peters495ad3c2001-01-15 01:36:40 +0000713
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000714 >>> import smtplib
715 >>> s=smtplib.SMTP("localhost")
Guido van Rossumfc40a831998-01-29 17:26:45 +0000716 >>> tolist=["one@one.org","two@two.org","three@three.org","four@four.org"]
Martin v. Löwis301b1cd2002-07-28 16:52:01 +0000717 >>> msg = '''\\
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000718 ... From: Me@my.org
719 ... Subject: testin'...
720 ...
721 ... This is a test '''
722 >>> s.sendmail("me@my.org",tolist,msg)
723 { "three@three.org" : ( 550 ,"User unknown" ) }
724 >>> s.quit()
Tim Peters495ad3c2001-01-15 01:36:40 +0000725
Barry Warsaw4c4bec81998-12-22 03:02:20 +0000726 In the above example, the message was accepted for delivery to three
727 of the four addresses, and one was rejected, with the error code
Barry Warsawd25c1b71999-11-28 17:11:06 +0000728 550. If all addresses are accepted, then the method will return an
Barry Warsaw4c4bec81998-12-22 03:02:20 +0000729 empty dictionary.
730
731 """
Christian Heimes679db4a2008-01-18 09:56:22 +0000732 self.ehlo_or_helo_if_needed()
Guido van Rossum95e6f701998-06-25 02:15:50 +0000733 esmtp_opts = []
R. David Murray7dff9e02010-11-08 17:15:13 +0000734 if isinstance(msg, str):
735 msg = _fix_eols(msg).encode('ascii')
Guido van Rossumfcfb6321998-08-04 15:29:54 +0000736 if self.does_esmtp:
737 # Hmmm? what's this? -ddm
738 # self.esmtp_features['7bit']=""
739 if self.has_extn('size'):
Walter Dörwald70a6b492004-02-12 17:35:32 +0000740 esmtp_opts.append("size=%d" % len(msg))
Guido van Rossumfcfb6321998-08-04 15:29:54 +0000741 for option in mail_options:
Guido van Rossum95e6f701998-06-25 02:15:50 +0000742 esmtp_opts.append(option)
Giampaolo Rodolàbd258bd2011-02-22 15:56:20 +0000743 (code, resp) = self.mail(from_addr, esmtp_opts)
Fred Drake8152d322000-12-12 23:20:45 +0000744 if code != 250:
Guido van Rossum45e2fbc1998-03-26 21:13:24 +0000745 self.rset()
Guido van Rossum296e1431999-04-07 15:03:39 +0000746 raise SMTPSenderRefused(code, resp, from_addr)
Giampaolo Rodolàbd258bd2011-02-22 15:56:20 +0000747 senderrs = {}
Guido van Rossum3172c5d2007-10-16 18:12:55 +0000748 if isinstance(to_addrs, str):
Jeremy Hylton31bb8ce1998-08-13 19:57:46 +0000749 to_addrs = [to_addrs]
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000750 for each in to_addrs:
Giampaolo Rodolàbd258bd2011-02-22 15:56:20 +0000751 (code, resp) = self.rcpt(each, rcpt_options)
Fred Drake8152d322000-12-12 23:20:45 +0000752 if (code != 250) and (code != 251):
Giampaolo Rodolàbd258bd2011-02-22 15:56:20 +0000753 senderrs[each] = (code, resp)
754 if len(senderrs) == len(to_addrs):
Guido van Rossum95e6f701998-06-25 02:15:50 +0000755 # the server refused all our recipients
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000756 self.rset()
Guido van Rossum296e1431999-04-07 15:03:39 +0000757 raise SMTPRecipientsRefused(senderrs)
Giampaolo Rodolàbd258bd2011-02-22 15:56:20 +0000758 (code, resp) = self.data(msg)
Fred Drake8152d322000-12-12 23:20:45 +0000759 if code != 250:
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000760 self.rset()
Guido van Rossum296e1431999-04-07 15:03:39 +0000761 raise SMTPDataError(code, resp)
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000762 #if we got here then somebody got our mail
Tim Peters495ad3c2001-01-15 01:36:40 +0000763 return senderrs
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000764
R. David Murray7dff9e02010-11-08 17:15:13 +0000765 def send_message(self, msg, from_addr=None, to_addrs=None,
766 mail_options=[], rcpt_options={}):
767 """Converts message to a bytestring and passes it to sendmail.
768
769 The arguments are as for sendmail, except that msg is an
R David Murrayac4e5ab2011-07-02 21:03:19 -0400770 email.message.Message object. If from_addr is None or to_addrs is
771 None, these arguments are taken from the headers of the Message as
772 described in RFC 2822 (a ValueError is raised if there is more than
773 one set of 'Resent-' headers). Regardless of the values of from_addr and
774 to_addr, any Bcc field (or Resent-Bcc field, when the Message is a
775 resent) of the Message object won't be transmitted. The Message
776 object is then serialized using email.generator.BytesGenerator and
777 sendmail is called to transmit the message.
778
R. David Murray7dff9e02010-11-08 17:15:13 +0000779 """
R David Murrayac4e5ab2011-07-02 21:03:19 -0400780 # 'Resent-Date' is a mandatory field if the Message is resent (RFC 2822
781 # Section 3.6.6). In such a case, we use the 'Resent-*' fields. However,
782 # if there is more than one 'Resent-' block there's no way to
783 # unambiguously determine which one is the most recent in all cases,
784 # so rather than guess we raise a ValueError in that case.
785 #
786 # TODO implement heuristics to guess the correct Resent-* block with an
787 # option allowing the user to enable the heuristics. (It should be
788 # possible to guess correctly almost all of the time.)
789 resent =msg.get_all('Resent-Date')
790 if resent is None:
791 header_prefix = ''
792 elif len(resent) == 1:
793 header_prefix = 'Resent-'
794 else:
795 raise ValueError("message has more than one 'Resent-' header block")
R. David Murray7dff9e02010-11-08 17:15:13 +0000796 if from_addr is None:
R David Murrayac4e5ab2011-07-02 21:03:19 -0400797 # Prefer the sender field per RFC 2822:3.6.2.
798 from_addr = (msg[header_prefix+'Sender']
799 if (header_prefix+'Sender') in msg
800 else msg[header_prefix+'From'])
R. David Murray7dff9e02010-11-08 17:15:13 +0000801 if to_addrs is None:
R David Murrayac4e5ab2011-07-02 21:03:19 -0400802 addr_fields = [f for f in (msg[header_prefix+'To'],
803 msg[header_prefix+'Bcc'],
804 msg[header_prefix+'Cc']) if f is not None]
R. David Murray7dff9e02010-11-08 17:15:13 +0000805 to_addrs = [a[1] for a in email.utils.getaddresses(addr_fields)]
R David Murrayac4e5ab2011-07-02 21:03:19 -0400806 # Make a local copy so we can delete the bcc headers.
807 msg_copy = copy.copy(msg)
808 del msg_copy['Bcc']
809 del msg_copy['Resent-Bcc']
R. David Murray7dff9e02010-11-08 17:15:13 +0000810 with io.BytesIO() as bytesmsg:
811 g = email.generator.BytesGenerator(bytesmsg)
R David Murrayac4e5ab2011-07-02 21:03:19 -0400812 g.flatten(msg_copy, linesep='\r\n')
R. David Murray7dff9e02010-11-08 17:15:13 +0000813 flatmsg = bytesmsg.getvalue()
814 return self.sendmail(from_addr, to_addrs, flatmsg, mail_options,
815 rcpt_options)
816
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000817 def close(self):
818 """Close the connection to the SMTP server."""
819 if self.file:
820 self.file.close()
821 self.file = None
822 if self.sock:
823 self.sock.close()
824 self.sock = None
825
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000826 def quit(self):
Guido van Rossum95e6f701998-06-25 02:15:50 +0000827 """Terminate the SMTP session."""
Christian Heimesba4af492008-03-28 00:55:15 +0000828 res = self.docmd("quit")
Guido van Rossum45e2fbc1998-03-26 21:13:24 +0000829 self.close()
Christian Heimesba4af492008-03-28 00:55:15 +0000830 return res
Guido van Rossum95e6f701998-06-25 02:15:50 +0000831
Thomas Wouters47b49bf2007-08-30 22:15:33 +0000832if _have_ssl:
Thomas Wouters89f507f2006-12-13 04:49:30 +0000833
Thomas Wouters47b49bf2007-08-30 22:15:33 +0000834 class SMTP_SSL(SMTP):
835 """ This is a subclass derived from SMTP that connects over an SSL encrypted
836 socket (to use this class you need a socket module that was compiled with SSL
837 support). If host is not specified, '' (the local host) is used. If port is
838 omitted, the standard SMTP-over-SSL port (465) is used. keyfile and certfile
839 are also optional - they can contain a PEM formatted private key and
Antoine Pitroue0650202011-05-18 18:03:09 +0200840 certificate chain file for the SSL connection. context also optional, can contain
841 a SSLContext, and is an alternative to keyfile and certfile; If it is specified both
842 keyfile and certfile must be None.
Thomas Wouters47b49bf2007-08-30 22:15:33 +0000843 """
Antoine Pitrouc1d52062011-05-07 19:39:37 +0200844
845 default_port = SMTP_SSL_PORT
846
Thomas Wouters47b49bf2007-08-30 22:15:33 +0000847 def __init__(self, host='', port=0, local_hostname=None,
Georg Brandlf78e02b2008-06-10 17:40:04 +0000848 keyfile=None, certfile=None,
Antoine Pitroue0650202011-05-18 18:03:09 +0200849 timeout=socket._GLOBAL_DEFAULT_TIMEOUT, context=None):
850 if context is not None and keyfile is not None:
851 raise ValueError("context and keyfile arguments are mutually "
852 "exclusive")
853 if context is not None and certfile is not None:
854 raise ValueError("context and certfile arguments are mutually "
855 "exclusive")
Thomas Wouters47b49bf2007-08-30 22:15:33 +0000856 self.keyfile = keyfile
857 self.certfile = certfile
Antoine Pitroue0650202011-05-18 18:03:09 +0200858 self.context = context
Thomas Wouters47b49bf2007-08-30 22:15:33 +0000859 SMTP.__init__(self, host, port, local_hostname, timeout)
Thomas Wouters47b49bf2007-08-30 22:15:33 +0000860
861 def _get_socket(self, host, port, timeout):
Giampaolo Rodolàbd258bd2011-02-22 15:56:20 +0000862 if self.debuglevel > 0:
863 print('connect:', (host, port), file=stderr)
R. David Murray87e20742009-05-23 01:30:26 +0000864 new_socket = socket.create_connection((host, port), timeout)
Antoine Pitroue0650202011-05-18 18:03:09 +0200865 if self.context is not None:
866 new_socket = self.context.wrap_socket(new_socket)
867 else:
868 new_socket = ssl.wrap_socket(new_socket, self.keyfile, self.certfile)
R. David Murray87e20742009-05-23 01:30:26 +0000869 return new_socket
Thomas Wouters47b49bf2007-08-30 22:15:33 +0000870
871 __all__.append("SMTP_SSL")
Barry Warsaw4c4bec81998-12-22 03:02:20 +0000872
Guido van Rossumd8faa362007-04-27 19:54:29 +0000873#
874# LMTP extension
875#
876LMTP_PORT = 2003
877
878class LMTP(SMTP):
879 """LMTP - Local Mail Transfer Protocol
880
881 The LMTP protocol, which is very similar to ESMTP, is heavily based
882 on the standard SMTP client. It's common to use Unix sockets for LMTP,
883 so our connect() method must support that as well as a regular
884 host:port server. To specify a Unix socket, you must use an absolute
885 path as the host, starting with a '/'.
886
887 Authentication is supported, using the regular SMTP mechanism. When
888 using a Unix socket, LMTP generally don't support or require any
889 authentication, but your mileage might vary."""
890
891 ehlo_msg = "lhlo"
892
Giampaolo Rodolàbd258bd2011-02-22 15:56:20 +0000893 def __init__(self, host='', port=LMTP_PORT, local_hostname=None):
Guido van Rossumd8faa362007-04-27 19:54:29 +0000894 """Initialize a new instance."""
895 SMTP.__init__(self, host, port, local_hostname)
896
Giampaolo Rodolàbd258bd2011-02-22 15:56:20 +0000897 def connect(self, host='localhost', port=0):
Guido van Rossumd8faa362007-04-27 19:54:29 +0000898 """Connect to the LMTP daemon, on either a Unix or a TCP socket."""
899 if host[0] != '/':
900 return SMTP.connect(self, host, port)
901
902 # Handle Unix-domain sockets.
903 try:
904 self.sock = socket.socket(socket.AF_UNIX, socket.SOCK_STREAM)
Antoine Pitrouf068ab82011-06-06 19:17:09 +0200905 self.file = None
Guido van Rossumd8faa362007-04-27 19:54:29 +0000906 self.sock.connect(host)
907 except socket.error as msg:
Giampaolo Rodolàbd258bd2011-02-22 15:56:20 +0000908 if self.debuglevel > 0:
909 print('connect fail:', host, file=stderr)
Guido van Rossumd8faa362007-04-27 19:54:29 +0000910 if self.sock:
911 self.sock.close()
912 self.sock = None
913 raise socket.error(msg)
914 (code, msg) = self.getreply()
Giampaolo Rodolàbd258bd2011-02-22 15:56:20 +0000915 if self.debuglevel > 0:
916 print('connect:', msg, file=stderr)
Guido van Rossumd8faa362007-04-27 19:54:29 +0000917 return (code, msg)
918
919
Guido van Rossum95e6f701998-06-25 02:15:50 +0000920# Test the sendmail method, which tests most of the others.
921# Note: This always sends to localhost.
922if __name__ == '__main__':
Andrew M. Kuchling6be424f2001-08-13 14:41:39 +0000923 import sys
Guido van Rossum95e6f701998-06-25 02:15:50 +0000924
925 def prompt(prompt):
926 sys.stdout.write(prompt + ": ")
Eric S. Raymondc013f302001-02-09 05:40:38 +0000927 return sys.stdin.readline().strip()
Guido van Rossum95e6f701998-06-25 02:15:50 +0000928
929 fromaddr = prompt("From")
Giampaolo Rodolàbd258bd2011-02-22 15:56:20 +0000930 toaddrs = prompt("To").split(',')
Guido van Rossumbe19ed72007-02-09 05:37:30 +0000931 print("Enter message, end with ^D:")
Guido van Rossum95e6f701998-06-25 02:15:50 +0000932 msg = ''
933 while 1:
934 line = sys.stdin.readline()
935 if not line:
936 break
937 msg = msg + line
Guido van Rossumbe19ed72007-02-09 05:37:30 +0000938 print("Message length is %d" % len(msg))
Guido van Rossum95e6f701998-06-25 02:15:50 +0000939
940 server = SMTP('localhost')
941 server.set_debuglevel(1)
942 server.sendmail(fromaddr, toaddrs, msg)
943 server.quit()