blob: e7d3786229b403b75f051a95374e93c253ff1efb [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
152def quotedata(data):
153 """Quote data for email.
154
Barry Warsawd25c1b71999-11-28 17:11:06 +0000155 Double leading '.', and change Unix newline '\\n', or Mac '\\r' into
Barry Warsawa7d9bdf1998-12-22 03:24:27 +0000156 Internet CRLF end-of-line.
157 """
Guido van Rossum69a79bc1998-07-13 15:18:49 +0000158 return re.sub(r'(?m)^\.', '..',
Guido van Rossumfcfb6321998-08-04 15:29:54 +0000159 re.sub(r'(?:\r\n|\n|\r(?!\n))', CRLF, data))
Guido van Rossum69a79bc1998-07-13 15:18:49 +0000160
Peter Schneider-Kamp7bc82bb2000-08-10 14:02:23 +0000161
Bill Janssen426ea0a2007-08-29 22:35:05 +0000162try:
163 import ssl
164except ImportError:
165 _have_ssl = False
166else:
Bill Janssen426ea0a2007-08-29 22:35:05 +0000167 class SSLFakeFile:
168 """A fake file like object that really wraps a SSLObject.
169
170 It only supports what is needed in smtplib.
171 """
172 def __init__(self, sslobj):
173 self.sslobj = sslobj
174
175 def readline(self):
176 str = ""
177 chr = None
178 while chr != "\n":
179 chr = self.sslobj.read(1)
Giampaolo Rodolà5c12ec62011-02-24 20:43:11 +0000180 if not chr:
181 break
Bill Janssen426ea0a2007-08-29 22:35:05 +0000182 str += chr
183 return str
184
185 def close(self):
186 pass
187
188 _have_ssl = True
189
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000190class SMTP:
Guido van Rossumfcfb6321998-08-04 15:29:54 +0000191 """This class manages a connection to an SMTP or ESMTP server.
192 SMTP Objects:
Tim Peters495ad3c2001-01-15 01:36:40 +0000193 SMTP objects have the following attributes:
194 helo_resp
195 This is the message given by the server in response to the
Guido van Rossumfcfb6321998-08-04 15:29:54 +0000196 most recent HELO command.
Tim Peters495ad3c2001-01-15 01:36:40 +0000197
Guido van Rossumfcfb6321998-08-04 15:29:54 +0000198 ehlo_resp
Tim Peters495ad3c2001-01-15 01:36:40 +0000199 This is the message given by the server in response to the
Guido van Rossumfcfb6321998-08-04 15:29:54 +0000200 most recent EHLO command. This is usually multiline.
201
Tim Peters495ad3c2001-01-15 01:36:40 +0000202 does_esmtp
Guido van Rossumfcfb6321998-08-04 15:29:54 +0000203 This is a True value _after you do an EHLO command_, if the
204 server supports ESMTP.
205
Tim Peters495ad3c2001-01-15 01:36:40 +0000206 esmtp_features
Guido van Rossumfcfb6321998-08-04 15:29:54 +0000207 This is a dictionary, which, if the server supports ESMTP,
Barry Warsawd25c1b71999-11-28 17:11:06 +0000208 will _after you do an EHLO command_, contain the names of the
209 SMTP service extensions this server supports, and their
Guido van Rossumfcfb6321998-08-04 15:29:54 +0000210 parameters (if any).
Barry Warsawd25c1b71999-11-28 17:11:06 +0000211
Tim Peters495ad3c2001-01-15 01:36:40 +0000212 Note, all extension names are mapped to lower case in the
213 dictionary.
Guido van Rossumfcfb6321998-08-04 15:29:54 +0000214
Barry Warsawd25c1b71999-11-28 17:11:06 +0000215 See each method's docstrings for details. In general, there is a
216 method of the same name to perform each SMTP command. There is also a
217 method called 'sendmail' that will do an entire mail transaction.
218 """
Guido van Rossum95e6f701998-06-25 02:15:50 +0000219 debuglevel = 0
220 file = None
221 helo_resp = None
Martin v. Löwis1190a382007-03-09 15:35:55 +0000222 ehlo_msg = "ehlo"
Guido van Rossum95e6f701998-06-25 02:15:50 +0000223 ehlo_resp = None
Guido van Rossumfcfb6321998-08-04 15:29:54 +0000224 does_esmtp = 0
Guido van Rossum95e6f701998-06-25 02:15:50 +0000225
Facundo Batista4f1b1ed2008-05-29 16:39:26 +0000226 def __init__(self, host='', port=0, local_hostname=None,
227 timeout=socket._GLOBAL_DEFAULT_TIMEOUT):
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000228 """Initialize a new instance.
229
Barry Warsawa7d9bdf1998-12-22 03:24:27 +0000230 If specified, `host' is the name of the remote host to which to
231 connect. If specified, `port' specifies the port to which to connect.
Barry Warsawd25c1b71999-11-28 17:11:06 +0000232 By default, smtplib.SMTP_PORT is used. An SMTPConnectError is raised
Neil Schemenauer6730f262002-03-24 15:30:40 +0000233 if the specified `host' doesn't respond correctly. If specified,
Tim Peters863ac442002-04-16 01:38:40 +0000234 `local_hostname` is used as the FQDN of the local host. By default,
235 the local hostname is found using socket.getfqdn().
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000236
237 """
Facundo Batista366d6262007-03-28 18:25:54 +0000238 self.timeout = timeout
Guido van Rossumfcfb6321998-08-04 15:29:54 +0000239 self.esmtp_features = {}
Martin v. Löwisee82c0e2006-10-27 07:13:28 +0000240 self.default_port = SMTP_PORT
Guido van Rossum296e1431999-04-07 15:03:39 +0000241 if host:
242 (code, msg) = self.connect(host, port)
243 if code != 220:
244 raise SMTPConnectError(code, msg)
Raymond Hettingerf13eb552002-06-02 00:40:05 +0000245 if local_hostname is not None:
Barry Warsaw13e34f72002-03-26 20:27:35 +0000246 self.local_hostname = local_hostname
Neil Schemenauer6730f262002-03-24 15:30:40 +0000247 else:
Barry Warsaw13e34f72002-03-26 20:27:35 +0000248 # RFC 2821 says we should use the fqdn in the EHLO/HELO verb, and
249 # if that can't be calculated, that we should use a domain literal
250 # instead (essentially an encoded IP address like [A.B.C.D]).
251 fqdn = socket.getfqdn()
252 if '.' in fqdn:
253 self.local_hostname = fqdn
254 else:
255 # We can't find an fqdn hostname, so use a domain literal
Georg Brandldcdfd222006-03-31 19:34:13 +0000256 addr = '127.0.0.1'
257 try:
258 addr = socket.gethostbyname(socket.gethostname())
259 except socket.gaierror:
260 pass
Barry Warsaw13e34f72002-03-26 20:27:35 +0000261 self.local_hostname = '[%s]' % addr
Tim Peters495ad3c2001-01-15 01:36:40 +0000262
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000263 def set_debuglevel(self, debuglevel):
264 """Set the debug output level.
265
Barry Warsawa7d9bdf1998-12-22 03:24:27 +0000266 A non-false value results in debug messages for connection and for all
267 messages sent to and received from the server.
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000268
269 """
270 self.debuglevel = debuglevel
271
Facundo Batista366d6262007-03-28 18:25:54 +0000272 def _get_socket(self, port, host, timeout):
Martin v. Löwisee82c0e2006-10-27 07:13:28 +0000273 # This makes it simpler for SMTP_SSL to use the SMTP connect code
274 # and just alter the socket connection bit.
Giampaolo Rodolà5c12ec62011-02-24 20:43:11 +0000275 if self.debuglevel > 0:
276 print>>stderr, 'connect:', (host, port)
Facundo Batista366d6262007-03-28 18:25:54 +0000277 return socket.create_connection((port, host), timeout)
Martin v. Löwisee82c0e2006-10-27 07:13:28 +0000278
Giampaolo Rodolà5c12ec62011-02-24 20:43:11 +0000279 def connect(self, host='localhost', port=0):
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000280 """Connect to a host on a given port.
Guido van Rossum95e6f701998-06-25 02:15:50 +0000281
Barry Warsaw4c4bec81998-12-22 03:02:20 +0000282 If the hostname ends with a colon (`:') followed by a number, and
283 there is no port specified, that suffix will be stripped off and the
284 number interpreted as the port number to use.
Guido van Rossum95e6f701998-06-25 02:15:50 +0000285
Barry Warsawa7d9bdf1998-12-22 03:24:27 +0000286 Note: This method is automatically invoked by __init__, if a host is
287 specified during instantiation.
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000288
289 """
Martin v. Löwis4eb59402001-07-26 13:37:33 +0000290 if not port and (host.find(':') == host.rfind(':')):
Martin v. Löwisa43c2f82001-07-24 20:34:08 +0000291 i = host.rfind(':')
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000292 if i >= 0:
Giampaolo Rodolà5c12ec62011-02-24 20:43:11 +0000293 host, port = host[:i], host[i + 1:]
294 try:
295 port = int(port)
Eric S. Raymond8d876032001-02-09 10:14:53 +0000296 except ValueError:
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000297 raise socket.error, "nonnumeric port"
Giampaolo Rodolà5c12ec62011-02-24 20:43:11 +0000298 if not port:
299 port = self.default_port
300 if self.debuglevel > 0:
301 print>>stderr, 'connect:', (host, port)
Facundo Batista366d6262007-03-28 18:25:54 +0000302 self.sock = self._get_socket(host, port, self.timeout)
Martin v. Löwisa43c2f82001-07-24 20:34:08 +0000303 (code, msg) = self.getreply()
Giampaolo Rodolà5c12ec62011-02-24 20:43:11 +0000304 if self.debuglevel > 0:
305 print>>stderr, "connect:", msg
Martin v. Löwisa43c2f82001-07-24 20:34:08 +0000306 return (code, msg)
Tim Peters495ad3c2001-01-15 01:36:40 +0000307
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000308 def send(self, str):
309 """Send `str' to the server."""
Giampaolo Rodolà5c12ec62011-02-24 20:43:11 +0000310 if self.debuglevel > 0:
311 print>>stderr, 'send:', repr(str)
Facundo Batista16609332008-02-23 12:27:17 +0000312 if hasattr(self, 'sock') and self.sock:
Guido van Rossum2880f6e1998-08-10 20:07:00 +0000313 try:
Martin v. Löwise12454f2002-02-16 23:06:19 +0000314 self.sock.sendall(str)
Guido van Rossum2880f6e1998-08-10 20:07:00 +0000315 except socket.error:
Barry Warsaw76750972001-12-14 20:34:20 +0000316 self.close()
Guido van Rossum40233ea1999-01-15 03:23:55 +0000317 raise SMTPServerDisconnected('Server not connected')
Guido van Rossumfc40a831998-01-29 17:26:45 +0000318 else:
Guido van Rossum40233ea1999-01-15 03:23:55 +0000319 raise SMTPServerDisconnected('please run connect() first')
Tim Peters495ad3c2001-01-15 01:36:40 +0000320
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000321 def putcmd(self, cmd, args=""):
Barry Warsawa7d9bdf1998-12-22 03:24:27 +0000322 """Send a command to the server."""
Guido van Rossumdb23d3d1999-06-09 15:13:10 +0000323 if args == "":
324 str = '%s%s' % (cmd, CRLF)
325 else:
326 str = '%s %s%s' % (cmd, args, CRLF)
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000327 self.send(str)
Tim Peters495ad3c2001-01-15 01:36:40 +0000328
Guido van Rossumfcfb6321998-08-04 15:29:54 +0000329 def getreply(self):
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000330 """Get a reply from the server.
Tim Peters495ad3c2001-01-15 01:36:40 +0000331
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000332 Returns a tuple consisting of:
Barry Warsawa7d9bdf1998-12-22 03:24:27 +0000333
334 - server response code (e.g. '250', or such, if all goes well)
335 Note: returns -1 if it can't read response code.
336
337 - server response string corresponding to response code (multiline
338 responses are converted to a single, multiline string).
Guido van Rossumf123f841999-03-29 20:33:21 +0000339
340 Raises SMTPServerDisconnected if end-of-file is reached.
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000341 """
Giampaolo Rodolà5c12ec62011-02-24 20:43:11 +0000342 resp = []
Guido van Rossum296e1431999-04-07 15:03:39 +0000343 if self.file is None:
344 self.file = self.sock.makefile('rb')
Guido van Rossum45e2fbc1998-03-26 21:13:24 +0000345 while 1:
Kristján Valur Jónsson51a035e2009-01-15 17:20:21 +0000346 try:
347 line = self.file.readline()
348 except socket.error:
349 line = ''
Guido van Rossum296e1431999-04-07 15:03:39 +0000350 if line == '':
351 self.close()
352 raise SMTPServerDisconnected("Connection unexpectedly closed")
Giampaolo Rodolà5c12ec62011-02-24 20:43:11 +0000353 if self.debuglevel > 0:
354 print>>stderr, 'reply:', repr(line)
Eric S. Raymondc013f302001-02-09 05:40:38 +0000355 resp.append(line[4:].strip())
Giampaolo Rodolà5c12ec62011-02-24 20:43:11 +0000356 code = line[:3]
Guido van Rossum296e1431999-04-07 15:03:39 +0000357 # Check that the error code is syntactically correct.
358 # Don't attempt to read a continuation line if it is broken.
359 try:
Eric S. Raymondc013f302001-02-09 05:40:38 +0000360 errcode = int(code)
Guido van Rossum296e1431999-04-07 15:03:39 +0000361 except ValueError:
362 errcode = -1
363 break
Guido van Rossumf123f841999-03-29 20:33:21 +0000364 # Check if multiline response.
Giampaolo Rodolà5c12ec62011-02-24 20:43:11 +0000365 if line[3:4] != "-":
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000366 break
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000367
Eric S. Raymondc013f302001-02-09 05:40:38 +0000368 errmsg = "\n".join(resp)
Tim Peters495ad3c2001-01-15 01:36:40 +0000369 if self.debuglevel > 0:
Giampaolo Rodolà5c12ec62011-02-24 20:43:11 +0000370 print>>stderr, 'reply: retcode (%s); Msg: %s' % (errcode, errmsg)
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000371 return errcode, errmsg
Tim Peters495ad3c2001-01-15 01:36:40 +0000372
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000373 def docmd(self, cmd, args=""):
Barry Warsawa7d9bdf1998-12-22 03:24:27 +0000374 """Send a command, and return its response code."""
Giampaolo Rodolà5c12ec62011-02-24 20:43:11 +0000375 self.putcmd(cmd, args)
Guido van Rossum296e1431999-04-07 15:03:39 +0000376 return self.getreply()
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000377
Barry Warsawa7d9bdf1998-12-22 03:24:27 +0000378 # std smtp commands
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000379 def helo(self, name=''):
Barry Warsawa7d9bdf1998-12-22 03:24:27 +0000380 """SMTP 'helo' command.
381 Hostname to send for this command defaults to the FQDN of the local
382 host.
383 """
Neil Schemenauer6730f262002-03-24 15:30:40 +0000384 self.putcmd("helo", name or self.local_hostname)
Giampaolo Rodolà5c12ec62011-02-24 20:43:11 +0000385 (code, msg) = self.getreply()
386 self.helo_resp = msg
387 return (code, msg)
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000388
Guido van Rossum95e6f701998-06-25 02:15:50 +0000389 def ehlo(self, name=''):
Barry Warsawa7d9bdf1998-12-22 03:24:27 +0000390 """ SMTP 'ehlo' command.
391 Hostname to send for this command defaults to the FQDN of the local
392 host.
393 """
Guido van Rossumf7fcf5e2001-09-14 16:08:44 +0000394 self.esmtp_features = {}
Martin v. Löwis1190a382007-03-09 15:35:55 +0000395 self.putcmd(self.ehlo_msg, name or self.local_hostname)
Giampaolo Rodolà5c12ec62011-02-24 20:43:11 +0000396 (code, msg) = self.getreply()
Tim Peters495ad3c2001-01-15 01:36:40 +0000397 # According to RFC1869 some (badly written)
398 # MTA's will disconnect on an ehlo. Toss an exception if
Guido van Rossumfcfb6321998-08-04 15:29:54 +0000399 # that happens -ddm
400 if code == -1 and len(msg) == 0:
Barry Warsaw76750972001-12-14 20:34:20 +0000401 self.close()
Guido van Rossum40233ea1999-01-15 03:23:55 +0000402 raise SMTPServerDisconnected("Server not connected")
Giampaolo Rodolà5c12ec62011-02-24 20:43:11 +0000403 self.ehlo_resp = msg
Fred Drake8152d322000-12-12 23:20:45 +0000404 if code != 250:
Giampaolo Rodolà5c12ec62011-02-24 20:43:11 +0000405 return (code, msg)
406 self.does_esmtp = 1
Thomas Wouters7e474022000-07-16 12:04:32 +0000407 #parse the ehlo response -ddm
Giampaolo Rodolà5c12ec62011-02-24 20:43:11 +0000408 resp = self.ehlo_resp.split('\n')
Guido van Rossumfcfb6321998-08-04 15:29:54 +0000409 del resp[0]
Guido van Rossum2880f6e1998-08-10 20:07:00 +0000410 for each in resp:
Piers Lauder385a77a2002-07-27 00:38:30 +0000411 # To be able to communicate with as many SMTP servers as possible,
412 # we have to take the old-style auth advertisement into account,
413 # because:
414 # 1) Else our SMTP feature parser gets confused.
415 # 2) There are some servers that only advertise the auth methods we
416 # support using the old style.
417 auth_match = OLDSTYLE_AUTH.match(each)
418 if auth_match:
419 # This doesn't remove duplicates, but that's no problem
420 self.esmtp_features["auth"] = self.esmtp_features.get("auth", "") \
421 + " " + auth_match.groups(0)[0]
422 continue
423
Barry Warsawbe22ae62002-04-15 20:03:30 +0000424 # RFC 1869 requires a space between ehlo keyword and parameters.
425 # It's actually stricter, in that only spaces are allowed between
426 # parameters, but were not going to check for that here. Note
427 # that the space isn't present if there are no parameters.
Giampaolo Rodolà5c12ec62011-02-24 20:43:11 +0000428 m = re.match(r'(?P<feature>[A-Za-z0-9][A-Za-z0-9\-]*) ?', each)
Guido van Rossumfcfb6321998-08-04 15:29:54 +0000429 if m:
Giampaolo Rodolà5c12ec62011-02-24 20:43:11 +0000430 feature = m.group("feature").lower()
431 params = m.string[m.end("feature"):].strip()
Piers Lauder385a77a2002-07-27 00:38:30 +0000432 if feature == "auth":
433 self.esmtp_features[feature] = self.esmtp_features.get(feature, "") \
434 + " " + params
435 else:
Giampaolo Rodolà5c12ec62011-02-24 20:43:11 +0000436 self.esmtp_features[feature] = params
437 return (code, msg)
Guido van Rossum95e6f701998-06-25 02:15:50 +0000438
Guido van Rossumfcfb6321998-08-04 15:29:54 +0000439 def has_extn(self, opt):
440 """Does the server support a given SMTP service extension?"""
Raymond Hettinger54f02222002-06-01 14:18:47 +0000441 return opt.lower() in self.esmtp_features
Guido van Rossum95e6f701998-06-25 02:15:50 +0000442
Guido van Rossum18586f41998-04-03 17:03:13 +0000443 def help(self, args=''):
Barry Warsawa7d9bdf1998-12-22 03:24:27 +0000444 """SMTP 'help' command.
445 Returns help text from server."""
Guido van Rossum18586f41998-04-03 17:03:13 +0000446 self.putcmd("help", args)
Kurt B. Kaiser58bd1902005-06-26 18:27:36 +0000447 return self.getreply()[1]
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000448
449 def rset(self):
Barry Warsawa7d9bdf1998-12-22 03:24:27 +0000450 """SMTP 'rset' command -- resets session."""
Guido van Rossum296e1431999-04-07 15:03:39 +0000451 return self.docmd("rset")
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000452
453 def noop(self):
Barry Warsawa7d9bdf1998-12-22 03:24:27 +0000454 """SMTP 'noop' command -- doesn't do anything :>"""
Guido van Rossum296e1431999-04-07 15:03:39 +0000455 return self.docmd("noop")
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000456
Giampaolo Rodolà5c12ec62011-02-24 20:43:11 +0000457 def mail(self, sender, options=[]):
Barry Warsawa7d9bdf1998-12-22 03:24:27 +0000458 """SMTP 'mail' command -- begins mail xfer session."""
Guido van Rossumfcfb6321998-08-04 15:29:54 +0000459 optionlist = ''
460 if options and self.does_esmtp:
Eric S. Raymondc013f302001-02-09 05:40:38 +0000461 optionlist = ' ' + ' '.join(options)
Giampaolo Rodolà5c12ec62011-02-24 20:43:11 +0000462 self.putcmd("mail", "FROM:%s%s" % (quoteaddr(sender), optionlist))
Guido van Rossum45e2fbc1998-03-26 21:13:24 +0000463 return self.getreply()
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000464
Giampaolo Rodolà5c12ec62011-02-24 20:43:11 +0000465 def rcpt(self, recip, options=[]):
Barry Warsawa7d9bdf1998-12-22 03:24:27 +0000466 """SMTP 'rcpt' command -- indicates 1 recipient for this mail."""
Guido van Rossumfcfb6321998-08-04 15:29:54 +0000467 optionlist = ''
468 if options and self.does_esmtp:
Eric S. Raymondc013f302001-02-09 05:40:38 +0000469 optionlist = ' ' + ' '.join(options)
Giampaolo Rodolà5c12ec62011-02-24 20:43:11 +0000470 self.putcmd("rcpt", "TO:%s%s" % (quoteaddr(recip), optionlist))
Guido van Rossum45e2fbc1998-03-26 21:13:24 +0000471 return self.getreply()
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000472
Giampaolo Rodolà5c12ec62011-02-24 20:43:11 +0000473 def data(self, msg):
Tim Peters495ad3c2001-01-15 01:36:40 +0000474 """SMTP 'DATA' command -- sends message data to server.
Guido van Rossum296e1431999-04-07 15:03:39 +0000475
Barry Warsaw4c4bec81998-12-22 03:02:20 +0000476 Automatically quotes lines beginning with a period per rfc821.
Guido van Rossum296e1431999-04-07 15:03:39 +0000477 Raises SMTPDataError if there is an unexpected reply to the
478 DATA command; the return value from this method is the final
479 response code received when the all data is sent.
Barry Warsaw4c4bec81998-12-22 03:02:20 +0000480 """
Guido van Rossum45e2fbc1998-03-26 21:13:24 +0000481 self.putcmd("data")
Giampaolo Rodolà5c12ec62011-02-24 20:43:11 +0000482 (code, repl) = self.getreply()
483 if self.debuglevel > 0:
484 print>>stderr, "data:", (code, repl)
Fred Drake8152d322000-12-12 23:20:45 +0000485 if code != 354:
Giampaolo Rodolà5c12ec62011-02-24 20:43:11 +0000486 raise SMTPDataError(code, repl)
Guido van Rossum45e2fbc1998-03-26 21:13:24 +0000487 else:
Guido van Rossum20c92281999-04-21 16:52:20 +0000488 q = quotedata(msg)
489 if q[-2:] != CRLF:
490 q = q + CRLF
491 q = q + "." + CRLF
492 self.send(q)
Giampaolo Rodolà5c12ec62011-02-24 20:43:11 +0000493 (code, msg) = self.getreply()
494 if self.debuglevel > 0:
495 print>>stderr, "data:", (code, msg)
496 return (code, msg)
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000497
Guido van Rossumfcfb6321998-08-04 15:29:54 +0000498 def verify(self, address):
Barry Warsawa7d9bdf1998-12-22 03:24:27 +0000499 """SMTP 'verify' command -- checks for address validity."""
Guido van Rossumfcfb6321998-08-04 15:29:54 +0000500 self.putcmd("vrfy", quoteaddr(address))
501 return self.getreply()
Barry Warsaw4c4bec81998-12-22 03:02:20 +0000502 # a.k.a.
Giampaolo Rodolà5c12ec62011-02-24 20:43:11 +0000503 vrfy = verify
Guido van Rossumfcfb6321998-08-04 15:29:54 +0000504
505 def expn(self, address):
Facundo Batista16609332008-02-23 12:27:17 +0000506 """SMTP 'expn' command -- expands a mailing list."""
Guido van Rossumfcfb6321998-08-04 15:29:54 +0000507 self.putcmd("expn", quoteaddr(address))
508 return self.getreply()
509
Barry Warsaw4c4bec81998-12-22 03:02:20 +0000510 # some useful methods
Guido van Rossumae010462001-09-11 15:57:46 +0000511
Gregory P. Smithbde4ae42008-01-17 08:35:49 +0000512 def ehlo_or_helo_if_needed(self):
513 """Call self.ehlo() and/or self.helo() if needed.
514
515 If there has been no previous EHLO or HELO command this session, this
516 method tries ESMTP EHLO first.
517
518 This method may raise the following exceptions:
519
520 SMTPHeloError The server didn't reply properly to
521 the helo greeting.
522 """
523 if self.helo_resp is None and self.ehlo_resp is None:
524 if not (200 <= self.ehlo()[0] <= 299):
525 (code, resp) = self.helo()
526 if not (200 <= code <= 299):
527 raise SMTPHeloError(code, resp)
528
Guido van Rossumae010462001-09-11 15:57:46 +0000529 def login(self, user, password):
530 """Log in on an SMTP server that requires authentication.
531
532 The arguments are:
533 - user: The user name to authenticate with.
534 - password: The password for the authentication.
535
536 If there has been no previous EHLO or HELO command this session, this
537 method tries ESMTP EHLO first.
538
539 This method will return normally if the authentication was successful.
540
541 This method may raise the following exceptions:
542
543 SMTPHeloError The server didn't reply properly to
544 the helo greeting.
545 SMTPAuthenticationError The server didn't accept the username/
546 password combination.
Fred Drake2f8f4d32001-10-13 18:35:32 +0000547 SMTPException No suitable authentication method was
Guido van Rossumae010462001-09-11 15:57:46 +0000548 found.
549 """
550
551 def encode_cram_md5(challenge, user, password):
552 challenge = base64.decodestring(challenge)
553 response = user + " " + hmac.HMAC(password, challenge).hexdigest()
Piers Lauder385a77a2002-07-27 00:38:30 +0000554 return encode_base64(response, eol="")
Guido van Rossumae010462001-09-11 15:57:46 +0000555
556 def encode_plain(user, password):
Johannes Gijsbers25946dd2004-12-06 21:25:26 +0000557 return encode_base64("\0%s\0%s" % (user, password), eol="")
Tim Peters469cdad2002-08-08 20:19:19 +0000558
Guido van Rossumae010462001-09-11 15:57:46 +0000559
560 AUTH_PLAIN = "PLAIN"
561 AUTH_CRAM_MD5 = "CRAM-MD5"
Piers Lauder385a77a2002-07-27 00:38:30 +0000562 AUTH_LOGIN = "LOGIN"
Guido van Rossumae010462001-09-11 15:57:46 +0000563
Gregory P. Smithbde4ae42008-01-17 08:35:49 +0000564 self.ehlo_or_helo_if_needed()
Guido van Rossumae010462001-09-11 15:57:46 +0000565
566 if not self.has_extn("auth"):
567 raise SMTPException("SMTP AUTH extension not supported by server.")
568
569 # Authentication methods the server supports:
570 authlist = self.esmtp_features["auth"].split()
571
572 # List of authentication methods we support: from preferred to
573 # less preferred methods. Except for the purpose of testing the weaker
574 # ones, we prefer stronger methods like CRAM-MD5:
Piers Lauder385a77a2002-07-27 00:38:30 +0000575 preferred_auths = [AUTH_CRAM_MD5, AUTH_PLAIN, AUTH_LOGIN]
Guido van Rossumae010462001-09-11 15:57:46 +0000576
577 # Determine the authentication method we'll use
578 authmethod = None
579 for method in preferred_auths:
580 if method in authlist:
581 authmethod = method
582 break
Tim Petersb64bec32001-09-18 02:26:39 +0000583
Guido van Rossumae010462001-09-11 15:57:46 +0000584 if authmethod == AUTH_CRAM_MD5:
585 (code, resp) = self.docmd("AUTH", AUTH_CRAM_MD5)
586 if code == 503:
587 # 503 == 'Error: already authenticated'
588 return (code, resp)
589 (code, resp) = self.docmd(encode_cram_md5(resp, user, password))
590 elif authmethod == AUTH_PLAIN:
Tim Petersb64bec32001-09-18 02:26:39 +0000591 (code, resp) = self.docmd("AUTH",
Guido van Rossumae010462001-09-11 15:57:46 +0000592 AUTH_PLAIN + " " + encode_plain(user, password))
Piers Lauder385a77a2002-07-27 00:38:30 +0000593 elif authmethod == AUTH_LOGIN:
594 (code, resp) = self.docmd("AUTH",
595 "%s %s" % (AUTH_LOGIN, encode_base64(user, eol="")))
596 if code != 334:
597 raise SMTPAuthenticationError(code, resp)
Martin v. Löwis49c05d32002-10-06 17:55:08 +0000598 (code, resp) = self.docmd(encode_base64(password, eol=""))
Raymond Hettinger7fdfc2d2002-05-31 17:49:10 +0000599 elif authmethod is None:
Fred Drake2f8f4d32001-10-13 18:35:32 +0000600 raise SMTPException("No suitable authentication method found.")
Raymond Hettingerdbecd932005-02-06 06:57:08 +0000601 if code not in (235, 503):
Guido van Rossumae010462001-09-11 15:57:46 +0000602 # 235 == 'Authentication successful'
603 # 503 == 'Error: already authenticated'
604 raise SMTPAuthenticationError(code, resp)
605 return (code, resp)
606
Giampaolo Rodolà5c12ec62011-02-24 20:43:11 +0000607 def starttls(self, keyfile=None, certfile=None):
Guido van Rossumf7fcf5e2001-09-14 16:08:44 +0000608 """Puts the connection to the SMTP server into TLS mode.
Tim Petersb64bec32001-09-18 02:26:39 +0000609
Gregory P. Smithbde4ae42008-01-17 08:35:49 +0000610 If there has been no previous EHLO or HELO command this session, this
611 method tries ESMTP EHLO first.
612
Guido van Rossumf7fcf5e2001-09-14 16:08:44 +0000613 If the server supports TLS, this will encrypt the rest of the SMTP
614 session. If you provide the keyfile and certfile parameters,
615 the identity of the SMTP server and client can be checked. This,
616 however, depends on whether the socket module really checks the
617 certificates.
Gregory P. Smithbde4ae42008-01-17 08:35:49 +0000618
619 This method may raise the following exceptions:
620
621 SMTPHeloError The server didn't reply properly to
622 the helo greeting.
Guido van Rossumf7fcf5e2001-09-14 16:08:44 +0000623 """
Gregory P. Smithbde4ae42008-01-17 08:35:49 +0000624 self.ehlo_or_helo_if_needed()
625 if not self.has_extn("starttls"):
626 raise SMTPException("STARTTLS extension not supported by server.")
Tim Petersb64bec32001-09-18 02:26:39 +0000627 (resp, reply) = self.docmd("STARTTLS")
Guido van Rossumf7fcf5e2001-09-14 16:08:44 +0000628 if resp == 220:
Bill Janssen426ea0a2007-08-29 22:35:05 +0000629 if not _have_ssl:
630 raise RuntimeError("No SSL support included in this Python")
Bill Janssen98d19da2007-09-10 21:51:02 +0000631 self.sock = ssl.wrap_socket(self.sock, keyfile, certfile)
Bill Janssen426ea0a2007-08-29 22:35:05 +0000632 self.file = SSLFakeFile(self.sock)
Gregory P. Smith63bfc1d2008-01-17 07:43:20 +0000633 # RFC 3207:
634 # The client MUST discard any knowledge obtained from
635 # the server, such as the list of SMTP service extensions,
636 # which was not obtained from the TLS negotiation itself.
637 self.helo_resp = None
638 self.ehlo_resp = None
639 self.esmtp_features = {}
640 self.does_esmtp = 0
Guido van Rossumf7fcf5e2001-09-14 16:08:44 +0000641 return (resp, reply)
Tim Petersb64bec32001-09-18 02:26:39 +0000642
Jeremy Hylton31bb8ce1998-08-13 19:57:46 +0000643 def sendmail(self, from_addr, to_addrs, msg, mail_options=[],
Tim Peters495ad3c2001-01-15 01:36:40 +0000644 rcpt_options=[]):
645 """This command performs an entire mail transaction.
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000646
Tim Peters495ad3c2001-01-15 01:36:40 +0000647 The arguments are:
Barry Warsaw4c4bec81998-12-22 03:02:20 +0000648 - from_addr : The address sending this mail.
649 - to_addrs : A list of addresses to send this mail to. A bare
650 string will be treated as a list with 1 address.
Tim Peters495ad3c2001-01-15 01:36:40 +0000651 - msg : The message to send.
Barry Warsaw4c4bec81998-12-22 03:02:20 +0000652 - mail_options : List of ESMTP options (such as 8bitmime) for the
653 mail command.
654 - rcpt_options : List of ESMTP options (such as DSN commands) for
655 all the rcpt commands.
656
657 If there has been no previous EHLO or HELO command this session, this
658 method tries ESMTP EHLO first. If the server does ESMTP, message size
659 and each of the specified options will be passed to it. If EHLO
660 fails, HELO will be tried and ESMTP options suppressed.
661
662 This method will return normally if the mail is accepted for at least
Barry Warsawd25c1b71999-11-28 17:11:06 +0000663 one recipient. It returns a dictionary, with one entry for each
664 recipient that was refused. Each entry contains a tuple of the SMTP
665 error code and the accompanying error message sent by the server.
Guido van Rossum296e1431999-04-07 15:03:39 +0000666
667 This method may raise the following exceptions:
668
669 SMTPHeloError The server didn't reply properly to
Tim Peters495ad3c2001-01-15 01:36:40 +0000670 the helo greeting.
Barry Warsawd25c1b71999-11-28 17:11:06 +0000671 SMTPRecipientsRefused The server rejected ALL recipients
Guido van Rossum296e1431999-04-07 15:03:39 +0000672 (no mail was sent).
673 SMTPSenderRefused The server didn't accept the from_addr.
674 SMTPDataError The server replied with an unexpected
675 error code (other than a refusal of
676 a recipient).
677
678 Note: the connection will be open even after an exception is raised.
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000679
Guido van Rossum95e6f701998-06-25 02:15:50 +0000680 Example:
Tim Peters495ad3c2001-01-15 01:36:40 +0000681
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000682 >>> import smtplib
683 >>> s=smtplib.SMTP("localhost")
Guido van Rossumfc40a831998-01-29 17:26:45 +0000684 >>> tolist=["one@one.org","two@two.org","three@three.org","four@four.org"]
Martin v. Löwis301b1cd2002-07-28 16:52:01 +0000685 >>> msg = '''\\
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000686 ... From: Me@my.org
687 ... Subject: testin'...
688 ...
689 ... This is a test '''
690 >>> s.sendmail("me@my.org",tolist,msg)
691 { "three@three.org" : ( 550 ,"User unknown" ) }
692 >>> s.quit()
Tim Peters495ad3c2001-01-15 01:36:40 +0000693
Barry Warsaw4c4bec81998-12-22 03:02:20 +0000694 In the above example, the message was accepted for delivery to three
695 of the four addresses, and one was rejected, with the error code
Barry Warsawd25c1b71999-11-28 17:11:06 +0000696 550. If all addresses are accepted, then the method will return an
Barry Warsaw4c4bec81998-12-22 03:02:20 +0000697 empty dictionary.
698
699 """
Gregory P. Smithbde4ae42008-01-17 08:35:49 +0000700 self.ehlo_or_helo_if_needed()
Guido van Rossum95e6f701998-06-25 02:15:50 +0000701 esmtp_opts = []
Guido van Rossumfcfb6321998-08-04 15:29:54 +0000702 if self.does_esmtp:
703 # Hmmm? what's this? -ddm
704 # self.esmtp_features['7bit']=""
705 if self.has_extn('size'):
Walter Dörwald70a6b492004-02-12 17:35:32 +0000706 esmtp_opts.append("size=%d" % len(msg))
Guido van Rossumfcfb6321998-08-04 15:29:54 +0000707 for option in mail_options:
Guido van Rossum95e6f701998-06-25 02:15:50 +0000708 esmtp_opts.append(option)
Guido van Rossumfcfb6321998-08-04 15:29:54 +0000709
Giampaolo Rodolà5c12ec62011-02-24 20:43:11 +0000710 (code, resp) = self.mail(from_addr, esmtp_opts)
Fred Drake8152d322000-12-12 23:20:45 +0000711 if code != 250:
Guido van Rossum45e2fbc1998-03-26 21:13:24 +0000712 self.rset()
Guido van Rossum296e1431999-04-07 15:03:39 +0000713 raise SMTPSenderRefused(code, resp, from_addr)
Giampaolo Rodolà5c12ec62011-02-24 20:43:11 +0000714 senderrs = {}
Walter Dörwald65230a22002-06-03 15:58:32 +0000715 if isinstance(to_addrs, basestring):
Jeremy Hylton31bb8ce1998-08-13 19:57:46 +0000716 to_addrs = [to_addrs]
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000717 for each in to_addrs:
Giampaolo Rodolà5c12ec62011-02-24 20:43:11 +0000718 (code, resp) = self.rcpt(each, rcpt_options)
Fred Drake8152d322000-12-12 23:20:45 +0000719 if (code != 250) and (code != 251):
Giampaolo Rodolà5c12ec62011-02-24 20:43:11 +0000720 senderrs[each] = (code, resp)
721 if len(senderrs) == len(to_addrs):
Guido van Rossum95e6f701998-06-25 02:15:50 +0000722 # the server refused all our recipients
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000723 self.rset()
Guido van Rossum296e1431999-04-07 15:03:39 +0000724 raise SMTPRecipientsRefused(senderrs)
Giampaolo Rodolà5c12ec62011-02-24 20:43:11 +0000725 (code, resp) = self.data(msg)
Fred Drake8152d322000-12-12 23:20:45 +0000726 if code != 250:
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000727 self.rset()
Guido van Rossum296e1431999-04-07 15:03:39 +0000728 raise SMTPDataError(code, resp)
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000729 #if we got here then somebody got our mail
Tim Peters495ad3c2001-01-15 01:36:40 +0000730 return senderrs
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000731
732
733 def close(self):
734 """Close the connection to the SMTP server."""
735 if self.file:
736 self.file.close()
737 self.file = None
738 if self.sock:
739 self.sock.close()
740 self.sock = None
741
742
743 def quit(self):
Guido van Rossum95e6f701998-06-25 02:15:50 +0000744 """Terminate the SMTP session."""
Georg Brandldeaf2ca2008-03-27 13:27:31 +0000745 res = self.docmd("quit")
Guido van Rossum45e2fbc1998-03-26 21:13:24 +0000746 self.close()
Georg Brandldeaf2ca2008-03-27 13:27:31 +0000747 return res
Guido van Rossum95e6f701998-06-25 02:15:50 +0000748
Bill Janssen426ea0a2007-08-29 22:35:05 +0000749if _have_ssl:
Martin v. Löwisee82c0e2006-10-27 07:13:28 +0000750
Bill Janssen426ea0a2007-08-29 22:35:05 +0000751 class SMTP_SSL(SMTP):
752 """ This is a subclass derived from SMTP that connects over an SSL encrypted
753 socket (to use this class you need a socket module that was compiled with SSL
754 support). If host is not specified, '' (the local host) is used. If port is
755 omitted, the standard SMTP-over-SSL port (465) is used. keyfile and certfile
756 are also optional - they can contain a PEM formatted private key and
757 certificate chain file for the SSL connection.
758 """
759 def __init__(self, host='', port=0, local_hostname=None,
Facundo Batista4f1b1ed2008-05-29 16:39:26 +0000760 keyfile=None, certfile=None,
761 timeout=socket._GLOBAL_DEFAULT_TIMEOUT):
Bill Janssen426ea0a2007-08-29 22:35:05 +0000762 self.keyfile = keyfile
763 self.certfile = certfile
764 SMTP.__init__(self, host, port, local_hostname, timeout)
765 self.default_port = SMTP_SSL_PORT
766
767 def _get_socket(self, host, port, timeout):
Giampaolo Rodolà5c12ec62011-02-24 20:43:11 +0000768 if self.debuglevel > 0:
769 print>>stderr, 'connect:', (host, port)
R. David Murrayad3058e2009-05-23 00:48:58 +0000770 new_socket = socket.create_connection((host, port), timeout)
771 new_socket = ssl.wrap_socket(new_socket, self.keyfile, self.certfile)
772 self.file = SSLFakeFile(new_socket)
773 return new_socket
Barry Warsaw4c4bec81998-12-22 03:02:20 +0000774
Thomas Woutersa6900e82007-08-30 21:54:39 +0000775 __all__.append("SMTP_SSL")
776
Martin v. Löwis1190a382007-03-09 15:35:55 +0000777#
778# LMTP extension
779#
780LMTP_PORT = 2003
781
782class LMTP(SMTP):
783 """LMTP - Local Mail Transfer Protocol
784
785 The LMTP protocol, which is very similar to ESMTP, is heavily based
786 on the standard SMTP client. It's common to use Unix sockets for LMTP,
787 so our connect() method must support that as well as a regular
788 host:port server. To specify a Unix socket, you must use an absolute
789 path as the host, starting with a '/'.
790
791 Authentication is supported, using the regular SMTP mechanism. When
792 using a Unix socket, LMTP generally don't support or require any
793 authentication, but your mileage might vary."""
794
795 ehlo_msg = "lhlo"
Tim Petersea5962f2007-03-12 18:07:52 +0000796
Giampaolo Rodolà5c12ec62011-02-24 20:43:11 +0000797 def __init__(self, host='', port=LMTP_PORT, local_hostname=None):
Martin v. Löwis1190a382007-03-09 15:35:55 +0000798 """Initialize a new instance."""
799 SMTP.__init__(self, host, port, local_hostname)
800
Giampaolo Rodolà5c12ec62011-02-24 20:43:11 +0000801 def connect(self, host='localhost', port=0):
Martin v. Löwis1190a382007-03-09 15:35:55 +0000802 """Connect to the LMTP daemon, on either a Unix or a TCP socket."""
Neal Norwitzc8f6c232007-03-10 03:19:18 +0000803 if host[0] != '/':
Martin v. Löwis1190a382007-03-09 15:35:55 +0000804 return SMTP.connect(self, host, port)
805
Neal Norwitzc8f6c232007-03-10 03:19:18 +0000806 # Handle Unix-domain sockets.
807 try:
808 self.sock = socket.socket(socket.AF_UNIX, socket.SOCK_STREAM)
809 self.sock.connect(host)
810 except socket.error, msg:
Giampaolo Rodolà5c12ec62011-02-24 20:43:11 +0000811 if self.debuglevel > 0:
812 print>>stderr, 'connect fail:', host
Neal Norwitzc8f6c232007-03-10 03:19:18 +0000813 if self.sock:
814 self.sock.close()
815 self.sock = None
816 raise socket.error, msg
817 (code, msg) = self.getreply()
Giampaolo Rodolà5c12ec62011-02-24 20:43:11 +0000818 if self.debuglevel > 0:
819 print>>stderr, "connect:", msg
Neal Norwitzc8f6c232007-03-10 03:19:18 +0000820 return (code, msg)
821
Martin v. Löwis1190a382007-03-09 15:35:55 +0000822
Guido van Rossum95e6f701998-06-25 02:15:50 +0000823# Test the sendmail method, which tests most of the others.
824# Note: This always sends to localhost.
825if __name__ == '__main__':
Andrew M. Kuchling6be424f2001-08-13 14:41:39 +0000826 import sys
Guido van Rossum95e6f701998-06-25 02:15:50 +0000827
828 def prompt(prompt):
829 sys.stdout.write(prompt + ": ")
Eric S. Raymondc013f302001-02-09 05:40:38 +0000830 return sys.stdin.readline().strip()
Guido van Rossum95e6f701998-06-25 02:15:50 +0000831
832 fromaddr = prompt("From")
Giampaolo Rodolà5c12ec62011-02-24 20:43:11 +0000833 toaddrs = prompt("To").split(',')
Guido van Rossum95e6f701998-06-25 02:15:50 +0000834 print "Enter message, end with ^D:"
835 msg = ''
836 while 1:
837 line = sys.stdin.readline()
838 if not line:
839 break
840 msg = msg + line
Walter Dörwald70a6b492004-02-12 17:35:32 +0000841 print "Message length is %d" % len(msg)
Guido van Rossum95e6f701998-06-25 02:15:50 +0000842
843 server = SMTP('localhost')
844 server.set_debuglevel(1)
845 server.sendmail(fromaddr, toaddrs, msg)
846 server.quit()