blob: 7f07840044b4b7fa1b44db57f170e308f175ac02 [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"
Guido van Rossumbbe323e1998-01-29 17:24:40 +000060
Piers Lauder385a77a2002-07-27 00:38:30 +000061OLDSTYLE_AUTH = re.compile(r"auth=(.*)", re.I)
62
Giampaolo Rodolà5c12ec62011-02-24 20:43:11 +000063
Tim Peters495ad3c2001-01-15 01:36:40 +000064# Exception classes used by this module.
Guido van Rossum296e1431999-04-07 15:03:39 +000065class SMTPException(Exception):
66 """Base class for all exceptions raised by this module."""
67
68class SMTPServerDisconnected(SMTPException):
69 """Not connected to any SMTP server.
70
71 This exception is raised when the server unexpectedly disconnects,
72 or when an attempt is made to use the SMTP instance before
73 connecting it to a server.
74 """
75
76class SMTPResponseException(SMTPException):
77 """Base class for all exceptions that include an SMTP error code.
78
79 These exceptions are generated in some instances when the SMTP
80 server returns an error code. The error code is stored in the
81 `smtp_code' attribute of the error, and the `smtp_error' attribute
82 is set to the error message.
83 """
84
85 def __init__(self, code, msg):
86 self.smtp_code = code
87 self.smtp_error = msg
88 self.args = (code, msg)
89
90class SMTPSenderRefused(SMTPResponseException):
91 """Sender address refused.
Guido van Rossumae010462001-09-11 15:57:46 +000092
Guido van Rossum296e1431999-04-07 15:03:39 +000093 In addition to the attributes set by on all SMTPResponseException
Barry Warsawd25c1b71999-11-28 17:11:06 +000094 exceptions, this sets `sender' to the string that the SMTP refused.
Guido van Rossum296e1431999-04-07 15:03:39 +000095 """
96
97 def __init__(self, code, msg, sender):
98 self.smtp_code = code
99 self.smtp_error = msg
100 self.sender = sender
101 self.args = (code, msg, sender)
102
Guido van Rossum20c92281999-04-21 16:52:20 +0000103class SMTPRecipientsRefused(SMTPException):
Barry Warsawd25c1b71999-11-28 17:11:06 +0000104 """All recipient addresses refused.
Guido van Rossumae010462001-09-11 15:57:46 +0000105
Thomas Wouters7e474022000-07-16 12:04:32 +0000106 The errors for each recipient are accessible through the attribute
Tim Peters495ad3c2001-01-15 01:36:40 +0000107 'recipients', which is a dictionary of exactly the same sort as
108 SMTP.sendmail() returns.
Guido van Rossum296e1431999-04-07 15:03:39 +0000109 """
110
111 def __init__(self, recipients):
112 self.recipients = recipients
Giampaolo Rodolà5c12ec62011-02-24 20:43:11 +0000113 self.args = (recipients,)
Guido van Rossum296e1431999-04-07 15:03:39 +0000114
115
Guido van Rossum296e1431999-04-07 15:03:39 +0000116class SMTPDataError(SMTPResponseException):
117 """The SMTP server didn't accept the data."""
118
119class SMTPConnectError(SMTPResponseException):
Barry Warsawd25c1b71999-11-28 17:11:06 +0000120 """Error during connection establishment."""
Guido van Rossum296e1431999-04-07 15:03:39 +0000121
122class SMTPHeloError(SMTPResponseException):
Barry Warsawd25c1b71999-11-28 17:11:06 +0000123 """The server refused our HELO reply."""
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000124
Guido van Rossumae010462001-09-11 15:57:46 +0000125class SMTPAuthenticationError(SMTPResponseException):
126 """Authentication error.
127
128 Most probably the server didn't accept the username/password
129 combination provided.
130 """
Peter Schneider-Kamp7bc82bb2000-08-10 14:02:23 +0000131
Giampaolo Rodolà5c12ec62011-02-24 20:43:11 +0000132
Guido van Rossum69a79bc1998-07-13 15:18:49 +0000133def quoteaddr(addr):
134 """Quote a subset of the email addresses defined by RFC 821.
135
Barry Warsawa7d9bdf1998-12-22 03:24:27 +0000136 Should be able to handle anything rfc822.parseaddr can handle.
137 """
Raymond Hettinger342456d2002-09-05 01:14:07 +0000138 m = (None, None)
Guido van Rossum69a79bc1998-07-13 15:18:49 +0000139 try:
Georg Brandl5a096e12007-01-22 19:40:21 +0000140 m = email.utils.parseaddr(addr)[1]
Guido van Rossumfcfb6321998-08-04 15:29:54 +0000141 except AttributeError:
142 pass
Giampaolo Rodolà5c12ec62011-02-24 20:43:11 +0000143 if m == (None, None): # Indicates parse failure or AttributeError
Georg Brandlbd3bc4d2006-02-17 09:52:53 +0000144 # something weird here.. punt -ddm
Raymond Hettinger342456d2002-09-05 01:14:07 +0000145 return "<%s>" % addr
Georg Brandlbd3bc4d2006-02-17 09:52:53 +0000146 elif m is None:
147 # the sender wants an empty return address
148 return "<>"
Guido van Rossumfcfb6321998-08-04 15:29:54 +0000149 else:
150 return "<%s>" % m
Guido van Rossum69a79bc1998-07-13 15:18:49 +0000151
R David Murray95225952011-07-18 21:34:04 -0400152def _addr_only(addrstring):
153 displayname, addr = email.utils.parseaddr(addrstring)
154 if (displayname, addr) == ('', ''):
155 # parseaddr couldn't parse it, so use it as is.
156 return addrstring
157 return addr
158
Guido van Rossum69a79bc1998-07-13 15:18:49 +0000159def quotedata(data):
160 """Quote data for email.
161
Barry Warsawd25c1b71999-11-28 17:11:06 +0000162 Double leading '.', and change Unix newline '\\n', or Mac '\\r' into
Barry Warsawa7d9bdf1998-12-22 03:24:27 +0000163 Internet CRLF end-of-line.
164 """
Guido van Rossum69a79bc1998-07-13 15:18:49 +0000165 return re.sub(r'(?m)^\.', '..',
Guido van Rossumfcfb6321998-08-04 15:29:54 +0000166 re.sub(r'(?:\r\n|\n|\r(?!\n))', CRLF, data))
Guido van Rossum69a79bc1998-07-13 15:18:49 +0000167
Peter Schneider-Kamp7bc82bb2000-08-10 14:02:23 +0000168
Bill Janssen426ea0a2007-08-29 22:35:05 +0000169try:
170 import ssl
171except ImportError:
172 _have_ssl = False
173else:
Bill Janssen426ea0a2007-08-29 22:35:05 +0000174 class SSLFakeFile:
175 """A fake file like object that really wraps a SSLObject.
176
177 It only supports what is needed in smtplib.
178 """
179 def __init__(self, sslobj):
180 self.sslobj = sslobj
181
182 def readline(self):
183 str = ""
184 chr = None
185 while chr != "\n":
186 chr = self.sslobj.read(1)
Giampaolo Rodolà5c12ec62011-02-24 20:43:11 +0000187 if not chr:
188 break
Bill Janssen426ea0a2007-08-29 22:35:05 +0000189 str += chr
190 return str
191
192 def close(self):
193 pass
194
195 _have_ssl = True
196
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000197class SMTP:
Guido van Rossumfcfb6321998-08-04 15:29:54 +0000198 """This class manages a connection to an SMTP or ESMTP server.
199 SMTP Objects:
Tim Peters495ad3c2001-01-15 01:36:40 +0000200 SMTP objects have the following attributes:
201 helo_resp
202 This is the message given by the server in response to the
Guido van Rossumfcfb6321998-08-04 15:29:54 +0000203 most recent HELO command.
Tim Peters495ad3c2001-01-15 01:36:40 +0000204
Guido van Rossumfcfb6321998-08-04 15:29:54 +0000205 ehlo_resp
Tim Peters495ad3c2001-01-15 01:36:40 +0000206 This is the message given by the server in response to the
Guido van Rossumfcfb6321998-08-04 15:29:54 +0000207 most recent EHLO command. This is usually multiline.
208
Tim Peters495ad3c2001-01-15 01:36:40 +0000209 does_esmtp
Guido van Rossumfcfb6321998-08-04 15:29:54 +0000210 This is a True value _after you do an EHLO command_, if the
211 server supports ESMTP.
212
Tim Peters495ad3c2001-01-15 01:36:40 +0000213 esmtp_features
Guido van Rossumfcfb6321998-08-04 15:29:54 +0000214 This is a dictionary, which, if the server supports ESMTP,
Barry Warsawd25c1b71999-11-28 17:11:06 +0000215 will _after you do an EHLO command_, contain the names of the
216 SMTP service extensions this server supports, and their
Guido van Rossumfcfb6321998-08-04 15:29:54 +0000217 parameters (if any).
Barry Warsawd25c1b71999-11-28 17:11:06 +0000218
Tim Peters495ad3c2001-01-15 01:36:40 +0000219 Note, all extension names are mapped to lower case in the
220 dictionary.
Guido van Rossumfcfb6321998-08-04 15:29:54 +0000221
Barry Warsawd25c1b71999-11-28 17:11:06 +0000222 See each method's docstrings for details. In general, there is a
223 method of the same name to perform each SMTP command. There is also a
224 method called 'sendmail' that will do an entire mail transaction.
225 """
Guido van Rossum95e6f701998-06-25 02:15:50 +0000226 debuglevel = 0
227 file = None
228 helo_resp = None
Martin v. Löwis1190a382007-03-09 15:35:55 +0000229 ehlo_msg = "ehlo"
Guido van Rossum95e6f701998-06-25 02:15:50 +0000230 ehlo_resp = None
Guido van Rossumfcfb6321998-08-04 15:29:54 +0000231 does_esmtp = 0
Antoine Pitrou21ce8f02011-05-07 19:59:33 +0200232 default_port = SMTP_PORT
Guido van Rossum95e6f701998-06-25 02:15:50 +0000233
Facundo Batista4f1b1ed2008-05-29 16:39:26 +0000234 def __init__(self, host='', port=0, local_hostname=None,
235 timeout=socket._GLOBAL_DEFAULT_TIMEOUT):
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000236 """Initialize a new instance.
237
Barry Warsawa7d9bdf1998-12-22 03:24:27 +0000238 If specified, `host' is the name of the remote host to which to
239 connect. If specified, `port' specifies the port to which to connect.
R David Murray2fc97e62013-04-13 14:37:22 -0400240 By default, smtplib.SMTP_PORT is used. If a host is specified the
R David Murray95752222013-06-23 16:10:37 -0400241 connect method is called, and if it returns anything other than a
242 success code an SMTPConnectError is raised. If specified,
R David Murray7f01d552013-06-23 16:02:34 -0400243 `local_hostname` is used as the FQDN of the local host for the
R David Murray95752222013-06-23 16:10:37 -0400244 HELO/EHLO command. Otherwise, the local hostname is found using
245 socket.getfqdn().
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000246
247 """
Facundo Batista366d6262007-03-28 18:25:54 +0000248 self.timeout = timeout
Guido van Rossumfcfb6321998-08-04 15:29:54 +0000249 self.esmtp_features = {}
Guido van Rossum296e1431999-04-07 15:03:39 +0000250 if host:
251 (code, msg) = self.connect(host, port)
252 if code != 220:
253 raise SMTPConnectError(code, msg)
Raymond Hettingerf13eb552002-06-02 00:40:05 +0000254 if local_hostname is not None:
Barry Warsaw13e34f72002-03-26 20:27:35 +0000255 self.local_hostname = local_hostname
Neil Schemenauer6730f262002-03-24 15:30:40 +0000256 else:
Barry Warsaw13e34f72002-03-26 20:27:35 +0000257 # RFC 2821 says we should use the fqdn in the EHLO/HELO verb, and
258 # if that can't be calculated, that we should use a domain literal
259 # instead (essentially an encoded IP address like [A.B.C.D]).
260 fqdn = socket.getfqdn()
261 if '.' in fqdn:
262 self.local_hostname = fqdn
263 else:
264 # We can't find an fqdn hostname, so use a domain literal
Georg Brandldcdfd222006-03-31 19:34:13 +0000265 addr = '127.0.0.1'
266 try:
267 addr = socket.gethostbyname(socket.gethostname())
268 except socket.gaierror:
269 pass
Barry Warsaw13e34f72002-03-26 20:27:35 +0000270 self.local_hostname = '[%s]' % addr
Tim Peters495ad3c2001-01-15 01:36:40 +0000271
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
R David Murrayc993a192013-04-02 12:15:07 -0400281 def _get_socket(self, host, port, timeout):
Martin v. Löwisee82c0e2006-10-27 07:13:28 +0000282 # This makes it simpler for SMTP_SSL to use the SMTP connect code
283 # and just alter the socket connection bit.
Giampaolo Rodolà5c12ec62011-02-24 20:43:11 +0000284 if self.debuglevel > 0:
285 print>>stderr, 'connect:', (host, port)
R David Murrayc993a192013-04-02 12:15:07 -0400286 return socket.create_connection((host, port), timeout)
Martin v. Löwisee82c0e2006-10-27 07:13:28 +0000287
Giampaolo Rodolà5c12ec62011-02-24 20:43:11 +0000288 def connect(self, host='localhost', port=0):
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000289 """Connect to a host on a given port.
Guido van Rossum95e6f701998-06-25 02:15:50 +0000290
Barry Warsaw4c4bec81998-12-22 03:02:20 +0000291 If the hostname ends with a colon (`:') followed by a number, and
292 there is no port specified, that suffix will be stripped off and the
293 number interpreted as the port number to use.
Guido van Rossum95e6f701998-06-25 02:15:50 +0000294
Barry Warsawa7d9bdf1998-12-22 03:24:27 +0000295 Note: This method is automatically invoked by __init__, if a host is
296 specified during instantiation.
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000297
298 """
Martin v. Löwis4eb59402001-07-26 13:37:33 +0000299 if not port and (host.find(':') == host.rfind(':')):
Martin v. Löwisa43c2f82001-07-24 20:34:08 +0000300 i = host.rfind(':')
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000301 if i >= 0:
Giampaolo Rodolà5c12ec62011-02-24 20:43:11 +0000302 host, port = host[:i], host[i + 1:]
303 try:
304 port = int(port)
Eric S. Raymond8d876032001-02-09 10:14:53 +0000305 except ValueError:
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000306 raise socket.error, "nonnumeric port"
Giampaolo Rodolà5c12ec62011-02-24 20:43:11 +0000307 if not port:
308 port = self.default_port
309 if self.debuglevel > 0:
310 print>>stderr, 'connect:', (host, port)
Facundo Batista366d6262007-03-28 18:25:54 +0000311 self.sock = self._get_socket(host, port, self.timeout)
Martin v. Löwisa43c2f82001-07-24 20:34:08 +0000312 (code, msg) = self.getreply()
Giampaolo Rodolà5c12ec62011-02-24 20:43:11 +0000313 if self.debuglevel > 0:
314 print>>stderr, "connect:", msg
Martin v. Löwisa43c2f82001-07-24 20:34:08 +0000315 return (code, msg)
Tim Peters495ad3c2001-01-15 01:36:40 +0000316
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000317 def send(self, str):
318 """Send `str' to the server."""
Giampaolo Rodolà5c12ec62011-02-24 20:43:11 +0000319 if self.debuglevel > 0:
320 print>>stderr, 'send:', repr(str)
Facundo Batista16609332008-02-23 12:27:17 +0000321 if hasattr(self, 'sock') and self.sock:
Guido van Rossum2880f6e1998-08-10 20:07:00 +0000322 try:
Martin v. Löwise12454f2002-02-16 23:06:19 +0000323 self.sock.sendall(str)
Guido van Rossum2880f6e1998-08-10 20:07:00 +0000324 except socket.error:
Barry Warsaw76750972001-12-14 20:34:20 +0000325 self.close()
Guido van Rossum40233ea1999-01-15 03:23:55 +0000326 raise SMTPServerDisconnected('Server not connected')
Guido van Rossumfc40a831998-01-29 17:26:45 +0000327 else:
Guido van Rossum40233ea1999-01-15 03:23:55 +0000328 raise SMTPServerDisconnected('please run connect() first')
Tim Peters495ad3c2001-01-15 01:36:40 +0000329
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000330 def putcmd(self, cmd, args=""):
Barry Warsawa7d9bdf1998-12-22 03:24:27 +0000331 """Send a command to the server."""
Guido van Rossumdb23d3d1999-06-09 15:13:10 +0000332 if args == "":
333 str = '%s%s' % (cmd, CRLF)
334 else:
335 str = '%s %s%s' % (cmd, args, CRLF)
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000336 self.send(str)
Tim Peters495ad3c2001-01-15 01:36:40 +0000337
Guido van Rossumfcfb6321998-08-04 15:29:54 +0000338 def getreply(self):
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000339 """Get a reply from the server.
Tim Peters495ad3c2001-01-15 01:36:40 +0000340
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000341 Returns a tuple consisting of:
Barry Warsawa7d9bdf1998-12-22 03:24:27 +0000342
343 - server response code (e.g. '250', or such, if all goes well)
344 Note: returns -1 if it can't read response code.
345
346 - server response string corresponding to response code (multiline
347 responses are converted to a single, multiline string).
Guido van Rossumf123f841999-03-29 20:33:21 +0000348
349 Raises SMTPServerDisconnected if end-of-file is reached.
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000350 """
Giampaolo Rodolà5c12ec62011-02-24 20:43:11 +0000351 resp = []
Guido van Rossum296e1431999-04-07 15:03:39 +0000352 if self.file is None:
353 self.file = self.sock.makefile('rb')
Guido van Rossum45e2fbc1998-03-26 21:13:24 +0000354 while 1:
Kristján Valur Jónsson51a035e2009-01-15 17:20:21 +0000355 try:
356 line = self.file.readline()
Antoine Pitrou0ad73582011-08-28 01:18:31 +0200357 except socket.error as e:
358 self.close()
359 raise SMTPServerDisconnected("Connection unexpectedly closed: "
360 + str(e))
Guido van Rossum296e1431999-04-07 15:03:39 +0000361 if line == '':
362 self.close()
363 raise SMTPServerDisconnected("Connection unexpectedly closed")
Giampaolo Rodolà5c12ec62011-02-24 20:43:11 +0000364 if self.debuglevel > 0:
365 print>>stderr, 'reply:', repr(line)
Eric S. Raymondc013f302001-02-09 05:40:38 +0000366 resp.append(line[4:].strip())
Giampaolo Rodolà5c12ec62011-02-24 20:43:11 +0000367 code = line[:3]
Guido van Rossum296e1431999-04-07 15:03:39 +0000368 # Check that the error code is syntactically correct.
369 # Don't attempt to read a continuation line if it is broken.
370 try:
Eric S. Raymondc013f302001-02-09 05:40:38 +0000371 errcode = int(code)
Guido van Rossum296e1431999-04-07 15:03:39 +0000372 except ValueError:
373 errcode = -1
374 break
Guido van Rossumf123f841999-03-29 20:33:21 +0000375 # Check if multiline response.
Giampaolo Rodolà5c12ec62011-02-24 20:43:11 +0000376 if line[3:4] != "-":
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000377 break
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000378
Eric S. Raymondc013f302001-02-09 05:40:38 +0000379 errmsg = "\n".join(resp)
Tim Peters495ad3c2001-01-15 01:36:40 +0000380 if self.debuglevel > 0:
Giampaolo Rodolà5c12ec62011-02-24 20:43:11 +0000381 print>>stderr, 'reply: retcode (%s); Msg: %s' % (errcode, errmsg)
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000382 return errcode, errmsg
Tim Peters495ad3c2001-01-15 01:36:40 +0000383
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000384 def docmd(self, cmd, args=""):
Barry Warsawa7d9bdf1998-12-22 03:24:27 +0000385 """Send a command, and return its response code."""
Giampaolo Rodolà5c12ec62011-02-24 20:43:11 +0000386 self.putcmd(cmd, args)
Guido van Rossum296e1431999-04-07 15:03:39 +0000387 return self.getreply()
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000388
Barry Warsawa7d9bdf1998-12-22 03:24:27 +0000389 # std smtp commands
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000390 def helo(self, name=''):
Barry Warsawa7d9bdf1998-12-22 03:24:27 +0000391 """SMTP 'helo' command.
392 Hostname to send for this command defaults to the FQDN of the local
393 host.
394 """
Neil Schemenauer6730f262002-03-24 15:30:40 +0000395 self.putcmd("helo", name or self.local_hostname)
Giampaolo Rodolà5c12ec62011-02-24 20:43:11 +0000396 (code, msg) = self.getreply()
397 self.helo_resp = msg
398 return (code, msg)
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000399
Guido van Rossum95e6f701998-06-25 02:15:50 +0000400 def ehlo(self, name=''):
Barry Warsawa7d9bdf1998-12-22 03:24:27 +0000401 """ SMTP 'ehlo' command.
402 Hostname to send for this command defaults to the FQDN of the local
403 host.
404 """
Guido van Rossumf7fcf5e2001-09-14 16:08:44 +0000405 self.esmtp_features = {}
Martin v. Löwis1190a382007-03-09 15:35:55 +0000406 self.putcmd(self.ehlo_msg, name or self.local_hostname)
Giampaolo Rodolà5c12ec62011-02-24 20:43:11 +0000407 (code, msg) = self.getreply()
Tim Peters495ad3c2001-01-15 01:36:40 +0000408 # According to RFC1869 some (badly written)
409 # MTA's will disconnect on an ehlo. Toss an exception if
Guido van Rossumfcfb6321998-08-04 15:29:54 +0000410 # that happens -ddm
411 if code == -1 and len(msg) == 0:
Barry Warsaw76750972001-12-14 20:34:20 +0000412 self.close()
Guido van Rossum40233ea1999-01-15 03:23:55 +0000413 raise SMTPServerDisconnected("Server not connected")
Giampaolo Rodolà5c12ec62011-02-24 20:43:11 +0000414 self.ehlo_resp = msg
Fred Drake8152d322000-12-12 23:20:45 +0000415 if code != 250:
Giampaolo Rodolà5c12ec62011-02-24 20:43:11 +0000416 return (code, msg)
417 self.does_esmtp = 1
Thomas Wouters7e474022000-07-16 12:04:32 +0000418 #parse the ehlo response -ddm
Giampaolo Rodolà5c12ec62011-02-24 20:43:11 +0000419 resp = self.ehlo_resp.split('\n')
Guido van Rossumfcfb6321998-08-04 15:29:54 +0000420 del resp[0]
Guido van Rossum2880f6e1998-08-10 20:07:00 +0000421 for each in resp:
Piers Lauder385a77a2002-07-27 00:38:30 +0000422 # To be able to communicate with as many SMTP servers as possible,
423 # we have to take the old-style auth advertisement into account,
424 # because:
425 # 1) Else our SMTP feature parser gets confused.
426 # 2) There are some servers that only advertise the auth methods we
427 # support using the old style.
428 auth_match = OLDSTYLE_AUTH.match(each)
429 if auth_match:
430 # This doesn't remove duplicates, but that's no problem
431 self.esmtp_features["auth"] = self.esmtp_features.get("auth", "") \
432 + " " + auth_match.groups(0)[0]
433 continue
434
Barry Warsawbe22ae62002-04-15 20:03:30 +0000435 # RFC 1869 requires a space between ehlo keyword and parameters.
436 # It's actually stricter, in that only spaces are allowed between
437 # parameters, but were not going to check for that here. Note
438 # that the space isn't present if there are no parameters.
Giampaolo Rodolà5c12ec62011-02-24 20:43:11 +0000439 m = re.match(r'(?P<feature>[A-Za-z0-9][A-Za-z0-9\-]*) ?', each)
Guido van Rossumfcfb6321998-08-04 15:29:54 +0000440 if m:
Giampaolo Rodolà5c12ec62011-02-24 20:43:11 +0000441 feature = m.group("feature").lower()
442 params = m.string[m.end("feature"):].strip()
Piers Lauder385a77a2002-07-27 00:38:30 +0000443 if feature == "auth":
444 self.esmtp_features[feature] = self.esmtp_features.get(feature, "") \
445 + " " + params
446 else:
Giampaolo Rodolà5c12ec62011-02-24 20:43:11 +0000447 self.esmtp_features[feature] = params
448 return (code, msg)
Guido van Rossum95e6f701998-06-25 02:15:50 +0000449
Guido van Rossumfcfb6321998-08-04 15:29:54 +0000450 def has_extn(self, opt):
451 """Does the server support a given SMTP service extension?"""
Raymond Hettinger54f02222002-06-01 14:18:47 +0000452 return opt.lower() in self.esmtp_features
Guido van Rossum95e6f701998-06-25 02:15:50 +0000453
Guido van Rossum18586f41998-04-03 17:03:13 +0000454 def help(self, args=''):
Barry Warsawa7d9bdf1998-12-22 03:24:27 +0000455 """SMTP 'help' command.
456 Returns help text from server."""
Guido van Rossum18586f41998-04-03 17:03:13 +0000457 self.putcmd("help", args)
Kurt B. Kaiser58bd1902005-06-26 18:27:36 +0000458 return self.getreply()[1]
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000459
460 def rset(self):
Barry Warsawa7d9bdf1998-12-22 03:24:27 +0000461 """SMTP 'rset' command -- resets session."""
Guido van Rossum296e1431999-04-07 15:03:39 +0000462 return self.docmd("rset")
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000463
464 def noop(self):
Barry Warsawa7d9bdf1998-12-22 03:24:27 +0000465 """SMTP 'noop' command -- doesn't do anything :>"""
Guido van Rossum296e1431999-04-07 15:03:39 +0000466 return self.docmd("noop")
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000467
Giampaolo Rodolà5c12ec62011-02-24 20:43:11 +0000468 def mail(self, sender, options=[]):
Barry Warsawa7d9bdf1998-12-22 03:24:27 +0000469 """SMTP 'mail' command -- begins mail xfer session."""
Guido van Rossumfcfb6321998-08-04 15:29:54 +0000470 optionlist = ''
471 if options and self.does_esmtp:
Eric S. Raymondc013f302001-02-09 05:40:38 +0000472 optionlist = ' ' + ' '.join(options)
Giampaolo Rodolà5c12ec62011-02-24 20:43:11 +0000473 self.putcmd("mail", "FROM:%s%s" % (quoteaddr(sender), optionlist))
Guido van Rossum45e2fbc1998-03-26 21:13:24 +0000474 return self.getreply()
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000475
Giampaolo Rodolà5c12ec62011-02-24 20:43:11 +0000476 def rcpt(self, recip, options=[]):
Barry Warsawa7d9bdf1998-12-22 03:24:27 +0000477 """SMTP 'rcpt' command -- indicates 1 recipient for this mail."""
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("rcpt", "TO:%s%s" % (quoteaddr(recip), 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 data(self, msg):
Tim Peters495ad3c2001-01-15 01:36:40 +0000485 """SMTP 'DATA' command -- sends message data to server.
Guido van Rossum296e1431999-04-07 15:03:39 +0000486
Barry Warsaw4c4bec81998-12-22 03:02:20 +0000487 Automatically quotes lines beginning with a period per rfc821.
Guido van Rossum296e1431999-04-07 15:03:39 +0000488 Raises SMTPDataError if there is an unexpected reply to the
489 DATA command; the return value from this method is the final
490 response code received when the all data is sent.
Barry Warsaw4c4bec81998-12-22 03:02:20 +0000491 """
Guido van Rossum45e2fbc1998-03-26 21:13:24 +0000492 self.putcmd("data")
Giampaolo Rodolà5c12ec62011-02-24 20:43:11 +0000493 (code, repl) = self.getreply()
494 if self.debuglevel > 0:
495 print>>stderr, "data:", (code, repl)
Fred Drake8152d322000-12-12 23:20:45 +0000496 if code != 354:
Giampaolo Rodolà5c12ec62011-02-24 20:43:11 +0000497 raise SMTPDataError(code, repl)
Guido van Rossum45e2fbc1998-03-26 21:13:24 +0000498 else:
Guido van Rossum20c92281999-04-21 16:52:20 +0000499 q = quotedata(msg)
500 if q[-2:] != CRLF:
501 q = q + CRLF
502 q = q + "." + CRLF
503 self.send(q)
Giampaolo Rodolà5c12ec62011-02-24 20:43:11 +0000504 (code, msg) = self.getreply()
505 if self.debuglevel > 0:
506 print>>stderr, "data:", (code, msg)
507 return (code, msg)
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000508
Guido van Rossumfcfb6321998-08-04 15:29:54 +0000509 def verify(self, address):
Barry Warsawa7d9bdf1998-12-22 03:24:27 +0000510 """SMTP 'verify' command -- checks for address validity."""
R David Murray95225952011-07-18 21:34:04 -0400511 self.putcmd("vrfy", _addr_only(address))
Guido van Rossumfcfb6321998-08-04 15:29:54 +0000512 return self.getreply()
Barry Warsaw4c4bec81998-12-22 03:02:20 +0000513 # a.k.a.
Giampaolo Rodolà5c12ec62011-02-24 20:43:11 +0000514 vrfy = verify
Guido van Rossumfcfb6321998-08-04 15:29:54 +0000515
516 def expn(self, address):
Facundo Batista16609332008-02-23 12:27:17 +0000517 """SMTP 'expn' command -- expands a mailing list."""
R David Murray95225952011-07-18 21:34:04 -0400518 self.putcmd("expn", _addr_only(address))
Guido van Rossumfcfb6321998-08-04 15:29:54 +0000519 return self.getreply()
520
Barry Warsaw4c4bec81998-12-22 03:02:20 +0000521 # some useful methods
Guido van Rossumae010462001-09-11 15:57:46 +0000522
Gregory P. Smithbde4ae42008-01-17 08:35:49 +0000523 def ehlo_or_helo_if_needed(self):
524 """Call self.ehlo() and/or self.helo() if needed.
525
526 If there has been no previous EHLO or HELO command this session, this
527 method tries ESMTP EHLO first.
528
529 This method may raise the following exceptions:
530
531 SMTPHeloError The server didn't reply properly to
532 the helo greeting.
533 """
534 if self.helo_resp is None and self.ehlo_resp is None:
535 if not (200 <= self.ehlo()[0] <= 299):
536 (code, resp) = self.helo()
537 if not (200 <= code <= 299):
538 raise SMTPHeloError(code, resp)
539
Guido van Rossumae010462001-09-11 15:57:46 +0000540 def login(self, user, password):
541 """Log in on an SMTP server that requires authentication.
542
543 The arguments are:
544 - user: The user name to authenticate with.
545 - password: The password for the authentication.
546
547 If there has been no previous EHLO or HELO command this session, this
548 method tries ESMTP EHLO first.
549
550 This method will return normally if the authentication was successful.
551
552 This method may raise the following exceptions:
553
554 SMTPHeloError The server didn't reply properly to
555 the helo greeting.
556 SMTPAuthenticationError The server didn't accept the username/
557 password combination.
Fred Drake2f8f4d32001-10-13 18:35:32 +0000558 SMTPException No suitable authentication method was
Guido van Rossumae010462001-09-11 15:57:46 +0000559 found.
560 """
561
562 def encode_cram_md5(challenge, user, password):
563 challenge = base64.decodestring(challenge)
564 response = user + " " + hmac.HMAC(password, challenge).hexdigest()
Piers Lauder385a77a2002-07-27 00:38:30 +0000565 return encode_base64(response, eol="")
Guido van Rossumae010462001-09-11 15:57:46 +0000566
567 def encode_plain(user, password):
Johannes Gijsbers25946dd2004-12-06 21:25:26 +0000568 return encode_base64("\0%s\0%s" % (user, password), eol="")
Tim Peters469cdad2002-08-08 20:19:19 +0000569
Guido van Rossumae010462001-09-11 15:57:46 +0000570
571 AUTH_PLAIN = "PLAIN"
572 AUTH_CRAM_MD5 = "CRAM-MD5"
Piers Lauder385a77a2002-07-27 00:38:30 +0000573 AUTH_LOGIN = "LOGIN"
Guido van Rossumae010462001-09-11 15:57:46 +0000574
Gregory P. Smithbde4ae42008-01-17 08:35:49 +0000575 self.ehlo_or_helo_if_needed()
Guido van Rossumae010462001-09-11 15:57:46 +0000576
577 if not self.has_extn("auth"):
578 raise SMTPException("SMTP AUTH extension not supported by server.")
579
580 # Authentication methods the server supports:
581 authlist = self.esmtp_features["auth"].split()
582
583 # List of authentication methods we support: from preferred to
584 # less preferred methods. Except for the purpose of testing the weaker
585 # ones, we prefer stronger methods like CRAM-MD5:
Piers Lauder385a77a2002-07-27 00:38:30 +0000586 preferred_auths = [AUTH_CRAM_MD5, AUTH_PLAIN, AUTH_LOGIN]
Guido van Rossumae010462001-09-11 15:57:46 +0000587
588 # Determine the authentication method we'll use
589 authmethod = None
590 for method in preferred_auths:
591 if method in authlist:
592 authmethod = method
593 break
Tim Petersb64bec32001-09-18 02:26:39 +0000594
Guido van Rossumae010462001-09-11 15:57:46 +0000595 if authmethod == AUTH_CRAM_MD5:
596 (code, resp) = self.docmd("AUTH", AUTH_CRAM_MD5)
597 if code == 503:
598 # 503 == 'Error: already authenticated'
599 return (code, resp)
600 (code, resp) = self.docmd(encode_cram_md5(resp, user, password))
601 elif authmethod == AUTH_PLAIN:
Tim Petersb64bec32001-09-18 02:26:39 +0000602 (code, resp) = self.docmd("AUTH",
Guido van Rossumae010462001-09-11 15:57:46 +0000603 AUTH_PLAIN + " " + encode_plain(user, password))
Piers Lauder385a77a2002-07-27 00:38:30 +0000604 elif authmethod == AUTH_LOGIN:
605 (code, resp) = self.docmd("AUTH",
606 "%s %s" % (AUTH_LOGIN, encode_base64(user, eol="")))
607 if code != 334:
608 raise SMTPAuthenticationError(code, resp)
Martin v. Löwis49c05d32002-10-06 17:55:08 +0000609 (code, resp) = self.docmd(encode_base64(password, eol=""))
Raymond Hettinger7fdfc2d2002-05-31 17:49:10 +0000610 elif authmethod is None:
Fred Drake2f8f4d32001-10-13 18:35:32 +0000611 raise SMTPException("No suitable authentication method found.")
Raymond Hettingerdbecd932005-02-06 06:57:08 +0000612 if code not in (235, 503):
Guido van Rossumae010462001-09-11 15:57:46 +0000613 # 235 == 'Authentication successful'
614 # 503 == 'Error: already authenticated'
615 raise SMTPAuthenticationError(code, resp)
616 return (code, resp)
617
Giampaolo Rodolà5c12ec62011-02-24 20:43:11 +0000618 def starttls(self, keyfile=None, certfile=None):
Guido van Rossumf7fcf5e2001-09-14 16:08:44 +0000619 """Puts the connection to the SMTP server into TLS mode.
Tim Petersb64bec32001-09-18 02:26:39 +0000620
Gregory P. Smithbde4ae42008-01-17 08:35:49 +0000621 If there has been no previous EHLO or HELO command this session, this
622 method tries ESMTP EHLO first.
623
Guido van Rossumf7fcf5e2001-09-14 16:08:44 +0000624 If the server supports TLS, this will encrypt the rest of the SMTP
625 session. If you provide the keyfile and certfile parameters,
626 the identity of the SMTP server and client can be checked. This,
627 however, depends on whether the socket module really checks the
628 certificates.
Gregory P. Smithbde4ae42008-01-17 08:35:49 +0000629
630 This method may raise the following exceptions:
631
632 SMTPHeloError The server didn't reply properly to
633 the helo greeting.
Guido van Rossumf7fcf5e2001-09-14 16:08:44 +0000634 """
Gregory P. Smithbde4ae42008-01-17 08:35:49 +0000635 self.ehlo_or_helo_if_needed()
636 if not self.has_extn("starttls"):
637 raise SMTPException("STARTTLS extension not supported by server.")
Tim Petersb64bec32001-09-18 02:26:39 +0000638 (resp, reply) = self.docmd("STARTTLS")
Guido van Rossumf7fcf5e2001-09-14 16:08:44 +0000639 if resp == 220:
Bill Janssen426ea0a2007-08-29 22:35:05 +0000640 if not _have_ssl:
641 raise RuntimeError("No SSL support included in this Python")
Bill Janssen98d19da2007-09-10 21:51:02 +0000642 self.sock = ssl.wrap_socket(self.sock, keyfile, certfile)
Bill Janssen426ea0a2007-08-29 22:35:05 +0000643 self.file = SSLFakeFile(self.sock)
Gregory P. Smith63bfc1d2008-01-17 07:43:20 +0000644 # RFC 3207:
645 # The client MUST discard any knowledge obtained from
646 # the server, such as the list of SMTP service extensions,
647 # which was not obtained from the TLS negotiation itself.
648 self.helo_resp = None
649 self.ehlo_resp = None
650 self.esmtp_features = {}
651 self.does_esmtp = 0
Guido van Rossumf7fcf5e2001-09-14 16:08:44 +0000652 return (resp, reply)
Tim Petersb64bec32001-09-18 02:26:39 +0000653
Jeremy Hylton31bb8ce1998-08-13 19:57:46 +0000654 def sendmail(self, from_addr, to_addrs, msg, mail_options=[],
Tim Peters495ad3c2001-01-15 01:36:40 +0000655 rcpt_options=[]):
656 """This command performs an entire mail transaction.
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000657
Tim Peters495ad3c2001-01-15 01:36:40 +0000658 The arguments are:
Barry Warsaw4c4bec81998-12-22 03:02:20 +0000659 - from_addr : The address sending this mail.
660 - to_addrs : A list of addresses to send this mail to. A bare
661 string will be treated as a list with 1 address.
Tim Peters495ad3c2001-01-15 01:36:40 +0000662 - msg : The message to send.
Barry Warsaw4c4bec81998-12-22 03:02:20 +0000663 - mail_options : List of ESMTP options (such as 8bitmime) for the
664 mail command.
665 - rcpt_options : List of ESMTP options (such as DSN commands) for
666 all the rcpt commands.
667
668 If there has been no previous EHLO or HELO command this session, this
669 method tries ESMTP EHLO first. If the server does ESMTP, message size
670 and each of the specified options will be passed to it. If EHLO
671 fails, HELO will be tried and ESMTP options suppressed.
672
673 This method will return normally if the mail is accepted for at least
Barry Warsawd25c1b71999-11-28 17:11:06 +0000674 one recipient. It returns a dictionary, with one entry for each
675 recipient that was refused. Each entry contains a tuple of the SMTP
676 error code and the accompanying error message sent by the server.
Guido van Rossum296e1431999-04-07 15:03:39 +0000677
678 This method may raise the following exceptions:
679
680 SMTPHeloError The server didn't reply properly to
Tim Peters495ad3c2001-01-15 01:36:40 +0000681 the helo greeting.
Barry Warsawd25c1b71999-11-28 17:11:06 +0000682 SMTPRecipientsRefused The server rejected ALL recipients
Guido van Rossum296e1431999-04-07 15:03:39 +0000683 (no mail was sent).
684 SMTPSenderRefused The server didn't accept the from_addr.
685 SMTPDataError The server replied with an unexpected
686 error code (other than a refusal of
687 a recipient).
688
689 Note: the connection will be open even after an exception is raised.
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000690
Guido van Rossum95e6f701998-06-25 02:15:50 +0000691 Example:
Tim Peters495ad3c2001-01-15 01:36:40 +0000692
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000693 >>> import smtplib
694 >>> s=smtplib.SMTP("localhost")
Guido van Rossumfc40a831998-01-29 17:26:45 +0000695 >>> tolist=["one@one.org","two@two.org","three@three.org","four@four.org"]
Martin v. Löwis301b1cd2002-07-28 16:52:01 +0000696 >>> msg = '''\\
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000697 ... From: Me@my.org
698 ... Subject: testin'...
699 ...
700 ... This is a test '''
701 >>> s.sendmail("me@my.org",tolist,msg)
702 { "three@three.org" : ( 550 ,"User unknown" ) }
703 >>> s.quit()
Tim Peters495ad3c2001-01-15 01:36:40 +0000704
Barry Warsaw4c4bec81998-12-22 03:02:20 +0000705 In the above example, the message was accepted for delivery to three
706 of the four addresses, and one was rejected, with the error code
Barry Warsawd25c1b71999-11-28 17:11:06 +0000707 550. If all addresses are accepted, then the method will return an
Barry Warsaw4c4bec81998-12-22 03:02:20 +0000708 empty dictionary.
709
710 """
Gregory P. Smithbde4ae42008-01-17 08:35:49 +0000711 self.ehlo_or_helo_if_needed()
Guido van Rossum95e6f701998-06-25 02:15:50 +0000712 esmtp_opts = []
Guido van Rossumfcfb6321998-08-04 15:29:54 +0000713 if self.does_esmtp:
714 # Hmmm? what's this? -ddm
715 # self.esmtp_features['7bit']=""
716 if self.has_extn('size'):
Walter Dörwald70a6b492004-02-12 17:35:32 +0000717 esmtp_opts.append("size=%d" % len(msg))
Guido van Rossumfcfb6321998-08-04 15:29:54 +0000718 for option in mail_options:
Guido van Rossum95e6f701998-06-25 02:15:50 +0000719 esmtp_opts.append(option)
Guido van Rossumfcfb6321998-08-04 15:29:54 +0000720
Giampaolo Rodolà5c12ec62011-02-24 20:43:11 +0000721 (code, resp) = self.mail(from_addr, esmtp_opts)
Fred Drake8152d322000-12-12 23:20:45 +0000722 if code != 250:
Guido van Rossum45e2fbc1998-03-26 21:13:24 +0000723 self.rset()
Guido van Rossum296e1431999-04-07 15:03:39 +0000724 raise SMTPSenderRefused(code, resp, from_addr)
Giampaolo Rodolà5c12ec62011-02-24 20:43:11 +0000725 senderrs = {}
Walter Dörwald65230a22002-06-03 15:58:32 +0000726 if isinstance(to_addrs, basestring):
Jeremy Hylton31bb8ce1998-08-13 19:57:46 +0000727 to_addrs = [to_addrs]
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000728 for each in to_addrs:
Giampaolo Rodolà5c12ec62011-02-24 20:43:11 +0000729 (code, resp) = self.rcpt(each, rcpt_options)
Fred Drake8152d322000-12-12 23:20:45 +0000730 if (code != 250) and (code != 251):
Giampaolo Rodolà5c12ec62011-02-24 20:43:11 +0000731 senderrs[each] = (code, resp)
732 if len(senderrs) == len(to_addrs):
Guido van Rossum95e6f701998-06-25 02:15:50 +0000733 # the server refused all our recipients
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000734 self.rset()
Guido van Rossum296e1431999-04-07 15:03:39 +0000735 raise SMTPRecipientsRefused(senderrs)
Giampaolo Rodolà5c12ec62011-02-24 20:43:11 +0000736 (code, resp) = self.data(msg)
Fred Drake8152d322000-12-12 23:20:45 +0000737 if code != 250:
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000738 self.rset()
Guido van Rossum296e1431999-04-07 15:03:39 +0000739 raise SMTPDataError(code, resp)
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000740 #if we got here then somebody got our mail
Tim Peters495ad3c2001-01-15 01:36:40 +0000741 return senderrs
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000742
743
744 def close(self):
745 """Close the connection to the SMTP server."""
746 if self.file:
747 self.file.close()
748 self.file = None
749 if self.sock:
750 self.sock.close()
751 self.sock = None
752
753
754 def quit(self):
Guido van Rossum95e6f701998-06-25 02:15:50 +0000755 """Terminate the SMTP session."""
Georg Brandldeaf2ca2008-03-27 13:27:31 +0000756 res = self.docmd("quit")
Guido van Rossum45e2fbc1998-03-26 21:13:24 +0000757 self.close()
Georg Brandldeaf2ca2008-03-27 13:27:31 +0000758 return res
Guido van Rossum95e6f701998-06-25 02:15:50 +0000759
Bill Janssen426ea0a2007-08-29 22:35:05 +0000760if _have_ssl:
Martin v. Löwisee82c0e2006-10-27 07:13:28 +0000761
Bill Janssen426ea0a2007-08-29 22:35:05 +0000762 class SMTP_SSL(SMTP):
R David Murray95752222013-06-23 16:10:37 -0400763 """ This is a subclass derived from SMTP that connects over an SSL
764 encrypted socket (to use this class you need a socket module that was
765 compiled with SSL support). If host is not specified, '' (the local
766 host) is used. If port is omitted, the standard SMTP-over-SSL port
767 (465) is used. local_hostname has the same meaning as it does in the
768 SMTP class. keyfile and certfile are also optional - they can contain
769 a PEM formatted private key and certificate chain file for the SSL
770 connection.
771
Bill Janssen426ea0a2007-08-29 22:35:05 +0000772 """
Antoine Pitrou21ce8f02011-05-07 19:59:33 +0200773
774 default_port = SMTP_SSL_PORT
775
Bill Janssen426ea0a2007-08-29 22:35:05 +0000776 def __init__(self, host='', port=0, local_hostname=None,
Facundo Batista4f1b1ed2008-05-29 16:39:26 +0000777 keyfile=None, certfile=None,
778 timeout=socket._GLOBAL_DEFAULT_TIMEOUT):
Bill Janssen426ea0a2007-08-29 22:35:05 +0000779 self.keyfile = keyfile
780 self.certfile = certfile
781 SMTP.__init__(self, host, port, local_hostname, timeout)
Bill Janssen426ea0a2007-08-29 22:35:05 +0000782
783 def _get_socket(self, host, port, timeout):
Giampaolo Rodolà5c12ec62011-02-24 20:43:11 +0000784 if self.debuglevel > 0:
785 print>>stderr, 'connect:', (host, port)
R. David Murrayad3058e2009-05-23 00:48:58 +0000786 new_socket = socket.create_connection((host, port), timeout)
787 new_socket = ssl.wrap_socket(new_socket, self.keyfile, self.certfile)
788 self.file = SSLFakeFile(new_socket)
789 return new_socket
Barry Warsaw4c4bec81998-12-22 03:02:20 +0000790
Thomas Woutersa6900e82007-08-30 21:54:39 +0000791 __all__.append("SMTP_SSL")
792
Martin v. Löwis1190a382007-03-09 15:35:55 +0000793#
794# LMTP extension
795#
796LMTP_PORT = 2003
797
798class LMTP(SMTP):
799 """LMTP - Local Mail Transfer Protocol
800
801 The LMTP protocol, which is very similar to ESMTP, is heavily based
R David Murray95752222013-06-23 16:10:37 -0400802 on the standard SMTP client. It's common to use Unix sockets for
803 LMTP, so our connect() method must support that as well as a regular
804 host:port server. local_hostname has the same meaning as it does in
805 the SMTP class. To specify a Unix socket, you must use an absolute
Martin v. Löwis1190a382007-03-09 15:35:55 +0000806 path as the host, starting with a '/'.
807
808 Authentication is supported, using the regular SMTP mechanism. When
809 using a Unix socket, LMTP generally don't support or require any
810 authentication, but your mileage might vary."""
811
812 ehlo_msg = "lhlo"
Tim Petersea5962f2007-03-12 18:07:52 +0000813
Giampaolo Rodolà5c12ec62011-02-24 20:43:11 +0000814 def __init__(self, host='', port=LMTP_PORT, local_hostname=None):
Martin v. Löwis1190a382007-03-09 15:35:55 +0000815 """Initialize a new instance."""
816 SMTP.__init__(self, host, port, local_hostname)
817
Giampaolo Rodolà5c12ec62011-02-24 20:43:11 +0000818 def connect(self, host='localhost', port=0):
Martin v. Löwis1190a382007-03-09 15:35:55 +0000819 """Connect to the LMTP daemon, on either a Unix or a TCP socket."""
Neal Norwitzc8f6c232007-03-10 03:19:18 +0000820 if host[0] != '/':
Martin v. Löwis1190a382007-03-09 15:35:55 +0000821 return SMTP.connect(self, host, port)
822
Neal Norwitzc8f6c232007-03-10 03:19:18 +0000823 # Handle Unix-domain sockets.
824 try:
825 self.sock = socket.socket(socket.AF_UNIX, socket.SOCK_STREAM)
826 self.sock.connect(host)
Andrew Svetloved3f6c62012-12-17 19:06:43 +0200827 except socket.error:
Giampaolo Rodolà5c12ec62011-02-24 20:43:11 +0000828 if self.debuglevel > 0:
829 print>>stderr, 'connect fail:', host
Neal Norwitzc8f6c232007-03-10 03:19:18 +0000830 if self.sock:
831 self.sock.close()
832 self.sock = None
Andrew Svetloved3f6c62012-12-17 19:06:43 +0200833 raise
Neal Norwitzc8f6c232007-03-10 03:19:18 +0000834 (code, msg) = self.getreply()
Giampaolo Rodolà5c12ec62011-02-24 20:43:11 +0000835 if self.debuglevel > 0:
836 print>>stderr, "connect:", msg
Neal Norwitzc8f6c232007-03-10 03:19:18 +0000837 return (code, msg)
838
Martin v. Löwis1190a382007-03-09 15:35:55 +0000839
Guido van Rossum95e6f701998-06-25 02:15:50 +0000840# Test the sendmail method, which tests most of the others.
841# Note: This always sends to localhost.
842if __name__ == '__main__':
Andrew M. Kuchling6be424f2001-08-13 14:41:39 +0000843 import sys
Guido van Rossum95e6f701998-06-25 02:15:50 +0000844
845 def prompt(prompt):
846 sys.stdout.write(prompt + ": ")
Eric S. Raymondc013f302001-02-09 05:40:38 +0000847 return sys.stdin.readline().strip()
Guido van Rossum95e6f701998-06-25 02:15:50 +0000848
849 fromaddr = prompt("From")
Giampaolo Rodolà5c12ec62011-02-24 20:43:11 +0000850 toaddrs = prompt("To").split(',')
Guido van Rossum95e6f701998-06-25 02:15:50 +0000851 print "Enter message, end with ^D:"
852 msg = ''
853 while 1:
854 line = sys.stdin.readline()
855 if not line:
856 break
857 msg = msg + line
Walter Dörwald70a6b492004-02-12 17:35:32 +0000858 print "Message length is %d" % len(msg)
Guido van Rossum95e6f701998-06-25 02:15:50 +0000859
860 server = SMTP('localhost')
861 server.set_debuglevel(1)
862 server.sendmail(fromaddr, toaddrs, msg)
863 server.quit()