blob: 69ae845dca43c69dc14b8fa02b3e801ce333ff6a [file] [log] [blame]
Benjamin Peterson90f5ba52010-03-11 22:53:45 +00001#! /usr/bin/env python3
Barry Warsaw4c4bec81998-12-22 03:02:20 +00002
Barry Warsawa1ae8842000-07-09 21:24:31 +00003'''SMTP/ESMTP client class.
Guido van Rossumbbe323e1998-01-29 17:24:40 +00004
Guido van Rossumf7fcf5e2001-09-14 16:08:44 +00005This should follow RFC 821 (SMTP), RFC 1869 (ESMTP), RFC 2554 (SMTP
6Authentication) and RFC 2487 (Secure SMTP over TLS).
Guido van Rossumbbe323e1998-01-29 17:24:40 +00007
Guido van Rossumfcfb6321998-08-04 15:29:54 +00008Notes:
9
10Please remember, when doing ESMTP, that the names of the SMTP service
Barry Warsaw4c4bec81998-12-22 03:02:20 +000011extensions are NOT the same thing as the option keywords for the RCPT
Guido van Rossumfcfb6321998-08-04 15:29:54 +000012and MAIL commands!
13
Guido van Rossumbbe323e1998-01-29 17:24:40 +000014Example:
15
Barry Warsawa7d9bdf1998-12-22 03:24:27 +000016 >>> import smtplib
17 >>> s=smtplib.SMTP("localhost")
Guido van Rossum7131f842007-02-09 20:13:25 +000018 >>> print(s.help())
Barry Warsawa7d9bdf1998-12-22 03:24:27 +000019 This is Sendmail version 8.8.4
20 Topics:
21 HELO EHLO MAIL RCPT DATA
22 RSET NOOP QUIT HELP VRFY
23 EXPN VERB ETRN DSN
24 For more info use "HELP <topic>".
25 To report bugs in the implementation send email to
26 sendmail-bugs@sendmail.org.
27 For local information send email to Postmaster at your site.
28 End of HELP info
29 >>> s.putcmd("vrfy","someone@here")
30 >>> s.getreply()
31 (250, "Somebody OverHere <somebody@here.my.org>")
32 >>> s.quit()
Barry Warsawa1ae8842000-07-09 21:24:31 +000033'''
Guido van Rossumbbe323e1998-01-29 17:24:40 +000034
Guido van Rossum98d9fd32000-02-28 15:12:25 +000035# Author: The Dragon De Monsyne <dragondm@integral.org>
36# ESMTP support, test code and doc fixes added by
37# Eric S. Raymond <esr@thyrsus.com>
38# Better RFC 821 compliance (MAIL and RCPT, and CRLF in data)
39# by Carey Evans <c.evans@clear.net.nz>, for picky mail servers.
Guido van Rossumae010462001-09-11 15:57:46 +000040# RFC 2554 (authentication) support by Gerhard Haering <gerhard@bigfoot.de>.
Tim Peters495ad3c2001-01-15 01:36:40 +000041#
Guido van Rossum98d9fd32000-02-28 15:12:25 +000042# This was modified from the Python 1.5 library HTTP lib.
43
Guido van Rossumbbe323e1998-01-29 17:24:40 +000044import socket
R. David Murray7dff9e02010-11-08 17:15:13 +000045import io
Barry Warsaw07201771998-12-22 20:37:36 +000046import re
Thomas Woutersb2137042007-02-01 18:02:27 +000047import email.utils
R. David Murray7dff9e02010-11-08 17:15:13 +000048import email.message
49import email.generator
Guido van Rossumae010462001-09-11 15:57:46 +000050import base64
51import hmac
R David Murrayac4e5ab2011-07-02 21:03:19 -040052import copy
Barry Warsaw2cc1f6d2007-08-30 14:28:55 +000053from email.base64mime import body_encode as encode_base64
Brett Cannone6f8a892004-07-10 23:14:30 +000054from sys import stderr
Guido van Rossumbbe323e1998-01-29 17:24:40 +000055
Giampaolo Rodolàbd258bd2011-02-22 15:56:20 +000056__all__ = ["SMTPException", "SMTPServerDisconnected", "SMTPResponseException",
57 "SMTPSenderRefused", "SMTPRecipientsRefused", "SMTPDataError",
58 "SMTPConnectError", "SMTPHeloError", "SMTPAuthenticationError",
59 "quoteaddr", "quotedata", "SMTP"]
Skip Montanaro0de65802001-02-15 22:15:14 +000060
Guido van Rossumbbe323e1998-01-29 17:24:40 +000061SMTP_PORT = 25
Thomas Wouters89f507f2006-12-13 04:49:30 +000062SMTP_SSL_PORT = 465
Giampaolo Rodolàbd258bd2011-02-22 15:56:20 +000063CRLF = "\r\n"
64bCRLF = b"\r\n"
Guido van Rossumbbe323e1998-01-29 17:24:40 +000065
Piers Lauder385a77a2002-07-27 00:38:30 +000066OLDSTYLE_AUTH = re.compile(r"auth=(.*)", re.I)
67
Tim Peters495ad3c2001-01-15 01:36:40 +000068# Exception classes used by this module.
R David Murray8a345962013-04-14 06:46:35 -040069class SMTPException(OSError):
Guido van Rossum296e1431999-04-07 15:03:39 +000070 """Base class for all exceptions raised by this module."""
71
72class SMTPServerDisconnected(SMTPException):
73 """Not connected to any SMTP server.
74
75 This exception is raised when the server unexpectedly disconnects,
76 or when an attempt is made to use the SMTP instance before
77 connecting it to a server.
78 """
79
80class SMTPResponseException(SMTPException):
81 """Base class for all exceptions that include an SMTP error code.
82
83 These exceptions are generated in some instances when the SMTP
84 server returns an error code. The error code is stored in the
85 `smtp_code' attribute of the error, and the `smtp_error' attribute
86 is set to the error message.
87 """
88
89 def __init__(self, code, msg):
90 self.smtp_code = code
91 self.smtp_error = msg
92 self.args = (code, msg)
93
94class SMTPSenderRefused(SMTPResponseException):
95 """Sender address refused.
Guido van Rossumae010462001-09-11 15:57:46 +000096
Guido van Rossum296e1431999-04-07 15:03:39 +000097 In addition to the attributes set by on all SMTPResponseException
Barry Warsawd25c1b71999-11-28 17:11:06 +000098 exceptions, this sets `sender' to the string that the SMTP refused.
Guido van Rossum296e1431999-04-07 15:03:39 +000099 """
100
101 def __init__(self, code, msg, sender):
102 self.smtp_code = code
103 self.smtp_error = msg
104 self.sender = sender
105 self.args = (code, msg, sender)
106
Guido van Rossum20c92281999-04-21 16:52:20 +0000107class SMTPRecipientsRefused(SMTPException):
Barry Warsawd25c1b71999-11-28 17:11:06 +0000108 """All recipient addresses refused.
Guido van Rossumae010462001-09-11 15:57:46 +0000109
Thomas Wouters7e474022000-07-16 12:04:32 +0000110 The errors for each recipient are accessible through the attribute
Tim Peters495ad3c2001-01-15 01:36:40 +0000111 'recipients', which is a dictionary of exactly the same sort as
112 SMTP.sendmail() returns.
Guido van Rossum296e1431999-04-07 15:03:39 +0000113 """
114
115 def __init__(self, recipients):
116 self.recipients = recipients
Giampaolo Rodolàbd258bd2011-02-22 15:56:20 +0000117 self.args = (recipients,)
Guido van Rossum296e1431999-04-07 15:03:39 +0000118
119
Guido van Rossum296e1431999-04-07 15:03:39 +0000120class SMTPDataError(SMTPResponseException):
121 """The SMTP server didn't accept the data."""
122
123class SMTPConnectError(SMTPResponseException):
Barry Warsawd25c1b71999-11-28 17:11:06 +0000124 """Error during connection establishment."""
Guido van Rossum296e1431999-04-07 15:03:39 +0000125
126class SMTPHeloError(SMTPResponseException):
Barry Warsawd25c1b71999-11-28 17:11:06 +0000127 """The server refused our HELO reply."""
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000128
Guido van Rossumae010462001-09-11 15:57:46 +0000129class SMTPAuthenticationError(SMTPResponseException):
130 """Authentication error.
131
132 Most probably the server didn't accept the username/password
133 combination provided.
134 """
Peter Schneider-Kamp7bc82bb2000-08-10 14:02:23 +0000135
R David Murray4c14bba2011-07-18 21:59:53 -0400136def quoteaddr(addrstring):
Guido van Rossum69a79bc1998-07-13 15:18:49 +0000137 """Quote a subset of the email addresses defined by RFC 821.
138
Georg Brandl9f0f9602008-06-12 22:23:59 +0000139 Should be able to handle anything email.utils.parseaddr can handle.
Barry Warsawa7d9bdf1998-12-22 03:24:27 +0000140 """
R David Murray4c14bba2011-07-18 21:59:53 -0400141 displayname, addr = email.utils.parseaddr(addrstring)
142 if (displayname, addr) == ('', ''):
143 # parseaddr couldn't parse it, use it as is and hope for the best.
144 if addrstring.strip().startswith('<'):
145 return addrstring
146 return "<%s>" % addrstring
147 return "<%s>" % addr
Guido van Rossum69a79bc1998-07-13 15:18:49 +0000148
R David Murray46346762011-07-18 21:38:54 -0400149def _addr_only(addrstring):
150 displayname, addr = email.utils.parseaddr(addrstring)
151 if (displayname, addr) == ('', ''):
152 # parseaddr couldn't parse it, so use it as is.
153 return addrstring
154 return addr
155
R. David Murray7dff9e02010-11-08 17:15:13 +0000156# Legacy method kept for backward compatibility.
Guido van Rossum69a79bc1998-07-13 15:18:49 +0000157def quotedata(data):
158 """Quote data for email.
159
Barry Warsawd25c1b71999-11-28 17:11:06 +0000160 Double leading '.', and change Unix newline '\\n', or Mac '\\r' into
Barry Warsawa7d9bdf1998-12-22 03:24:27 +0000161 Internet CRLF end-of-line.
162 """
Guido van Rossum69a79bc1998-07-13 15:18:49 +0000163 return re.sub(r'(?m)^\.', '..',
Guido van Rossumfcfb6321998-08-04 15:29:54 +0000164 re.sub(r'(?:\r\n|\n|\r(?!\n))', CRLF, data))
Guido van Rossum69a79bc1998-07-13 15:18:49 +0000165
R. David Murray7dff9e02010-11-08 17:15:13 +0000166def _quote_periods(bindata):
R David Murray0f663d02011-06-09 15:05:57 -0400167 return re.sub(br'(?m)^\.', b'..', bindata)
R. David Murray7dff9e02010-11-08 17:15:13 +0000168
169def _fix_eols(data):
170 return re.sub(r'(?:\r\n|\n|\r(?!\n))', CRLF, data)
171
Thomas Wouters47b49bf2007-08-30 22:15:33 +0000172try:
173 import ssl
Brett Cannoncd171c82013-07-04 17:43:24 -0400174except ImportError:
Thomas Wouters47b49bf2007-08-30 22:15:33 +0000175 _have_ssl = False
176else:
Thomas Wouters47b49bf2007-08-30 22:15:33 +0000177 _have_ssl = True
178
Peter Schneider-Kamp7bc82bb2000-08-10 14:02:23 +0000179
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000180class SMTP:
Guido van Rossumfcfb6321998-08-04 15:29:54 +0000181 """This class manages a connection to an SMTP or ESMTP server.
182 SMTP Objects:
Tim Peters495ad3c2001-01-15 01:36:40 +0000183 SMTP objects have the following attributes:
184 helo_resp
185 This is the message given by the server in response to the
Guido van Rossumfcfb6321998-08-04 15:29:54 +0000186 most recent HELO command.
Tim Peters495ad3c2001-01-15 01:36:40 +0000187
Guido van Rossumfcfb6321998-08-04 15:29:54 +0000188 ehlo_resp
Tim Peters495ad3c2001-01-15 01:36:40 +0000189 This is the message given by the server in response to the
Guido van Rossumfcfb6321998-08-04 15:29:54 +0000190 most recent EHLO command. This is usually multiline.
191
Tim Peters495ad3c2001-01-15 01:36:40 +0000192 does_esmtp
Guido van Rossumfcfb6321998-08-04 15:29:54 +0000193 This is a True value _after you do an EHLO command_, if the
194 server supports ESMTP.
195
Tim Peters495ad3c2001-01-15 01:36:40 +0000196 esmtp_features
Guido van Rossumfcfb6321998-08-04 15:29:54 +0000197 This is a dictionary, which, if the server supports ESMTP,
Barry Warsawd25c1b71999-11-28 17:11:06 +0000198 will _after you do an EHLO command_, contain the names of the
199 SMTP service extensions this server supports, and their
Guido van Rossumfcfb6321998-08-04 15:29:54 +0000200 parameters (if any).
Barry Warsawd25c1b71999-11-28 17:11:06 +0000201
Tim Peters495ad3c2001-01-15 01:36:40 +0000202 Note, all extension names are mapped to lower case in the
203 dictionary.
Guido van Rossumfcfb6321998-08-04 15:29:54 +0000204
Barry Warsawd25c1b71999-11-28 17:11:06 +0000205 See each method's docstrings for details. In general, there is a
206 method of the same name to perform each SMTP command. There is also a
207 method called 'sendmail' that will do an entire mail transaction.
208 """
Guido van Rossum95e6f701998-06-25 02:15:50 +0000209 debuglevel = 0
210 file = None
211 helo_resp = None
Guido van Rossumd8faa362007-04-27 19:54:29 +0000212 ehlo_msg = "ehlo"
Guido van Rossum95e6f701998-06-25 02:15:50 +0000213 ehlo_resp = None
Guido van Rossumfcfb6321998-08-04 15:29:54 +0000214 does_esmtp = 0
Antoine Pitrouc1d52062011-05-07 19:39:37 +0200215 default_port = SMTP_PORT
Guido van Rossum95e6f701998-06-25 02:15:50 +0000216
Georg Brandlf78e02b2008-06-10 17:40:04 +0000217 def __init__(self, host='', port=0, local_hostname=None,
Senthil Kumaran3d23fd62011-07-30 10:56:50 +0800218 timeout=socket._GLOBAL_DEFAULT_TIMEOUT,
219 source_address=None):
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000220 """Initialize a new instance.
221
Barry Warsawa7d9bdf1998-12-22 03:24:27 +0000222 If specified, `host' is the name of the remote host to which to
223 connect. If specified, `port' specifies the port to which to connect.
R David Murray14ee3cf2013-04-13 14:40:33 -0400224 By default, smtplib.SMTP_PORT is used. If a host is specified the
R David Murray021362d2013-06-23 16:05:44 -0400225 connect method is called, and if it returns anything other than a
226 success code an SMTPConnectError is raised. If specified,
227 `local_hostname` is used as the FQDN of the local host in the HELO/EHLO
228 command. Otherwise, the local hostname is found using
229 socket.getfqdn(). The `source_address` parameter takes a 2-tuple (host,
230 port) for the socket to bind to as its source address before
231 connecting. If the host is '' and port is 0, the OS default behavior
232 will be used.
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000233
234 """
Guido van Rossumd8faa362007-04-27 19:54:29 +0000235 self.timeout = timeout
Guido van Rossumfcfb6321998-08-04 15:29:54 +0000236 self.esmtp_features = {}
Senthil Kumaran3d23fd62011-07-30 10:56:50 +0800237 self.source_address = source_address
238
Guido van Rossum296e1431999-04-07 15:03:39 +0000239 if host:
240 (code, msg) = self.connect(host, port)
241 if code != 220:
242 raise SMTPConnectError(code, msg)
Raymond Hettingerf13eb552002-06-02 00:40:05 +0000243 if local_hostname is not None:
Barry Warsaw13e34f72002-03-26 20:27:35 +0000244 self.local_hostname = local_hostname
Neil Schemenauer6730f262002-03-24 15:30:40 +0000245 else:
Barry Warsaw13e34f72002-03-26 20:27:35 +0000246 # RFC 2821 says we should use the fqdn in the EHLO/HELO verb, and
247 # if that can't be calculated, that we should use a domain literal
248 # instead (essentially an encoded IP address like [A.B.C.D]).
249 fqdn = socket.getfqdn()
250 if '.' in fqdn:
251 self.local_hostname = fqdn
252 else:
253 # We can't find an fqdn hostname, so use a domain literal
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000254 addr = '127.0.0.1'
255 try:
256 addr = socket.gethostbyname(socket.gethostname())
257 except socket.gaierror:
258 pass
Barry Warsaw13e34f72002-03-26 20:27:35 +0000259 self.local_hostname = '[%s]' % addr
Tim Peters495ad3c2001-01-15 01:36:40 +0000260
Barry Warsaw1f5c9582011-03-15 15:04:44 -0400261 def __enter__(self):
262 return self
263
264 def __exit__(self, *args):
265 try:
266 code, message = self.docmd("QUIT")
267 if code != 221:
268 raise SMTPResponseException(code, message)
269 except SMTPServerDisconnected:
270 pass
271 finally:
272 self.close()
273
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000274 def set_debuglevel(self, debuglevel):
275 """Set the debug output level.
276
Barry Warsawa7d9bdf1998-12-22 03:24:27 +0000277 A non-false value results in debug messages for connection and for all
278 messages sent to and received from the server.
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000279
280 """
281 self.debuglevel = debuglevel
282
Barry Warsawc9181712008-03-19 14:25:51 +0000283 def _get_socket(self, host, port, timeout):
Thomas Wouters89f507f2006-12-13 04:49:30 +0000284 # This makes it simpler for SMTP_SSL to use the SMTP connect code
285 # and just alter the socket connection bit.
Giampaolo Rodolàbd258bd2011-02-22 15:56:20 +0000286 if self.debuglevel > 0:
Senthil Kumaranb351a482011-07-31 09:14:17 +0800287 print('connect: to', (host, port), self.source_address,
288 file=stderr)
Senthil Kumaran3d23fd62011-07-30 10:56:50 +0800289 return socket.create_connection((host, port), timeout,
290 self.source_address)
Thomas Wouters89f507f2006-12-13 04:49:30 +0000291
Senthil Kumaran3d23fd62011-07-30 10:56:50 +0800292 def connect(self, host='localhost', port=0, source_address=None):
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000293 """Connect to a host on a given port.
Guido van Rossum95e6f701998-06-25 02:15:50 +0000294
Barry Warsaw4c4bec81998-12-22 03:02:20 +0000295 If the hostname ends with a colon (`:') followed by a number, and
296 there is no port specified, that suffix will be stripped off and the
297 number interpreted as the port number to use.
Guido van Rossum95e6f701998-06-25 02:15:50 +0000298
Barry Warsawa7d9bdf1998-12-22 03:24:27 +0000299 Note: This method is automatically invoked by __init__, if a host is
300 specified during instantiation.
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000301
302 """
Senthil Kumaranb351a482011-07-31 09:14:17 +0800303
304 if source_address:
305 self.source_address = source_address
306
Martin v. Löwis4eb59402001-07-26 13:37:33 +0000307 if not port and (host.find(':') == host.rfind(':')):
Martin v. Löwisa43c2f82001-07-24 20:34:08 +0000308 i = host.rfind(':')
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000309 if i >= 0:
Giampaolo Rodolàbd258bd2011-02-22 15:56:20 +0000310 host, port = host[:i], host[i + 1:]
311 try:
312 port = int(port)
Eric S. Raymond8d876032001-02-09 10:14:53 +0000313 except ValueError:
Andrew Svetlov2ade6f22012-12-17 18:57:16 +0200314 raise OSError("nonnumeric port")
Giampaolo Rodolàbd258bd2011-02-22 15:56:20 +0000315 if not port:
316 port = self.default_port
317 if self.debuglevel > 0:
318 print('connect:', (host, port), file=stderr)
Guido van Rossumd8faa362007-04-27 19:54:29 +0000319 self.sock = self._get_socket(host, port, self.timeout)
Antoine Pitrouf068ab82011-06-06 19:17:09 +0200320 self.file = None
Martin v. Löwisa43c2f82001-07-24 20:34:08 +0000321 (code, msg) = self.getreply()
Giampaolo Rodolàbd258bd2011-02-22 15:56:20 +0000322 if self.debuglevel > 0:
323 print("connect:", msg, file=stderr)
Martin v. Löwisa43c2f82001-07-24 20:34:08 +0000324 return (code, msg)
Tim Peters495ad3c2001-01-15 01:36:40 +0000325
Guido van Rossum8a392d72007-11-21 22:09:45 +0000326 def send(self, s):
327 """Send `s' to the server."""
Giampaolo Rodolàbd258bd2011-02-22 15:56:20 +0000328 if self.debuglevel > 0:
329 print('send:', repr(s), file=stderr)
Christian Heimes90c3d9b2008-02-23 13:18:03 +0000330 if hasattr(self, 'sock') and self.sock:
Guido van Rossum8a392d72007-11-21 22:09:45 +0000331 if isinstance(s, str):
332 s = s.encode("ascii")
Guido van Rossum2880f6e1998-08-10 20:07:00 +0000333 try:
Guido van Rossum8a392d72007-11-21 22:09:45 +0000334 self.sock.sendall(s)
Andrew Svetlov2ade6f22012-12-17 18:57:16 +0200335 except OSError:
Barry Warsaw76750972001-12-14 20:34:20 +0000336 self.close()
Guido van Rossum40233ea1999-01-15 03:23:55 +0000337 raise SMTPServerDisconnected('Server not connected')
Guido van Rossumfc40a831998-01-29 17:26:45 +0000338 else:
Guido van Rossum40233ea1999-01-15 03:23:55 +0000339 raise SMTPServerDisconnected('please run connect() first')
Tim Peters495ad3c2001-01-15 01:36:40 +0000340
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000341 def putcmd(self, cmd, args=""):
Barry Warsawa7d9bdf1998-12-22 03:24:27 +0000342 """Send a command to the server."""
Guido van Rossumdb23d3d1999-06-09 15:13:10 +0000343 if args == "":
344 str = '%s%s' % (cmd, CRLF)
345 else:
346 str = '%s %s%s' % (cmd, args, CRLF)
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000347 self.send(str)
Tim Peters495ad3c2001-01-15 01:36:40 +0000348
Guido van Rossumfcfb6321998-08-04 15:29:54 +0000349 def getreply(self):
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000350 """Get a reply from the server.
Tim Peters495ad3c2001-01-15 01:36:40 +0000351
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000352 Returns a tuple consisting of:
Barry Warsawa7d9bdf1998-12-22 03:24:27 +0000353
354 - server response code (e.g. '250', or such, if all goes well)
355 Note: returns -1 if it can't read response code.
356
357 - server response string corresponding to response code (multiline
358 responses are converted to a single, multiline string).
Guido van Rossumf123f841999-03-29 20:33:21 +0000359
360 Raises SMTPServerDisconnected if end-of-file is reached.
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000361 """
Giampaolo Rodolàbd258bd2011-02-22 15:56:20 +0000362 resp = []
Guido van Rossum296e1431999-04-07 15:03:39 +0000363 if self.file is None:
364 self.file = self.sock.makefile('rb')
Guido van Rossum45e2fbc1998-03-26 21:13:24 +0000365 while 1:
Benjamin Petersone1cdfd72009-01-18 21:02:37 +0000366 try:
367 line = self.file.readline()
Andrew Svetlov2ade6f22012-12-17 18:57:16 +0200368 except OSError as e:
Antoine Pitrou6b2e1602011-08-28 01:20:42 +0200369 self.close()
370 raise SMTPServerDisconnected("Connection unexpectedly closed: "
371 + str(e))
Guido van Rossum806c2462007-08-06 23:33:07 +0000372 if not line:
Guido van Rossum296e1431999-04-07 15:03:39 +0000373 self.close()
374 raise SMTPServerDisconnected("Connection unexpectedly closed")
Giampaolo Rodolàbd258bd2011-02-22 15:56:20 +0000375 if self.debuglevel > 0:
376 print('reply:', repr(line), file=stderr)
Guido van Rossum806c2462007-08-06 23:33:07 +0000377 resp.append(line[4:].strip(b' \t\r\n'))
Giampaolo Rodolàbd258bd2011-02-22 15:56:20 +0000378 code = line[:3]
Guido van Rossum296e1431999-04-07 15:03:39 +0000379 # Check that the error code is syntactically correct.
380 # Don't attempt to read a continuation line if it is broken.
381 try:
Eric S. Raymondc013f302001-02-09 05:40:38 +0000382 errcode = int(code)
Guido van Rossum296e1431999-04-07 15:03:39 +0000383 except ValueError:
384 errcode = -1
385 break
Guido van Rossumf123f841999-03-29 20:33:21 +0000386 # Check if multiline response.
Guido van Rossum806c2462007-08-06 23:33:07 +0000387 if line[3:4] != b"-":
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000388 break
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000389
Guido van Rossumc43e79f2007-06-18 18:26:36 +0000390 errmsg = b"\n".join(resp)
Tim Peters495ad3c2001-01-15 01:36:40 +0000391 if self.debuglevel > 0:
Senthil Kumaranb351a482011-07-31 09:14:17 +0800392 print('reply: retcode (%s); Msg: %s' % (errcode, errmsg),
393 file=stderr)
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000394 return errcode, errmsg
Tim Peters495ad3c2001-01-15 01:36:40 +0000395
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000396 def docmd(self, cmd, args=""):
Barry Warsawa7d9bdf1998-12-22 03:24:27 +0000397 """Send a command, and return its response code."""
Giampaolo Rodolàbd258bd2011-02-22 15:56:20 +0000398 self.putcmd(cmd, args)
Guido van Rossum296e1431999-04-07 15:03:39 +0000399 return self.getreply()
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000400
Barry Warsawa7d9bdf1998-12-22 03:24:27 +0000401 # std smtp commands
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000402 def helo(self, name=''):
Barry Warsawa7d9bdf1998-12-22 03:24:27 +0000403 """SMTP 'helo' command.
404 Hostname to send for this command defaults to the FQDN of the local
405 host.
406 """
Neil Schemenauer6730f262002-03-24 15:30:40 +0000407 self.putcmd("helo", name or self.local_hostname)
Giampaolo Rodolàbd258bd2011-02-22 15:56:20 +0000408 (code, msg) = self.getreply()
409 self.helo_resp = msg
410 return (code, msg)
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000411
Guido van Rossum95e6f701998-06-25 02:15:50 +0000412 def ehlo(self, name=''):
Barry Warsawa7d9bdf1998-12-22 03:24:27 +0000413 """ SMTP 'ehlo' command.
414 Hostname to send for this command defaults to the FQDN of the local
415 host.
416 """
Guido van Rossumf7fcf5e2001-09-14 16:08:44 +0000417 self.esmtp_features = {}
Guido van Rossumd8faa362007-04-27 19:54:29 +0000418 self.putcmd(self.ehlo_msg, name or self.local_hostname)
Giampaolo Rodolàbd258bd2011-02-22 15:56:20 +0000419 (code, msg) = self.getreply()
Tim Peters495ad3c2001-01-15 01:36:40 +0000420 # According to RFC1869 some (badly written)
421 # MTA's will disconnect on an ehlo. Toss an exception if
Guido van Rossumfcfb6321998-08-04 15:29:54 +0000422 # that happens -ddm
423 if code == -1 and len(msg) == 0:
Barry Warsaw76750972001-12-14 20:34:20 +0000424 self.close()
Guido van Rossum40233ea1999-01-15 03:23:55 +0000425 raise SMTPServerDisconnected("Server not connected")
Giampaolo Rodolàbd258bd2011-02-22 15:56:20 +0000426 self.ehlo_resp = msg
Fred Drake8152d322000-12-12 23:20:45 +0000427 if code != 250:
Giampaolo Rodolàbd258bd2011-02-22 15:56:20 +0000428 return (code, msg)
429 self.does_esmtp = 1
Thomas Wouters7e474022000-07-16 12:04:32 +0000430 #parse the ehlo response -ddm
Guido van Rossum04110fb2007-08-24 16:32:05 +0000431 assert isinstance(self.ehlo_resp, bytes), repr(self.ehlo_resp)
Giampaolo Rodolàbd258bd2011-02-22 15:56:20 +0000432 resp = self.ehlo_resp.decode("latin-1").split('\n')
Guido van Rossumfcfb6321998-08-04 15:29:54 +0000433 del resp[0]
Guido van Rossum2880f6e1998-08-10 20:07:00 +0000434 for each in resp:
Piers Lauder385a77a2002-07-27 00:38:30 +0000435 # To be able to communicate with as many SMTP servers as possible,
436 # we have to take the old-style auth advertisement into account,
437 # because:
438 # 1) Else our SMTP feature parser gets confused.
439 # 2) There are some servers that only advertise the auth methods we
440 # support using the old style.
441 auth_match = OLDSTYLE_AUTH.match(each)
442 if auth_match:
443 # This doesn't remove duplicates, but that's no problem
444 self.esmtp_features["auth"] = self.esmtp_features.get("auth", "") \
445 + " " + auth_match.groups(0)[0]
446 continue
447
Barry Warsawbe22ae62002-04-15 20:03:30 +0000448 # RFC 1869 requires a space between ehlo keyword and parameters.
449 # It's actually stricter, in that only spaces are allowed between
450 # parameters, but were not going to check for that here. Note
451 # that the space isn't present if there are no parameters.
Giampaolo Rodolàbd258bd2011-02-22 15:56:20 +0000452 m = re.match(r'(?P<feature>[A-Za-z0-9][A-Za-z0-9\-]*) ?', each)
Guido van Rossumfcfb6321998-08-04 15:29:54 +0000453 if m:
Giampaolo Rodolàbd258bd2011-02-22 15:56:20 +0000454 feature = m.group("feature").lower()
455 params = m.string[m.end("feature"):].strip()
Piers Lauder385a77a2002-07-27 00:38:30 +0000456 if feature == "auth":
457 self.esmtp_features[feature] = self.esmtp_features.get(feature, "") \
458 + " " + params
459 else:
Giampaolo Rodolàbd258bd2011-02-22 15:56:20 +0000460 self.esmtp_features[feature] = params
461 return (code, msg)
Guido van Rossum95e6f701998-06-25 02:15:50 +0000462
Guido van Rossumfcfb6321998-08-04 15:29:54 +0000463 def has_extn(self, opt):
464 """Does the server support a given SMTP service extension?"""
Raymond Hettinger54f02222002-06-01 14:18:47 +0000465 return opt.lower() in self.esmtp_features
Guido van Rossum95e6f701998-06-25 02:15:50 +0000466
Guido van Rossum18586f41998-04-03 17:03:13 +0000467 def help(self, args=''):
Barry Warsawa7d9bdf1998-12-22 03:24:27 +0000468 """SMTP 'help' command.
469 Returns help text from server."""
Guido van Rossum18586f41998-04-03 17:03:13 +0000470 self.putcmd("help", args)
Kurt B. Kaiser58bd1902005-06-26 18:27:36 +0000471 return self.getreply()[1]
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000472
473 def rset(self):
Barry Warsawa7d9bdf1998-12-22 03:24:27 +0000474 """SMTP 'rset' command -- resets session."""
Guido van Rossum296e1431999-04-07 15:03:39 +0000475 return self.docmd("rset")
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000476
477 def noop(self):
Barry Warsawa7d9bdf1998-12-22 03:24:27 +0000478 """SMTP 'noop' command -- doesn't do anything :>"""
Guido van Rossum296e1431999-04-07 15:03:39 +0000479 return self.docmd("noop")
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000480
Giampaolo Rodolàbd258bd2011-02-22 15:56:20 +0000481 def mail(self, sender, options=[]):
Barry Warsawa7d9bdf1998-12-22 03:24:27 +0000482 """SMTP 'mail' command -- begins mail xfer session."""
Guido van Rossumfcfb6321998-08-04 15:29:54 +0000483 optionlist = ''
484 if options and self.does_esmtp:
Eric S. Raymondc013f302001-02-09 05:40:38 +0000485 optionlist = ' ' + ' '.join(options)
Giampaolo Rodolàbd258bd2011-02-22 15:56:20 +0000486 self.putcmd("mail", "FROM:%s%s" % (quoteaddr(sender), optionlist))
Guido van Rossum45e2fbc1998-03-26 21:13:24 +0000487 return self.getreply()
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000488
Giampaolo Rodolàbd258bd2011-02-22 15:56:20 +0000489 def rcpt(self, recip, options=[]):
Barry Warsawa7d9bdf1998-12-22 03:24:27 +0000490 """SMTP 'rcpt' command -- indicates 1 recipient for this mail."""
Guido van Rossumfcfb6321998-08-04 15:29:54 +0000491 optionlist = ''
492 if options and self.does_esmtp:
Eric S. Raymondc013f302001-02-09 05:40:38 +0000493 optionlist = ' ' + ' '.join(options)
Giampaolo Rodolàbd258bd2011-02-22 15:56:20 +0000494 self.putcmd("rcpt", "TO:%s%s" % (quoteaddr(recip), optionlist))
Guido van Rossum45e2fbc1998-03-26 21:13:24 +0000495 return self.getreply()
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000496
Giampaolo Rodolàbd258bd2011-02-22 15:56:20 +0000497 def data(self, msg):
Tim Peters495ad3c2001-01-15 01:36:40 +0000498 """SMTP 'DATA' command -- sends message data to server.
Guido van Rossum296e1431999-04-07 15:03:39 +0000499
Barry Warsaw4c4bec81998-12-22 03:02:20 +0000500 Automatically quotes lines beginning with a period per rfc821.
Guido van Rossum296e1431999-04-07 15:03:39 +0000501 Raises SMTPDataError if there is an unexpected reply to the
502 DATA command; the return value from this method is the final
R. David Murray7dff9e02010-11-08 17:15:13 +0000503 response code received when the all data is sent. If msg
504 is a string, lone '\r' and '\n' characters are converted to
505 '\r\n' characters. If msg is bytes, it is transmitted as is.
Barry Warsaw4c4bec81998-12-22 03:02:20 +0000506 """
Guido van Rossum45e2fbc1998-03-26 21:13:24 +0000507 self.putcmd("data")
Giampaolo Rodolàbd258bd2011-02-22 15:56:20 +0000508 (code, repl) = self.getreply()
509 if self.debuglevel > 0:
510 print("data:", (code, repl), file=stderr)
Fred Drake8152d322000-12-12 23:20:45 +0000511 if code != 354:
Giampaolo Rodolàbd258bd2011-02-22 15:56:20 +0000512 raise SMTPDataError(code, repl)
Guido van Rossum45e2fbc1998-03-26 21:13:24 +0000513 else:
R. David Murray7dff9e02010-11-08 17:15:13 +0000514 if isinstance(msg, str):
515 msg = _fix_eols(msg).encode('ascii')
516 q = _quote_periods(msg)
517 if q[-2:] != bCRLF:
518 q = q + bCRLF
519 q = q + b"." + bCRLF
Guido van Rossum20c92281999-04-21 16:52:20 +0000520 self.send(q)
Giampaolo Rodolàbd258bd2011-02-22 15:56:20 +0000521 (code, msg) = self.getreply()
522 if self.debuglevel > 0:
523 print("data:", (code, msg), file=stderr)
524 return (code, msg)
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000525
Guido van Rossumfcfb6321998-08-04 15:29:54 +0000526 def verify(self, address):
Barry Warsawa7d9bdf1998-12-22 03:24:27 +0000527 """SMTP 'verify' command -- checks for address validity."""
R David Murray46346762011-07-18 21:38:54 -0400528 self.putcmd("vrfy", _addr_only(address))
Guido van Rossumfcfb6321998-08-04 15:29:54 +0000529 return self.getreply()
Barry Warsaw4c4bec81998-12-22 03:02:20 +0000530 # a.k.a.
Giampaolo Rodolàbd258bd2011-02-22 15:56:20 +0000531 vrfy = verify
Guido van Rossumfcfb6321998-08-04 15:29:54 +0000532
533 def expn(self, address):
Christian Heimes90c3d9b2008-02-23 13:18:03 +0000534 """SMTP 'expn' command -- expands a mailing list."""
R David Murray46346762011-07-18 21:38:54 -0400535 self.putcmd("expn", _addr_only(address))
Guido van Rossumfcfb6321998-08-04 15:29:54 +0000536 return self.getreply()
537
Barry Warsaw4c4bec81998-12-22 03:02:20 +0000538 # some useful methods
Guido van Rossumae010462001-09-11 15:57:46 +0000539
Christian Heimes679db4a2008-01-18 09:56:22 +0000540 def ehlo_or_helo_if_needed(self):
541 """Call self.ehlo() and/or self.helo() if needed.
542
543 If there has been no previous EHLO or HELO command this session, this
544 method tries ESMTP EHLO first.
545
546 This method may raise the following exceptions:
547
548 SMTPHeloError The server didn't reply properly to
549 the helo greeting.
550 """
551 if self.helo_resp is None and self.ehlo_resp is None:
552 if not (200 <= self.ehlo()[0] <= 299):
553 (code, resp) = self.helo()
554 if not (200 <= code <= 299):
555 raise SMTPHeloError(code, resp)
556
Guido van Rossumae010462001-09-11 15:57:46 +0000557 def login(self, user, password):
558 """Log in on an SMTP server that requires authentication.
559
560 The arguments are:
561 - user: The user name to authenticate with.
562 - password: The password for the authentication.
563
564 If there has been no previous EHLO or HELO command this session, this
565 method tries ESMTP EHLO first.
566
567 This method will return normally if the authentication was successful.
568
569 This method may raise the following exceptions:
570
571 SMTPHeloError The server didn't reply properly to
572 the helo greeting.
573 SMTPAuthenticationError The server didn't accept the username/
574 password combination.
Fred Drake2f8f4d32001-10-13 18:35:32 +0000575 SMTPException No suitable authentication method was
Guido van Rossumae010462001-09-11 15:57:46 +0000576 found.
577 """
578
579 def encode_cram_md5(challenge, user, password):
Georg Brandl706824f2009-06-04 09:42:55 +0000580 challenge = base64.decodebytes(challenge)
R. David Murrayfb123912009-05-28 18:19:00 +0000581 response = user + " " + hmac.HMAC(password.encode('ascii'),
Christian Heimes634919a2013-11-20 17:23:06 +0100582 challenge, 'md5').hexdigest()
R. David Murrayfb123912009-05-28 18:19:00 +0000583 return encode_base64(response.encode('ascii'), eol='')
Guido van Rossumae010462001-09-11 15:57:46 +0000584
585 def encode_plain(user, password):
R. David Murraycaa27b72009-05-23 18:49:56 +0000586 s = "\0%s\0%s" % (user, password)
587 return encode_base64(s.encode('ascii'), eol='')
Tim Peters469cdad2002-08-08 20:19:19 +0000588
Guido van Rossumae010462001-09-11 15:57:46 +0000589 AUTH_PLAIN = "PLAIN"
590 AUTH_CRAM_MD5 = "CRAM-MD5"
Piers Lauder385a77a2002-07-27 00:38:30 +0000591 AUTH_LOGIN = "LOGIN"
Guido van Rossumae010462001-09-11 15:57:46 +0000592
Christian Heimes679db4a2008-01-18 09:56:22 +0000593 self.ehlo_or_helo_if_needed()
Guido van Rossumae010462001-09-11 15:57:46 +0000594
595 if not self.has_extn("auth"):
596 raise SMTPException("SMTP AUTH extension not supported by server.")
597
Gerhard Häring1c5471f2010-08-05 14:08:44 +0000598 # Authentication methods the server claims to support
599 advertised_authlist = self.esmtp_features["auth"].split()
Guido van Rossumae010462001-09-11 15:57:46 +0000600
601 # List of authentication methods we support: from preferred to
602 # less preferred methods. Except for the purpose of testing the weaker
603 # ones, we prefer stronger methods like CRAM-MD5:
Piers Lauder385a77a2002-07-27 00:38:30 +0000604 preferred_auths = [AUTH_CRAM_MD5, AUTH_PLAIN, AUTH_LOGIN]
Guido van Rossumae010462001-09-11 15:57:46 +0000605
Gerhard Häring1c5471f2010-08-05 14:08:44 +0000606 # We try the authentication methods the server advertises, but only the
607 # ones *we* support. And in our preferred order.
608 authlist = [auth for auth in preferred_auths if auth in advertised_authlist]
609 if not authlist:
Fred Drake2f8f4d32001-10-13 18:35:32 +0000610 raise SMTPException("No suitable authentication method found.")
Gerhard Häring1c5471f2010-08-05 14:08:44 +0000611
612 # Some servers advertise authentication methods they don't really
613 # support, so if authentication fails, we continue until we've tried
614 # all methods.
615 for authmethod in authlist:
616 if authmethod == AUTH_CRAM_MD5:
617 (code, resp) = self.docmd("AUTH", AUTH_CRAM_MD5)
618 if code == 334:
619 (code, resp) = self.docmd(encode_cram_md5(resp, user, password))
620 elif authmethod == AUTH_PLAIN:
621 (code, resp) = self.docmd("AUTH",
622 AUTH_PLAIN + " " + encode_plain(user, password))
623 elif authmethod == AUTH_LOGIN:
624 (code, resp) = self.docmd("AUTH",
625 "%s %s" % (AUTH_LOGIN, encode_base64(user.encode('ascii'), eol='')))
626 if code == 334:
627 (code, resp) = self.docmd(encode_base64(password.encode('ascii'), eol=''))
628
Guido van Rossumae010462001-09-11 15:57:46 +0000629 # 235 == 'Authentication successful'
630 # 503 == 'Error: already authenticated'
Gerhard Häring1c5471f2010-08-05 14:08:44 +0000631 if code in (235, 503):
632 return (code, resp)
633
634 # We could not login sucessfully. Return result of last attempt.
635 raise SMTPAuthenticationError(code, resp)
Guido van Rossumae010462001-09-11 15:57:46 +0000636
Antoine Pitroue0650202011-05-18 18:03:09 +0200637 def starttls(self, keyfile=None, certfile=None, context=None):
Guido van Rossumf7fcf5e2001-09-14 16:08:44 +0000638 """Puts the connection to the SMTP server into TLS mode.
Tim Petersb64bec32001-09-18 02:26:39 +0000639
Christian Heimes679db4a2008-01-18 09:56:22 +0000640 If there has been no previous EHLO or HELO command this session, this
641 method tries ESMTP EHLO first.
642
Guido van Rossumf7fcf5e2001-09-14 16:08:44 +0000643 If the server supports TLS, this will encrypt the rest of the SMTP
644 session. If you provide the keyfile and certfile parameters,
645 the identity of the SMTP server and client can be checked. This,
646 however, depends on whether the socket module really checks the
647 certificates.
Christian Heimes679db4a2008-01-18 09:56:22 +0000648
649 This method may raise the following exceptions:
650
651 SMTPHeloError The server didn't reply properly to
652 the helo greeting.
Guido van Rossumf7fcf5e2001-09-14 16:08:44 +0000653 """
Christian Heimes679db4a2008-01-18 09:56:22 +0000654 self.ehlo_or_helo_if_needed()
655 if not self.has_extn("starttls"):
656 raise SMTPException("STARTTLS extension not supported by server.")
Tim Petersb64bec32001-09-18 02:26:39 +0000657 (resp, reply) = self.docmd("STARTTLS")
Guido van Rossumf7fcf5e2001-09-14 16:08:44 +0000658 if resp == 220:
Thomas Wouters47b49bf2007-08-30 22:15:33 +0000659 if not _have_ssl:
660 raise RuntimeError("No SSL support included in this Python")
Antoine Pitroue0650202011-05-18 18:03:09 +0200661 if context is not None and keyfile is not None:
662 raise ValueError("context and keyfile arguments are mutually "
663 "exclusive")
664 if context is not None and certfile is not None:
665 raise ValueError("context and certfile arguments are mutually "
666 "exclusive")
667 if context is not None:
668 self.sock = context.wrap_socket(self.sock)
669 else:
670 self.sock = ssl.wrap_socket(self.sock, keyfile, certfile)
Antoine Pitrouf068ab82011-06-06 19:17:09 +0200671 self.file = None
Christian Heimes679db4a2008-01-18 09:56:22 +0000672 # RFC 3207:
673 # The client MUST discard any knowledge obtained from
674 # the server, such as the list of SMTP service extensions,
675 # which was not obtained from the TLS negotiation itself.
676 self.helo_resp = None
677 self.ehlo_resp = None
678 self.esmtp_features = {}
679 self.does_esmtp = 0
Guido van Rossumf7fcf5e2001-09-14 16:08:44 +0000680 return (resp, reply)
Tim Petersb64bec32001-09-18 02:26:39 +0000681
Jeremy Hylton31bb8ce1998-08-13 19:57:46 +0000682 def sendmail(self, from_addr, to_addrs, msg, mail_options=[],
Tim Peters495ad3c2001-01-15 01:36:40 +0000683 rcpt_options=[]):
684 """This command performs an entire mail transaction.
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000685
Tim Peters495ad3c2001-01-15 01:36:40 +0000686 The arguments are:
Barry Warsaw4c4bec81998-12-22 03:02:20 +0000687 - from_addr : The address sending this mail.
688 - to_addrs : A list of addresses to send this mail to. A bare
689 string will be treated as a list with 1 address.
Tim Peters495ad3c2001-01-15 01:36:40 +0000690 - msg : The message to send.
Barry Warsaw4c4bec81998-12-22 03:02:20 +0000691 - mail_options : List of ESMTP options (such as 8bitmime) for the
692 mail command.
693 - rcpt_options : List of ESMTP options (such as DSN commands) for
694 all the rcpt commands.
695
R. David Murray7dff9e02010-11-08 17:15:13 +0000696 msg may be a string containing characters in the ASCII range, or a byte
697 string. A string is encoded to bytes using the ascii codec, and lone
R David Murrayac4e5ab2011-07-02 21:03:19 -0400698 \\r and \\n characters are converted to \\r\\n characters.
R. David Murray7dff9e02010-11-08 17:15:13 +0000699
Barry Warsaw4c4bec81998-12-22 03:02:20 +0000700 If there has been no previous EHLO or HELO command this session, this
701 method tries ESMTP EHLO first. If the server does ESMTP, message size
702 and each of the specified options will be passed to it. If EHLO
703 fails, HELO will be tried and ESMTP options suppressed.
704
705 This method will return normally if the mail is accepted for at least
Barry Warsawd25c1b71999-11-28 17:11:06 +0000706 one recipient. It returns a dictionary, with one entry for each
707 recipient that was refused. Each entry contains a tuple of the SMTP
708 error code and the accompanying error message sent by the server.
Guido van Rossum296e1431999-04-07 15:03:39 +0000709
710 This method may raise the following exceptions:
711
712 SMTPHeloError The server didn't reply properly to
Tim Peters495ad3c2001-01-15 01:36:40 +0000713 the helo greeting.
Barry Warsawd25c1b71999-11-28 17:11:06 +0000714 SMTPRecipientsRefused The server rejected ALL recipients
Guido van Rossum296e1431999-04-07 15:03:39 +0000715 (no mail was sent).
716 SMTPSenderRefused The server didn't accept the from_addr.
717 SMTPDataError The server replied with an unexpected
718 error code (other than a refusal of
719 a recipient).
720
721 Note: the connection will be open even after an exception is raised.
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000722
Guido van Rossum95e6f701998-06-25 02:15:50 +0000723 Example:
Tim Peters495ad3c2001-01-15 01:36:40 +0000724
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000725 >>> import smtplib
726 >>> s=smtplib.SMTP("localhost")
Guido van Rossumfc40a831998-01-29 17:26:45 +0000727 >>> tolist=["one@one.org","two@two.org","three@three.org","four@four.org"]
Martin v. Löwis301b1cd2002-07-28 16:52:01 +0000728 >>> msg = '''\\
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000729 ... From: Me@my.org
730 ... Subject: testin'...
731 ...
732 ... This is a test '''
733 >>> s.sendmail("me@my.org",tolist,msg)
734 { "three@three.org" : ( 550 ,"User unknown" ) }
735 >>> s.quit()
Tim Peters495ad3c2001-01-15 01:36:40 +0000736
Barry Warsaw4c4bec81998-12-22 03:02:20 +0000737 In the above example, the message was accepted for delivery to three
738 of the four addresses, and one was rejected, with the error code
Barry Warsawd25c1b71999-11-28 17:11:06 +0000739 550. If all addresses are accepted, then the method will return an
Barry Warsaw4c4bec81998-12-22 03:02:20 +0000740 empty dictionary.
741
742 """
Christian Heimes679db4a2008-01-18 09:56:22 +0000743 self.ehlo_or_helo_if_needed()
Guido van Rossum95e6f701998-06-25 02:15:50 +0000744 esmtp_opts = []
R. David Murray7dff9e02010-11-08 17:15:13 +0000745 if isinstance(msg, str):
746 msg = _fix_eols(msg).encode('ascii')
Guido van Rossumfcfb6321998-08-04 15:29:54 +0000747 if self.does_esmtp:
748 # Hmmm? what's this? -ddm
749 # self.esmtp_features['7bit']=""
750 if self.has_extn('size'):
Walter Dörwald70a6b492004-02-12 17:35:32 +0000751 esmtp_opts.append("size=%d" % len(msg))
Guido van Rossumfcfb6321998-08-04 15:29:54 +0000752 for option in mail_options:
Guido van Rossum95e6f701998-06-25 02:15:50 +0000753 esmtp_opts.append(option)
Giampaolo Rodolàbd258bd2011-02-22 15:56:20 +0000754 (code, resp) = self.mail(from_addr, esmtp_opts)
Fred Drake8152d322000-12-12 23:20:45 +0000755 if code != 250:
R David Murrayd312c742013-03-20 20:36:14 -0400756 if code == 421:
757 self.close()
758 else:
759 self.rset()
Guido van Rossum296e1431999-04-07 15:03:39 +0000760 raise SMTPSenderRefused(code, resp, from_addr)
Giampaolo Rodolàbd258bd2011-02-22 15:56:20 +0000761 senderrs = {}
Guido van Rossum3172c5d2007-10-16 18:12:55 +0000762 if isinstance(to_addrs, str):
Jeremy Hylton31bb8ce1998-08-13 19:57:46 +0000763 to_addrs = [to_addrs]
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000764 for each in to_addrs:
Giampaolo Rodolàbd258bd2011-02-22 15:56:20 +0000765 (code, resp) = self.rcpt(each, rcpt_options)
Fred Drake8152d322000-12-12 23:20:45 +0000766 if (code != 250) and (code != 251):
Giampaolo Rodolàbd258bd2011-02-22 15:56:20 +0000767 senderrs[each] = (code, resp)
R David Murrayd312c742013-03-20 20:36:14 -0400768 if code == 421:
769 self.close()
770 raise SMTPRecipientsRefused(senderrs)
Giampaolo Rodolàbd258bd2011-02-22 15:56:20 +0000771 if len(senderrs) == len(to_addrs):
Guido van Rossum95e6f701998-06-25 02:15:50 +0000772 # the server refused all our recipients
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000773 self.rset()
Guido van Rossum296e1431999-04-07 15:03:39 +0000774 raise SMTPRecipientsRefused(senderrs)
Giampaolo Rodolàbd258bd2011-02-22 15:56:20 +0000775 (code, resp) = self.data(msg)
Fred Drake8152d322000-12-12 23:20:45 +0000776 if code != 250:
R David Murrayd312c742013-03-20 20:36:14 -0400777 if code == 421:
778 self.close()
779 else:
780 self.rset()
Guido van Rossum296e1431999-04-07 15:03:39 +0000781 raise SMTPDataError(code, resp)
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000782 #if we got here then somebody got our mail
Tim Peters495ad3c2001-01-15 01:36:40 +0000783 return senderrs
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000784
R. David Murray7dff9e02010-11-08 17:15:13 +0000785 def send_message(self, msg, from_addr=None, to_addrs=None,
786 mail_options=[], rcpt_options={}):
787 """Converts message to a bytestring and passes it to sendmail.
788
789 The arguments are as for sendmail, except that msg is an
R David Murrayac4e5ab2011-07-02 21:03:19 -0400790 email.message.Message object. If from_addr is None or to_addrs is
791 None, these arguments are taken from the headers of the Message as
792 described in RFC 2822 (a ValueError is raised if there is more than
793 one set of 'Resent-' headers). Regardless of the values of from_addr and
794 to_addr, any Bcc field (or Resent-Bcc field, when the Message is a
795 resent) of the Message object won't be transmitted. The Message
796 object is then serialized using email.generator.BytesGenerator and
797 sendmail is called to transmit the message.
798
R. David Murray7dff9e02010-11-08 17:15:13 +0000799 """
R David Murrayac4e5ab2011-07-02 21:03:19 -0400800 # 'Resent-Date' is a mandatory field if the Message is resent (RFC 2822
801 # Section 3.6.6). In such a case, we use the 'Resent-*' fields. However,
802 # if there is more than one 'Resent-' block there's no way to
803 # unambiguously determine which one is the most recent in all cases,
804 # so rather than guess we raise a ValueError in that case.
805 #
806 # TODO implement heuristics to guess the correct Resent-* block with an
807 # option allowing the user to enable the heuristics. (It should be
808 # possible to guess correctly almost all of the time.)
Senthil Kumaranb351a482011-07-31 09:14:17 +0800809
810 resent = msg.get_all('Resent-Date')
R David Murrayac4e5ab2011-07-02 21:03:19 -0400811 if resent is None:
812 header_prefix = ''
813 elif len(resent) == 1:
814 header_prefix = 'Resent-'
815 else:
816 raise ValueError("message has more than one 'Resent-' header block")
R. David Murray7dff9e02010-11-08 17:15:13 +0000817 if from_addr is None:
R David Murrayac4e5ab2011-07-02 21:03:19 -0400818 # Prefer the sender field per RFC 2822:3.6.2.
Senthil Kumaranb351a482011-07-31 09:14:17 +0800819 from_addr = (msg[header_prefix + 'Sender']
820 if (header_prefix + 'Sender') in msg
821 else msg[header_prefix + 'From'])
R. David Murray7dff9e02010-11-08 17:15:13 +0000822 if to_addrs is None:
Senthil Kumaranb351a482011-07-31 09:14:17 +0800823 addr_fields = [f for f in (msg[header_prefix + 'To'],
824 msg[header_prefix + 'Bcc'],
825 msg[header_prefix + 'Cc']) if f is not None]
R. David Murray7dff9e02010-11-08 17:15:13 +0000826 to_addrs = [a[1] for a in email.utils.getaddresses(addr_fields)]
R David Murrayac4e5ab2011-07-02 21:03:19 -0400827 # Make a local copy so we can delete the bcc headers.
828 msg_copy = copy.copy(msg)
829 del msg_copy['Bcc']
830 del msg_copy['Resent-Bcc']
R. David Murray7dff9e02010-11-08 17:15:13 +0000831 with io.BytesIO() as bytesmsg:
832 g = email.generator.BytesGenerator(bytesmsg)
R David Murrayac4e5ab2011-07-02 21:03:19 -0400833 g.flatten(msg_copy, linesep='\r\n')
R. David Murray7dff9e02010-11-08 17:15:13 +0000834 flatmsg = bytesmsg.getvalue()
835 return self.sendmail(from_addr, to_addrs, flatmsg, mail_options,
836 rcpt_options)
837
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000838 def close(self):
839 """Close the connection to the SMTP server."""
840 if self.file:
841 self.file.close()
842 self.file = None
843 if self.sock:
844 self.sock.close()
845 self.sock = None
846
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000847 def quit(self):
Guido van Rossum95e6f701998-06-25 02:15:50 +0000848 """Terminate the SMTP session."""
Christian Heimesba4af492008-03-28 00:55:15 +0000849 res = self.docmd("quit")
Guido van Rossum45e2fbc1998-03-26 21:13:24 +0000850 self.close()
Christian Heimesba4af492008-03-28 00:55:15 +0000851 return res
Guido van Rossum95e6f701998-06-25 02:15:50 +0000852
Thomas Wouters47b49bf2007-08-30 22:15:33 +0000853if _have_ssl:
Thomas Wouters89f507f2006-12-13 04:49:30 +0000854
Thomas Wouters47b49bf2007-08-30 22:15:33 +0000855 class SMTP_SSL(SMTP):
R David Murray021362d2013-06-23 16:05:44 -0400856 """ This is a subclass derived from SMTP that connects over an SSL
857 encrypted socket (to use this class you need a socket module that was
858 compiled with SSL support). If host is not specified, '' (the local
859 host) is used. If port is omitted, the standard SMTP-over-SSL port
860 (465) is used. local_hostname and source_address have the same meaning
861 as they do in the SMTP class. keyfile and certfile are also optional -
862 they can contain a PEM formatted private key and certificate chain file
863 for the SSL connection. context also optional, can contain a
864 SSLContext, and is an alternative to keyfile and certfile; If it is
865 specified both keyfile and certfile must be None.
866
Thomas Wouters47b49bf2007-08-30 22:15:33 +0000867 """
Antoine Pitrouc1d52062011-05-07 19:39:37 +0200868
869 default_port = SMTP_SSL_PORT
870
Thomas Wouters47b49bf2007-08-30 22:15:33 +0000871 def __init__(self, host='', port=0, local_hostname=None,
Georg Brandlf78e02b2008-06-10 17:40:04 +0000872 keyfile=None, certfile=None,
Senthil Kumaran3d23fd62011-07-30 10:56:50 +0800873 timeout=socket._GLOBAL_DEFAULT_TIMEOUT,
874 source_address=None, context=None):
Antoine Pitroue0650202011-05-18 18:03:09 +0200875 if context is not None and keyfile is not None:
876 raise ValueError("context and keyfile arguments are mutually "
877 "exclusive")
878 if context is not None and certfile is not None:
879 raise ValueError("context and certfile arguments are mutually "
880 "exclusive")
Thomas Wouters47b49bf2007-08-30 22:15:33 +0000881 self.keyfile = keyfile
882 self.certfile = certfile
Antoine Pitroue0650202011-05-18 18:03:09 +0200883 self.context = context
Senthil Kumaran3d23fd62011-07-30 10:56:50 +0800884 SMTP.__init__(self, host, port, local_hostname, timeout,
885 source_address)
Thomas Wouters47b49bf2007-08-30 22:15:33 +0000886
887 def _get_socket(self, host, port, timeout):
Giampaolo Rodolàbd258bd2011-02-22 15:56:20 +0000888 if self.debuglevel > 0:
889 print('connect:', (host, port), file=stderr)
Senthil Kumaran3d23fd62011-07-30 10:56:50 +0800890 new_socket = socket.create_connection((host, port), timeout,
891 self.source_address)
Antoine Pitroue0650202011-05-18 18:03:09 +0200892 if self.context is not None:
893 new_socket = self.context.wrap_socket(new_socket)
894 else:
895 new_socket = ssl.wrap_socket(new_socket, self.keyfile, self.certfile)
R. David Murray87e20742009-05-23 01:30:26 +0000896 return new_socket
Thomas Wouters47b49bf2007-08-30 22:15:33 +0000897
898 __all__.append("SMTP_SSL")
Barry Warsaw4c4bec81998-12-22 03:02:20 +0000899
Guido van Rossumd8faa362007-04-27 19:54:29 +0000900#
901# LMTP extension
902#
903LMTP_PORT = 2003
904
905class LMTP(SMTP):
906 """LMTP - Local Mail Transfer Protocol
907
908 The LMTP protocol, which is very similar to ESMTP, is heavily based
R David Murray021362d2013-06-23 16:05:44 -0400909 on the standard SMTP client. It's common to use Unix sockets for
910 LMTP, so our connect() method must support that as well as a regular
R David Murray36beb662013-06-23 15:47:50 -0400911 host:port server. local_hostname and source_address have the same
R David Murray021362d2013-06-23 16:05:44 -0400912 meaning as they do in the SMTP class. To specify a Unix socket,
913 you must use an absolute path as the host, starting with a '/'.
Guido van Rossumd8faa362007-04-27 19:54:29 +0000914
915 Authentication is supported, using the regular SMTP mechanism. When
916 using a Unix socket, LMTP generally don't support or require any
917 authentication, but your mileage might vary."""
918
919 ehlo_msg = "lhlo"
920
Senthil Kumaran3d23fd62011-07-30 10:56:50 +0800921 def __init__(self, host='', port=LMTP_PORT, local_hostname=None,
922 source_address=None):
Guido van Rossumd8faa362007-04-27 19:54:29 +0000923 """Initialize a new instance."""
Senthil Kumaranb351a482011-07-31 09:14:17 +0800924 SMTP.__init__(self, host, port, local_hostname=local_hostname,
925 source_address=source_address)
Guido van Rossumd8faa362007-04-27 19:54:29 +0000926
Senthil Kumaran3d23fd62011-07-30 10:56:50 +0800927 def connect(self, host='localhost', port=0, source_address=None):
Guido van Rossumd8faa362007-04-27 19:54:29 +0000928 """Connect to the LMTP daemon, on either a Unix or a TCP socket."""
929 if host[0] != '/':
Senthil Kumaranb351a482011-07-31 09:14:17 +0800930 return SMTP.connect(self, host, port, source_address=source_address)
Guido van Rossumd8faa362007-04-27 19:54:29 +0000931
932 # Handle Unix-domain sockets.
933 try:
934 self.sock = socket.socket(socket.AF_UNIX, socket.SOCK_STREAM)
Antoine Pitrouf068ab82011-06-06 19:17:09 +0200935 self.file = None
Guido van Rossumd8faa362007-04-27 19:54:29 +0000936 self.sock.connect(host)
Andrew Svetlov2ade6f22012-12-17 18:57:16 +0200937 except OSError:
Giampaolo Rodolàbd258bd2011-02-22 15:56:20 +0000938 if self.debuglevel > 0:
939 print('connect fail:', host, file=stderr)
Guido van Rossumd8faa362007-04-27 19:54:29 +0000940 if self.sock:
941 self.sock.close()
942 self.sock = None
Andrew Svetlovb6693c42012-12-17 18:54:53 +0200943 raise
Guido van Rossumd8faa362007-04-27 19:54:29 +0000944 (code, msg) = self.getreply()
Giampaolo Rodolàbd258bd2011-02-22 15:56:20 +0000945 if self.debuglevel > 0:
946 print('connect:', msg, file=stderr)
Guido van Rossumd8faa362007-04-27 19:54:29 +0000947 return (code, msg)
948
949
Guido van Rossum95e6f701998-06-25 02:15:50 +0000950# Test the sendmail method, which tests most of the others.
951# Note: This always sends to localhost.
952if __name__ == '__main__':
Andrew M. Kuchling6be424f2001-08-13 14:41:39 +0000953 import sys
Guido van Rossum95e6f701998-06-25 02:15:50 +0000954
955 def prompt(prompt):
956 sys.stdout.write(prompt + ": ")
Ezio Melotti6bfecd12011-10-18 13:20:07 +0300957 sys.stdout.flush()
Eric S. Raymondc013f302001-02-09 05:40:38 +0000958 return sys.stdin.readline().strip()
Guido van Rossum95e6f701998-06-25 02:15:50 +0000959
960 fromaddr = prompt("From")
Giampaolo Rodolàbd258bd2011-02-22 15:56:20 +0000961 toaddrs = prompt("To").split(',')
Guido van Rossumbe19ed72007-02-09 05:37:30 +0000962 print("Enter message, end with ^D:")
Guido van Rossum95e6f701998-06-25 02:15:50 +0000963 msg = ''
964 while 1:
965 line = sys.stdin.readline()
966 if not line:
967 break
968 msg = msg + line
Guido van Rossumbe19ed72007-02-09 05:37:30 +0000969 print("Message length is %d" % len(msg))
Guido van Rossum95e6f701998-06-25 02:15:50 +0000970
971 server = SMTP('localhost')
972 server.set_debuglevel(1)
973 server.sendmail(fromaddr, toaddrs, msg)
974 server.quit()