blob: 69d7f71d96ab1f1a11865c7bac3b7d6057b09b61 [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
Skip Montanaro0de65802001-02-15 22:15:14 +000052__all__ = ["SMTPException","SMTPServerDisconnected","SMTPResponseException",
53 "SMTPSenderRefused","SMTPRecipientsRefused","SMTPDataError",
Guido van Rossumae010462001-09-11 15:57:46 +000054 "SMTPConnectError","SMTPHeloError","SMTPAuthenticationError",
Thomas Woutersa6900e82007-08-30 21:54:39 +000055 "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
Guido van Rossumbbe323e1998-01-29 17:24:40 +000059CRLF="\r\n"
60
Piers Lauder385a77a2002-07-27 00:38:30 +000061OLDSTYLE_AUTH = re.compile(r"auth=(.*)", re.I)
62
Tim Peters495ad3c2001-01-15 01:36:40 +000063# Exception classes used by this module.
Guido van Rossum296e1431999-04-07 15:03:39 +000064class SMTPException(Exception):
65 """Base class for all exceptions raised by this module."""
66
67class SMTPServerDisconnected(SMTPException):
68 """Not connected to any SMTP server.
69
70 This exception is raised when the server unexpectedly disconnects,
71 or when an attempt is made to use the SMTP instance before
72 connecting it to a server.
73 """
74
75class SMTPResponseException(SMTPException):
76 """Base class for all exceptions that include an SMTP error code.
77
78 These exceptions are generated in some instances when the SMTP
79 server returns an error code. The error code is stored in the
80 `smtp_code' attribute of the error, and the `smtp_error' attribute
81 is set to the error message.
82 """
83
84 def __init__(self, code, msg):
85 self.smtp_code = code
86 self.smtp_error = msg
87 self.args = (code, msg)
88
89class SMTPSenderRefused(SMTPResponseException):
90 """Sender address refused.
Guido van Rossumae010462001-09-11 15:57:46 +000091
Guido van Rossum296e1431999-04-07 15:03:39 +000092 In addition to the attributes set by on all SMTPResponseException
Barry Warsawd25c1b71999-11-28 17:11:06 +000093 exceptions, this sets `sender' to the string that the SMTP refused.
Guido van Rossum296e1431999-04-07 15:03:39 +000094 """
95
96 def __init__(self, code, msg, sender):
97 self.smtp_code = code
98 self.smtp_error = msg
99 self.sender = sender
100 self.args = (code, msg, sender)
101
Guido van Rossum20c92281999-04-21 16:52:20 +0000102class SMTPRecipientsRefused(SMTPException):
Barry Warsawd25c1b71999-11-28 17:11:06 +0000103 """All recipient addresses refused.
Guido van Rossumae010462001-09-11 15:57:46 +0000104
Thomas Wouters7e474022000-07-16 12:04:32 +0000105 The errors for each recipient are accessible through the attribute
Tim Peters495ad3c2001-01-15 01:36:40 +0000106 'recipients', which is a dictionary of exactly the same sort as
107 SMTP.sendmail() returns.
Guido van Rossum296e1431999-04-07 15:03:39 +0000108 """
109
110 def __init__(self, recipients):
111 self.recipients = recipients
112 self.args = ( recipients,)
113
114
Guido van Rossum296e1431999-04-07 15:03:39 +0000115class SMTPDataError(SMTPResponseException):
116 """The SMTP server didn't accept the data."""
117
118class SMTPConnectError(SMTPResponseException):
Barry Warsawd25c1b71999-11-28 17:11:06 +0000119 """Error during connection establishment."""
Guido van Rossum296e1431999-04-07 15:03:39 +0000120
121class SMTPHeloError(SMTPResponseException):
Barry Warsawd25c1b71999-11-28 17:11:06 +0000122 """The server refused our HELO reply."""
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000123
Guido van Rossumae010462001-09-11 15:57:46 +0000124class SMTPAuthenticationError(SMTPResponseException):
125 """Authentication error.
126
127 Most probably the server didn't accept the username/password
128 combination provided.
129 """
Peter Schneider-Kamp7bc82bb2000-08-10 14:02:23 +0000130
Guido van Rossum69a79bc1998-07-13 15:18:49 +0000131def quoteaddr(addr):
132 """Quote a subset of the email addresses defined by RFC 821.
133
Barry Warsawa7d9bdf1998-12-22 03:24:27 +0000134 Should be able to handle anything rfc822.parseaddr can handle.
135 """
Raymond Hettinger342456d2002-09-05 01:14:07 +0000136 m = (None, None)
Guido van Rossum69a79bc1998-07-13 15:18:49 +0000137 try:
Georg Brandl5a096e12007-01-22 19:40:21 +0000138 m = email.utils.parseaddr(addr)[1]
Guido van Rossumfcfb6321998-08-04 15:29:54 +0000139 except AttributeError:
140 pass
Raymond Hettinger342456d2002-09-05 01:14:07 +0000141 if m == (None, None): # Indicates parse failure or AttributeError
Georg Brandlbd3bc4d2006-02-17 09:52:53 +0000142 # something weird here.. punt -ddm
Raymond Hettinger342456d2002-09-05 01:14:07 +0000143 return "<%s>" % addr
Georg Brandlbd3bc4d2006-02-17 09:52:53 +0000144 elif m is None:
145 # the sender wants an empty return address
146 return "<>"
Guido van Rossumfcfb6321998-08-04 15:29:54 +0000147 else:
148 return "<%s>" % m
Guido van Rossum69a79bc1998-07-13 15:18:49 +0000149
150def quotedata(data):
151 """Quote data for email.
152
Barry Warsawd25c1b71999-11-28 17:11:06 +0000153 Double leading '.', and change Unix newline '\\n', or Mac '\\r' into
Barry Warsawa7d9bdf1998-12-22 03:24:27 +0000154 Internet CRLF end-of-line.
155 """
Guido van Rossum69a79bc1998-07-13 15:18:49 +0000156 return re.sub(r'(?m)^\.', '..',
Guido van Rossumfcfb6321998-08-04 15:29:54 +0000157 re.sub(r'(?:\r\n|\n|\r(?!\n))', CRLF, data))
Guido van Rossum69a79bc1998-07-13 15:18:49 +0000158
Peter Schneider-Kamp7bc82bb2000-08-10 14:02:23 +0000159
Bill Janssen426ea0a2007-08-29 22:35:05 +0000160try:
161 import ssl
162except ImportError:
163 _have_ssl = False
164else:
Bill Janssen426ea0a2007-08-29 22:35:05 +0000165 class SSLFakeFile:
166 """A fake file like object that really wraps a SSLObject.
167
168 It only supports what is needed in smtplib.
169 """
170 def __init__(self, sslobj):
171 self.sslobj = sslobj
172
173 def readline(self):
174 str = ""
175 chr = None
176 while chr != "\n":
177 chr = self.sslobj.read(1)
Sean Reifscheiderac2ed1e2008-03-20 00:46:50 +0000178 if not chr: break
Bill Janssen426ea0a2007-08-29 22:35:05 +0000179 str += chr
180 return str
181
182 def close(self):
183 pass
184
185 _have_ssl = True
186
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000187class SMTP:
Guido van Rossumfcfb6321998-08-04 15:29:54 +0000188 """This class manages a connection to an SMTP or ESMTP server.
189 SMTP Objects:
Tim Peters495ad3c2001-01-15 01:36:40 +0000190 SMTP objects have the following attributes:
191 helo_resp
192 This is the message given by the server in response to the
Guido van Rossumfcfb6321998-08-04 15:29:54 +0000193 most recent HELO command.
Tim Peters495ad3c2001-01-15 01:36:40 +0000194
Guido van Rossumfcfb6321998-08-04 15:29:54 +0000195 ehlo_resp
Tim Peters495ad3c2001-01-15 01:36:40 +0000196 This is the message given by the server in response to the
Guido van Rossumfcfb6321998-08-04 15:29:54 +0000197 most recent EHLO command. This is usually multiline.
198
Tim Peters495ad3c2001-01-15 01:36:40 +0000199 does_esmtp
Guido van Rossumfcfb6321998-08-04 15:29:54 +0000200 This is a True value _after you do an EHLO command_, if the
201 server supports ESMTP.
202
Tim Peters495ad3c2001-01-15 01:36:40 +0000203 esmtp_features
Guido van Rossumfcfb6321998-08-04 15:29:54 +0000204 This is a dictionary, which, if the server supports ESMTP,
Barry Warsawd25c1b71999-11-28 17:11:06 +0000205 will _after you do an EHLO command_, contain the names of the
206 SMTP service extensions this server supports, and their
Guido van Rossumfcfb6321998-08-04 15:29:54 +0000207 parameters (if any).
Barry Warsawd25c1b71999-11-28 17:11:06 +0000208
Tim Peters495ad3c2001-01-15 01:36:40 +0000209 Note, all extension names are mapped to lower case in the
210 dictionary.
Guido van Rossumfcfb6321998-08-04 15:29:54 +0000211
Barry Warsawd25c1b71999-11-28 17:11:06 +0000212 See each method's docstrings for details. In general, there is a
213 method of the same name to perform each SMTP command. There is also a
214 method called 'sendmail' that will do an entire mail transaction.
215 """
Guido van Rossum95e6f701998-06-25 02:15:50 +0000216 debuglevel = 0
217 file = None
218 helo_resp = None
Martin v. Löwis1190a382007-03-09 15:35:55 +0000219 ehlo_msg = "ehlo"
Guido van Rossum95e6f701998-06-25 02:15:50 +0000220 ehlo_resp = None
Guido van Rossumfcfb6321998-08-04 15:29:54 +0000221 does_esmtp = 0
Guido van Rossum95e6f701998-06-25 02:15:50 +0000222
Facundo Batista4f1b1ed2008-05-29 16:39:26 +0000223 def __init__(self, host='', port=0, local_hostname=None,
224 timeout=socket._GLOBAL_DEFAULT_TIMEOUT):
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000225 """Initialize a new instance.
226
Barry Warsawa7d9bdf1998-12-22 03:24:27 +0000227 If specified, `host' is the name of the remote host to which to
228 connect. If specified, `port' specifies the port to which to connect.
Barry Warsawd25c1b71999-11-28 17:11:06 +0000229 By default, smtplib.SMTP_PORT is used. An SMTPConnectError is raised
Neil Schemenauer6730f262002-03-24 15:30:40 +0000230 if the specified `host' doesn't respond correctly. If specified,
Tim Peters863ac442002-04-16 01:38:40 +0000231 `local_hostname` is used as the FQDN of the local host. By default,
232 the local hostname is found using socket.getfqdn().
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000233
234 """
Facundo Batista366d6262007-03-28 18:25:54 +0000235 self.timeout = timeout
Guido van Rossumfcfb6321998-08-04 15:29:54 +0000236 self.esmtp_features = {}
Martin v. Löwisee82c0e2006-10-27 07:13:28 +0000237 self.default_port = SMTP_PORT
Guido van Rossum296e1431999-04-07 15:03:39 +0000238 if host:
239 (code, msg) = self.connect(host, port)
240 if code != 220:
241 raise SMTPConnectError(code, msg)
Raymond Hettingerf13eb552002-06-02 00:40:05 +0000242 if local_hostname is not None:
Barry Warsaw13e34f72002-03-26 20:27:35 +0000243 self.local_hostname = local_hostname
Neil Schemenauer6730f262002-03-24 15:30:40 +0000244 else:
Barry Warsaw13e34f72002-03-26 20:27:35 +0000245 # RFC 2821 says we should use the fqdn in the EHLO/HELO verb, and
246 # if that can't be calculated, that we should use a domain literal
247 # instead (essentially an encoded IP address like [A.B.C.D]).
248 fqdn = socket.getfqdn()
249 if '.' in fqdn:
250 self.local_hostname = fqdn
251 else:
252 # We can't find an fqdn hostname, so use a domain literal
Georg Brandldcdfd222006-03-31 19:34:13 +0000253 addr = '127.0.0.1'
254 try:
255 addr = socket.gethostbyname(socket.gethostname())
256 except socket.gaierror:
257 pass
Barry Warsaw13e34f72002-03-26 20:27:35 +0000258 self.local_hostname = '[%s]' % addr
Tim Peters495ad3c2001-01-15 01:36:40 +0000259
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000260 def set_debuglevel(self, debuglevel):
261 """Set the debug output level.
262
Barry Warsawa7d9bdf1998-12-22 03:24:27 +0000263 A non-false value results in debug messages for connection and for all
264 messages sent to and received from the server.
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000265
266 """
267 self.debuglevel = debuglevel
268
Facundo Batista366d6262007-03-28 18:25:54 +0000269 def _get_socket(self, port, host, timeout):
Martin v. Löwisee82c0e2006-10-27 07:13:28 +0000270 # This makes it simpler for SMTP_SSL to use the SMTP connect code
271 # and just alter the socket connection bit.
Martin v. Löwisee82c0e2006-10-27 07:13:28 +0000272 if self.debuglevel > 0: print>>stderr, 'connect:', (host, port)
Facundo Batista366d6262007-03-28 18:25:54 +0000273 return socket.create_connection((port, host), timeout)
Martin v. Löwisee82c0e2006-10-27 07:13:28 +0000274
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000275 def connect(self, host='localhost', port = 0):
276 """Connect to a host on a given port.
Guido van Rossum95e6f701998-06-25 02:15:50 +0000277
Barry Warsaw4c4bec81998-12-22 03:02:20 +0000278 If the hostname ends with a colon (`:') followed by a number, and
279 there is no port specified, that suffix will be stripped off and the
280 number interpreted as the port number to use.
Guido van Rossum95e6f701998-06-25 02:15:50 +0000281
Barry Warsawa7d9bdf1998-12-22 03:24:27 +0000282 Note: This method is automatically invoked by __init__, if a host is
283 specified during instantiation.
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000284
285 """
Martin v. Löwis4eb59402001-07-26 13:37:33 +0000286 if not port and (host.find(':') == host.rfind(':')):
Martin v. Löwisa43c2f82001-07-24 20:34:08 +0000287 i = host.rfind(':')
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000288 if i >= 0:
289 host, port = host[:i], host[i+1:]
Eric S. Raymondc013f302001-02-09 05:40:38 +0000290 try: port = int(port)
Eric S. Raymond8d876032001-02-09 10:14:53 +0000291 except ValueError:
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000292 raise socket.error, "nonnumeric port"
Martin v. Löwisee82c0e2006-10-27 07:13:28 +0000293 if not port: port = self.default_port
Brett Cannone6f8a892004-07-10 23:14:30 +0000294 if self.debuglevel > 0: print>>stderr, 'connect:', (host, port)
Facundo Batista366d6262007-03-28 18:25:54 +0000295 self.sock = self._get_socket(host, port, self.timeout)
Martin v. Löwisa43c2f82001-07-24 20:34:08 +0000296 (code, msg) = self.getreply()
Brett Cannone6f8a892004-07-10 23:14:30 +0000297 if self.debuglevel > 0: print>>stderr, "connect:", msg
Martin v. Löwisa43c2f82001-07-24 20:34:08 +0000298 return (code, msg)
Tim Peters495ad3c2001-01-15 01:36:40 +0000299
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000300 def send(self, str):
301 """Send `str' to the server."""
Brett Cannone6f8a892004-07-10 23:14:30 +0000302 if self.debuglevel > 0: print>>stderr, 'send:', repr(str)
Facundo Batista16609332008-02-23 12:27:17 +0000303 if hasattr(self, 'sock') and self.sock:
Guido van Rossum2880f6e1998-08-10 20:07:00 +0000304 try:
Martin v. Löwise12454f2002-02-16 23:06:19 +0000305 self.sock.sendall(str)
Guido van Rossum2880f6e1998-08-10 20:07:00 +0000306 except socket.error:
Barry Warsaw76750972001-12-14 20:34:20 +0000307 self.close()
Guido van Rossum40233ea1999-01-15 03:23:55 +0000308 raise SMTPServerDisconnected('Server not connected')
Guido van Rossumfc40a831998-01-29 17:26:45 +0000309 else:
Guido van Rossum40233ea1999-01-15 03:23:55 +0000310 raise SMTPServerDisconnected('please run connect() first')
Tim Peters495ad3c2001-01-15 01:36:40 +0000311
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000312 def putcmd(self, cmd, args=""):
Barry Warsawa7d9bdf1998-12-22 03:24:27 +0000313 """Send a command to the server."""
Guido van Rossumdb23d3d1999-06-09 15:13:10 +0000314 if args == "":
315 str = '%s%s' % (cmd, CRLF)
316 else:
317 str = '%s %s%s' % (cmd, args, CRLF)
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000318 self.send(str)
Tim Peters495ad3c2001-01-15 01:36:40 +0000319
Guido van Rossumfcfb6321998-08-04 15:29:54 +0000320 def getreply(self):
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000321 """Get a reply from the server.
Tim Peters495ad3c2001-01-15 01:36:40 +0000322
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000323 Returns a tuple consisting of:
Barry Warsawa7d9bdf1998-12-22 03:24:27 +0000324
325 - server response code (e.g. '250', or such, if all goes well)
326 Note: returns -1 if it can't read response code.
327
328 - server response string corresponding to response code (multiline
329 responses are converted to a single, multiline string).
Guido van Rossumf123f841999-03-29 20:33:21 +0000330
331 Raises SMTPServerDisconnected if end-of-file is reached.
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000332 """
333 resp=[]
Guido van Rossum296e1431999-04-07 15:03:39 +0000334 if self.file is None:
335 self.file = self.sock.makefile('rb')
Guido van Rossum45e2fbc1998-03-26 21:13:24 +0000336 while 1:
Kristján Valur Jónsson51a035e2009-01-15 17:20:21 +0000337 try:
338 line = self.file.readline()
339 except socket.error:
340 line = ''
Guido van Rossum296e1431999-04-07 15:03:39 +0000341 if line == '':
342 self.close()
343 raise SMTPServerDisconnected("Connection unexpectedly closed")
Brett Cannone6f8a892004-07-10 23:14:30 +0000344 if self.debuglevel > 0: print>>stderr, 'reply:', repr(line)
Eric S. Raymondc013f302001-02-09 05:40:38 +0000345 resp.append(line[4:].strip())
Guido van Rossum45e2fbc1998-03-26 21:13:24 +0000346 code=line[:3]
Guido van Rossum296e1431999-04-07 15:03:39 +0000347 # Check that the error code is syntactically correct.
348 # Don't attempt to read a continuation line if it is broken.
349 try:
Eric S. Raymondc013f302001-02-09 05:40:38 +0000350 errcode = int(code)
Guido van Rossum296e1431999-04-07 15:03:39 +0000351 except ValueError:
352 errcode = -1
353 break
Guido van Rossumf123f841999-03-29 20:33:21 +0000354 # Check if multiline response.
Guido van Rossum45e2fbc1998-03-26 21:13:24 +0000355 if line[3:4]!="-":
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000356 break
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000357
Eric S. Raymondc013f302001-02-09 05:40:38 +0000358 errmsg = "\n".join(resp)
Tim Peters495ad3c2001-01-15 01:36:40 +0000359 if self.debuglevel > 0:
Brett Cannone6f8a892004-07-10 23:14:30 +0000360 print>>stderr, 'reply: retcode (%s); Msg: %s' % (errcode,errmsg)
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000361 return errcode, errmsg
Tim Peters495ad3c2001-01-15 01:36:40 +0000362
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000363 def docmd(self, cmd, args=""):
Barry Warsawa7d9bdf1998-12-22 03:24:27 +0000364 """Send a command, and return its response code."""
Guido van Rossum45e2fbc1998-03-26 21:13:24 +0000365 self.putcmd(cmd,args)
Guido van Rossum296e1431999-04-07 15:03:39 +0000366 return self.getreply()
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000367
Barry Warsawa7d9bdf1998-12-22 03:24:27 +0000368 # std smtp commands
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000369 def helo(self, name=''):
Barry Warsawa7d9bdf1998-12-22 03:24:27 +0000370 """SMTP 'helo' command.
371 Hostname to send for this command defaults to the FQDN of the local
372 host.
373 """
Neil Schemenauer6730f262002-03-24 15:30:40 +0000374 self.putcmd("helo", name or self.local_hostname)
Guido van Rossum45e2fbc1998-03-26 21:13:24 +0000375 (code,msg)=self.getreply()
376 self.helo_resp=msg
Guido van Rossum296e1431999-04-07 15:03:39 +0000377 return (code,msg)
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000378
Guido van Rossum95e6f701998-06-25 02:15:50 +0000379 def ehlo(self, name=''):
Barry Warsawa7d9bdf1998-12-22 03:24:27 +0000380 """ SMTP 'ehlo' command.
381 Hostname to send for this command defaults to the FQDN of the local
382 host.
383 """
Guido van Rossumf7fcf5e2001-09-14 16:08:44 +0000384 self.esmtp_features = {}
Martin v. Löwis1190a382007-03-09 15:35:55 +0000385 self.putcmd(self.ehlo_msg, name or self.local_hostname)
Guido van Rossumfcfb6321998-08-04 15:29:54 +0000386 (code,msg)=self.getreply()
Tim Peters495ad3c2001-01-15 01:36:40 +0000387 # According to RFC1869 some (badly written)
388 # MTA's will disconnect on an ehlo. Toss an exception if
Guido van Rossumfcfb6321998-08-04 15:29:54 +0000389 # that happens -ddm
390 if code == -1 and len(msg) == 0:
Barry Warsaw76750972001-12-14 20:34:20 +0000391 self.close()
Guido van Rossum40233ea1999-01-15 03:23:55 +0000392 raise SMTPServerDisconnected("Server not connected")
Guido van Rossum95e6f701998-06-25 02:15:50 +0000393 self.ehlo_resp=msg
Fred Drake8152d322000-12-12 23:20:45 +0000394 if code != 250:
Guido van Rossum296e1431999-04-07 15:03:39 +0000395 return (code,msg)
Guido van Rossumfcfb6321998-08-04 15:29:54 +0000396 self.does_esmtp=1
Thomas Wouters7e474022000-07-16 12:04:32 +0000397 #parse the ehlo response -ddm
Eric S. Raymondc013f302001-02-09 05:40:38 +0000398 resp=self.ehlo_resp.split('\n')
Guido van Rossumfcfb6321998-08-04 15:29:54 +0000399 del resp[0]
Guido van Rossum2880f6e1998-08-10 20:07:00 +0000400 for each in resp:
Piers Lauder385a77a2002-07-27 00:38:30 +0000401 # To be able to communicate with as many SMTP servers as possible,
402 # we have to take the old-style auth advertisement into account,
403 # because:
404 # 1) Else our SMTP feature parser gets confused.
405 # 2) There are some servers that only advertise the auth methods we
406 # support using the old style.
407 auth_match = OLDSTYLE_AUTH.match(each)
408 if auth_match:
409 # This doesn't remove duplicates, but that's no problem
410 self.esmtp_features["auth"] = self.esmtp_features.get("auth", "") \
411 + " " + auth_match.groups(0)[0]
412 continue
413
Barry Warsawbe22ae62002-04-15 20:03:30 +0000414 # RFC 1869 requires a space between ehlo keyword and parameters.
415 # It's actually stricter, in that only spaces are allowed between
416 # parameters, but were not going to check for that here. Note
417 # that the space isn't present if there are no parameters.
418 m=re.match(r'(?P<feature>[A-Za-z0-9][A-Za-z0-9\-]*) ?',each)
Guido van Rossumfcfb6321998-08-04 15:29:54 +0000419 if m:
Eric S. Raymondc013f302001-02-09 05:40:38 +0000420 feature=m.group("feature").lower()
421 params=m.string[m.end("feature"):].strip()
Piers Lauder385a77a2002-07-27 00:38:30 +0000422 if feature == "auth":
423 self.esmtp_features[feature] = self.esmtp_features.get(feature, "") \
424 + " " + params
425 else:
426 self.esmtp_features[feature]=params
Guido van Rossum296e1431999-04-07 15:03:39 +0000427 return (code,msg)
Guido van Rossum95e6f701998-06-25 02:15:50 +0000428
Guido van Rossumfcfb6321998-08-04 15:29:54 +0000429 def has_extn(self, opt):
430 """Does the server support a given SMTP service extension?"""
Raymond Hettinger54f02222002-06-01 14:18:47 +0000431 return opt.lower() in self.esmtp_features
Guido van Rossum95e6f701998-06-25 02:15:50 +0000432
Guido van Rossum18586f41998-04-03 17:03:13 +0000433 def help(self, args=''):
Barry Warsawa7d9bdf1998-12-22 03:24:27 +0000434 """SMTP 'help' command.
435 Returns help text from server."""
Guido van Rossum18586f41998-04-03 17:03:13 +0000436 self.putcmd("help", args)
Kurt B. Kaiser58bd1902005-06-26 18:27:36 +0000437 return self.getreply()[1]
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000438
439 def rset(self):
Barry Warsawa7d9bdf1998-12-22 03:24:27 +0000440 """SMTP 'rset' command -- resets session."""
Guido van Rossum296e1431999-04-07 15:03:39 +0000441 return self.docmd("rset")
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000442
443 def noop(self):
Barry Warsawa7d9bdf1998-12-22 03:24:27 +0000444 """SMTP 'noop' command -- doesn't do anything :>"""
Guido van Rossum296e1431999-04-07 15:03:39 +0000445 return self.docmd("noop")
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000446
Guido van Rossum95e6f701998-06-25 02:15:50 +0000447 def mail(self,sender,options=[]):
Barry Warsawa7d9bdf1998-12-22 03:24:27 +0000448 """SMTP 'mail' command -- begins mail xfer session."""
Guido van Rossumfcfb6321998-08-04 15:29:54 +0000449 optionlist = ''
450 if options and self.does_esmtp:
Eric S. Raymondc013f302001-02-09 05:40:38 +0000451 optionlist = ' ' + ' '.join(options)
Guido van Rossumdb23d3d1999-06-09 15:13:10 +0000452 self.putcmd("mail", "FROM:%s%s" % (quoteaddr(sender) ,optionlist))
Guido van Rossum45e2fbc1998-03-26 21:13:24 +0000453 return self.getreply()
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000454
Guido van Rossumfcfb6321998-08-04 15:29:54 +0000455 def rcpt(self,recip,options=[]):
Barry Warsawa7d9bdf1998-12-22 03:24:27 +0000456 """SMTP 'rcpt' command -- indicates 1 recipient for this mail."""
Guido van Rossumfcfb6321998-08-04 15:29:54 +0000457 optionlist = ''
458 if options and self.does_esmtp:
Eric S. Raymondc013f302001-02-09 05:40:38 +0000459 optionlist = ' ' + ' '.join(options)
Guido van Rossum348fd061999-01-14 04:18:46 +0000460 self.putcmd("rcpt","TO:%s%s" % (quoteaddr(recip),optionlist))
Guido van Rossum45e2fbc1998-03-26 21:13:24 +0000461 return self.getreply()
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000462
463 def data(self,msg):
Tim Peters495ad3c2001-01-15 01:36:40 +0000464 """SMTP 'DATA' command -- sends message data to server.
Guido van Rossum296e1431999-04-07 15:03:39 +0000465
Barry Warsaw4c4bec81998-12-22 03:02:20 +0000466 Automatically quotes lines beginning with a period per rfc821.
Guido van Rossum296e1431999-04-07 15:03:39 +0000467 Raises SMTPDataError if there is an unexpected reply to the
468 DATA command; the return value from this method is the final
469 response code received when the all data is sent.
Barry Warsaw4c4bec81998-12-22 03:02:20 +0000470 """
Guido van Rossum45e2fbc1998-03-26 21:13:24 +0000471 self.putcmd("data")
472 (code,repl)=self.getreply()
Brett Cannone6f8a892004-07-10 23:14:30 +0000473 if self.debuglevel >0 : print>>stderr, "data:", (code,repl)
Fred Drake8152d322000-12-12 23:20:45 +0000474 if code != 354:
Guido van Rossum296e1431999-04-07 15:03:39 +0000475 raise SMTPDataError(code,repl)
Guido van Rossum45e2fbc1998-03-26 21:13:24 +0000476 else:
Guido van Rossum20c92281999-04-21 16:52:20 +0000477 q = quotedata(msg)
478 if q[-2:] != CRLF:
479 q = q + CRLF
480 q = q + "." + CRLF
481 self.send(q)
Guido van Rossum45e2fbc1998-03-26 21:13:24 +0000482 (code,msg)=self.getreply()
Brett Cannone6f8a892004-07-10 23:14:30 +0000483 if self.debuglevel >0 : print>>stderr, "data:", (code,msg)
Guido van Rossum296e1431999-04-07 15:03:39 +0000484 return (code,msg)
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000485
Guido van Rossumfcfb6321998-08-04 15:29:54 +0000486 def verify(self, address):
Barry Warsawa7d9bdf1998-12-22 03:24:27 +0000487 """SMTP 'verify' command -- checks for address validity."""
Guido van Rossumfcfb6321998-08-04 15:29:54 +0000488 self.putcmd("vrfy", quoteaddr(address))
489 return self.getreply()
Barry Warsaw4c4bec81998-12-22 03:02:20 +0000490 # a.k.a.
491 vrfy=verify
Guido van Rossumfcfb6321998-08-04 15:29:54 +0000492
493 def expn(self, address):
Facundo Batista16609332008-02-23 12:27:17 +0000494 """SMTP 'expn' command -- expands a mailing list."""
Guido van Rossumfcfb6321998-08-04 15:29:54 +0000495 self.putcmd("expn", quoteaddr(address))
496 return self.getreply()
497
Barry Warsaw4c4bec81998-12-22 03:02:20 +0000498 # some useful methods
Guido van Rossumae010462001-09-11 15:57:46 +0000499
Gregory P. Smithbde4ae42008-01-17 08:35:49 +0000500 def ehlo_or_helo_if_needed(self):
501 """Call self.ehlo() and/or self.helo() if needed.
502
503 If there has been no previous EHLO or HELO command this session, this
504 method tries ESMTP EHLO first.
505
506 This method may raise the following exceptions:
507
508 SMTPHeloError The server didn't reply properly to
509 the helo greeting.
510 """
511 if self.helo_resp is None and self.ehlo_resp is None:
512 if not (200 <= self.ehlo()[0] <= 299):
513 (code, resp) = self.helo()
514 if not (200 <= code <= 299):
515 raise SMTPHeloError(code, resp)
516
Guido van Rossumae010462001-09-11 15:57:46 +0000517 def login(self, user, password):
518 """Log in on an SMTP server that requires authentication.
519
520 The arguments are:
521 - user: The user name to authenticate with.
522 - password: The password for the authentication.
523
524 If there has been no previous EHLO or HELO command this session, this
525 method tries ESMTP EHLO first.
526
527 This method will return normally if the authentication was successful.
528
529 This method may raise the following exceptions:
530
531 SMTPHeloError The server didn't reply properly to
532 the helo greeting.
533 SMTPAuthenticationError The server didn't accept the username/
534 password combination.
Fred Drake2f8f4d32001-10-13 18:35:32 +0000535 SMTPException No suitable authentication method was
Guido van Rossumae010462001-09-11 15:57:46 +0000536 found.
537 """
538
539 def encode_cram_md5(challenge, user, password):
540 challenge = base64.decodestring(challenge)
541 response = user + " " + hmac.HMAC(password, challenge).hexdigest()
Piers Lauder385a77a2002-07-27 00:38:30 +0000542 return encode_base64(response, eol="")
Guido van Rossumae010462001-09-11 15:57:46 +0000543
544 def encode_plain(user, password):
Johannes Gijsbers25946dd2004-12-06 21:25:26 +0000545 return encode_base64("\0%s\0%s" % (user, password), eol="")
Tim Peters469cdad2002-08-08 20:19:19 +0000546
Guido van Rossumae010462001-09-11 15:57:46 +0000547
548 AUTH_PLAIN = "PLAIN"
549 AUTH_CRAM_MD5 = "CRAM-MD5"
Piers Lauder385a77a2002-07-27 00:38:30 +0000550 AUTH_LOGIN = "LOGIN"
Guido van Rossumae010462001-09-11 15:57:46 +0000551
Gregory P. Smithbde4ae42008-01-17 08:35:49 +0000552 self.ehlo_or_helo_if_needed()
Guido van Rossumae010462001-09-11 15:57:46 +0000553
554 if not self.has_extn("auth"):
555 raise SMTPException("SMTP AUTH extension not supported by server.")
556
557 # Authentication methods the server supports:
558 authlist = self.esmtp_features["auth"].split()
559
560 # List of authentication methods we support: from preferred to
561 # less preferred methods. Except for the purpose of testing the weaker
562 # ones, we prefer stronger methods like CRAM-MD5:
Piers Lauder385a77a2002-07-27 00:38:30 +0000563 preferred_auths = [AUTH_CRAM_MD5, AUTH_PLAIN, AUTH_LOGIN]
Guido van Rossumae010462001-09-11 15:57:46 +0000564
565 # Determine the authentication method we'll use
566 authmethod = None
567 for method in preferred_auths:
568 if method in authlist:
569 authmethod = method
570 break
Tim Petersb64bec32001-09-18 02:26:39 +0000571
Guido van Rossumae010462001-09-11 15:57:46 +0000572 if authmethod == AUTH_CRAM_MD5:
573 (code, resp) = self.docmd("AUTH", AUTH_CRAM_MD5)
574 if code == 503:
575 # 503 == 'Error: already authenticated'
576 return (code, resp)
577 (code, resp) = self.docmd(encode_cram_md5(resp, user, password))
578 elif authmethod == AUTH_PLAIN:
Tim Petersb64bec32001-09-18 02:26:39 +0000579 (code, resp) = self.docmd("AUTH",
Guido van Rossumae010462001-09-11 15:57:46 +0000580 AUTH_PLAIN + " " + encode_plain(user, password))
Piers Lauder385a77a2002-07-27 00:38:30 +0000581 elif authmethod == AUTH_LOGIN:
582 (code, resp) = self.docmd("AUTH",
583 "%s %s" % (AUTH_LOGIN, encode_base64(user, eol="")))
584 if code != 334:
585 raise SMTPAuthenticationError(code, resp)
Martin v. Löwis49c05d32002-10-06 17:55:08 +0000586 (code, resp) = self.docmd(encode_base64(password, eol=""))
Raymond Hettinger7fdfc2d2002-05-31 17:49:10 +0000587 elif authmethod is None:
Fred Drake2f8f4d32001-10-13 18:35:32 +0000588 raise SMTPException("No suitable authentication method found.")
Raymond Hettingerdbecd932005-02-06 06:57:08 +0000589 if code not in (235, 503):
Guido van Rossumae010462001-09-11 15:57:46 +0000590 # 235 == 'Authentication successful'
591 # 503 == 'Error: already authenticated'
592 raise SMTPAuthenticationError(code, resp)
593 return (code, resp)
594
Guido van Rossumf7fcf5e2001-09-14 16:08:44 +0000595 def starttls(self, keyfile = None, certfile = None):
596 """Puts the connection to the SMTP server into TLS mode.
Tim Petersb64bec32001-09-18 02:26:39 +0000597
Gregory P. Smithbde4ae42008-01-17 08:35:49 +0000598 If there has been no previous EHLO or HELO command this session, this
599 method tries ESMTP EHLO first.
600
Guido van Rossumf7fcf5e2001-09-14 16:08:44 +0000601 If the server supports TLS, this will encrypt the rest of the SMTP
602 session. If you provide the keyfile and certfile parameters,
603 the identity of the SMTP server and client can be checked. This,
604 however, depends on whether the socket module really checks the
605 certificates.
Gregory P. Smithbde4ae42008-01-17 08:35:49 +0000606
607 This method may raise the following exceptions:
608
609 SMTPHeloError The server didn't reply properly to
610 the helo greeting.
Guido van Rossumf7fcf5e2001-09-14 16:08:44 +0000611 """
Gregory P. Smithbde4ae42008-01-17 08:35:49 +0000612 self.ehlo_or_helo_if_needed()
613 if not self.has_extn("starttls"):
614 raise SMTPException("STARTTLS extension not supported by server.")
Tim Petersb64bec32001-09-18 02:26:39 +0000615 (resp, reply) = self.docmd("STARTTLS")
Guido van Rossumf7fcf5e2001-09-14 16:08:44 +0000616 if resp == 220:
Bill Janssen426ea0a2007-08-29 22:35:05 +0000617 if not _have_ssl:
618 raise RuntimeError("No SSL support included in this Python")
Bill Janssen98d19da2007-09-10 21:51:02 +0000619 self.sock = ssl.wrap_socket(self.sock, keyfile, certfile)
Bill Janssen426ea0a2007-08-29 22:35:05 +0000620 self.file = SSLFakeFile(self.sock)
Gregory P. Smith63bfc1d2008-01-17 07:43:20 +0000621 # RFC 3207:
622 # The client MUST discard any knowledge obtained from
623 # the server, such as the list of SMTP service extensions,
624 # which was not obtained from the TLS negotiation itself.
625 self.helo_resp = None
626 self.ehlo_resp = None
627 self.esmtp_features = {}
628 self.does_esmtp = 0
Guido van Rossumf7fcf5e2001-09-14 16:08:44 +0000629 return (resp, reply)
Tim Petersb64bec32001-09-18 02:26:39 +0000630
Jeremy Hylton31bb8ce1998-08-13 19:57:46 +0000631 def sendmail(self, from_addr, to_addrs, msg, mail_options=[],
Tim Peters495ad3c2001-01-15 01:36:40 +0000632 rcpt_options=[]):
633 """This command performs an entire mail transaction.
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000634
Tim Peters495ad3c2001-01-15 01:36:40 +0000635 The arguments are:
Barry Warsaw4c4bec81998-12-22 03:02:20 +0000636 - from_addr : The address sending this mail.
637 - to_addrs : A list of addresses to send this mail to. A bare
638 string will be treated as a list with 1 address.
Tim Peters495ad3c2001-01-15 01:36:40 +0000639 - msg : The message to send.
Barry Warsaw4c4bec81998-12-22 03:02:20 +0000640 - mail_options : List of ESMTP options (such as 8bitmime) for the
641 mail command.
642 - rcpt_options : List of ESMTP options (such as DSN commands) for
643 all the rcpt commands.
644
645 If there has been no previous EHLO or HELO command this session, this
646 method tries ESMTP EHLO first. If the server does ESMTP, message size
647 and each of the specified options will be passed to it. If EHLO
648 fails, HELO will be tried and ESMTP options suppressed.
649
650 This method will return normally if the mail is accepted for at least
Barry Warsawd25c1b71999-11-28 17:11:06 +0000651 one recipient. It returns a dictionary, with one entry for each
652 recipient that was refused. Each entry contains a tuple of the SMTP
653 error code and the accompanying error message sent by the server.
Guido van Rossum296e1431999-04-07 15:03:39 +0000654
655 This method may raise the following exceptions:
656
657 SMTPHeloError The server didn't reply properly to
Tim Peters495ad3c2001-01-15 01:36:40 +0000658 the helo greeting.
Barry Warsawd25c1b71999-11-28 17:11:06 +0000659 SMTPRecipientsRefused The server rejected ALL recipients
Guido van Rossum296e1431999-04-07 15:03:39 +0000660 (no mail was sent).
661 SMTPSenderRefused The server didn't accept the from_addr.
662 SMTPDataError The server replied with an unexpected
663 error code (other than a refusal of
664 a recipient).
665
666 Note: the connection will be open even after an exception is raised.
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000667
Guido van Rossum95e6f701998-06-25 02:15:50 +0000668 Example:
Tim Peters495ad3c2001-01-15 01:36:40 +0000669
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000670 >>> import smtplib
671 >>> s=smtplib.SMTP("localhost")
Guido van Rossumfc40a831998-01-29 17:26:45 +0000672 >>> tolist=["one@one.org","two@two.org","three@three.org","four@four.org"]
Martin v. Löwis301b1cd2002-07-28 16:52:01 +0000673 >>> msg = '''\\
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000674 ... From: Me@my.org
675 ... Subject: testin'...
676 ...
677 ... This is a test '''
678 >>> s.sendmail("me@my.org",tolist,msg)
679 { "three@three.org" : ( 550 ,"User unknown" ) }
680 >>> s.quit()
Tim Peters495ad3c2001-01-15 01:36:40 +0000681
Barry Warsaw4c4bec81998-12-22 03:02:20 +0000682 In the above example, the message was accepted for delivery to three
683 of the four addresses, and one was rejected, with the error code
Barry Warsawd25c1b71999-11-28 17:11:06 +0000684 550. If all addresses are accepted, then the method will return an
Barry Warsaw4c4bec81998-12-22 03:02:20 +0000685 empty dictionary.
686
687 """
Gregory P. Smithbde4ae42008-01-17 08:35:49 +0000688 self.ehlo_or_helo_if_needed()
Guido van Rossum95e6f701998-06-25 02:15:50 +0000689 esmtp_opts = []
Guido van Rossumfcfb6321998-08-04 15:29:54 +0000690 if self.does_esmtp:
691 # Hmmm? what's this? -ddm
692 # self.esmtp_features['7bit']=""
693 if self.has_extn('size'):
Walter Dörwald70a6b492004-02-12 17:35:32 +0000694 esmtp_opts.append("size=%d" % len(msg))
Guido van Rossumfcfb6321998-08-04 15:29:54 +0000695 for option in mail_options:
Guido van Rossum95e6f701998-06-25 02:15:50 +0000696 esmtp_opts.append(option)
Guido van Rossumfcfb6321998-08-04 15:29:54 +0000697
Guido van Rossum95e6f701998-06-25 02:15:50 +0000698 (code,resp) = self.mail(from_addr, esmtp_opts)
Fred Drake8152d322000-12-12 23:20:45 +0000699 if code != 250:
Guido van Rossum45e2fbc1998-03-26 21:13:24 +0000700 self.rset()
Guido van Rossum296e1431999-04-07 15:03:39 +0000701 raise SMTPSenderRefused(code, resp, from_addr)
Guido van Rossum45e2fbc1998-03-26 21:13:24 +0000702 senderrs={}
Walter Dörwald65230a22002-06-03 15:58:32 +0000703 if isinstance(to_addrs, basestring):
Jeremy Hylton31bb8ce1998-08-13 19:57:46 +0000704 to_addrs = [to_addrs]
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000705 for each in to_addrs:
Guido van Rossumfcfb6321998-08-04 15:29:54 +0000706 (code,resp)=self.rcpt(each, rcpt_options)
Fred Drake8152d322000-12-12 23:20:45 +0000707 if (code != 250) and (code != 251):
Guido van Rossumfc40a831998-01-29 17:26:45 +0000708 senderrs[each]=(code,resp)
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000709 if len(senderrs)==len(to_addrs):
Guido van Rossum95e6f701998-06-25 02:15:50 +0000710 # the server refused all our recipients
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000711 self.rset()
Guido van Rossum296e1431999-04-07 15:03:39 +0000712 raise SMTPRecipientsRefused(senderrs)
Fred Drake8152d322000-12-12 23:20:45 +0000713 (code,resp) = self.data(msg)
714 if code != 250:
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000715 self.rset()
Guido van Rossum296e1431999-04-07 15:03:39 +0000716 raise SMTPDataError(code, resp)
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000717 #if we got here then somebody got our mail
Tim Peters495ad3c2001-01-15 01:36:40 +0000718 return senderrs
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000719
720
721 def close(self):
722 """Close the connection to the SMTP server."""
723 if self.file:
724 self.file.close()
725 self.file = None
726 if self.sock:
727 self.sock.close()
728 self.sock = None
729
730
731 def quit(self):
Guido van Rossum95e6f701998-06-25 02:15:50 +0000732 """Terminate the SMTP session."""
Georg Brandldeaf2ca2008-03-27 13:27:31 +0000733 res = self.docmd("quit")
Guido van Rossum45e2fbc1998-03-26 21:13:24 +0000734 self.close()
Georg Brandldeaf2ca2008-03-27 13:27:31 +0000735 return res
Guido van Rossum95e6f701998-06-25 02:15:50 +0000736
Bill Janssen426ea0a2007-08-29 22:35:05 +0000737if _have_ssl:
Martin v. Löwisee82c0e2006-10-27 07:13:28 +0000738
Bill Janssen426ea0a2007-08-29 22:35:05 +0000739 class SMTP_SSL(SMTP):
740 """ This is a subclass derived from SMTP that connects over an SSL encrypted
741 socket (to use this class you need a socket module that was compiled with SSL
742 support). If host is not specified, '' (the local host) is used. If port is
743 omitted, the standard SMTP-over-SSL port (465) is used. keyfile and certfile
744 are also optional - they can contain a PEM formatted private key and
745 certificate chain file for the SSL connection.
746 """
747 def __init__(self, host='', port=0, local_hostname=None,
Facundo Batista4f1b1ed2008-05-29 16:39:26 +0000748 keyfile=None, certfile=None,
749 timeout=socket._GLOBAL_DEFAULT_TIMEOUT):
Bill Janssen426ea0a2007-08-29 22:35:05 +0000750 self.keyfile = keyfile
751 self.certfile = certfile
752 SMTP.__init__(self, host, port, local_hostname, timeout)
753 self.default_port = SMTP_SSL_PORT
754
755 def _get_socket(self, host, port, timeout):
756 if self.debuglevel > 0: print>>stderr, 'connect:', (host, port)
757 self.sock = socket.create_connection((host, port), timeout)
Bill Janssen98d19da2007-09-10 21:51:02 +0000758 self.sock = ssl.wrap_socket(self.sock, self.keyfile, self.certfile)
Bill Janssen470dcd22007-08-31 19:03:31 +0000759 self.file = SSLFakeFile(self.sock)
Barry Warsaw4c4bec81998-12-22 03:02:20 +0000760
Thomas Woutersa6900e82007-08-30 21:54:39 +0000761 __all__.append("SMTP_SSL")
762
Martin v. Löwis1190a382007-03-09 15:35:55 +0000763#
764# LMTP extension
765#
766LMTP_PORT = 2003
767
768class LMTP(SMTP):
769 """LMTP - Local Mail Transfer Protocol
770
771 The LMTP protocol, which is very similar to ESMTP, is heavily based
772 on the standard SMTP client. It's common to use Unix sockets for LMTP,
773 so our connect() method must support that as well as a regular
774 host:port server. To specify a Unix socket, you must use an absolute
775 path as the host, starting with a '/'.
776
777 Authentication is supported, using the regular SMTP mechanism. When
778 using a Unix socket, LMTP generally don't support or require any
779 authentication, but your mileage might vary."""
780
781 ehlo_msg = "lhlo"
Tim Petersea5962f2007-03-12 18:07:52 +0000782
Martin v. Löwis1190a382007-03-09 15:35:55 +0000783 def __init__(self, host = '', port = LMTP_PORT, local_hostname = None):
784 """Initialize a new instance."""
785 SMTP.__init__(self, host, port, local_hostname)
786
Neal Norwitzc8f6c232007-03-10 03:19:18 +0000787 def connect(self, host = 'localhost', port = 0):
Martin v. Löwis1190a382007-03-09 15:35:55 +0000788 """Connect to the LMTP daemon, on either a Unix or a TCP socket."""
Neal Norwitzc8f6c232007-03-10 03:19:18 +0000789 if host[0] != '/':
Martin v. Löwis1190a382007-03-09 15:35:55 +0000790 return SMTP.connect(self, host, port)
791
Neal Norwitzc8f6c232007-03-10 03:19:18 +0000792 # Handle Unix-domain sockets.
793 try:
794 self.sock = socket.socket(socket.AF_UNIX, socket.SOCK_STREAM)
795 self.sock.connect(host)
796 except socket.error, msg:
797 if self.debuglevel > 0: print>>stderr, 'connect fail:', host
798 if self.sock:
799 self.sock.close()
800 self.sock = None
801 raise socket.error, msg
802 (code, msg) = self.getreply()
803 if self.debuglevel > 0: print>>stderr, "connect:", msg
804 return (code, msg)
805
Martin v. Löwis1190a382007-03-09 15:35:55 +0000806
Guido van Rossum95e6f701998-06-25 02:15:50 +0000807# Test the sendmail method, which tests most of the others.
808# Note: This always sends to localhost.
809if __name__ == '__main__':
Andrew M. Kuchling6be424f2001-08-13 14:41:39 +0000810 import sys
Guido van Rossum95e6f701998-06-25 02:15:50 +0000811
812 def prompt(prompt):
813 sys.stdout.write(prompt + ": ")
Eric S. Raymondc013f302001-02-09 05:40:38 +0000814 return sys.stdin.readline().strip()
Guido van Rossum95e6f701998-06-25 02:15:50 +0000815
816 fromaddr = prompt("From")
Eric S. Raymond38151ed2001-02-09 07:40:17 +0000817 toaddrs = prompt("To").split(',')
Guido van Rossum95e6f701998-06-25 02:15:50 +0000818 print "Enter message, end with ^D:"
819 msg = ''
820 while 1:
821 line = sys.stdin.readline()
822 if not line:
823 break
824 msg = msg + line
Walter Dörwald70a6b492004-02-12 17:35:32 +0000825 print "Message length is %d" % len(msg)
Guido van Rossum95e6f701998-06-25 02:15:50 +0000826
827 server = SMTP('localhost')
828 server.set_debuglevel(1)
829 server.sendmail(fromaddr, toaddrs, msg)
830 server.quit()