blob: 0c6106543240a6b1201120c6f8fc8b84763d241f [file] [log] [blame]
Barry Warsaw4c4bec81998-12-22 03:02:20 +00001#! /usr/bin/env python
2
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")
18 >>> print s.help()
19 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
Barry Warsaw07201771998-12-22 20:37:36 +000045import re
Georg Brandl5a096e12007-01-22 19:40:21 +000046import email.utils
Guido van Rossumae010462001-09-11 15:57:46 +000047import base64
48import hmac
Georg Brandl5a096e12007-01-22 19:40:21 +000049from email.base64mime import encode as encode_base64
Brett Cannone6f8a892004-07-10 23:14:30 +000050from sys import stderr
Guido van Rossumbbe323e1998-01-29 17:24:40 +000051
Giampaolo Rodolà5c12ec62011-02-24 20:43:11 +000052__all__ = ["SMTPException", "SMTPServerDisconnected", "SMTPResponseException",
53 "SMTPSenderRefused", "SMTPRecipientsRefused", "SMTPDataError",
54 "SMTPConnectError", "SMTPHeloError", "SMTPAuthenticationError",
55 "quoteaddr", "quotedata", "SMTP"]
Skip Montanaro0de65802001-02-15 22:15:14 +000056
Guido van Rossumbbe323e1998-01-29 17:24:40 +000057SMTP_PORT = 25
Martin v. Löwisee82c0e2006-10-27 07:13:28 +000058SMTP_SSL_PORT = 465
Giampaolo Rodolà5c12ec62011-02-24 20:43:11 +000059CRLF = "\r\n"
Benjamin Petersondabfc562014-12-05 20:05:18 -050060_MAXLINE = 8192 # more than 8 times larger than RFC 821, 4.5.3
Guido van Rossumbbe323e1998-01-29 17:24:40 +000061
Piers Lauder385a77a2002-07-27 00:38:30 +000062OLDSTYLE_AUTH = re.compile(r"auth=(.*)", re.I)
63
Giampaolo Rodolà5c12ec62011-02-24 20:43:11 +000064
Tim Peters495ad3c2001-01-15 01:36:40 +000065# Exception classes used by this module.
Guido van Rossum296e1431999-04-07 15:03:39 +000066class SMTPException(Exception):
67 """Base class for all exceptions raised by this module."""
68
69class SMTPServerDisconnected(SMTPException):
70 """Not connected to any SMTP server.
71
72 This exception is raised when the server unexpectedly disconnects,
73 or when an attempt is made to use the SMTP instance before
74 connecting it to a server.
75 """
76
77class SMTPResponseException(SMTPException):
78 """Base class for all exceptions that include an SMTP error code.
79
80 These exceptions are generated in some instances when the SMTP
81 server returns an error code. The error code is stored in the
82 `smtp_code' attribute of the error, and the `smtp_error' attribute
83 is set to the error message.
84 """
85
86 def __init__(self, code, msg):
87 self.smtp_code = code
88 self.smtp_error = msg
89 self.args = (code, msg)
90
91class SMTPSenderRefused(SMTPResponseException):
92 """Sender address refused.
Guido van Rossumae010462001-09-11 15:57:46 +000093
Guido van Rossum296e1431999-04-07 15:03:39 +000094 In addition to the attributes set by on all SMTPResponseException
Barry Warsawd25c1b71999-11-28 17:11:06 +000095 exceptions, this sets `sender' to the string that the SMTP refused.
Guido van Rossum296e1431999-04-07 15:03:39 +000096 """
97
98 def __init__(self, code, msg, sender):
99 self.smtp_code = code
100 self.smtp_error = msg
101 self.sender = sender
102 self.args = (code, msg, sender)
103
Guido van Rossum20c92281999-04-21 16:52:20 +0000104class SMTPRecipientsRefused(SMTPException):
Barry Warsawd25c1b71999-11-28 17:11:06 +0000105 """All recipient addresses refused.
Guido van Rossumae010462001-09-11 15:57:46 +0000106
Thomas Wouters7e474022000-07-16 12:04:32 +0000107 The errors for each recipient are accessible through the attribute
Tim Peters495ad3c2001-01-15 01:36:40 +0000108 'recipients', which is a dictionary of exactly the same sort as
109 SMTP.sendmail() returns.
Guido van Rossum296e1431999-04-07 15:03:39 +0000110 """
111
112 def __init__(self, recipients):
113 self.recipients = recipients
Giampaolo Rodolà5c12ec62011-02-24 20:43:11 +0000114 self.args = (recipients,)
Guido van Rossum296e1431999-04-07 15:03:39 +0000115
116
Guido van Rossum296e1431999-04-07 15:03:39 +0000117class SMTPDataError(SMTPResponseException):
118 """The SMTP server didn't accept the data."""
119
120class SMTPConnectError(SMTPResponseException):
Barry Warsawd25c1b71999-11-28 17:11:06 +0000121 """Error during connection establishment."""
Guido van Rossum296e1431999-04-07 15:03:39 +0000122
123class SMTPHeloError(SMTPResponseException):
Barry Warsawd25c1b71999-11-28 17:11:06 +0000124 """The server refused our HELO reply."""
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000125
Guido van Rossumae010462001-09-11 15:57:46 +0000126class SMTPAuthenticationError(SMTPResponseException):
127 """Authentication error.
128
129 Most probably the server didn't accept the username/password
130 combination provided.
131 """
Peter Schneider-Kamp7bc82bb2000-08-10 14:02:23 +0000132
Giampaolo Rodolà5c12ec62011-02-24 20:43:11 +0000133
Guido van Rossum69a79bc1998-07-13 15:18:49 +0000134def quoteaddr(addr):
135 """Quote a subset of the email addresses defined by RFC 821.
136
Barry Warsawa7d9bdf1998-12-22 03:24:27 +0000137 Should be able to handle anything rfc822.parseaddr can handle.
138 """
Raymond Hettinger342456d2002-09-05 01:14:07 +0000139 m = (None, None)
Guido van Rossum69a79bc1998-07-13 15:18:49 +0000140 try:
Georg Brandl5a096e12007-01-22 19:40:21 +0000141 m = email.utils.parseaddr(addr)[1]
Guido van Rossumfcfb6321998-08-04 15:29:54 +0000142 except AttributeError:
143 pass
Giampaolo Rodolà5c12ec62011-02-24 20:43:11 +0000144 if m == (None, None): # Indicates parse failure or AttributeError
Georg Brandlbd3bc4d2006-02-17 09:52:53 +0000145 # something weird here.. punt -ddm
Raymond Hettinger342456d2002-09-05 01:14:07 +0000146 return "<%s>" % addr
Georg Brandlbd3bc4d2006-02-17 09:52:53 +0000147 elif m is None:
148 # the sender wants an empty return address
149 return "<>"
Guido van Rossumfcfb6321998-08-04 15:29:54 +0000150 else:
151 return "<%s>" % m
Guido van Rossum69a79bc1998-07-13 15:18:49 +0000152
R David Murray95225952011-07-18 21:34:04 -0400153def _addr_only(addrstring):
154 displayname, addr = email.utils.parseaddr(addrstring)
155 if (displayname, addr) == ('', ''):
156 # parseaddr couldn't parse it, so use it as is.
157 return addrstring
158 return addr
159
Guido van Rossum69a79bc1998-07-13 15:18:49 +0000160def quotedata(data):
161 """Quote data for email.
162
Barry Warsawd25c1b71999-11-28 17:11:06 +0000163 Double leading '.', and change Unix newline '\\n', or Mac '\\r' into
Barry Warsawa7d9bdf1998-12-22 03:24:27 +0000164 Internet CRLF end-of-line.
165 """
Guido van Rossum69a79bc1998-07-13 15:18:49 +0000166 return re.sub(r'(?m)^\.', '..',
Guido van Rossumfcfb6321998-08-04 15:29:54 +0000167 re.sub(r'(?:\r\n|\n|\r(?!\n))', CRLF, data))
Guido van Rossum69a79bc1998-07-13 15:18:49 +0000168
Peter Schneider-Kamp7bc82bb2000-08-10 14:02:23 +0000169
Bill Janssen426ea0a2007-08-29 22:35:05 +0000170try:
171 import ssl
172except ImportError:
173 _have_ssl = False
174else:
Bill Janssen426ea0a2007-08-29 22:35:05 +0000175 class SSLFakeFile:
176 """A fake file like object that really wraps a SSLObject.
177
178 It only supports what is needed in smtplib.
179 """
180 def __init__(self, sslobj):
181 self.sslobj = sslobj
182
Benjamin Petersondabfc562014-12-05 20:05:18 -0500183 def readline(self, size=-1):
184 if size < 0:
185 size = None
Bill Janssen426ea0a2007-08-29 22:35:05 +0000186 str = ""
187 chr = None
188 while chr != "\n":
Benjamin Petersondabfc562014-12-05 20:05:18 -0500189 if size is not None and len(str) >= size:
190 break
Bill Janssen426ea0a2007-08-29 22:35:05 +0000191 chr = self.sslobj.read(1)
Giampaolo Rodolà5c12ec62011-02-24 20:43:11 +0000192 if not chr:
193 break
Bill Janssen426ea0a2007-08-29 22:35:05 +0000194 str += chr
195 return str
196
197 def close(self):
198 pass
199
200 _have_ssl = True
201
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000202class SMTP:
Guido van Rossumfcfb6321998-08-04 15:29:54 +0000203 """This class manages a connection to an SMTP or ESMTP server.
204 SMTP Objects:
Tim Peters495ad3c2001-01-15 01:36:40 +0000205 SMTP objects have the following attributes:
206 helo_resp
207 This is the message given by the server in response to the
Guido van Rossumfcfb6321998-08-04 15:29:54 +0000208 most recent HELO command.
Tim Peters495ad3c2001-01-15 01:36:40 +0000209
Guido van Rossumfcfb6321998-08-04 15:29:54 +0000210 ehlo_resp
Tim Peters495ad3c2001-01-15 01:36:40 +0000211 This is the message given by the server in response to the
Guido van Rossumfcfb6321998-08-04 15:29:54 +0000212 most recent EHLO command. This is usually multiline.
213
Tim Peters495ad3c2001-01-15 01:36:40 +0000214 does_esmtp
Guido van Rossumfcfb6321998-08-04 15:29:54 +0000215 This is a True value _after you do an EHLO command_, if the
216 server supports ESMTP.
217
Tim Peters495ad3c2001-01-15 01:36:40 +0000218 esmtp_features
Guido van Rossumfcfb6321998-08-04 15:29:54 +0000219 This is a dictionary, which, if the server supports ESMTP,
Barry Warsawd25c1b71999-11-28 17:11:06 +0000220 will _after you do an EHLO command_, contain the names of the
221 SMTP service extensions this server supports, and their
Guido van Rossumfcfb6321998-08-04 15:29:54 +0000222 parameters (if any).
Barry Warsawd25c1b71999-11-28 17:11:06 +0000223
Tim Peters495ad3c2001-01-15 01:36:40 +0000224 Note, all extension names are mapped to lower case in the
225 dictionary.
Guido van Rossumfcfb6321998-08-04 15:29:54 +0000226
Barry Warsawd25c1b71999-11-28 17:11:06 +0000227 See each method's docstrings for details. In general, there is a
228 method of the same name to perform each SMTP command. There is also a
229 method called 'sendmail' that will do an entire mail transaction.
230 """
Guido van Rossum95e6f701998-06-25 02:15:50 +0000231 debuglevel = 0
232 file = None
233 helo_resp = None
Martin v. Löwis1190a382007-03-09 15:35:55 +0000234 ehlo_msg = "ehlo"
Guido van Rossum95e6f701998-06-25 02:15:50 +0000235 ehlo_resp = None
Guido van Rossumfcfb6321998-08-04 15:29:54 +0000236 does_esmtp = 0
Antoine Pitrou21ce8f02011-05-07 19:59:33 +0200237 default_port = SMTP_PORT
Guido van Rossum95e6f701998-06-25 02:15:50 +0000238
Facundo Batista4f1b1ed2008-05-29 16:39:26 +0000239 def __init__(self, host='', port=0, local_hostname=None,
240 timeout=socket._GLOBAL_DEFAULT_TIMEOUT):
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000241 """Initialize a new instance.
242
Barry Warsawa7d9bdf1998-12-22 03:24:27 +0000243 If specified, `host' is the name of the remote host to which to
244 connect. If specified, `port' specifies the port to which to connect.
R David Murray2fc97e62013-04-13 14:37:22 -0400245 By default, smtplib.SMTP_PORT is used. If a host is specified the
R David Murray95752222013-06-23 16:10:37 -0400246 connect method is called, and if it returns anything other than a
247 success code an SMTPConnectError is raised. If specified,
R David Murray7f01d552013-06-23 16:02:34 -0400248 `local_hostname` is used as the FQDN of the local host for the
R David Murray95752222013-06-23 16:10:37 -0400249 HELO/EHLO command. Otherwise, the local hostname is found using
250 socket.getfqdn().
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000251
252 """
Facundo Batista366d6262007-03-28 18:25:54 +0000253 self.timeout = timeout
Guido van Rossumfcfb6321998-08-04 15:29:54 +0000254 self.esmtp_features = {}
Guido van Rossum296e1431999-04-07 15:03:39 +0000255 if host:
256 (code, msg) = self.connect(host, port)
257 if code != 220:
Stéphane Wirtel779e7c92017-05-24 20:24:27 +0200258 self.close()
Guido van Rossum296e1431999-04-07 15:03:39 +0000259 raise SMTPConnectError(code, msg)
Raymond Hettingerf13eb552002-06-02 00:40:05 +0000260 if local_hostname is not None:
Barry Warsaw13e34f72002-03-26 20:27:35 +0000261 self.local_hostname = local_hostname
Neil Schemenauer6730f262002-03-24 15:30:40 +0000262 else:
Barry Warsaw13e34f72002-03-26 20:27:35 +0000263 # RFC 2821 says we should use the fqdn in the EHLO/HELO verb, and
264 # if that can't be calculated, that we should use a domain literal
265 # instead (essentially an encoded IP address like [A.B.C.D]).
266 fqdn = socket.getfqdn()
267 if '.' in fqdn:
268 self.local_hostname = fqdn
269 else:
270 # We can't find an fqdn hostname, so use a domain literal
Georg Brandldcdfd222006-03-31 19:34:13 +0000271 addr = '127.0.0.1'
272 try:
273 addr = socket.gethostbyname(socket.gethostname())
274 except socket.gaierror:
275 pass
Barry Warsaw13e34f72002-03-26 20:27:35 +0000276 self.local_hostname = '[%s]' % addr
Tim Peters495ad3c2001-01-15 01:36:40 +0000277
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000278 def set_debuglevel(self, debuglevel):
279 """Set the debug output level.
280
Barry Warsawa7d9bdf1998-12-22 03:24:27 +0000281 A non-false value results in debug messages for connection and for all
282 messages sent to and received from the server.
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000283
284 """
285 self.debuglevel = debuglevel
286
R David Murrayc993a192013-04-02 12:15:07 -0400287 def _get_socket(self, host, port, timeout):
Martin v. Löwisee82c0e2006-10-27 07:13:28 +0000288 # This makes it simpler for SMTP_SSL to use the SMTP connect code
289 # and just alter the socket connection bit.
Giampaolo Rodolà5c12ec62011-02-24 20:43:11 +0000290 if self.debuglevel > 0:
291 print>>stderr, 'connect:', (host, port)
R David Murrayc993a192013-04-02 12:15:07 -0400292 return socket.create_connection((host, port), timeout)
Martin v. Löwisee82c0e2006-10-27 07:13:28 +0000293
Giampaolo Rodolà5c12ec62011-02-24 20:43:11 +0000294 def connect(self, host='localhost', port=0):
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000295 """Connect to a host on a given port.
Guido van Rossum95e6f701998-06-25 02:15:50 +0000296
Barry Warsaw4c4bec81998-12-22 03:02:20 +0000297 If the hostname ends with a colon (`:') followed by a number, and
298 there is no port specified, that suffix will be stripped off and the
299 number interpreted as the port number to use.
Guido van Rossum95e6f701998-06-25 02:15:50 +0000300
Barry Warsawa7d9bdf1998-12-22 03:24:27 +0000301 Note: This method is automatically invoked by __init__, if a host is
302 specified during instantiation.
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000303
304 """
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à5c12ec62011-02-24 20:43:11 +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 Rossumbbe323e1998-01-29 17:24:40 +0000312 raise socket.error, "nonnumeric port"
Giampaolo Rodolà5c12ec62011-02-24 20:43:11 +0000313 if not port:
314 port = self.default_port
315 if self.debuglevel > 0:
316 print>>stderr, 'connect:', (host, port)
Facundo Batista366d6262007-03-28 18:25:54 +0000317 self.sock = self._get_socket(host, port, self.timeout)
Martin v. Löwisa43c2f82001-07-24 20:34:08 +0000318 (code, msg) = self.getreply()
Giampaolo Rodolà5c12ec62011-02-24 20:43:11 +0000319 if self.debuglevel > 0:
320 print>>stderr, "connect:", msg
Martin v. Löwisa43c2f82001-07-24 20:34:08 +0000321 return (code, msg)
Tim Peters495ad3c2001-01-15 01:36:40 +0000322
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000323 def send(self, str):
324 """Send `str' to the server."""
Giampaolo Rodolà5c12ec62011-02-24 20:43:11 +0000325 if self.debuglevel > 0:
326 print>>stderr, 'send:', repr(str)
Facundo Batista16609332008-02-23 12:27:17 +0000327 if hasattr(self, 'sock') and self.sock:
Guido van Rossum2880f6e1998-08-10 20:07:00 +0000328 try:
Martin v. Löwise12454f2002-02-16 23:06:19 +0000329 self.sock.sendall(str)
Guido van Rossum2880f6e1998-08-10 20:07:00 +0000330 except socket.error:
Barry Warsaw76750972001-12-14 20:34:20 +0000331 self.close()
Guido van Rossum40233ea1999-01-15 03:23:55 +0000332 raise SMTPServerDisconnected('Server not connected')
Guido van Rossumfc40a831998-01-29 17:26:45 +0000333 else:
Guido van Rossum40233ea1999-01-15 03:23:55 +0000334 raise SMTPServerDisconnected('please run connect() first')
Tim Peters495ad3c2001-01-15 01:36:40 +0000335
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000336 def putcmd(self, cmd, args=""):
Barry Warsawa7d9bdf1998-12-22 03:24:27 +0000337 """Send a command to the server."""
Guido van Rossumdb23d3d1999-06-09 15:13:10 +0000338 if args == "":
339 str = '%s%s' % (cmd, CRLF)
340 else:
341 str = '%s %s%s' % (cmd, args, CRLF)
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000342 self.send(str)
Tim Peters495ad3c2001-01-15 01:36:40 +0000343
Guido van Rossumfcfb6321998-08-04 15:29:54 +0000344 def getreply(self):
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000345 """Get a reply from the server.
Tim Peters495ad3c2001-01-15 01:36:40 +0000346
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000347 Returns a tuple consisting of:
Barry Warsawa7d9bdf1998-12-22 03:24:27 +0000348
349 - server response code (e.g. '250', or such, if all goes well)
350 Note: returns -1 if it can't read response code.
351
352 - server response string corresponding to response code (multiline
353 responses are converted to a single, multiline string).
Guido van Rossumf123f841999-03-29 20:33:21 +0000354
355 Raises SMTPServerDisconnected if end-of-file is reached.
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000356 """
Giampaolo Rodolà5c12ec62011-02-24 20:43:11 +0000357 resp = []
Guido van Rossum296e1431999-04-07 15:03:39 +0000358 if self.file is None:
359 self.file = self.sock.makefile('rb')
Guido van Rossum45e2fbc1998-03-26 21:13:24 +0000360 while 1:
Kristján Valur Jónsson51a035e2009-01-15 17:20:21 +0000361 try:
Benjamin Petersondabfc562014-12-05 20:05:18 -0500362 line = self.file.readline(_MAXLINE + 1)
Antoine Pitrou0ad73582011-08-28 01:18:31 +0200363 except socket.error as e:
364 self.close()
365 raise SMTPServerDisconnected("Connection unexpectedly closed: "
366 + str(e))
Guido van Rossum296e1431999-04-07 15:03:39 +0000367 if line == '':
368 self.close()
369 raise SMTPServerDisconnected("Connection unexpectedly closed")
Giampaolo Rodolà5c12ec62011-02-24 20:43:11 +0000370 if self.debuglevel > 0:
371 print>>stderr, 'reply:', repr(line)
Benjamin Petersondabfc562014-12-05 20:05:18 -0500372 if len(line) > _MAXLINE:
373 raise SMTPResponseException(500, "Line too long.")
Eric S. Raymondc013f302001-02-09 05:40:38 +0000374 resp.append(line[4:].strip())
Giampaolo Rodolà5c12ec62011-02-24 20:43:11 +0000375 code = line[:3]
Guido van Rossum296e1431999-04-07 15:03:39 +0000376 # Check that the error code is syntactically correct.
377 # Don't attempt to read a continuation line if it is broken.
378 try:
Eric S. Raymondc013f302001-02-09 05:40:38 +0000379 errcode = int(code)
Guido van Rossum296e1431999-04-07 15:03:39 +0000380 except ValueError:
381 errcode = -1
382 break
Guido van Rossumf123f841999-03-29 20:33:21 +0000383 # Check if multiline response.
Giampaolo Rodolà5c12ec62011-02-24 20:43:11 +0000384 if line[3:4] != "-":
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000385 break
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000386
Eric S. Raymondc013f302001-02-09 05:40:38 +0000387 errmsg = "\n".join(resp)
Tim Peters495ad3c2001-01-15 01:36:40 +0000388 if self.debuglevel > 0:
Giampaolo Rodolà5c12ec62011-02-24 20:43:11 +0000389 print>>stderr, 'reply: retcode (%s); Msg: %s' % (errcode, errmsg)
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000390 return errcode, errmsg
Tim Peters495ad3c2001-01-15 01:36:40 +0000391
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000392 def docmd(self, cmd, args=""):
Barry Warsawa7d9bdf1998-12-22 03:24:27 +0000393 """Send a command, and return its response code."""
Giampaolo Rodolà5c12ec62011-02-24 20:43:11 +0000394 self.putcmd(cmd, args)
Guido van Rossum296e1431999-04-07 15:03:39 +0000395 return self.getreply()
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000396
Barry Warsawa7d9bdf1998-12-22 03:24:27 +0000397 # std smtp commands
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000398 def helo(self, name=''):
Barry Warsawa7d9bdf1998-12-22 03:24:27 +0000399 """SMTP 'helo' command.
400 Hostname to send for this command defaults to the FQDN of the local
401 host.
402 """
Neil Schemenauer6730f262002-03-24 15:30:40 +0000403 self.putcmd("helo", name or self.local_hostname)
Giampaolo Rodolà5c12ec62011-02-24 20:43:11 +0000404 (code, msg) = self.getreply()
405 self.helo_resp = msg
406 return (code, msg)
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000407
Guido van Rossum95e6f701998-06-25 02:15:50 +0000408 def ehlo(self, name=''):
Barry Warsawa7d9bdf1998-12-22 03:24:27 +0000409 """ SMTP 'ehlo' command.
410 Hostname to send for this command defaults to the FQDN of the local
411 host.
412 """
Guido van Rossumf7fcf5e2001-09-14 16:08:44 +0000413 self.esmtp_features = {}
Martin v. Löwis1190a382007-03-09 15:35:55 +0000414 self.putcmd(self.ehlo_msg, name or self.local_hostname)
Giampaolo Rodolà5c12ec62011-02-24 20:43:11 +0000415 (code, msg) = self.getreply()
Tim Peters495ad3c2001-01-15 01:36:40 +0000416 # According to RFC1869 some (badly written)
417 # MTA's will disconnect on an ehlo. Toss an exception if
Guido van Rossumfcfb6321998-08-04 15:29:54 +0000418 # that happens -ddm
419 if code == -1 and len(msg) == 0:
Barry Warsaw76750972001-12-14 20:34:20 +0000420 self.close()
Guido van Rossum40233ea1999-01-15 03:23:55 +0000421 raise SMTPServerDisconnected("Server not connected")
Giampaolo Rodolà5c12ec62011-02-24 20:43:11 +0000422 self.ehlo_resp = msg
Fred Drake8152d322000-12-12 23:20:45 +0000423 if code != 250:
Giampaolo Rodolà5c12ec62011-02-24 20:43:11 +0000424 return (code, msg)
425 self.does_esmtp = 1
Thomas Wouters7e474022000-07-16 12:04:32 +0000426 #parse the ehlo response -ddm
Giampaolo Rodolà5c12ec62011-02-24 20:43:11 +0000427 resp = self.ehlo_resp.split('\n')
Guido van Rossumfcfb6321998-08-04 15:29:54 +0000428 del resp[0]
Guido van Rossum2880f6e1998-08-10 20:07:00 +0000429 for each in resp:
Piers Lauder385a77a2002-07-27 00:38:30 +0000430 # To be able to communicate with as many SMTP servers as possible,
431 # we have to take the old-style auth advertisement into account,
432 # because:
433 # 1) Else our SMTP feature parser gets confused.
434 # 2) There are some servers that only advertise the auth methods we
435 # support using the old style.
436 auth_match = OLDSTYLE_AUTH.match(each)
437 if auth_match:
438 # This doesn't remove duplicates, but that's no problem
439 self.esmtp_features["auth"] = self.esmtp_features.get("auth", "") \
440 + " " + auth_match.groups(0)[0]
441 continue
442
Barry Warsawbe22ae62002-04-15 20:03:30 +0000443 # RFC 1869 requires a space between ehlo keyword and parameters.
444 # It's actually stricter, in that only spaces are allowed between
445 # parameters, but were not going to check for that here. Note
446 # that the space isn't present if there are no parameters.
Giampaolo Rodolà5c12ec62011-02-24 20:43:11 +0000447 m = re.match(r'(?P<feature>[A-Za-z0-9][A-Za-z0-9\-]*) ?', each)
Guido van Rossumfcfb6321998-08-04 15:29:54 +0000448 if m:
Giampaolo Rodolà5c12ec62011-02-24 20:43:11 +0000449 feature = m.group("feature").lower()
450 params = m.string[m.end("feature"):].strip()
Piers Lauder385a77a2002-07-27 00:38:30 +0000451 if feature == "auth":
452 self.esmtp_features[feature] = self.esmtp_features.get(feature, "") \
453 + " " + params
454 else:
Giampaolo Rodolà5c12ec62011-02-24 20:43:11 +0000455 self.esmtp_features[feature] = params
456 return (code, msg)
Guido van Rossum95e6f701998-06-25 02:15:50 +0000457
Guido van Rossumfcfb6321998-08-04 15:29:54 +0000458 def has_extn(self, opt):
459 """Does the server support a given SMTP service extension?"""
Raymond Hettinger54f02222002-06-01 14:18:47 +0000460 return opt.lower() in self.esmtp_features
Guido van Rossum95e6f701998-06-25 02:15:50 +0000461
Guido van Rossum18586f41998-04-03 17:03:13 +0000462 def help(self, args=''):
Barry Warsawa7d9bdf1998-12-22 03:24:27 +0000463 """SMTP 'help' command.
464 Returns help text from server."""
Guido van Rossum18586f41998-04-03 17:03:13 +0000465 self.putcmd("help", args)
Kurt B. Kaiser58bd1902005-06-26 18:27:36 +0000466 return self.getreply()[1]
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000467
468 def rset(self):
Barry Warsawa7d9bdf1998-12-22 03:24:27 +0000469 """SMTP 'rset' command -- resets session."""
Guido van Rossum296e1431999-04-07 15:03:39 +0000470 return self.docmd("rset")
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000471
472 def noop(self):
Barry Warsawa7d9bdf1998-12-22 03:24:27 +0000473 """SMTP 'noop' command -- doesn't do anything :>"""
Guido van Rossum296e1431999-04-07 15:03:39 +0000474 return self.docmd("noop")
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000475
Giampaolo Rodolà5c12ec62011-02-24 20:43:11 +0000476 def mail(self, sender, options=[]):
Barry Warsawa7d9bdf1998-12-22 03:24:27 +0000477 """SMTP 'mail' command -- begins mail xfer session."""
Guido van Rossumfcfb6321998-08-04 15:29:54 +0000478 optionlist = ''
479 if options and self.does_esmtp:
Eric S. Raymondc013f302001-02-09 05:40:38 +0000480 optionlist = ' ' + ' '.join(options)
Giampaolo Rodolà5c12ec62011-02-24 20:43:11 +0000481 self.putcmd("mail", "FROM:%s%s" % (quoteaddr(sender), optionlist))
Guido van Rossum45e2fbc1998-03-26 21:13:24 +0000482 return self.getreply()
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000483
Giampaolo Rodolà5c12ec62011-02-24 20:43:11 +0000484 def rcpt(self, recip, options=[]):
Barry Warsawa7d9bdf1998-12-22 03:24:27 +0000485 """SMTP 'rcpt' command -- indicates 1 recipient for this mail."""
Guido van Rossumfcfb6321998-08-04 15:29:54 +0000486 optionlist = ''
487 if options and self.does_esmtp:
Eric S. Raymondc013f302001-02-09 05:40:38 +0000488 optionlist = ' ' + ' '.join(options)
Giampaolo Rodolà5c12ec62011-02-24 20:43:11 +0000489 self.putcmd("rcpt", "TO:%s%s" % (quoteaddr(recip), optionlist))
Guido van Rossum45e2fbc1998-03-26 21:13:24 +0000490 return self.getreply()
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000491
Giampaolo Rodolà5c12ec62011-02-24 20:43:11 +0000492 def data(self, msg):
Tim Peters495ad3c2001-01-15 01:36:40 +0000493 """SMTP 'DATA' command -- sends message data to server.
Guido van Rossum296e1431999-04-07 15:03:39 +0000494
Barry Warsaw4c4bec81998-12-22 03:02:20 +0000495 Automatically quotes lines beginning with a period per rfc821.
Guido van Rossum296e1431999-04-07 15:03:39 +0000496 Raises SMTPDataError if there is an unexpected reply to the
497 DATA command; the return value from this method is the final
498 response code received when the all data is sent.
Barry Warsaw4c4bec81998-12-22 03:02:20 +0000499 """
Guido van Rossum45e2fbc1998-03-26 21:13:24 +0000500 self.putcmd("data")
Giampaolo Rodolà5c12ec62011-02-24 20:43:11 +0000501 (code, repl) = self.getreply()
502 if self.debuglevel > 0:
503 print>>stderr, "data:", (code, repl)
Fred Drake8152d322000-12-12 23:20:45 +0000504 if code != 354:
Giampaolo Rodolà5c12ec62011-02-24 20:43:11 +0000505 raise SMTPDataError(code, repl)
Guido van Rossum45e2fbc1998-03-26 21:13:24 +0000506 else:
Guido van Rossum20c92281999-04-21 16:52:20 +0000507 q = quotedata(msg)
508 if q[-2:] != CRLF:
509 q = q + CRLF
510 q = q + "." + CRLF
511 self.send(q)
Giampaolo Rodolà5c12ec62011-02-24 20:43:11 +0000512 (code, msg) = self.getreply()
513 if self.debuglevel > 0:
514 print>>stderr, "data:", (code, msg)
515 return (code, msg)
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000516
Guido van Rossumfcfb6321998-08-04 15:29:54 +0000517 def verify(self, address):
Barry Warsawa7d9bdf1998-12-22 03:24:27 +0000518 """SMTP 'verify' command -- checks for address validity."""
R David Murray95225952011-07-18 21:34:04 -0400519 self.putcmd("vrfy", _addr_only(address))
Guido van Rossumfcfb6321998-08-04 15:29:54 +0000520 return self.getreply()
Barry Warsaw4c4bec81998-12-22 03:02:20 +0000521 # a.k.a.
Giampaolo Rodolà5c12ec62011-02-24 20:43:11 +0000522 vrfy = verify
Guido van Rossumfcfb6321998-08-04 15:29:54 +0000523
524 def expn(self, address):
Facundo Batista16609332008-02-23 12:27:17 +0000525 """SMTP 'expn' command -- expands a mailing list."""
R David Murray95225952011-07-18 21:34:04 -0400526 self.putcmd("expn", _addr_only(address))
Guido van Rossumfcfb6321998-08-04 15:29:54 +0000527 return self.getreply()
528
Barry Warsaw4c4bec81998-12-22 03:02:20 +0000529 # some useful methods
Guido van Rossumae010462001-09-11 15:57:46 +0000530
Gregory P. Smithbde4ae42008-01-17 08:35:49 +0000531 def ehlo_or_helo_if_needed(self):
532 """Call self.ehlo() and/or self.helo() if needed.
533
534 If there has been no previous EHLO or HELO command this session, this
535 method tries ESMTP EHLO first.
536
537 This method may raise the following exceptions:
538
539 SMTPHeloError The server didn't reply properly to
540 the helo greeting.
541 """
542 if self.helo_resp is None and self.ehlo_resp is None:
543 if not (200 <= self.ehlo()[0] <= 299):
544 (code, resp) = self.helo()
545 if not (200 <= code <= 299):
546 raise SMTPHeloError(code, resp)
547
Guido van Rossumae010462001-09-11 15:57:46 +0000548 def login(self, user, password):
549 """Log in on an SMTP server that requires authentication.
550
551 The arguments are:
552 - user: The user name to authenticate with.
553 - password: The password for the authentication.
554
555 If there has been no previous EHLO or HELO command this session, this
556 method tries ESMTP EHLO first.
557
558 This method will return normally if the authentication was successful.
559
560 This method may raise the following exceptions:
561
562 SMTPHeloError The server didn't reply properly to
563 the helo greeting.
564 SMTPAuthenticationError The server didn't accept the username/
565 password combination.
Fred Drake2f8f4d32001-10-13 18:35:32 +0000566 SMTPException No suitable authentication method was
Guido van Rossumae010462001-09-11 15:57:46 +0000567 found.
568 """
569
570 def encode_cram_md5(challenge, user, password):
571 challenge = base64.decodestring(challenge)
572 response = user + " " + hmac.HMAC(password, challenge).hexdigest()
Piers Lauder385a77a2002-07-27 00:38:30 +0000573 return encode_base64(response, eol="")
Guido van Rossumae010462001-09-11 15:57:46 +0000574
575 def encode_plain(user, password):
Johannes Gijsbers25946dd2004-12-06 21:25:26 +0000576 return encode_base64("\0%s\0%s" % (user, password), eol="")
Tim Peters469cdad2002-08-08 20:19:19 +0000577
Guido van Rossumae010462001-09-11 15:57:46 +0000578
579 AUTH_PLAIN = "PLAIN"
580 AUTH_CRAM_MD5 = "CRAM-MD5"
Piers Lauder385a77a2002-07-27 00:38:30 +0000581 AUTH_LOGIN = "LOGIN"
Guido van Rossumae010462001-09-11 15:57:46 +0000582
Gregory P. Smithbde4ae42008-01-17 08:35:49 +0000583 self.ehlo_or_helo_if_needed()
Guido van Rossumae010462001-09-11 15:57:46 +0000584
585 if not self.has_extn("auth"):
586 raise SMTPException("SMTP AUTH extension not supported by server.")
587
588 # Authentication methods the server supports:
589 authlist = self.esmtp_features["auth"].split()
590
591 # List of authentication methods we support: from preferred to
592 # less preferred methods. Except for the purpose of testing the weaker
593 # ones, we prefer stronger methods like CRAM-MD5:
Piers Lauder385a77a2002-07-27 00:38:30 +0000594 preferred_auths = [AUTH_CRAM_MD5, AUTH_PLAIN, AUTH_LOGIN]
Guido van Rossumae010462001-09-11 15:57:46 +0000595
596 # Determine the authentication method we'll use
597 authmethod = None
598 for method in preferred_auths:
599 if method in authlist:
600 authmethod = method
601 break
Tim Petersb64bec32001-09-18 02:26:39 +0000602
Guido van Rossumae010462001-09-11 15:57:46 +0000603 if authmethod == AUTH_CRAM_MD5:
604 (code, resp) = self.docmd("AUTH", AUTH_CRAM_MD5)
605 if code == 503:
606 # 503 == 'Error: already authenticated'
607 return (code, resp)
608 (code, resp) = self.docmd(encode_cram_md5(resp, user, password))
609 elif authmethod == AUTH_PLAIN:
Tim Petersb64bec32001-09-18 02:26:39 +0000610 (code, resp) = self.docmd("AUTH",
Guido van Rossumae010462001-09-11 15:57:46 +0000611 AUTH_PLAIN + " " + encode_plain(user, password))
Piers Lauder385a77a2002-07-27 00:38:30 +0000612 elif authmethod == AUTH_LOGIN:
613 (code, resp) = self.docmd("AUTH",
614 "%s %s" % (AUTH_LOGIN, encode_base64(user, eol="")))
615 if code != 334:
616 raise SMTPAuthenticationError(code, resp)
Martin v. Löwis49c05d32002-10-06 17:55:08 +0000617 (code, resp) = self.docmd(encode_base64(password, eol=""))
Raymond Hettinger7fdfc2d2002-05-31 17:49:10 +0000618 elif authmethod is None:
Fred Drake2f8f4d32001-10-13 18:35:32 +0000619 raise SMTPException("No suitable authentication method found.")
Raymond Hettingerdbecd932005-02-06 06:57:08 +0000620 if code not in (235, 503):
Guido van Rossumae010462001-09-11 15:57:46 +0000621 # 235 == 'Authentication successful'
622 # 503 == 'Error: already authenticated'
623 raise SMTPAuthenticationError(code, resp)
624 return (code, resp)
625
Giampaolo Rodolà5c12ec62011-02-24 20:43:11 +0000626 def starttls(self, keyfile=None, certfile=None):
Guido van Rossumf7fcf5e2001-09-14 16:08:44 +0000627 """Puts the connection to the SMTP server into TLS mode.
Tim Petersb64bec32001-09-18 02:26:39 +0000628
Gregory P. Smithbde4ae42008-01-17 08:35:49 +0000629 If there has been no previous EHLO or HELO command this session, this
630 method tries ESMTP EHLO first.
631
Guido van Rossumf7fcf5e2001-09-14 16:08:44 +0000632 If the server supports TLS, this will encrypt the rest of the SMTP
633 session. If you provide the keyfile and certfile parameters,
634 the identity of the SMTP server and client can be checked. This,
635 however, depends on whether the socket module really checks the
636 certificates.
Gregory P. Smithbde4ae42008-01-17 08:35:49 +0000637
638 This method may raise the following exceptions:
639
640 SMTPHeloError The server didn't reply properly to
641 the helo greeting.
Guido van Rossumf7fcf5e2001-09-14 16:08:44 +0000642 """
Gregory P. Smithbde4ae42008-01-17 08:35:49 +0000643 self.ehlo_or_helo_if_needed()
644 if not self.has_extn("starttls"):
645 raise SMTPException("STARTTLS extension not supported by server.")
Tim Petersb64bec32001-09-18 02:26:39 +0000646 (resp, reply) = self.docmd("STARTTLS")
Guido van Rossumf7fcf5e2001-09-14 16:08:44 +0000647 if resp == 220:
Bill Janssen426ea0a2007-08-29 22:35:05 +0000648 if not _have_ssl:
649 raise RuntimeError("No SSL support included in this Python")
Bill Janssen98d19da2007-09-10 21:51:02 +0000650 self.sock = ssl.wrap_socket(self.sock, keyfile, certfile)
Bill Janssen426ea0a2007-08-29 22:35:05 +0000651 self.file = SSLFakeFile(self.sock)
Gregory P. Smith63bfc1d2008-01-17 07:43:20 +0000652 # RFC 3207:
653 # The client MUST discard any knowledge obtained from
654 # the server, such as the list of SMTP service extensions,
655 # which was not obtained from the TLS negotiation itself.
656 self.helo_resp = None
657 self.ehlo_resp = None
658 self.esmtp_features = {}
659 self.does_esmtp = 0
Benjamin Peterson2e1b7fc2016-06-11 13:16:42 -0700660 else:
661 # RFC 3207:
662 # 501 Syntax error (no parameters allowed)
663 # 454 TLS not available due to temporary reason
664 raise SMTPResponseException(resp, reply)
Guido van Rossumf7fcf5e2001-09-14 16:08:44 +0000665 return (resp, reply)
Tim Petersb64bec32001-09-18 02:26:39 +0000666
Jeremy Hylton31bb8ce1998-08-13 19:57:46 +0000667 def sendmail(self, from_addr, to_addrs, msg, mail_options=[],
Tim Peters495ad3c2001-01-15 01:36:40 +0000668 rcpt_options=[]):
669 """This command performs an entire mail transaction.
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000670
Tim Peters495ad3c2001-01-15 01:36:40 +0000671 The arguments are:
Barry Warsaw4c4bec81998-12-22 03:02:20 +0000672 - from_addr : The address sending this mail.
673 - to_addrs : A list of addresses to send this mail to. A bare
674 string will be treated as a list with 1 address.
Tim Peters495ad3c2001-01-15 01:36:40 +0000675 - msg : The message to send.
Barry Warsaw4c4bec81998-12-22 03:02:20 +0000676 - mail_options : List of ESMTP options (such as 8bitmime) for the
677 mail command.
678 - rcpt_options : List of ESMTP options (such as DSN commands) for
679 all the rcpt commands.
680
681 If there has been no previous EHLO or HELO command this session, this
682 method tries ESMTP EHLO first. If the server does ESMTP, message size
683 and each of the specified options will be passed to it. If EHLO
684 fails, HELO will be tried and ESMTP options suppressed.
685
686 This method will return normally if the mail is accepted for at least
Barry Warsawd25c1b71999-11-28 17:11:06 +0000687 one recipient. It returns a dictionary, with one entry for each
688 recipient that was refused. Each entry contains a tuple of the SMTP
689 error code and the accompanying error message sent by the server.
Guido van Rossum296e1431999-04-07 15:03:39 +0000690
691 This method may raise the following exceptions:
692
693 SMTPHeloError The server didn't reply properly to
Tim Peters495ad3c2001-01-15 01:36:40 +0000694 the helo greeting.
Barry Warsawd25c1b71999-11-28 17:11:06 +0000695 SMTPRecipientsRefused The server rejected ALL recipients
Guido van Rossum296e1431999-04-07 15:03:39 +0000696 (no mail was sent).
697 SMTPSenderRefused The server didn't accept the from_addr.
698 SMTPDataError The server replied with an unexpected
699 error code (other than a refusal of
700 a recipient).
701
702 Note: the connection will be open even after an exception is raised.
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000703
Guido van Rossum95e6f701998-06-25 02:15:50 +0000704 Example:
Tim Peters495ad3c2001-01-15 01:36:40 +0000705
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000706 >>> import smtplib
707 >>> s=smtplib.SMTP("localhost")
Guido van Rossumfc40a831998-01-29 17:26:45 +0000708 >>> tolist=["one@one.org","two@two.org","three@three.org","four@four.org"]
Martin v. Löwis301b1cd2002-07-28 16:52:01 +0000709 >>> msg = '''\\
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000710 ... From: Me@my.org
711 ... Subject: testin'...
712 ...
713 ... This is a test '''
714 >>> s.sendmail("me@my.org",tolist,msg)
715 { "three@three.org" : ( 550 ,"User unknown" ) }
716 >>> s.quit()
Tim Peters495ad3c2001-01-15 01:36:40 +0000717
Barry Warsaw4c4bec81998-12-22 03:02:20 +0000718 In the above example, the message was accepted for delivery to three
719 of the four addresses, and one was rejected, with the error code
Barry Warsawd25c1b71999-11-28 17:11:06 +0000720 550. If all addresses are accepted, then the method will return an
Barry Warsaw4c4bec81998-12-22 03:02:20 +0000721 empty dictionary.
722
723 """
Gregory P. Smithbde4ae42008-01-17 08:35:49 +0000724 self.ehlo_or_helo_if_needed()
Guido van Rossum95e6f701998-06-25 02:15:50 +0000725 esmtp_opts = []
Guido van Rossumfcfb6321998-08-04 15:29:54 +0000726 if self.does_esmtp:
727 # Hmmm? what's this? -ddm
728 # self.esmtp_features['7bit']=""
729 if self.has_extn('size'):
Walter Dörwald70a6b492004-02-12 17:35:32 +0000730 esmtp_opts.append("size=%d" % len(msg))
Guido van Rossumfcfb6321998-08-04 15:29:54 +0000731 for option in mail_options:
Guido van Rossum95e6f701998-06-25 02:15:50 +0000732 esmtp_opts.append(option)
Guido van Rossumfcfb6321998-08-04 15:29:54 +0000733
Giampaolo Rodolà5c12ec62011-02-24 20:43:11 +0000734 (code, resp) = self.mail(from_addr, esmtp_opts)
Fred Drake8152d322000-12-12 23:20:45 +0000735 if code != 250:
Guido van Rossum45e2fbc1998-03-26 21:13:24 +0000736 self.rset()
Guido van Rossum296e1431999-04-07 15:03:39 +0000737 raise SMTPSenderRefused(code, resp, from_addr)
Giampaolo Rodolà5c12ec62011-02-24 20:43:11 +0000738 senderrs = {}
Walter Dörwald65230a22002-06-03 15:58:32 +0000739 if isinstance(to_addrs, basestring):
Jeremy Hylton31bb8ce1998-08-13 19:57:46 +0000740 to_addrs = [to_addrs]
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000741 for each in to_addrs:
Giampaolo Rodolà5c12ec62011-02-24 20:43:11 +0000742 (code, resp) = self.rcpt(each, rcpt_options)
Fred Drake8152d322000-12-12 23:20:45 +0000743 if (code != 250) and (code != 251):
Giampaolo Rodolà5c12ec62011-02-24 20:43:11 +0000744 senderrs[each] = (code, resp)
745 if len(senderrs) == len(to_addrs):
Guido van Rossum95e6f701998-06-25 02:15:50 +0000746 # the server refused all our recipients
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000747 self.rset()
Guido van Rossum296e1431999-04-07 15:03:39 +0000748 raise SMTPRecipientsRefused(senderrs)
Giampaolo Rodolà5c12ec62011-02-24 20:43:11 +0000749 (code, resp) = self.data(msg)
Fred Drake8152d322000-12-12 23:20:45 +0000750 if code != 250:
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000751 self.rset()
Guido van Rossum296e1431999-04-07 15:03:39 +0000752 raise SMTPDataError(code, resp)
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000753 #if we got here then somebody got our mail
Tim Peters495ad3c2001-01-15 01:36:40 +0000754 return senderrs
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000755
756
757 def close(self):
758 """Close the connection to the SMTP server."""
Serhiy Storchaka1aa2c0f2015-04-10 13:24:10 +0300759 try:
760 file = self.file
761 self.file = None
762 if file:
763 file.close()
764 finally:
765 sock = self.sock
766 self.sock = None
767 if sock:
768 sock.close()
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000769
770
771 def quit(self):
Guido van Rossum95e6f701998-06-25 02:15:50 +0000772 """Terminate the SMTP session."""
Georg Brandldeaf2ca2008-03-27 13:27:31 +0000773 res = self.docmd("quit")
R David Murray7234e032014-08-30 16:56:49 -0400774 # A new EHLO is required after reconnecting with connect()
775 self.ehlo_resp = self.helo_resp = None
776 self.esmtp_features = {}
777 self.does_esmtp = False
Guido van Rossum45e2fbc1998-03-26 21:13:24 +0000778 self.close()
Georg Brandldeaf2ca2008-03-27 13:27:31 +0000779 return res
Guido van Rossum95e6f701998-06-25 02:15:50 +0000780
Bill Janssen426ea0a2007-08-29 22:35:05 +0000781if _have_ssl:
Martin v. Löwisee82c0e2006-10-27 07:13:28 +0000782
Bill Janssen426ea0a2007-08-29 22:35:05 +0000783 class SMTP_SSL(SMTP):
R David Murray95752222013-06-23 16:10:37 -0400784 """ This is a subclass derived from SMTP that connects over an SSL
785 encrypted socket (to use this class you need a socket module that was
786 compiled with SSL support). If host is not specified, '' (the local
787 host) is used. If port is omitted, the standard SMTP-over-SSL port
788 (465) is used. local_hostname has the same meaning as it does in the
789 SMTP class. keyfile and certfile are also optional - they can contain
790 a PEM formatted private key and certificate chain file for the SSL
791 connection.
792
Bill Janssen426ea0a2007-08-29 22:35:05 +0000793 """
Antoine Pitrou21ce8f02011-05-07 19:59:33 +0200794
795 default_port = SMTP_SSL_PORT
796
Bill Janssen426ea0a2007-08-29 22:35:05 +0000797 def __init__(self, host='', port=0, local_hostname=None,
Facundo Batista4f1b1ed2008-05-29 16:39:26 +0000798 keyfile=None, certfile=None,
799 timeout=socket._GLOBAL_DEFAULT_TIMEOUT):
Bill Janssen426ea0a2007-08-29 22:35:05 +0000800 self.keyfile = keyfile
801 self.certfile = certfile
802 SMTP.__init__(self, host, port, local_hostname, timeout)
Bill Janssen426ea0a2007-08-29 22:35:05 +0000803
804 def _get_socket(self, host, port, timeout):
Giampaolo Rodolà5c12ec62011-02-24 20:43:11 +0000805 if self.debuglevel > 0:
806 print>>stderr, 'connect:', (host, port)
R. David Murrayad3058e2009-05-23 00:48:58 +0000807 new_socket = socket.create_connection((host, port), timeout)
808 new_socket = ssl.wrap_socket(new_socket, self.keyfile, self.certfile)
809 self.file = SSLFakeFile(new_socket)
810 return new_socket
Barry Warsaw4c4bec81998-12-22 03:02:20 +0000811
Thomas Woutersa6900e82007-08-30 21:54:39 +0000812 __all__.append("SMTP_SSL")
813
Martin v. Löwis1190a382007-03-09 15:35:55 +0000814#
815# LMTP extension
816#
817LMTP_PORT = 2003
818
819class LMTP(SMTP):
820 """LMTP - Local Mail Transfer Protocol
821
822 The LMTP protocol, which is very similar to ESMTP, is heavily based
R David Murray95752222013-06-23 16:10:37 -0400823 on the standard SMTP client. It's common to use Unix sockets for
824 LMTP, so our connect() method must support that as well as a regular
825 host:port server. local_hostname has the same meaning as it does in
826 the SMTP class. To specify a Unix socket, you must use an absolute
Martin v. Löwis1190a382007-03-09 15:35:55 +0000827 path as the host, starting with a '/'.
828
829 Authentication is supported, using the regular SMTP mechanism. When
830 using a Unix socket, LMTP generally don't support or require any
831 authentication, but your mileage might vary."""
832
833 ehlo_msg = "lhlo"
Tim Petersea5962f2007-03-12 18:07:52 +0000834
Giampaolo Rodolà5c12ec62011-02-24 20:43:11 +0000835 def __init__(self, host='', port=LMTP_PORT, local_hostname=None):
Martin v. Löwis1190a382007-03-09 15:35:55 +0000836 """Initialize a new instance."""
837 SMTP.__init__(self, host, port, local_hostname)
838
Giampaolo Rodolà5c12ec62011-02-24 20:43:11 +0000839 def connect(self, host='localhost', port=0):
Martin v. Löwis1190a382007-03-09 15:35:55 +0000840 """Connect to the LMTP daemon, on either a Unix or a TCP socket."""
Neal Norwitzc8f6c232007-03-10 03:19:18 +0000841 if host[0] != '/':
Martin v. Löwis1190a382007-03-09 15:35:55 +0000842 return SMTP.connect(self, host, port)
843
Neal Norwitzc8f6c232007-03-10 03:19:18 +0000844 # Handle Unix-domain sockets.
845 try:
846 self.sock = socket.socket(socket.AF_UNIX, socket.SOCK_STREAM)
847 self.sock.connect(host)
Andrew Svetloved3f6c62012-12-17 19:06:43 +0200848 except socket.error:
Giampaolo Rodolà5c12ec62011-02-24 20:43:11 +0000849 if self.debuglevel > 0:
850 print>>stderr, 'connect fail:', host
Neal Norwitzc8f6c232007-03-10 03:19:18 +0000851 if self.sock:
852 self.sock.close()
853 self.sock = None
Andrew Svetloved3f6c62012-12-17 19:06:43 +0200854 raise
Neal Norwitzc8f6c232007-03-10 03:19:18 +0000855 (code, msg) = self.getreply()
Giampaolo Rodolà5c12ec62011-02-24 20:43:11 +0000856 if self.debuglevel > 0:
857 print>>stderr, "connect:", msg
Neal Norwitzc8f6c232007-03-10 03:19:18 +0000858 return (code, msg)
859
Martin v. Löwis1190a382007-03-09 15:35:55 +0000860
Guido van Rossum95e6f701998-06-25 02:15:50 +0000861# Test the sendmail method, which tests most of the others.
862# Note: This always sends to localhost.
863if __name__ == '__main__':
Andrew M. Kuchling6be424f2001-08-13 14:41:39 +0000864 import sys
Guido van Rossum95e6f701998-06-25 02:15:50 +0000865
866 def prompt(prompt):
867 sys.stdout.write(prompt + ": ")
Eric S. Raymondc013f302001-02-09 05:40:38 +0000868 return sys.stdin.readline().strip()
Guido van Rossum95e6f701998-06-25 02:15:50 +0000869
870 fromaddr = prompt("From")
Giampaolo Rodolà5c12ec62011-02-24 20:43:11 +0000871 toaddrs = prompt("To").split(',')
Guido van Rossum95e6f701998-06-25 02:15:50 +0000872 print "Enter message, end with ^D:"
873 msg = ''
874 while 1:
875 line = sys.stdin.readline()
876 if not line:
877 break
878 msg = msg + line
Walter Dörwald70a6b492004-02-12 17:35:32 +0000879 print "Message length is %d" % len(msg)
Guido van Rossum95e6f701998-06-25 02:15:50 +0000880
881 server = SMTP('localhost')
882 server.set_debuglevel(1)
883 server.sendmail(fromaddr, toaddrs, msg)
884 server.quit()