blob: c949d77b513f622bea90678f26792726317aab88 [file] [log] [blame]
Benjamin Peterson90f5ba52010-03-11 22:53:45 +00001#! /usr/bin/env python3
Barry Warsaw4c4bec81998-12-22 03:02:20 +00002
Barry Warsawa1ae8842000-07-09 21:24:31 +00003'''SMTP/ESMTP client class.
Guido van Rossumbbe323e1998-01-29 17:24:40 +00004
Guido van Rossumf7fcf5e2001-09-14 16:08:44 +00005This should follow RFC 821 (SMTP), RFC 1869 (ESMTP), RFC 2554 (SMTP
6Authentication) and RFC 2487 (Secure SMTP over TLS).
Guido van Rossumbbe323e1998-01-29 17:24:40 +00007
Guido van Rossumfcfb6321998-08-04 15:29:54 +00008Notes:
9
10Please remember, when doing ESMTP, that the names of the SMTP service
Barry Warsaw4c4bec81998-12-22 03:02:20 +000011extensions are NOT the same thing as the option keywords for the RCPT
Guido van Rossumfcfb6321998-08-04 15:29:54 +000012and MAIL commands!
13
Guido van Rossumbbe323e1998-01-29 17:24:40 +000014Example:
15
Barry Warsawa7d9bdf1998-12-22 03:24:27 +000016 >>> import smtplib
17 >>> s=smtplib.SMTP("localhost")
Guido van Rossum7131f842007-02-09 20:13:25 +000018 >>> print(s.help())
Barry Warsawa7d9bdf1998-12-22 03:24:27 +000019 This is Sendmail version 8.8.4
20 Topics:
21 HELO EHLO MAIL RCPT DATA
22 RSET NOOP QUIT HELP VRFY
23 EXPN VERB ETRN DSN
24 For more info use "HELP <topic>".
25 To report bugs in the implementation send email to
26 sendmail-bugs@sendmail.org.
27 For local information send email to Postmaster at your site.
28 End of HELP info
29 >>> s.putcmd("vrfy","someone@here")
30 >>> s.getreply()
31 (250, "Somebody OverHere <somebody@here.my.org>")
32 >>> s.quit()
Barry Warsawa1ae8842000-07-09 21:24:31 +000033'''
Guido van Rossumbbe323e1998-01-29 17:24:40 +000034
Guido van Rossum98d9fd32000-02-28 15:12:25 +000035# Author: The Dragon De Monsyne <dragondm@integral.org>
36# ESMTP support, test code and doc fixes added by
37# Eric S. Raymond <esr@thyrsus.com>
38# Better RFC 821 compliance (MAIL and RCPT, and CRLF in data)
39# by Carey Evans <c.evans@clear.net.nz>, for picky mail servers.
Guido van Rossumae010462001-09-11 15:57:46 +000040# RFC 2554 (authentication) support by Gerhard Haering <gerhard@bigfoot.de>.
Tim Peters495ad3c2001-01-15 01:36:40 +000041#
Guido van Rossum98d9fd32000-02-28 15:12:25 +000042# This was modified from the Python 1.5 library HTTP lib.
43
Guido van Rossumbbe323e1998-01-29 17:24:40 +000044import socket
R. David Murray7dff9e02010-11-08 17:15:13 +000045import io
Barry Warsaw07201771998-12-22 20:37:36 +000046import re
Thomas Woutersb2137042007-02-01 18:02:27 +000047import email.utils
R. David Murray7dff9e02010-11-08 17:15:13 +000048import email.message
49import email.generator
Guido van Rossumae010462001-09-11 15:57:46 +000050import base64
51import hmac
R David Murrayac4e5ab2011-07-02 21:03:19 -040052import copy
Barry Warsaw2cc1f6d2007-08-30 14:28:55 +000053from email.base64mime import body_encode as encode_base64
Brett Cannone6f8a892004-07-10 23:14:30 +000054from sys import stderr
Guido van Rossumbbe323e1998-01-29 17:24:40 +000055
Giampaolo Rodolàbd258bd2011-02-22 15:56:20 +000056__all__ = ["SMTPException", "SMTPServerDisconnected", "SMTPResponseException",
57 "SMTPSenderRefused", "SMTPRecipientsRefused", "SMTPDataError",
58 "SMTPConnectError", "SMTPHeloError", "SMTPAuthenticationError",
59 "quoteaddr", "quotedata", "SMTP"]
Skip Montanaro0de65802001-02-15 22:15:14 +000060
Guido van Rossumbbe323e1998-01-29 17:24:40 +000061SMTP_PORT = 25
Thomas Wouters89f507f2006-12-13 04:49:30 +000062SMTP_SSL_PORT = 465
Giampaolo Rodolàbd258bd2011-02-22 15:56:20 +000063CRLF = "\r\n"
64bCRLF = b"\r\n"
Guido van Rossumbbe323e1998-01-29 17:24:40 +000065
Piers Lauder385a77a2002-07-27 00:38:30 +000066OLDSTYLE_AUTH = re.compile(r"auth=(.*)", re.I)
67
Tim Peters495ad3c2001-01-15 01:36:40 +000068# Exception classes used by this module.
Guido van Rossum296e1431999-04-07 15:03:39 +000069class SMTPException(Exception):
70 """Base class for all exceptions raised by this module."""
71
72class SMTPServerDisconnected(SMTPException):
73 """Not connected to any SMTP server.
74
75 This exception is raised when the server unexpectedly disconnects,
76 or when an attempt is made to use the SMTP instance before
77 connecting it to a server.
78 """
79
80class SMTPResponseException(SMTPException):
81 """Base class for all exceptions that include an SMTP error code.
82
83 These exceptions are generated in some instances when the SMTP
84 server returns an error code. The error code is stored in the
85 `smtp_code' attribute of the error, and the `smtp_error' attribute
86 is set to the error message.
87 """
88
89 def __init__(self, code, msg):
90 self.smtp_code = code
91 self.smtp_error = msg
92 self.args = (code, msg)
93
94class SMTPSenderRefused(SMTPResponseException):
95 """Sender address refused.
Guido van Rossumae010462001-09-11 15:57:46 +000096
Guido van Rossum296e1431999-04-07 15:03:39 +000097 In addition to the attributes set by on all SMTPResponseException
Barry Warsawd25c1b71999-11-28 17:11:06 +000098 exceptions, this sets `sender' to the string that the SMTP refused.
Guido van Rossum296e1431999-04-07 15:03:39 +000099 """
100
101 def __init__(self, code, msg, sender):
102 self.smtp_code = code
103 self.smtp_error = msg
104 self.sender = sender
105 self.args = (code, msg, sender)
106
Guido van Rossum20c92281999-04-21 16:52:20 +0000107class SMTPRecipientsRefused(SMTPException):
Barry Warsawd25c1b71999-11-28 17:11:06 +0000108 """All recipient addresses refused.
Guido van Rossumae010462001-09-11 15:57:46 +0000109
Thomas Wouters7e474022000-07-16 12:04:32 +0000110 The errors for each recipient are accessible through the attribute
Tim Peters495ad3c2001-01-15 01:36:40 +0000111 'recipients', which is a dictionary of exactly the same sort as
112 SMTP.sendmail() returns.
Guido van Rossum296e1431999-04-07 15:03:39 +0000113 """
114
115 def __init__(self, recipients):
116 self.recipients = recipients
Giampaolo Rodolàbd258bd2011-02-22 15:56:20 +0000117 self.args = (recipients,)
Guido van Rossum296e1431999-04-07 15:03:39 +0000118
119
Guido van Rossum296e1431999-04-07 15:03:39 +0000120class SMTPDataError(SMTPResponseException):
121 """The SMTP server didn't accept the data."""
122
123class SMTPConnectError(SMTPResponseException):
Barry Warsawd25c1b71999-11-28 17:11:06 +0000124 """Error during connection establishment."""
Guido van Rossum296e1431999-04-07 15:03:39 +0000125
126class SMTPHeloError(SMTPResponseException):
Barry Warsawd25c1b71999-11-28 17:11:06 +0000127 """The server refused our HELO reply."""
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000128
Guido van Rossumae010462001-09-11 15:57:46 +0000129class SMTPAuthenticationError(SMTPResponseException):
130 """Authentication error.
131
132 Most probably the server didn't accept the username/password
133 combination provided.
134 """
Peter Schneider-Kamp7bc82bb2000-08-10 14:02:23 +0000135
R David Murray4c14bba2011-07-18 21:59:53 -0400136def quoteaddr(addrstring):
Guido van Rossum69a79bc1998-07-13 15:18:49 +0000137 """Quote a subset of the email addresses defined by RFC 821.
138
Georg Brandl9f0f9602008-06-12 22:23:59 +0000139 Should be able to handle anything email.utils.parseaddr can handle.
Barry Warsawa7d9bdf1998-12-22 03:24:27 +0000140 """
R David Murray4c14bba2011-07-18 21:59:53 -0400141 displayname, addr = email.utils.parseaddr(addrstring)
142 if (displayname, addr) == ('', ''):
143 # parseaddr couldn't parse it, use it as is and hope for the best.
144 if addrstring.strip().startswith('<'):
145 return addrstring
146 return "<%s>" % addrstring
147 return "<%s>" % addr
Guido van Rossum69a79bc1998-07-13 15:18:49 +0000148
R David Murray46346762011-07-18 21:38:54 -0400149def _addr_only(addrstring):
150 displayname, addr = email.utils.parseaddr(addrstring)
151 if (displayname, addr) == ('', ''):
152 # parseaddr couldn't parse it, so use it as is.
153 return addrstring
154 return addr
155
R. David Murray7dff9e02010-11-08 17:15:13 +0000156# Legacy method kept for backward compatibility.
Guido van Rossum69a79bc1998-07-13 15:18:49 +0000157def quotedata(data):
158 """Quote data for email.
159
Barry Warsawd25c1b71999-11-28 17:11:06 +0000160 Double leading '.', and change Unix newline '\\n', or Mac '\\r' into
Barry Warsawa7d9bdf1998-12-22 03:24:27 +0000161 Internet CRLF end-of-line.
162 """
Guido van Rossum69a79bc1998-07-13 15:18:49 +0000163 return re.sub(r'(?m)^\.', '..',
Guido van Rossumfcfb6321998-08-04 15:29:54 +0000164 re.sub(r'(?:\r\n|\n|\r(?!\n))', CRLF, data))
Guido van Rossum69a79bc1998-07-13 15:18:49 +0000165
R. David Murray7dff9e02010-11-08 17:15:13 +0000166def _quote_periods(bindata):
R David Murray0f663d02011-06-09 15:05:57 -0400167 return re.sub(br'(?m)^\.', b'..', bindata)
R. David Murray7dff9e02010-11-08 17:15:13 +0000168
169def _fix_eols(data):
170 return re.sub(r'(?:\r\n|\n|\r(?!\n))', CRLF, data)
171
Thomas Wouters47b49bf2007-08-30 22:15:33 +0000172try:
173 import ssl
174except ImportError:
175 _have_ssl = False
176else:
Thomas Wouters47b49bf2007-08-30 22:15:33 +0000177 _have_ssl = True
178
Peter Schneider-Kamp7bc82bb2000-08-10 14:02:23 +0000179
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000180class SMTP:
Guido van Rossumfcfb6321998-08-04 15:29:54 +0000181 """This class manages a connection to an SMTP or ESMTP server.
182 SMTP Objects:
Tim Peters495ad3c2001-01-15 01:36:40 +0000183 SMTP objects have the following attributes:
184 helo_resp
185 This is the message given by the server in response to the
Guido van Rossumfcfb6321998-08-04 15:29:54 +0000186 most recent HELO command.
Tim Peters495ad3c2001-01-15 01:36:40 +0000187
Guido van Rossumfcfb6321998-08-04 15:29:54 +0000188 ehlo_resp
Tim Peters495ad3c2001-01-15 01:36:40 +0000189 This is the message given by the server in response to the
Guido van Rossumfcfb6321998-08-04 15:29:54 +0000190 most recent EHLO command. This is usually multiline.
191
Tim Peters495ad3c2001-01-15 01:36:40 +0000192 does_esmtp
Guido van Rossumfcfb6321998-08-04 15:29:54 +0000193 This is a True value _after you do an EHLO command_, if the
194 server supports ESMTP.
195
Tim Peters495ad3c2001-01-15 01:36:40 +0000196 esmtp_features
Guido van Rossumfcfb6321998-08-04 15:29:54 +0000197 This is a dictionary, which, if the server supports ESMTP,
Barry Warsawd25c1b71999-11-28 17:11:06 +0000198 will _after you do an EHLO command_, contain the names of the
199 SMTP service extensions this server supports, and their
Guido van Rossumfcfb6321998-08-04 15:29:54 +0000200 parameters (if any).
Barry Warsawd25c1b71999-11-28 17:11:06 +0000201
Tim Peters495ad3c2001-01-15 01:36:40 +0000202 Note, all extension names are mapped to lower case in the
203 dictionary.
Guido van Rossumfcfb6321998-08-04 15:29:54 +0000204
Barry Warsawd25c1b71999-11-28 17:11:06 +0000205 See each method's docstrings for details. In general, there is a
206 method of the same name to perform each SMTP command. There is also a
207 method called 'sendmail' that will do an entire mail transaction.
208 """
Guido van Rossum95e6f701998-06-25 02:15:50 +0000209 debuglevel = 0
210 file = None
211 helo_resp = None
Guido van Rossumd8faa362007-04-27 19:54:29 +0000212 ehlo_msg = "ehlo"
Guido van Rossum95e6f701998-06-25 02:15:50 +0000213 ehlo_resp = None
Guido van Rossumfcfb6321998-08-04 15:29:54 +0000214 does_esmtp = 0
Antoine Pitrouc1d52062011-05-07 19:39:37 +0200215 default_port = SMTP_PORT
Guido van Rossum95e6f701998-06-25 02:15:50 +0000216
Georg Brandlf78e02b2008-06-10 17:40:04 +0000217 def __init__(self, host='', port=0, local_hostname=None,
Senthil Kumaran3d23fd62011-07-30 10:56:50 +0800218 timeout=socket._GLOBAL_DEFAULT_TIMEOUT,
219 source_address=None):
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000220 """Initialize a new instance.
221
Barry Warsawa7d9bdf1998-12-22 03:24:27 +0000222 If specified, `host' is the name of the remote host to which to
223 connect. If specified, `port' specifies the port to which to connect.
Barry Warsawd25c1b71999-11-28 17:11:06 +0000224 By default, smtplib.SMTP_PORT is used. An SMTPConnectError is raised
Neil Schemenauer6730f262002-03-24 15:30:40 +0000225 if the specified `host' doesn't respond correctly. If specified,
Tim Peters863ac442002-04-16 01:38:40 +0000226 `local_hostname` is used as the FQDN of the local host. By default,
Senthil Kumaran3d23fd62011-07-30 10:56:50 +0800227 the local hostname is found using socket.getfqdn(). The
228 `source_address` parameter takes a 2-tuple (host, port) for the socket
229 to bind to as its source address before connecting. If the host is ''
230 and port is 0, the OS default behavior will be used.
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000231
232 """
Guido van Rossumd8faa362007-04-27 19:54:29 +0000233 self.timeout = timeout
Guido van Rossumfcfb6321998-08-04 15:29:54 +0000234 self.esmtp_features = {}
Senthil Kumaran3d23fd62011-07-30 10:56:50 +0800235 self.source_address = source_address
236
Guido van Rossum296e1431999-04-07 15:03:39 +0000237 if host:
238 (code, msg) = self.connect(host, port)
239 if code != 220:
240 raise SMTPConnectError(code, msg)
Raymond Hettingerf13eb552002-06-02 00:40:05 +0000241 if local_hostname is not None:
Barry Warsaw13e34f72002-03-26 20:27:35 +0000242 self.local_hostname = local_hostname
Neil Schemenauer6730f262002-03-24 15:30:40 +0000243 else:
Barry Warsaw13e34f72002-03-26 20:27:35 +0000244 # RFC 2821 says we should use the fqdn in the EHLO/HELO verb, and
245 # if that can't be calculated, that we should use a domain literal
246 # instead (essentially an encoded IP address like [A.B.C.D]).
247 fqdn = socket.getfqdn()
248 if '.' in fqdn:
249 self.local_hostname = fqdn
250 else:
251 # We can't find an fqdn hostname, so use a domain literal
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000252 addr = '127.0.0.1'
253 try:
254 addr = socket.gethostbyname(socket.gethostname())
255 except socket.gaierror:
256 pass
Barry Warsaw13e34f72002-03-26 20:27:35 +0000257 self.local_hostname = '[%s]' % addr
Tim Peters495ad3c2001-01-15 01:36:40 +0000258
Barry Warsaw1f5c9582011-03-15 15:04:44 -0400259 def __enter__(self):
260 return self
261
262 def __exit__(self, *args):
263 try:
264 code, message = self.docmd("QUIT")
265 if code != 221:
266 raise SMTPResponseException(code, message)
267 except SMTPServerDisconnected:
268 pass
269 finally:
270 self.close()
271
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000272 def set_debuglevel(self, debuglevel):
273 """Set the debug output level.
274
Barry Warsawa7d9bdf1998-12-22 03:24:27 +0000275 A non-false value results in debug messages for connection and for all
276 messages sent to and received from the server.
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000277
278 """
279 self.debuglevel = debuglevel
280
Barry Warsawc9181712008-03-19 14:25:51 +0000281 def _get_socket(self, host, port, timeout):
Thomas Wouters89f507f2006-12-13 04:49:30 +0000282 # This makes it simpler for SMTP_SSL to use the SMTP connect code
283 # and just alter the socket connection bit.
Giampaolo Rodolàbd258bd2011-02-22 15:56:20 +0000284 if self.debuglevel > 0:
Senthil Kumaranb351a482011-07-31 09:14:17 +0800285 print('connect: to', (host, port), self.source_address,
286 file=stderr)
Senthil Kumaran3d23fd62011-07-30 10:56:50 +0800287 return socket.create_connection((host, port), timeout,
288 self.source_address)
Thomas Wouters89f507f2006-12-13 04:49:30 +0000289
Senthil Kumaran3d23fd62011-07-30 10:56:50 +0800290 def connect(self, host='localhost', port=0, source_address=None):
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000291 """Connect to a host on a given port.
Guido van Rossum95e6f701998-06-25 02:15:50 +0000292
Barry Warsaw4c4bec81998-12-22 03:02:20 +0000293 If the hostname ends with a colon (`:') followed by a number, and
294 there is no port specified, that suffix will be stripped off and the
295 number interpreted as the port number to use.
Guido van Rossum95e6f701998-06-25 02:15:50 +0000296
Barry Warsawa7d9bdf1998-12-22 03:24:27 +0000297 Note: This method is automatically invoked by __init__, if a host is
298 specified during instantiation.
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000299
300 """
Senthil Kumaranb351a482011-07-31 09:14:17 +0800301
302 if source_address:
303 self.source_address = source_address
304
Martin v. Löwis4eb59402001-07-26 13:37:33 +0000305 if not port and (host.find(':') == host.rfind(':')):
Martin v. Löwisa43c2f82001-07-24 20:34:08 +0000306 i = host.rfind(':')
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000307 if i >= 0:
Giampaolo Rodolàbd258bd2011-02-22 15:56:20 +0000308 host, port = host[:i], host[i + 1:]
309 try:
310 port = int(port)
Eric S. Raymond8d876032001-02-09 10:14:53 +0000311 except ValueError:
Guido van Rossumd8faa362007-04-27 19:54:29 +0000312 raise socket.error("nonnumeric port")
Giampaolo Rodolàbd258bd2011-02-22 15:56:20 +0000313 if not port:
314 port = self.default_port
315 if self.debuglevel > 0:
316 print('connect:', (host, port), file=stderr)
Guido van Rossumd8faa362007-04-27 19:54:29 +0000317 self.sock = self._get_socket(host, port, self.timeout)
Antoine Pitrouf068ab82011-06-06 19:17:09 +0200318 self.file = None
Martin v. Löwisa43c2f82001-07-24 20:34:08 +0000319 (code, msg) = self.getreply()
Giampaolo Rodolàbd258bd2011-02-22 15:56:20 +0000320 if self.debuglevel > 0:
321 print("connect:", msg, file=stderr)
Martin v. Löwisa43c2f82001-07-24 20:34:08 +0000322 return (code, msg)
Tim Peters495ad3c2001-01-15 01:36:40 +0000323
Guido van Rossum8a392d72007-11-21 22:09:45 +0000324 def send(self, s):
325 """Send `s' to the server."""
Giampaolo Rodolàbd258bd2011-02-22 15:56:20 +0000326 if self.debuglevel > 0:
327 print('send:', repr(s), file=stderr)
Christian Heimes90c3d9b2008-02-23 13:18:03 +0000328 if hasattr(self, 'sock') and self.sock:
Guido van Rossum8a392d72007-11-21 22:09:45 +0000329 if isinstance(s, str):
330 s = s.encode("ascii")
Guido van Rossum2880f6e1998-08-10 20:07:00 +0000331 try:
Guido van Rossum8a392d72007-11-21 22:09:45 +0000332 self.sock.sendall(s)
Guido van Rossum2880f6e1998-08-10 20:07:00 +0000333 except socket.error:
Barry Warsaw76750972001-12-14 20:34:20 +0000334 self.close()
Guido van Rossum40233ea1999-01-15 03:23:55 +0000335 raise SMTPServerDisconnected('Server not connected')
Guido van Rossumfc40a831998-01-29 17:26:45 +0000336 else:
Guido van Rossum40233ea1999-01-15 03:23:55 +0000337 raise SMTPServerDisconnected('please run connect() first')
Tim Peters495ad3c2001-01-15 01:36:40 +0000338
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000339 def putcmd(self, cmd, args=""):
Barry Warsawa7d9bdf1998-12-22 03:24:27 +0000340 """Send a command to the server."""
Guido van Rossumdb23d3d1999-06-09 15:13:10 +0000341 if args == "":
342 str = '%s%s' % (cmd, CRLF)
343 else:
344 str = '%s %s%s' % (cmd, args, CRLF)
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000345 self.send(str)
Tim Peters495ad3c2001-01-15 01:36:40 +0000346
Guido van Rossumfcfb6321998-08-04 15:29:54 +0000347 def getreply(self):
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000348 """Get a reply from the server.
Tim Peters495ad3c2001-01-15 01:36:40 +0000349
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000350 Returns a tuple consisting of:
Barry Warsawa7d9bdf1998-12-22 03:24:27 +0000351
352 - server response code (e.g. '250', or such, if all goes well)
353 Note: returns -1 if it can't read response code.
354
355 - server response string corresponding to response code (multiline
356 responses are converted to a single, multiline string).
Guido van Rossumf123f841999-03-29 20:33:21 +0000357
358 Raises SMTPServerDisconnected if end-of-file is reached.
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000359 """
Giampaolo Rodolàbd258bd2011-02-22 15:56:20 +0000360 resp = []
Guido van Rossum296e1431999-04-07 15:03:39 +0000361 if self.file is None:
362 self.file = self.sock.makefile('rb')
Guido van Rossum45e2fbc1998-03-26 21:13:24 +0000363 while 1:
Benjamin Petersone1cdfd72009-01-18 21:02:37 +0000364 try:
365 line = self.file.readline()
Antoine Pitrou6b2e1602011-08-28 01:20:42 +0200366 except socket.error as e:
367 self.close()
368 raise SMTPServerDisconnected("Connection unexpectedly closed: "
369 + str(e))
Guido van Rossum806c2462007-08-06 23:33:07 +0000370 if not line:
Guido van Rossum296e1431999-04-07 15:03:39 +0000371 self.close()
372 raise SMTPServerDisconnected("Connection unexpectedly closed")
Giampaolo Rodolàbd258bd2011-02-22 15:56:20 +0000373 if self.debuglevel > 0:
374 print('reply:', repr(line), file=stderr)
Guido van Rossum806c2462007-08-06 23:33:07 +0000375 resp.append(line[4:].strip(b' \t\r\n'))
Giampaolo Rodolàbd258bd2011-02-22 15:56:20 +0000376 code = line[:3]
Guido van Rossum296e1431999-04-07 15:03:39 +0000377 # Check that the error code is syntactically correct.
378 # Don't attempt to read a continuation line if it is broken.
379 try:
Eric S. Raymondc013f302001-02-09 05:40:38 +0000380 errcode = int(code)
Guido van Rossum296e1431999-04-07 15:03:39 +0000381 except ValueError:
382 errcode = -1
383 break
Guido van Rossumf123f841999-03-29 20:33:21 +0000384 # Check if multiline response.
Guido van Rossum806c2462007-08-06 23:33:07 +0000385 if line[3:4] != b"-":
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000386 break
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000387
Guido van Rossumc43e79f2007-06-18 18:26:36 +0000388 errmsg = b"\n".join(resp)
Tim Peters495ad3c2001-01-15 01:36:40 +0000389 if self.debuglevel > 0:
Senthil Kumaranb351a482011-07-31 09:14:17 +0800390 print('reply: retcode (%s); Msg: %s' % (errcode, errmsg),
391 file=stderr)
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000392 return errcode, errmsg
Tim Peters495ad3c2001-01-15 01:36:40 +0000393
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000394 def docmd(self, cmd, args=""):
Barry Warsawa7d9bdf1998-12-22 03:24:27 +0000395 """Send a command, and return its response code."""
Giampaolo Rodolàbd258bd2011-02-22 15:56:20 +0000396 self.putcmd(cmd, args)
Guido van Rossum296e1431999-04-07 15:03:39 +0000397 return self.getreply()
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000398
Barry Warsawa7d9bdf1998-12-22 03:24:27 +0000399 # std smtp commands
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000400 def helo(self, name=''):
Barry Warsawa7d9bdf1998-12-22 03:24:27 +0000401 """SMTP 'helo' command.
402 Hostname to send for this command defaults to the FQDN of the local
403 host.
404 """
Neil Schemenauer6730f262002-03-24 15:30:40 +0000405 self.putcmd("helo", name or self.local_hostname)
Giampaolo Rodolàbd258bd2011-02-22 15:56:20 +0000406 (code, msg) = self.getreply()
407 self.helo_resp = msg
408 return (code, msg)
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000409
Guido van Rossum95e6f701998-06-25 02:15:50 +0000410 def ehlo(self, name=''):
Barry Warsawa7d9bdf1998-12-22 03:24:27 +0000411 """ SMTP 'ehlo' command.
412 Hostname to send for this command defaults to the FQDN of the local
413 host.
414 """
Guido van Rossumf7fcf5e2001-09-14 16:08:44 +0000415 self.esmtp_features = {}
Guido van Rossumd8faa362007-04-27 19:54:29 +0000416 self.putcmd(self.ehlo_msg, name or self.local_hostname)
Giampaolo Rodolàbd258bd2011-02-22 15:56:20 +0000417 (code, msg) = self.getreply()
Tim Peters495ad3c2001-01-15 01:36:40 +0000418 # According to RFC1869 some (badly written)
419 # MTA's will disconnect on an ehlo. Toss an exception if
Guido van Rossumfcfb6321998-08-04 15:29:54 +0000420 # that happens -ddm
421 if code == -1 and len(msg) == 0:
Barry Warsaw76750972001-12-14 20:34:20 +0000422 self.close()
Guido van Rossum40233ea1999-01-15 03:23:55 +0000423 raise SMTPServerDisconnected("Server not connected")
Giampaolo Rodolàbd258bd2011-02-22 15:56:20 +0000424 self.ehlo_resp = msg
Fred Drake8152d322000-12-12 23:20:45 +0000425 if code != 250:
Giampaolo Rodolàbd258bd2011-02-22 15:56:20 +0000426 return (code, msg)
427 self.does_esmtp = 1
Thomas Wouters7e474022000-07-16 12:04:32 +0000428 #parse the ehlo response -ddm
Guido van Rossum04110fb2007-08-24 16:32:05 +0000429 assert isinstance(self.ehlo_resp, bytes), repr(self.ehlo_resp)
Giampaolo Rodolàbd258bd2011-02-22 15:56:20 +0000430 resp = self.ehlo_resp.decode("latin-1").split('\n')
Guido van Rossumfcfb6321998-08-04 15:29:54 +0000431 del resp[0]
Guido van Rossum2880f6e1998-08-10 20:07:00 +0000432 for each in resp:
Piers Lauder385a77a2002-07-27 00:38:30 +0000433 # To be able to communicate with as many SMTP servers as possible,
434 # we have to take the old-style auth advertisement into account,
435 # because:
436 # 1) Else our SMTP feature parser gets confused.
437 # 2) There are some servers that only advertise the auth methods we
438 # support using the old style.
439 auth_match = OLDSTYLE_AUTH.match(each)
440 if auth_match:
441 # This doesn't remove duplicates, but that's no problem
442 self.esmtp_features["auth"] = self.esmtp_features.get("auth", "") \
443 + " " + auth_match.groups(0)[0]
444 continue
445
Barry Warsawbe22ae62002-04-15 20:03:30 +0000446 # RFC 1869 requires a space between ehlo keyword and parameters.
447 # It's actually stricter, in that only spaces are allowed between
448 # parameters, but were not going to check for that here. Note
449 # that the space isn't present if there are no parameters.
Giampaolo Rodolàbd258bd2011-02-22 15:56:20 +0000450 m = re.match(r'(?P<feature>[A-Za-z0-9][A-Za-z0-9\-]*) ?', each)
Guido van Rossumfcfb6321998-08-04 15:29:54 +0000451 if m:
Giampaolo Rodolàbd258bd2011-02-22 15:56:20 +0000452 feature = m.group("feature").lower()
453 params = m.string[m.end("feature"):].strip()
Piers Lauder385a77a2002-07-27 00:38:30 +0000454 if feature == "auth":
455 self.esmtp_features[feature] = self.esmtp_features.get(feature, "") \
456 + " " + params
457 else:
Giampaolo Rodolàbd258bd2011-02-22 15:56:20 +0000458 self.esmtp_features[feature] = params
459 return (code, msg)
Guido van Rossum95e6f701998-06-25 02:15:50 +0000460
Guido van Rossumfcfb6321998-08-04 15:29:54 +0000461 def has_extn(self, opt):
462 """Does the server support a given SMTP service extension?"""
Raymond Hettinger54f02222002-06-01 14:18:47 +0000463 return opt.lower() in self.esmtp_features
Guido van Rossum95e6f701998-06-25 02:15:50 +0000464
Guido van Rossum18586f41998-04-03 17:03:13 +0000465 def help(self, args=''):
Barry Warsawa7d9bdf1998-12-22 03:24:27 +0000466 """SMTP 'help' command.
467 Returns help text from server."""
Guido van Rossum18586f41998-04-03 17:03:13 +0000468 self.putcmd("help", args)
Kurt B. Kaiser58bd1902005-06-26 18:27:36 +0000469 return self.getreply()[1]
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000470
471 def rset(self):
Barry Warsawa7d9bdf1998-12-22 03:24:27 +0000472 """SMTP 'rset' command -- resets session."""
Guido van Rossum296e1431999-04-07 15:03:39 +0000473 return self.docmd("rset")
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000474
475 def noop(self):
Barry Warsawa7d9bdf1998-12-22 03:24:27 +0000476 """SMTP 'noop' command -- doesn't do anything :>"""
Guido van Rossum296e1431999-04-07 15:03:39 +0000477 return self.docmd("noop")
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000478
Giampaolo Rodolàbd258bd2011-02-22 15:56:20 +0000479 def mail(self, sender, options=[]):
Barry Warsawa7d9bdf1998-12-22 03:24:27 +0000480 """SMTP 'mail' command -- begins mail xfer session."""
Guido van Rossumfcfb6321998-08-04 15:29:54 +0000481 optionlist = ''
482 if options and self.does_esmtp:
Eric S. Raymondc013f302001-02-09 05:40:38 +0000483 optionlist = ' ' + ' '.join(options)
Giampaolo Rodolàbd258bd2011-02-22 15:56:20 +0000484 self.putcmd("mail", "FROM:%s%s" % (quoteaddr(sender), optionlist))
Guido van Rossum45e2fbc1998-03-26 21:13:24 +0000485 return self.getreply()
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000486
Giampaolo Rodolàbd258bd2011-02-22 15:56:20 +0000487 def rcpt(self, recip, options=[]):
Barry Warsawa7d9bdf1998-12-22 03:24:27 +0000488 """SMTP 'rcpt' command -- indicates 1 recipient for this mail."""
Guido van Rossumfcfb6321998-08-04 15:29:54 +0000489 optionlist = ''
490 if options and self.does_esmtp:
Eric S. Raymondc013f302001-02-09 05:40:38 +0000491 optionlist = ' ' + ' '.join(options)
Giampaolo Rodolàbd258bd2011-02-22 15:56:20 +0000492 self.putcmd("rcpt", "TO:%s%s" % (quoteaddr(recip), optionlist))
Guido van Rossum45e2fbc1998-03-26 21:13:24 +0000493 return self.getreply()
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000494
Giampaolo Rodolàbd258bd2011-02-22 15:56:20 +0000495 def data(self, msg):
Tim Peters495ad3c2001-01-15 01:36:40 +0000496 """SMTP 'DATA' command -- sends message data to server.
Guido van Rossum296e1431999-04-07 15:03:39 +0000497
Barry Warsaw4c4bec81998-12-22 03:02:20 +0000498 Automatically quotes lines beginning with a period per rfc821.
Guido van Rossum296e1431999-04-07 15:03:39 +0000499 Raises SMTPDataError if there is an unexpected reply to the
500 DATA command; the return value from this method is the final
R. David Murray7dff9e02010-11-08 17:15:13 +0000501 response code received when the all data is sent. If msg
502 is a string, lone '\r' and '\n' characters are converted to
503 '\r\n' characters. If msg is bytes, it is transmitted as is.
Barry Warsaw4c4bec81998-12-22 03:02:20 +0000504 """
Guido van Rossum45e2fbc1998-03-26 21:13:24 +0000505 self.putcmd("data")
Giampaolo Rodolàbd258bd2011-02-22 15:56:20 +0000506 (code, repl) = self.getreply()
507 if self.debuglevel > 0:
508 print("data:", (code, repl), file=stderr)
Fred Drake8152d322000-12-12 23:20:45 +0000509 if code != 354:
Giampaolo Rodolàbd258bd2011-02-22 15:56:20 +0000510 raise SMTPDataError(code, repl)
Guido van Rossum45e2fbc1998-03-26 21:13:24 +0000511 else:
R. David Murray7dff9e02010-11-08 17:15:13 +0000512 if isinstance(msg, str):
513 msg = _fix_eols(msg).encode('ascii')
514 q = _quote_periods(msg)
515 if q[-2:] != bCRLF:
516 q = q + bCRLF
517 q = q + b"." + bCRLF
Guido van Rossum20c92281999-04-21 16:52:20 +0000518 self.send(q)
Giampaolo Rodolàbd258bd2011-02-22 15:56:20 +0000519 (code, msg) = self.getreply()
520 if self.debuglevel > 0:
521 print("data:", (code, msg), file=stderr)
522 return (code, msg)
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000523
Guido van Rossumfcfb6321998-08-04 15:29:54 +0000524 def verify(self, address):
Barry Warsawa7d9bdf1998-12-22 03:24:27 +0000525 """SMTP 'verify' command -- checks for address validity."""
R David Murray46346762011-07-18 21:38:54 -0400526 self.putcmd("vrfy", _addr_only(address))
Guido van Rossumfcfb6321998-08-04 15:29:54 +0000527 return self.getreply()
Barry Warsaw4c4bec81998-12-22 03:02:20 +0000528 # a.k.a.
Giampaolo Rodolàbd258bd2011-02-22 15:56:20 +0000529 vrfy = verify
Guido van Rossumfcfb6321998-08-04 15:29:54 +0000530
531 def expn(self, address):
Christian Heimes90c3d9b2008-02-23 13:18:03 +0000532 """SMTP 'expn' command -- expands a mailing list."""
R David Murray46346762011-07-18 21:38:54 -0400533 self.putcmd("expn", _addr_only(address))
Guido van Rossumfcfb6321998-08-04 15:29:54 +0000534 return self.getreply()
535
Barry Warsaw4c4bec81998-12-22 03:02:20 +0000536 # some useful methods
Guido van Rossumae010462001-09-11 15:57:46 +0000537
Christian Heimes679db4a2008-01-18 09:56:22 +0000538 def ehlo_or_helo_if_needed(self):
539 """Call self.ehlo() and/or self.helo() if needed.
540
541 If there has been no previous EHLO or HELO command this session, this
542 method tries ESMTP EHLO first.
543
544 This method may raise the following exceptions:
545
546 SMTPHeloError The server didn't reply properly to
547 the helo greeting.
548 """
549 if self.helo_resp is None and self.ehlo_resp is None:
550 if not (200 <= self.ehlo()[0] <= 299):
551 (code, resp) = self.helo()
552 if not (200 <= code <= 299):
553 raise SMTPHeloError(code, resp)
554
Guido van Rossumae010462001-09-11 15:57:46 +0000555 def login(self, user, password):
556 """Log in on an SMTP server that requires authentication.
557
558 The arguments are:
559 - user: The user name to authenticate with.
560 - password: The password for the authentication.
561
562 If there has been no previous EHLO or HELO command this session, this
563 method tries ESMTP EHLO first.
564
565 This method will return normally if the authentication was successful.
566
567 This method may raise the following exceptions:
568
569 SMTPHeloError The server didn't reply properly to
570 the helo greeting.
571 SMTPAuthenticationError The server didn't accept the username/
572 password combination.
Fred Drake2f8f4d32001-10-13 18:35:32 +0000573 SMTPException No suitable authentication method was
Guido van Rossumae010462001-09-11 15:57:46 +0000574 found.
575 """
576
577 def encode_cram_md5(challenge, user, password):
Georg Brandl706824f2009-06-04 09:42:55 +0000578 challenge = base64.decodebytes(challenge)
R. David Murrayfb123912009-05-28 18:19:00 +0000579 response = user + " " + hmac.HMAC(password.encode('ascii'),
580 challenge).hexdigest()
581 return encode_base64(response.encode('ascii'), eol='')
Guido van Rossumae010462001-09-11 15:57:46 +0000582
583 def encode_plain(user, password):
R. David Murraycaa27b72009-05-23 18:49:56 +0000584 s = "\0%s\0%s" % (user, password)
585 return encode_base64(s.encode('ascii'), eol='')
Tim Peters469cdad2002-08-08 20:19:19 +0000586
Guido van Rossumae010462001-09-11 15:57:46 +0000587 AUTH_PLAIN = "PLAIN"
588 AUTH_CRAM_MD5 = "CRAM-MD5"
Piers Lauder385a77a2002-07-27 00:38:30 +0000589 AUTH_LOGIN = "LOGIN"
Guido van Rossumae010462001-09-11 15:57:46 +0000590
Christian Heimes679db4a2008-01-18 09:56:22 +0000591 self.ehlo_or_helo_if_needed()
Guido van Rossumae010462001-09-11 15:57:46 +0000592
593 if not self.has_extn("auth"):
594 raise SMTPException("SMTP AUTH extension not supported by server.")
595
Gerhard Häring1c5471f2010-08-05 14:08:44 +0000596 # Authentication methods the server claims to support
597 advertised_authlist = self.esmtp_features["auth"].split()
Guido van Rossumae010462001-09-11 15:57:46 +0000598
599 # List of authentication methods we support: from preferred to
600 # less preferred methods. Except for the purpose of testing the weaker
601 # ones, we prefer stronger methods like CRAM-MD5:
Piers Lauder385a77a2002-07-27 00:38:30 +0000602 preferred_auths = [AUTH_CRAM_MD5, AUTH_PLAIN, AUTH_LOGIN]
Guido van Rossumae010462001-09-11 15:57:46 +0000603
Gerhard Häring1c5471f2010-08-05 14:08:44 +0000604 # We try the authentication methods the server advertises, but only the
605 # ones *we* support. And in our preferred order.
606 authlist = [auth for auth in preferred_auths if auth in advertised_authlist]
607 if not authlist:
Fred Drake2f8f4d32001-10-13 18:35:32 +0000608 raise SMTPException("No suitable authentication method found.")
Gerhard Häring1c5471f2010-08-05 14:08:44 +0000609
610 # Some servers advertise authentication methods they don't really
611 # support, so if authentication fails, we continue until we've tried
612 # all methods.
613 for authmethod in authlist:
614 if authmethod == AUTH_CRAM_MD5:
615 (code, resp) = self.docmd("AUTH", AUTH_CRAM_MD5)
616 if code == 334:
617 (code, resp) = self.docmd(encode_cram_md5(resp, user, password))
618 elif authmethod == AUTH_PLAIN:
619 (code, resp) = self.docmd("AUTH",
620 AUTH_PLAIN + " " + encode_plain(user, password))
621 elif authmethod == AUTH_LOGIN:
622 (code, resp) = self.docmd("AUTH",
623 "%s %s" % (AUTH_LOGIN, encode_base64(user.encode('ascii'), eol='')))
624 if code == 334:
625 (code, resp) = self.docmd(encode_base64(password.encode('ascii'), eol=''))
626
Guido van Rossumae010462001-09-11 15:57:46 +0000627 # 235 == 'Authentication successful'
628 # 503 == 'Error: already authenticated'
Gerhard Häring1c5471f2010-08-05 14:08:44 +0000629 if code in (235, 503):
630 return (code, resp)
631
632 # We could not login sucessfully. Return result of last attempt.
633 raise SMTPAuthenticationError(code, resp)
Guido van Rossumae010462001-09-11 15:57:46 +0000634
Antoine Pitroue0650202011-05-18 18:03:09 +0200635 def starttls(self, keyfile=None, certfile=None, context=None):
Guido van Rossumf7fcf5e2001-09-14 16:08:44 +0000636 """Puts the connection to the SMTP server into TLS mode.
Tim Petersb64bec32001-09-18 02:26:39 +0000637
Christian Heimes679db4a2008-01-18 09:56:22 +0000638 If there has been no previous EHLO or HELO command this session, this
639 method tries ESMTP EHLO first.
640
Guido van Rossumf7fcf5e2001-09-14 16:08:44 +0000641 If the server supports TLS, this will encrypt the rest of the SMTP
642 session. If you provide the keyfile and certfile parameters,
643 the identity of the SMTP server and client can be checked. This,
644 however, depends on whether the socket module really checks the
645 certificates.
Christian Heimes679db4a2008-01-18 09:56:22 +0000646
647 This method may raise the following exceptions:
648
649 SMTPHeloError The server didn't reply properly to
650 the helo greeting.
Guido van Rossumf7fcf5e2001-09-14 16:08:44 +0000651 """
Christian Heimes679db4a2008-01-18 09:56:22 +0000652 self.ehlo_or_helo_if_needed()
653 if not self.has_extn("starttls"):
654 raise SMTPException("STARTTLS extension not supported by server.")
Tim Petersb64bec32001-09-18 02:26:39 +0000655 (resp, reply) = self.docmd("STARTTLS")
Guido van Rossumf7fcf5e2001-09-14 16:08:44 +0000656 if resp == 220:
Thomas Wouters47b49bf2007-08-30 22:15:33 +0000657 if not _have_ssl:
658 raise RuntimeError("No SSL support included in this Python")
Antoine Pitroue0650202011-05-18 18:03:09 +0200659 if context is not None and keyfile is not None:
660 raise ValueError("context and keyfile arguments are mutually "
661 "exclusive")
662 if context is not None and certfile is not None:
663 raise ValueError("context and certfile arguments are mutually "
664 "exclusive")
665 if context is not None:
666 self.sock = context.wrap_socket(self.sock)
667 else:
668 self.sock = ssl.wrap_socket(self.sock, keyfile, certfile)
Antoine Pitrouf068ab82011-06-06 19:17:09 +0200669 self.file = None
Christian Heimes679db4a2008-01-18 09:56:22 +0000670 # RFC 3207:
671 # The client MUST discard any knowledge obtained from
672 # the server, such as the list of SMTP service extensions,
673 # which was not obtained from the TLS negotiation itself.
674 self.helo_resp = None
675 self.ehlo_resp = None
676 self.esmtp_features = {}
677 self.does_esmtp = 0
Guido van Rossumf7fcf5e2001-09-14 16:08:44 +0000678 return (resp, reply)
Tim Petersb64bec32001-09-18 02:26:39 +0000679
Jeremy Hylton31bb8ce1998-08-13 19:57:46 +0000680 def sendmail(self, from_addr, to_addrs, msg, mail_options=[],
Tim Peters495ad3c2001-01-15 01:36:40 +0000681 rcpt_options=[]):
682 """This command performs an entire mail transaction.
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000683
Tim Peters495ad3c2001-01-15 01:36:40 +0000684 The arguments are:
Barry Warsaw4c4bec81998-12-22 03:02:20 +0000685 - from_addr : The address sending this mail.
686 - to_addrs : A list of addresses to send this mail to. A bare
687 string will be treated as a list with 1 address.
Tim Peters495ad3c2001-01-15 01:36:40 +0000688 - msg : The message to send.
Barry Warsaw4c4bec81998-12-22 03:02:20 +0000689 - mail_options : List of ESMTP options (such as 8bitmime) for the
690 mail command.
691 - rcpt_options : List of ESMTP options (such as DSN commands) for
692 all the rcpt commands.
693
R. David Murray7dff9e02010-11-08 17:15:13 +0000694 msg may be a string containing characters in the ASCII range, or a byte
695 string. A string is encoded to bytes using the ascii codec, and lone
R David Murrayac4e5ab2011-07-02 21:03:19 -0400696 \\r and \\n characters are converted to \\r\\n characters.
R. David Murray7dff9e02010-11-08 17:15:13 +0000697
Barry Warsaw4c4bec81998-12-22 03:02:20 +0000698 If there has been no previous EHLO or HELO command this session, this
699 method tries ESMTP EHLO first. If the server does ESMTP, message size
700 and each of the specified options will be passed to it. If EHLO
701 fails, HELO will be tried and ESMTP options suppressed.
702
703 This method will return normally if the mail is accepted for at least
Barry Warsawd25c1b71999-11-28 17:11:06 +0000704 one recipient. It returns a dictionary, with one entry for each
705 recipient that was refused. Each entry contains a tuple of the SMTP
706 error code and the accompanying error message sent by the server.
Guido van Rossum296e1431999-04-07 15:03:39 +0000707
708 This method may raise the following exceptions:
709
710 SMTPHeloError The server didn't reply properly to
Tim Peters495ad3c2001-01-15 01:36:40 +0000711 the helo greeting.
Barry Warsawd25c1b71999-11-28 17:11:06 +0000712 SMTPRecipientsRefused The server rejected ALL recipients
Guido van Rossum296e1431999-04-07 15:03:39 +0000713 (no mail was sent).
714 SMTPSenderRefused The server didn't accept the from_addr.
715 SMTPDataError The server replied with an unexpected
716 error code (other than a refusal of
717 a recipient).
718
719 Note: the connection will be open even after an exception is raised.
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000720
Guido van Rossum95e6f701998-06-25 02:15:50 +0000721 Example:
Tim Peters495ad3c2001-01-15 01:36:40 +0000722
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000723 >>> import smtplib
724 >>> s=smtplib.SMTP("localhost")
Guido van Rossumfc40a831998-01-29 17:26:45 +0000725 >>> tolist=["one@one.org","two@two.org","three@three.org","four@four.org"]
Martin v. Löwis301b1cd2002-07-28 16:52:01 +0000726 >>> msg = '''\\
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000727 ... From: Me@my.org
728 ... Subject: testin'...
729 ...
730 ... This is a test '''
731 >>> s.sendmail("me@my.org",tolist,msg)
732 { "three@three.org" : ( 550 ,"User unknown" ) }
733 >>> s.quit()
Tim Peters495ad3c2001-01-15 01:36:40 +0000734
Barry Warsaw4c4bec81998-12-22 03:02:20 +0000735 In the above example, the message was accepted for delivery to three
736 of the four addresses, and one was rejected, with the error code
Barry Warsawd25c1b71999-11-28 17:11:06 +0000737 550. If all addresses are accepted, then the method will return an
Barry Warsaw4c4bec81998-12-22 03:02:20 +0000738 empty dictionary.
739
740 """
Christian Heimes679db4a2008-01-18 09:56:22 +0000741 self.ehlo_or_helo_if_needed()
Guido van Rossum95e6f701998-06-25 02:15:50 +0000742 esmtp_opts = []
R. David Murray7dff9e02010-11-08 17:15:13 +0000743 if isinstance(msg, str):
744 msg = _fix_eols(msg).encode('ascii')
Guido van Rossumfcfb6321998-08-04 15:29:54 +0000745 if self.does_esmtp:
746 # Hmmm? what's this? -ddm
747 # self.esmtp_features['7bit']=""
748 if self.has_extn('size'):
Walter Dörwald70a6b492004-02-12 17:35:32 +0000749 esmtp_opts.append("size=%d" % len(msg))
Guido van Rossumfcfb6321998-08-04 15:29:54 +0000750 for option in mail_options:
Guido van Rossum95e6f701998-06-25 02:15:50 +0000751 esmtp_opts.append(option)
Giampaolo Rodolàbd258bd2011-02-22 15:56:20 +0000752 (code, resp) = self.mail(from_addr, esmtp_opts)
Fred Drake8152d322000-12-12 23:20:45 +0000753 if code != 250:
Guido van Rossum45e2fbc1998-03-26 21:13:24 +0000754 self.rset()
Guido van Rossum296e1431999-04-07 15:03:39 +0000755 raise SMTPSenderRefused(code, resp, from_addr)
Giampaolo Rodolàbd258bd2011-02-22 15:56:20 +0000756 senderrs = {}
Guido van Rossum3172c5d2007-10-16 18:12:55 +0000757 if isinstance(to_addrs, str):
Jeremy Hylton31bb8ce1998-08-13 19:57:46 +0000758 to_addrs = [to_addrs]
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000759 for each in to_addrs:
Giampaolo Rodolàbd258bd2011-02-22 15:56:20 +0000760 (code, resp) = self.rcpt(each, rcpt_options)
Fred Drake8152d322000-12-12 23:20:45 +0000761 if (code != 250) and (code != 251):
Giampaolo Rodolàbd258bd2011-02-22 15:56:20 +0000762 senderrs[each] = (code, resp)
763 if len(senderrs) == len(to_addrs):
Guido van Rossum95e6f701998-06-25 02:15:50 +0000764 # the server refused all our recipients
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000765 self.rset()
Guido van Rossum296e1431999-04-07 15:03:39 +0000766 raise SMTPRecipientsRefused(senderrs)
Giampaolo Rodolàbd258bd2011-02-22 15:56:20 +0000767 (code, resp) = self.data(msg)
Fred Drake8152d322000-12-12 23:20:45 +0000768 if code != 250:
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000769 self.rset()
Guido van Rossum296e1431999-04-07 15:03:39 +0000770 raise SMTPDataError(code, resp)
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000771 #if we got here then somebody got our mail
Tim Peters495ad3c2001-01-15 01:36:40 +0000772 return senderrs
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000773
R. David Murray7dff9e02010-11-08 17:15:13 +0000774 def send_message(self, msg, from_addr=None, to_addrs=None,
775 mail_options=[], rcpt_options={}):
776 """Converts message to a bytestring and passes it to sendmail.
777
778 The arguments are as for sendmail, except that msg is an
R David Murrayac4e5ab2011-07-02 21:03:19 -0400779 email.message.Message object. If from_addr is None or to_addrs is
780 None, these arguments are taken from the headers of the Message as
781 described in RFC 2822 (a ValueError is raised if there is more than
782 one set of 'Resent-' headers). Regardless of the values of from_addr and
783 to_addr, any Bcc field (or Resent-Bcc field, when the Message is a
784 resent) of the Message object won't be transmitted. The Message
785 object is then serialized using email.generator.BytesGenerator and
786 sendmail is called to transmit the message.
787
R. David Murray7dff9e02010-11-08 17:15:13 +0000788 """
R David Murrayac4e5ab2011-07-02 21:03:19 -0400789 # 'Resent-Date' is a mandatory field if the Message is resent (RFC 2822
790 # Section 3.6.6). In such a case, we use the 'Resent-*' fields. However,
791 # if there is more than one 'Resent-' block there's no way to
792 # unambiguously determine which one is the most recent in all cases,
793 # so rather than guess we raise a ValueError in that case.
794 #
795 # TODO implement heuristics to guess the correct Resent-* block with an
796 # option allowing the user to enable the heuristics. (It should be
797 # possible to guess correctly almost all of the time.)
Senthil Kumaranb351a482011-07-31 09:14:17 +0800798
799 resent = msg.get_all('Resent-Date')
R David Murrayac4e5ab2011-07-02 21:03:19 -0400800 if resent is None:
801 header_prefix = ''
802 elif len(resent) == 1:
803 header_prefix = 'Resent-'
804 else:
805 raise ValueError("message has more than one 'Resent-' header block")
R. David Murray7dff9e02010-11-08 17:15:13 +0000806 if from_addr is None:
R David Murrayac4e5ab2011-07-02 21:03:19 -0400807 # Prefer the sender field per RFC 2822:3.6.2.
Senthil Kumaranb351a482011-07-31 09:14:17 +0800808 from_addr = (msg[header_prefix + 'Sender']
809 if (header_prefix + 'Sender') in msg
810 else msg[header_prefix + 'From'])
R. David Murray7dff9e02010-11-08 17:15:13 +0000811 if to_addrs is None:
Senthil Kumaranb351a482011-07-31 09:14:17 +0800812 addr_fields = [f for f in (msg[header_prefix + 'To'],
813 msg[header_prefix + 'Bcc'],
814 msg[header_prefix + 'Cc']) if f is not None]
R. David Murray7dff9e02010-11-08 17:15:13 +0000815 to_addrs = [a[1] for a in email.utils.getaddresses(addr_fields)]
R David Murrayac4e5ab2011-07-02 21:03:19 -0400816 # Make a local copy so we can delete the bcc headers.
817 msg_copy = copy.copy(msg)
818 del msg_copy['Bcc']
819 del msg_copy['Resent-Bcc']
R. David Murray7dff9e02010-11-08 17:15:13 +0000820 with io.BytesIO() as bytesmsg:
821 g = email.generator.BytesGenerator(bytesmsg)
R David Murrayac4e5ab2011-07-02 21:03:19 -0400822 g.flatten(msg_copy, linesep='\r\n')
R. David Murray7dff9e02010-11-08 17:15:13 +0000823 flatmsg = bytesmsg.getvalue()
824 return self.sendmail(from_addr, to_addrs, flatmsg, mail_options,
825 rcpt_options)
826
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000827 def close(self):
828 """Close the connection to the SMTP server."""
829 if self.file:
830 self.file.close()
831 self.file = None
832 if self.sock:
833 self.sock.close()
834 self.sock = None
835
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000836 def quit(self):
Guido van Rossum95e6f701998-06-25 02:15:50 +0000837 """Terminate the SMTP session."""
Christian Heimesba4af492008-03-28 00:55:15 +0000838 res = self.docmd("quit")
Guido van Rossum45e2fbc1998-03-26 21:13:24 +0000839 self.close()
Christian Heimesba4af492008-03-28 00:55:15 +0000840 return res
Guido van Rossum95e6f701998-06-25 02:15:50 +0000841
Thomas Wouters47b49bf2007-08-30 22:15:33 +0000842if _have_ssl:
Thomas Wouters89f507f2006-12-13 04:49:30 +0000843
Thomas Wouters47b49bf2007-08-30 22:15:33 +0000844 class SMTP_SSL(SMTP):
845 """ This is a subclass derived from SMTP that connects over an SSL encrypted
846 socket (to use this class you need a socket module that was compiled with SSL
847 support). If host is not specified, '' (the local host) is used. If port is
Senthil Kumaran3d23fd62011-07-30 10:56:50 +0800848 omitted, the standard SMTP-over-SSL port (465) is used. The optional
849 source_address takes a two-tuple (host,port) for socket to bind to. keyfile and certfile
Thomas Wouters47b49bf2007-08-30 22:15:33 +0000850 are also optional - they can contain a PEM formatted private key and
Antoine Pitroue0650202011-05-18 18:03:09 +0200851 certificate chain file for the SSL connection. context also optional, can contain
852 a SSLContext, and is an alternative to keyfile and certfile; If it is specified both
853 keyfile and certfile must be None.
Thomas Wouters47b49bf2007-08-30 22:15:33 +0000854 """
Antoine Pitrouc1d52062011-05-07 19:39:37 +0200855
856 default_port = SMTP_SSL_PORT
857
Thomas Wouters47b49bf2007-08-30 22:15:33 +0000858 def __init__(self, host='', port=0, local_hostname=None,
Georg Brandlf78e02b2008-06-10 17:40:04 +0000859 keyfile=None, certfile=None,
Senthil Kumaran3d23fd62011-07-30 10:56:50 +0800860 timeout=socket._GLOBAL_DEFAULT_TIMEOUT,
861 source_address=None, context=None):
Antoine Pitroue0650202011-05-18 18:03:09 +0200862 if context is not None and keyfile is not None:
863 raise ValueError("context and keyfile arguments are mutually "
864 "exclusive")
865 if context is not None and certfile is not None:
866 raise ValueError("context and certfile arguments are mutually "
867 "exclusive")
Thomas Wouters47b49bf2007-08-30 22:15:33 +0000868 self.keyfile = keyfile
869 self.certfile = certfile
Antoine Pitroue0650202011-05-18 18:03:09 +0200870 self.context = context
Senthil Kumaran3d23fd62011-07-30 10:56:50 +0800871 SMTP.__init__(self, host, port, local_hostname, timeout,
872 source_address)
Thomas Wouters47b49bf2007-08-30 22:15:33 +0000873
874 def _get_socket(self, host, port, timeout):
Giampaolo Rodolàbd258bd2011-02-22 15:56:20 +0000875 if self.debuglevel > 0:
876 print('connect:', (host, port), file=stderr)
Senthil Kumaran3d23fd62011-07-30 10:56:50 +0800877 new_socket = socket.create_connection((host, port), timeout,
878 self.source_address)
Antoine Pitroue0650202011-05-18 18:03:09 +0200879 if self.context is not None:
880 new_socket = self.context.wrap_socket(new_socket)
881 else:
882 new_socket = ssl.wrap_socket(new_socket, self.keyfile, self.certfile)
R. David Murray87e20742009-05-23 01:30:26 +0000883 return new_socket
Thomas Wouters47b49bf2007-08-30 22:15:33 +0000884
885 __all__.append("SMTP_SSL")
Barry Warsaw4c4bec81998-12-22 03:02:20 +0000886
Guido van Rossumd8faa362007-04-27 19:54:29 +0000887#
888# LMTP extension
889#
890LMTP_PORT = 2003
891
892class LMTP(SMTP):
893 """LMTP - Local Mail Transfer Protocol
894
895 The LMTP protocol, which is very similar to ESMTP, is heavily based
896 on the standard SMTP client. It's common to use Unix sockets for LMTP,
897 so our connect() method must support that as well as a regular
898 host:port server. To specify a Unix socket, you must use an absolute
899 path as the host, starting with a '/'.
900
901 Authentication is supported, using the regular SMTP mechanism. When
902 using a Unix socket, LMTP generally don't support or require any
903 authentication, but your mileage might vary."""
904
905 ehlo_msg = "lhlo"
906
Senthil Kumaran3d23fd62011-07-30 10:56:50 +0800907 def __init__(self, host='', port=LMTP_PORT, local_hostname=None,
908 source_address=None):
Guido van Rossumd8faa362007-04-27 19:54:29 +0000909 """Initialize a new instance."""
Senthil Kumaranb351a482011-07-31 09:14:17 +0800910 SMTP.__init__(self, host, port, local_hostname=local_hostname,
911 source_address=source_address)
Guido van Rossumd8faa362007-04-27 19:54:29 +0000912
Senthil Kumaran3d23fd62011-07-30 10:56:50 +0800913 def connect(self, host='localhost', port=0, source_address=None):
Guido van Rossumd8faa362007-04-27 19:54:29 +0000914 """Connect to the LMTP daemon, on either a Unix or a TCP socket."""
915 if host[0] != '/':
Senthil Kumaranb351a482011-07-31 09:14:17 +0800916 return SMTP.connect(self, host, port, source_address=source_address)
Guido van Rossumd8faa362007-04-27 19:54:29 +0000917
918 # Handle Unix-domain sockets.
919 try:
920 self.sock = socket.socket(socket.AF_UNIX, socket.SOCK_STREAM)
Antoine Pitrouf068ab82011-06-06 19:17:09 +0200921 self.file = None
Guido van Rossumd8faa362007-04-27 19:54:29 +0000922 self.sock.connect(host)
Andrew Svetlovb6693c42012-12-17 18:54:53 +0200923 except socket.error:
Giampaolo Rodolàbd258bd2011-02-22 15:56:20 +0000924 if self.debuglevel > 0:
925 print('connect fail:', host, file=stderr)
Guido van Rossumd8faa362007-04-27 19:54:29 +0000926 if self.sock:
927 self.sock.close()
928 self.sock = None
Andrew Svetlovb6693c42012-12-17 18:54:53 +0200929 raise
Guido van Rossumd8faa362007-04-27 19:54:29 +0000930 (code, msg) = self.getreply()
Giampaolo Rodolàbd258bd2011-02-22 15:56:20 +0000931 if self.debuglevel > 0:
932 print('connect:', msg, file=stderr)
Guido van Rossumd8faa362007-04-27 19:54:29 +0000933 return (code, msg)
934
935
Guido van Rossum95e6f701998-06-25 02:15:50 +0000936# Test the sendmail method, which tests most of the others.
937# Note: This always sends to localhost.
938if __name__ == '__main__':
Andrew M. Kuchling6be424f2001-08-13 14:41:39 +0000939 import sys
Guido van Rossum95e6f701998-06-25 02:15:50 +0000940
941 def prompt(prompt):
942 sys.stdout.write(prompt + ": ")
Ezio Melotti6bfecd12011-10-18 13:20:07 +0300943 sys.stdout.flush()
Eric S. Raymondc013f302001-02-09 05:40:38 +0000944 return sys.stdin.readline().strip()
Guido van Rossum95e6f701998-06-25 02:15:50 +0000945
946 fromaddr = prompt("From")
Giampaolo Rodolàbd258bd2011-02-22 15:56:20 +0000947 toaddrs = prompt("To").split(',')
Guido van Rossumbe19ed72007-02-09 05:37:30 +0000948 print("Enter message, end with ^D:")
Guido van Rossum95e6f701998-06-25 02:15:50 +0000949 msg = ''
950 while 1:
951 line = sys.stdin.readline()
952 if not line:
953 break
954 msg = msg + line
Guido van Rossumbe19ed72007-02-09 05:37:30 +0000955 print("Message length is %d" % len(msg))
Guido van Rossum95e6f701998-06-25 02:15:50 +0000956
957 server = SMTP('localhost')
958 server.set_debuglevel(1)
959 server.sendmail(fromaddr, toaddrs, msg)
960 server.quit()