blob: 41a3c97b626aa72af96689dbd3e45b4277641ad5 [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:
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000337 line = self.file.readline()
Guido van Rossum296e1431999-04-07 15:03:39 +0000338 if line == '':
339 self.close()
340 raise SMTPServerDisconnected("Connection unexpectedly closed")
Brett Cannone6f8a892004-07-10 23:14:30 +0000341 if self.debuglevel > 0: print>>stderr, 'reply:', repr(line)
Eric S. Raymondc013f302001-02-09 05:40:38 +0000342 resp.append(line[4:].strip())
Guido van Rossum45e2fbc1998-03-26 21:13:24 +0000343 code=line[:3]
Guido van Rossum296e1431999-04-07 15:03:39 +0000344 # Check that the error code is syntactically correct.
345 # Don't attempt to read a continuation line if it is broken.
346 try:
Eric S. Raymondc013f302001-02-09 05:40:38 +0000347 errcode = int(code)
Guido van Rossum296e1431999-04-07 15:03:39 +0000348 except ValueError:
349 errcode = -1
350 break
Guido van Rossumf123f841999-03-29 20:33:21 +0000351 # Check if multiline response.
Guido van Rossum45e2fbc1998-03-26 21:13:24 +0000352 if line[3:4]!="-":
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000353 break
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000354
Eric S. Raymondc013f302001-02-09 05:40:38 +0000355 errmsg = "\n".join(resp)
Tim Peters495ad3c2001-01-15 01:36:40 +0000356 if self.debuglevel > 0:
Brett Cannone6f8a892004-07-10 23:14:30 +0000357 print>>stderr, 'reply: retcode (%s); Msg: %s' % (errcode,errmsg)
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000358 return errcode, errmsg
Tim Peters495ad3c2001-01-15 01:36:40 +0000359
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000360 def docmd(self, cmd, args=""):
Barry Warsawa7d9bdf1998-12-22 03:24:27 +0000361 """Send a command, and return its response code."""
Guido van Rossum45e2fbc1998-03-26 21:13:24 +0000362 self.putcmd(cmd,args)
Guido van Rossum296e1431999-04-07 15:03:39 +0000363 return self.getreply()
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000364
Barry Warsawa7d9bdf1998-12-22 03:24:27 +0000365 # std smtp commands
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000366 def helo(self, name=''):
Barry Warsawa7d9bdf1998-12-22 03:24:27 +0000367 """SMTP 'helo' command.
368 Hostname to send for this command defaults to the FQDN of the local
369 host.
370 """
Neil Schemenauer6730f262002-03-24 15:30:40 +0000371 self.putcmd("helo", name or self.local_hostname)
Guido van Rossum45e2fbc1998-03-26 21:13:24 +0000372 (code,msg)=self.getreply()
373 self.helo_resp=msg
Guido van Rossum296e1431999-04-07 15:03:39 +0000374 return (code,msg)
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000375
Guido van Rossum95e6f701998-06-25 02:15:50 +0000376 def ehlo(self, name=''):
Barry Warsawa7d9bdf1998-12-22 03:24:27 +0000377 """ SMTP 'ehlo' command.
378 Hostname to send for this command defaults to the FQDN of the local
379 host.
380 """
Guido van Rossumf7fcf5e2001-09-14 16:08:44 +0000381 self.esmtp_features = {}
Martin v. Löwis1190a382007-03-09 15:35:55 +0000382 self.putcmd(self.ehlo_msg, name or self.local_hostname)
Guido van Rossumfcfb6321998-08-04 15:29:54 +0000383 (code,msg)=self.getreply()
Tim Peters495ad3c2001-01-15 01:36:40 +0000384 # According to RFC1869 some (badly written)
385 # MTA's will disconnect on an ehlo. Toss an exception if
Guido van Rossumfcfb6321998-08-04 15:29:54 +0000386 # that happens -ddm
387 if code == -1 and len(msg) == 0:
Barry Warsaw76750972001-12-14 20:34:20 +0000388 self.close()
Guido van Rossum40233ea1999-01-15 03:23:55 +0000389 raise SMTPServerDisconnected("Server not connected")
Guido van Rossum95e6f701998-06-25 02:15:50 +0000390 self.ehlo_resp=msg
Fred Drake8152d322000-12-12 23:20:45 +0000391 if code != 250:
Guido van Rossum296e1431999-04-07 15:03:39 +0000392 return (code,msg)
Guido van Rossumfcfb6321998-08-04 15:29:54 +0000393 self.does_esmtp=1
Thomas Wouters7e474022000-07-16 12:04:32 +0000394 #parse the ehlo response -ddm
Eric S. Raymondc013f302001-02-09 05:40:38 +0000395 resp=self.ehlo_resp.split('\n')
Guido van Rossumfcfb6321998-08-04 15:29:54 +0000396 del resp[0]
Guido van Rossum2880f6e1998-08-10 20:07:00 +0000397 for each in resp:
Piers Lauder385a77a2002-07-27 00:38:30 +0000398 # To be able to communicate with as many SMTP servers as possible,
399 # we have to take the old-style auth advertisement into account,
400 # because:
401 # 1) Else our SMTP feature parser gets confused.
402 # 2) There are some servers that only advertise the auth methods we
403 # support using the old style.
404 auth_match = OLDSTYLE_AUTH.match(each)
405 if auth_match:
406 # This doesn't remove duplicates, but that's no problem
407 self.esmtp_features["auth"] = self.esmtp_features.get("auth", "") \
408 + " " + auth_match.groups(0)[0]
409 continue
410
Barry Warsawbe22ae62002-04-15 20:03:30 +0000411 # RFC 1869 requires a space between ehlo keyword and parameters.
412 # It's actually stricter, in that only spaces are allowed between
413 # parameters, but were not going to check for that here. Note
414 # that the space isn't present if there are no parameters.
415 m=re.match(r'(?P<feature>[A-Za-z0-9][A-Za-z0-9\-]*) ?',each)
Guido van Rossumfcfb6321998-08-04 15:29:54 +0000416 if m:
Eric S. Raymondc013f302001-02-09 05:40:38 +0000417 feature=m.group("feature").lower()
418 params=m.string[m.end("feature"):].strip()
Piers Lauder385a77a2002-07-27 00:38:30 +0000419 if feature == "auth":
420 self.esmtp_features[feature] = self.esmtp_features.get(feature, "") \
421 + " " + params
422 else:
423 self.esmtp_features[feature]=params
Guido van Rossum296e1431999-04-07 15:03:39 +0000424 return (code,msg)
Guido van Rossum95e6f701998-06-25 02:15:50 +0000425
Guido van Rossumfcfb6321998-08-04 15:29:54 +0000426 def has_extn(self, opt):
427 """Does the server support a given SMTP service extension?"""
Raymond Hettinger54f02222002-06-01 14:18:47 +0000428 return opt.lower() in self.esmtp_features
Guido van Rossum95e6f701998-06-25 02:15:50 +0000429
Guido van Rossum18586f41998-04-03 17:03:13 +0000430 def help(self, args=''):
Barry Warsawa7d9bdf1998-12-22 03:24:27 +0000431 """SMTP 'help' command.
432 Returns help text from server."""
Guido van Rossum18586f41998-04-03 17:03:13 +0000433 self.putcmd("help", args)
Kurt B. Kaiser58bd1902005-06-26 18:27:36 +0000434 return self.getreply()[1]
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000435
436 def rset(self):
Barry Warsawa7d9bdf1998-12-22 03:24:27 +0000437 """SMTP 'rset' command -- resets session."""
Guido van Rossum296e1431999-04-07 15:03:39 +0000438 return self.docmd("rset")
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000439
440 def noop(self):
Barry Warsawa7d9bdf1998-12-22 03:24:27 +0000441 """SMTP 'noop' command -- doesn't do anything :>"""
Guido van Rossum296e1431999-04-07 15:03:39 +0000442 return self.docmd("noop")
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000443
Guido van Rossum95e6f701998-06-25 02:15:50 +0000444 def mail(self,sender,options=[]):
Barry Warsawa7d9bdf1998-12-22 03:24:27 +0000445 """SMTP 'mail' command -- begins mail xfer session."""
Guido van Rossumfcfb6321998-08-04 15:29:54 +0000446 optionlist = ''
447 if options and self.does_esmtp:
Eric S. Raymondc013f302001-02-09 05:40:38 +0000448 optionlist = ' ' + ' '.join(options)
Guido van Rossumdb23d3d1999-06-09 15:13:10 +0000449 self.putcmd("mail", "FROM:%s%s" % (quoteaddr(sender) ,optionlist))
Guido van Rossum45e2fbc1998-03-26 21:13:24 +0000450 return self.getreply()
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000451
Guido van Rossumfcfb6321998-08-04 15:29:54 +0000452 def rcpt(self,recip,options=[]):
Barry Warsawa7d9bdf1998-12-22 03:24:27 +0000453 """SMTP 'rcpt' command -- indicates 1 recipient for this mail."""
Guido van Rossumfcfb6321998-08-04 15:29:54 +0000454 optionlist = ''
455 if options and self.does_esmtp:
Eric S. Raymondc013f302001-02-09 05:40:38 +0000456 optionlist = ' ' + ' '.join(options)
Guido van Rossum348fd061999-01-14 04:18:46 +0000457 self.putcmd("rcpt","TO:%s%s" % (quoteaddr(recip),optionlist))
Guido van Rossum45e2fbc1998-03-26 21:13:24 +0000458 return self.getreply()
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000459
460 def data(self,msg):
Tim Peters495ad3c2001-01-15 01:36:40 +0000461 """SMTP 'DATA' command -- sends message data to server.
Guido van Rossum296e1431999-04-07 15:03:39 +0000462
Barry Warsaw4c4bec81998-12-22 03:02:20 +0000463 Automatically quotes lines beginning with a period per rfc821.
Guido van Rossum296e1431999-04-07 15:03:39 +0000464 Raises SMTPDataError if there is an unexpected reply to the
465 DATA command; the return value from this method is the final
466 response code received when the all data is sent.
Barry Warsaw4c4bec81998-12-22 03:02:20 +0000467 """
Guido van Rossum45e2fbc1998-03-26 21:13:24 +0000468 self.putcmd("data")
469 (code,repl)=self.getreply()
Brett Cannone6f8a892004-07-10 23:14:30 +0000470 if self.debuglevel >0 : print>>stderr, "data:", (code,repl)
Fred Drake8152d322000-12-12 23:20:45 +0000471 if code != 354:
Guido van Rossum296e1431999-04-07 15:03:39 +0000472 raise SMTPDataError(code,repl)
Guido van Rossum45e2fbc1998-03-26 21:13:24 +0000473 else:
Guido van Rossum20c92281999-04-21 16:52:20 +0000474 q = quotedata(msg)
475 if q[-2:] != CRLF:
476 q = q + CRLF
477 q = q + "." + CRLF
478 self.send(q)
Guido van Rossum45e2fbc1998-03-26 21:13:24 +0000479 (code,msg)=self.getreply()
Brett Cannone6f8a892004-07-10 23:14:30 +0000480 if self.debuglevel >0 : print>>stderr, "data:", (code,msg)
Guido van Rossum296e1431999-04-07 15:03:39 +0000481 return (code,msg)
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000482
Guido van Rossumfcfb6321998-08-04 15:29:54 +0000483 def verify(self, address):
Barry Warsawa7d9bdf1998-12-22 03:24:27 +0000484 """SMTP 'verify' command -- checks for address validity."""
Guido van Rossumfcfb6321998-08-04 15:29:54 +0000485 self.putcmd("vrfy", quoteaddr(address))
486 return self.getreply()
Barry Warsaw4c4bec81998-12-22 03:02:20 +0000487 # a.k.a.
488 vrfy=verify
Guido van Rossumfcfb6321998-08-04 15:29:54 +0000489
490 def expn(self, address):
Facundo Batista16609332008-02-23 12:27:17 +0000491 """SMTP 'expn' command -- expands a mailing list."""
Guido van Rossumfcfb6321998-08-04 15:29:54 +0000492 self.putcmd("expn", quoteaddr(address))
493 return self.getreply()
494
Barry Warsaw4c4bec81998-12-22 03:02:20 +0000495 # some useful methods
Guido van Rossumae010462001-09-11 15:57:46 +0000496
Gregory P. Smithbde4ae42008-01-17 08:35:49 +0000497 def ehlo_or_helo_if_needed(self):
498 """Call self.ehlo() and/or self.helo() if needed.
499
500 If there has been no previous EHLO or HELO command this session, this
501 method tries ESMTP EHLO first.
502
503 This method may raise the following exceptions:
504
505 SMTPHeloError The server didn't reply properly to
506 the helo greeting.
507 """
508 if self.helo_resp is None and self.ehlo_resp is None:
509 if not (200 <= self.ehlo()[0] <= 299):
510 (code, resp) = self.helo()
511 if not (200 <= code <= 299):
512 raise SMTPHeloError(code, resp)
513
Guido van Rossumae010462001-09-11 15:57:46 +0000514 def login(self, user, password):
515 """Log in on an SMTP server that requires authentication.
516
517 The arguments are:
518 - user: The user name to authenticate with.
519 - password: The password for the authentication.
520
521 If there has been no previous EHLO or HELO command this session, this
522 method tries ESMTP EHLO first.
523
524 This method will return normally if the authentication was successful.
525
526 This method may raise the following exceptions:
527
528 SMTPHeloError The server didn't reply properly to
529 the helo greeting.
530 SMTPAuthenticationError The server didn't accept the username/
531 password combination.
Fred Drake2f8f4d32001-10-13 18:35:32 +0000532 SMTPException No suitable authentication method was
Guido van Rossumae010462001-09-11 15:57:46 +0000533 found.
534 """
535
536 def encode_cram_md5(challenge, user, password):
537 challenge = base64.decodestring(challenge)
538 response = user + " " + hmac.HMAC(password, challenge).hexdigest()
Piers Lauder385a77a2002-07-27 00:38:30 +0000539 return encode_base64(response, eol="")
Guido van Rossumae010462001-09-11 15:57:46 +0000540
541 def encode_plain(user, password):
Johannes Gijsbers25946dd2004-12-06 21:25:26 +0000542 return encode_base64("\0%s\0%s" % (user, password), eol="")
Tim Peters469cdad2002-08-08 20:19:19 +0000543
Guido van Rossumae010462001-09-11 15:57:46 +0000544
545 AUTH_PLAIN = "PLAIN"
546 AUTH_CRAM_MD5 = "CRAM-MD5"
Piers Lauder385a77a2002-07-27 00:38:30 +0000547 AUTH_LOGIN = "LOGIN"
Guido van Rossumae010462001-09-11 15:57:46 +0000548
Gregory P. Smithbde4ae42008-01-17 08:35:49 +0000549 self.ehlo_or_helo_if_needed()
Guido van Rossumae010462001-09-11 15:57:46 +0000550
551 if not self.has_extn("auth"):
552 raise SMTPException("SMTP AUTH extension not supported by server.")
553
554 # Authentication methods the server supports:
555 authlist = self.esmtp_features["auth"].split()
556
557 # List of authentication methods we support: from preferred to
558 # less preferred methods. Except for the purpose of testing the weaker
559 # ones, we prefer stronger methods like CRAM-MD5:
Piers Lauder385a77a2002-07-27 00:38:30 +0000560 preferred_auths = [AUTH_CRAM_MD5, AUTH_PLAIN, AUTH_LOGIN]
Guido van Rossumae010462001-09-11 15:57:46 +0000561
562 # Determine the authentication method we'll use
563 authmethod = None
564 for method in preferred_auths:
565 if method in authlist:
566 authmethod = method
567 break
Tim Petersb64bec32001-09-18 02:26:39 +0000568
Guido van Rossumae010462001-09-11 15:57:46 +0000569 if authmethod == AUTH_CRAM_MD5:
570 (code, resp) = self.docmd("AUTH", AUTH_CRAM_MD5)
571 if code == 503:
572 # 503 == 'Error: already authenticated'
573 return (code, resp)
574 (code, resp) = self.docmd(encode_cram_md5(resp, user, password))
575 elif authmethod == AUTH_PLAIN:
Tim Petersb64bec32001-09-18 02:26:39 +0000576 (code, resp) = self.docmd("AUTH",
Guido van Rossumae010462001-09-11 15:57:46 +0000577 AUTH_PLAIN + " " + encode_plain(user, password))
Piers Lauder385a77a2002-07-27 00:38:30 +0000578 elif authmethod == AUTH_LOGIN:
579 (code, resp) = self.docmd("AUTH",
580 "%s %s" % (AUTH_LOGIN, encode_base64(user, eol="")))
581 if code != 334:
582 raise SMTPAuthenticationError(code, resp)
Martin v. Löwis49c05d32002-10-06 17:55:08 +0000583 (code, resp) = self.docmd(encode_base64(password, eol=""))
Raymond Hettinger7fdfc2d2002-05-31 17:49:10 +0000584 elif authmethod is None:
Fred Drake2f8f4d32001-10-13 18:35:32 +0000585 raise SMTPException("No suitable authentication method found.")
Raymond Hettingerdbecd932005-02-06 06:57:08 +0000586 if code not in (235, 503):
Guido van Rossumae010462001-09-11 15:57:46 +0000587 # 235 == 'Authentication successful'
588 # 503 == 'Error: already authenticated'
589 raise SMTPAuthenticationError(code, resp)
590 return (code, resp)
591
Guido van Rossumf7fcf5e2001-09-14 16:08:44 +0000592 def starttls(self, keyfile = None, certfile = None):
593 """Puts the connection to the SMTP server into TLS mode.
Tim Petersb64bec32001-09-18 02:26:39 +0000594
Gregory P. Smithbde4ae42008-01-17 08:35:49 +0000595 If there has been no previous EHLO or HELO command this session, this
596 method tries ESMTP EHLO first.
597
Guido van Rossumf7fcf5e2001-09-14 16:08:44 +0000598 If the server supports TLS, this will encrypt the rest of the SMTP
599 session. If you provide the keyfile and certfile parameters,
600 the identity of the SMTP server and client can be checked. This,
601 however, depends on whether the socket module really checks the
602 certificates.
Gregory P. Smithbde4ae42008-01-17 08:35:49 +0000603
604 This method may raise the following exceptions:
605
606 SMTPHeloError The server didn't reply properly to
607 the helo greeting.
Guido van Rossumf7fcf5e2001-09-14 16:08:44 +0000608 """
Gregory P. Smithbde4ae42008-01-17 08:35:49 +0000609 self.ehlo_or_helo_if_needed()
610 if not self.has_extn("starttls"):
611 raise SMTPException("STARTTLS extension not supported by server.")
Tim Petersb64bec32001-09-18 02:26:39 +0000612 (resp, reply) = self.docmd("STARTTLS")
Guido van Rossumf7fcf5e2001-09-14 16:08:44 +0000613 if resp == 220:
Bill Janssen426ea0a2007-08-29 22:35:05 +0000614 if not _have_ssl:
615 raise RuntimeError("No SSL support included in this Python")
Bill Janssen98d19da2007-09-10 21:51:02 +0000616 self.sock = ssl.wrap_socket(self.sock, keyfile, certfile)
Bill Janssen426ea0a2007-08-29 22:35:05 +0000617 self.file = SSLFakeFile(self.sock)
Gregory P. Smith63bfc1d2008-01-17 07:43:20 +0000618 # RFC 3207:
619 # The client MUST discard any knowledge obtained from
620 # the server, such as the list of SMTP service extensions,
621 # which was not obtained from the TLS negotiation itself.
622 self.helo_resp = None
623 self.ehlo_resp = None
624 self.esmtp_features = {}
625 self.does_esmtp = 0
Guido van Rossumf7fcf5e2001-09-14 16:08:44 +0000626 return (resp, reply)
Tim Petersb64bec32001-09-18 02:26:39 +0000627
Jeremy Hylton31bb8ce1998-08-13 19:57:46 +0000628 def sendmail(self, from_addr, to_addrs, msg, mail_options=[],
Tim Peters495ad3c2001-01-15 01:36:40 +0000629 rcpt_options=[]):
630 """This command performs an entire mail transaction.
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000631
Tim Peters495ad3c2001-01-15 01:36:40 +0000632 The arguments are:
Barry Warsaw4c4bec81998-12-22 03:02:20 +0000633 - from_addr : The address sending this mail.
634 - to_addrs : A list of addresses to send this mail to. A bare
635 string will be treated as a list with 1 address.
Tim Peters495ad3c2001-01-15 01:36:40 +0000636 - msg : The message to send.
Barry Warsaw4c4bec81998-12-22 03:02:20 +0000637 - mail_options : List of ESMTP options (such as 8bitmime) for the
638 mail command.
639 - rcpt_options : List of ESMTP options (such as DSN commands) for
640 all the rcpt commands.
641
642 If there has been no previous EHLO or HELO command this session, this
643 method tries ESMTP EHLO first. If the server does ESMTP, message size
644 and each of the specified options will be passed to it. If EHLO
645 fails, HELO will be tried and ESMTP options suppressed.
646
647 This method will return normally if the mail is accepted for at least
Barry Warsawd25c1b71999-11-28 17:11:06 +0000648 one recipient. It returns a dictionary, with one entry for each
649 recipient that was refused. Each entry contains a tuple of the SMTP
650 error code and the accompanying error message sent by the server.
Guido van Rossum296e1431999-04-07 15:03:39 +0000651
652 This method may raise the following exceptions:
653
654 SMTPHeloError The server didn't reply properly to
Tim Peters495ad3c2001-01-15 01:36:40 +0000655 the helo greeting.
Barry Warsawd25c1b71999-11-28 17:11:06 +0000656 SMTPRecipientsRefused The server rejected ALL recipients
Guido van Rossum296e1431999-04-07 15:03:39 +0000657 (no mail was sent).
658 SMTPSenderRefused The server didn't accept the from_addr.
659 SMTPDataError The server replied with an unexpected
660 error code (other than a refusal of
661 a recipient).
662
663 Note: the connection will be open even after an exception is raised.
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000664
Guido van Rossum95e6f701998-06-25 02:15:50 +0000665 Example:
Tim Peters495ad3c2001-01-15 01:36:40 +0000666
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000667 >>> import smtplib
668 >>> s=smtplib.SMTP("localhost")
Guido van Rossumfc40a831998-01-29 17:26:45 +0000669 >>> tolist=["one@one.org","two@two.org","three@three.org","four@four.org"]
Martin v. Löwis301b1cd2002-07-28 16:52:01 +0000670 >>> msg = '''\\
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000671 ... From: Me@my.org
672 ... Subject: testin'...
673 ...
674 ... This is a test '''
675 >>> s.sendmail("me@my.org",tolist,msg)
676 { "three@three.org" : ( 550 ,"User unknown" ) }
677 >>> s.quit()
Tim Peters495ad3c2001-01-15 01:36:40 +0000678
Barry Warsaw4c4bec81998-12-22 03:02:20 +0000679 In the above example, the message was accepted for delivery to three
680 of the four addresses, and one was rejected, with the error code
Barry Warsawd25c1b71999-11-28 17:11:06 +0000681 550. If all addresses are accepted, then the method will return an
Barry Warsaw4c4bec81998-12-22 03:02:20 +0000682 empty dictionary.
683
684 """
Gregory P. Smithbde4ae42008-01-17 08:35:49 +0000685 self.ehlo_or_helo_if_needed()
Guido van Rossum95e6f701998-06-25 02:15:50 +0000686 esmtp_opts = []
Guido van Rossumfcfb6321998-08-04 15:29:54 +0000687 if self.does_esmtp:
688 # Hmmm? what's this? -ddm
689 # self.esmtp_features['7bit']=""
690 if self.has_extn('size'):
Walter Dörwald70a6b492004-02-12 17:35:32 +0000691 esmtp_opts.append("size=%d" % len(msg))
Guido van Rossumfcfb6321998-08-04 15:29:54 +0000692 for option in mail_options:
Guido van Rossum95e6f701998-06-25 02:15:50 +0000693 esmtp_opts.append(option)
Guido van Rossumfcfb6321998-08-04 15:29:54 +0000694
Guido van Rossum95e6f701998-06-25 02:15:50 +0000695 (code,resp) = self.mail(from_addr, esmtp_opts)
Fred Drake8152d322000-12-12 23:20:45 +0000696 if code != 250:
Guido van Rossum45e2fbc1998-03-26 21:13:24 +0000697 self.rset()
Guido van Rossum296e1431999-04-07 15:03:39 +0000698 raise SMTPSenderRefused(code, resp, from_addr)
Guido van Rossum45e2fbc1998-03-26 21:13:24 +0000699 senderrs={}
Walter Dörwald65230a22002-06-03 15:58:32 +0000700 if isinstance(to_addrs, basestring):
Jeremy Hylton31bb8ce1998-08-13 19:57:46 +0000701 to_addrs = [to_addrs]
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000702 for each in to_addrs:
Guido van Rossumfcfb6321998-08-04 15:29:54 +0000703 (code,resp)=self.rcpt(each, rcpt_options)
Fred Drake8152d322000-12-12 23:20:45 +0000704 if (code != 250) and (code != 251):
Guido van Rossumfc40a831998-01-29 17:26:45 +0000705 senderrs[each]=(code,resp)
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000706 if len(senderrs)==len(to_addrs):
Guido van Rossum95e6f701998-06-25 02:15:50 +0000707 # the server refused all our recipients
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000708 self.rset()
Guido van Rossum296e1431999-04-07 15:03:39 +0000709 raise SMTPRecipientsRefused(senderrs)
Fred Drake8152d322000-12-12 23:20:45 +0000710 (code,resp) = self.data(msg)
711 if code != 250:
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000712 self.rset()
Guido van Rossum296e1431999-04-07 15:03:39 +0000713 raise SMTPDataError(code, resp)
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000714 #if we got here then somebody got our mail
Tim Peters495ad3c2001-01-15 01:36:40 +0000715 return senderrs
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000716
717
718 def close(self):
719 """Close the connection to the SMTP server."""
720 if self.file:
721 self.file.close()
722 self.file = None
723 if self.sock:
724 self.sock.close()
725 self.sock = None
726
727
728 def quit(self):
Guido van Rossum95e6f701998-06-25 02:15:50 +0000729 """Terminate the SMTP session."""
Georg Brandldeaf2ca2008-03-27 13:27:31 +0000730 res = self.docmd("quit")
Guido van Rossum45e2fbc1998-03-26 21:13:24 +0000731 self.close()
Georg Brandldeaf2ca2008-03-27 13:27:31 +0000732 return res
Guido van Rossum95e6f701998-06-25 02:15:50 +0000733
Bill Janssen426ea0a2007-08-29 22:35:05 +0000734if _have_ssl:
Martin v. Löwisee82c0e2006-10-27 07:13:28 +0000735
Bill Janssen426ea0a2007-08-29 22:35:05 +0000736 class SMTP_SSL(SMTP):
737 """ This is a subclass derived from SMTP that connects over an SSL encrypted
738 socket (to use this class you need a socket module that was compiled with SSL
739 support). If host is not specified, '' (the local host) is used. If port is
740 omitted, the standard SMTP-over-SSL port (465) is used. keyfile and certfile
741 are also optional - they can contain a PEM formatted private key and
742 certificate chain file for the SSL connection.
743 """
744 def __init__(self, host='', port=0, local_hostname=None,
Facundo Batista4f1b1ed2008-05-29 16:39:26 +0000745 keyfile=None, certfile=None,
746 timeout=socket._GLOBAL_DEFAULT_TIMEOUT):
Bill Janssen426ea0a2007-08-29 22:35:05 +0000747 self.keyfile = keyfile
748 self.certfile = certfile
749 SMTP.__init__(self, host, port, local_hostname, timeout)
750 self.default_port = SMTP_SSL_PORT
751
752 def _get_socket(self, host, port, timeout):
753 if self.debuglevel > 0: print>>stderr, 'connect:', (host, port)
R. David Murrayeb059b82009-05-23 01:42:42 +0000754 new_socket = socket.create_connection((host, port), timeout)
755 new_socket = ssl.wrap_socket(new_socket, self.keyfile, self.certfile)
756 self.file = SSLFakeFile(new_socket)
757 return new_socket
Barry Warsaw4c4bec81998-12-22 03:02:20 +0000758
Thomas Woutersa6900e82007-08-30 21:54:39 +0000759 __all__.append("SMTP_SSL")
760
Martin v. Löwis1190a382007-03-09 15:35:55 +0000761#
762# LMTP extension
763#
764LMTP_PORT = 2003
765
766class LMTP(SMTP):
767 """LMTP - Local Mail Transfer Protocol
768
769 The LMTP protocol, which is very similar to ESMTP, is heavily based
770 on the standard SMTP client. It's common to use Unix sockets for LMTP,
771 so our connect() method must support that as well as a regular
772 host:port server. To specify a Unix socket, you must use an absolute
773 path as the host, starting with a '/'.
774
775 Authentication is supported, using the regular SMTP mechanism. When
776 using a Unix socket, LMTP generally don't support or require any
777 authentication, but your mileage might vary."""
778
779 ehlo_msg = "lhlo"
Tim Petersea5962f2007-03-12 18:07:52 +0000780
Martin v. Löwis1190a382007-03-09 15:35:55 +0000781 def __init__(self, host = '', port = LMTP_PORT, local_hostname = None):
782 """Initialize a new instance."""
783 SMTP.__init__(self, host, port, local_hostname)
784
Neal Norwitzc8f6c232007-03-10 03:19:18 +0000785 def connect(self, host = 'localhost', port = 0):
Martin v. Löwis1190a382007-03-09 15:35:55 +0000786 """Connect to the LMTP daemon, on either a Unix or a TCP socket."""
Neal Norwitzc8f6c232007-03-10 03:19:18 +0000787 if host[0] != '/':
Martin v. Löwis1190a382007-03-09 15:35:55 +0000788 return SMTP.connect(self, host, port)
789
Neal Norwitzc8f6c232007-03-10 03:19:18 +0000790 # Handle Unix-domain sockets.
791 try:
792 self.sock = socket.socket(socket.AF_UNIX, socket.SOCK_STREAM)
793 self.sock.connect(host)
794 except socket.error, msg:
795 if self.debuglevel > 0: print>>stderr, 'connect fail:', host
796 if self.sock:
797 self.sock.close()
798 self.sock = None
799 raise socket.error, msg
800 (code, msg) = self.getreply()
801 if self.debuglevel > 0: print>>stderr, "connect:", msg
802 return (code, msg)
803
Martin v. Löwis1190a382007-03-09 15:35:55 +0000804
Guido van Rossum95e6f701998-06-25 02:15:50 +0000805# Test the sendmail method, which tests most of the others.
806# Note: This always sends to localhost.
807if __name__ == '__main__':
Andrew M. Kuchling6be424f2001-08-13 14:41:39 +0000808 import sys
Guido van Rossum95e6f701998-06-25 02:15:50 +0000809
810 def prompt(prompt):
811 sys.stdout.write(prompt + ": ")
Eric S. Raymondc013f302001-02-09 05:40:38 +0000812 return sys.stdin.readline().strip()
Guido van Rossum95e6f701998-06-25 02:15:50 +0000813
814 fromaddr = prompt("From")
Eric S. Raymond38151ed2001-02-09 07:40:17 +0000815 toaddrs = prompt("To").split(',')
Guido van Rossum95e6f701998-06-25 02:15:50 +0000816 print "Enter message, end with ^D:"
817 msg = ''
818 while 1:
819 line = sys.stdin.readline()
820 if not line:
821 break
822 msg = msg + line
Walter Dörwald70a6b492004-02-12 17:35:32 +0000823 print "Message length is %d" % len(msg)
Guido van Rossum95e6f701998-06-25 02:15:50 +0000824
825 server = SMTP('localhost')
826 server.set_debuglevel(1)
827 server.sendmail(fromaddr, toaddrs, msg)
828 server.quit()