blob: bb9c239a2764cf1ead04a6acfeaf4912d7831789 [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)
178 str += chr
179 return str
180
181 def close(self):
182 pass
183
184 _have_ssl = True
185
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000186class SMTP:
Guido van Rossumfcfb6321998-08-04 15:29:54 +0000187 """This class manages a connection to an SMTP or ESMTP server.
188 SMTP Objects:
Tim Peters495ad3c2001-01-15 01:36:40 +0000189 SMTP objects have the following attributes:
190 helo_resp
191 This is the message given by the server in response to the
Guido van Rossumfcfb6321998-08-04 15:29:54 +0000192 most recent HELO command.
Tim Peters495ad3c2001-01-15 01:36:40 +0000193
Guido van Rossumfcfb6321998-08-04 15:29:54 +0000194 ehlo_resp
Tim Peters495ad3c2001-01-15 01:36:40 +0000195 This is the message given by the server in response to the
Guido van Rossumfcfb6321998-08-04 15:29:54 +0000196 most recent EHLO command. This is usually multiline.
197
Tim Peters495ad3c2001-01-15 01:36:40 +0000198 does_esmtp
Guido van Rossumfcfb6321998-08-04 15:29:54 +0000199 This is a True value _after you do an EHLO command_, if the
200 server supports ESMTP.
201
Tim Peters495ad3c2001-01-15 01:36:40 +0000202 esmtp_features
Guido van Rossumfcfb6321998-08-04 15:29:54 +0000203 This is a dictionary, which, if the server supports ESMTP,
Barry Warsawd25c1b71999-11-28 17:11:06 +0000204 will _after you do an EHLO command_, contain the names of the
205 SMTP service extensions this server supports, and their
Guido van Rossumfcfb6321998-08-04 15:29:54 +0000206 parameters (if any).
Barry Warsawd25c1b71999-11-28 17:11:06 +0000207
Tim Peters495ad3c2001-01-15 01:36:40 +0000208 Note, all extension names are mapped to lower case in the
209 dictionary.
Guido van Rossumfcfb6321998-08-04 15:29:54 +0000210
Barry Warsawd25c1b71999-11-28 17:11:06 +0000211 See each method's docstrings for details. In general, there is a
212 method of the same name to perform each SMTP command. There is also a
213 method called 'sendmail' that will do an entire mail transaction.
214 """
Guido van Rossum95e6f701998-06-25 02:15:50 +0000215 debuglevel = 0
216 file = None
217 helo_resp = None
Martin v. Löwis1190a382007-03-09 15:35:55 +0000218 ehlo_msg = "ehlo"
Guido van Rossum95e6f701998-06-25 02:15:50 +0000219 ehlo_resp = None
Guido van Rossumfcfb6321998-08-04 15:29:54 +0000220 does_esmtp = 0
Guido van Rossum95e6f701998-06-25 02:15:50 +0000221
Facundo Batista366d6262007-03-28 18:25:54 +0000222 def __init__(self, host='', port=0, local_hostname=None, timeout=None):
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000223 """Initialize a new instance.
224
Barry Warsawa7d9bdf1998-12-22 03:24:27 +0000225 If specified, `host' is the name of the remote host to which to
226 connect. If specified, `port' specifies the port to which to connect.
Barry Warsawd25c1b71999-11-28 17:11:06 +0000227 By default, smtplib.SMTP_PORT is used. An SMTPConnectError is raised
Neil Schemenauer6730f262002-03-24 15:30:40 +0000228 if the specified `host' doesn't respond correctly. If specified,
Tim Peters863ac442002-04-16 01:38:40 +0000229 `local_hostname` is used as the FQDN of the local host. By default,
230 the local hostname is found using socket.getfqdn().
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000231
232 """
Facundo Batista366d6262007-03-28 18:25:54 +0000233 self.timeout = timeout
Guido van Rossumfcfb6321998-08-04 15:29:54 +0000234 self.esmtp_features = {}
Martin v. Löwisee82c0e2006-10-27 07:13:28 +0000235 self.default_port = SMTP_PORT
Guido van Rossum296e1431999-04-07 15:03:39 +0000236 if host:
237 (code, msg) = self.connect(host, port)
238 if code != 220:
239 raise SMTPConnectError(code, msg)
Raymond Hettingerf13eb552002-06-02 00:40:05 +0000240 if local_hostname is not None:
Barry Warsaw13e34f72002-03-26 20:27:35 +0000241 self.local_hostname = local_hostname
Neil Schemenauer6730f262002-03-24 15:30:40 +0000242 else:
Barry Warsaw13e34f72002-03-26 20:27:35 +0000243 # RFC 2821 says we should use the fqdn in the EHLO/HELO verb, and
244 # if that can't be calculated, that we should use a domain literal
245 # instead (essentially an encoded IP address like [A.B.C.D]).
246 fqdn = socket.getfqdn()
247 if '.' in fqdn:
248 self.local_hostname = fqdn
249 else:
250 # We can't find an fqdn hostname, so use a domain literal
Georg Brandldcdfd222006-03-31 19:34:13 +0000251 addr = '127.0.0.1'
252 try:
253 addr = socket.gethostbyname(socket.gethostname())
254 except socket.gaierror:
255 pass
Barry Warsaw13e34f72002-03-26 20:27:35 +0000256 self.local_hostname = '[%s]' % addr
Tim Peters495ad3c2001-01-15 01:36:40 +0000257
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000258 def set_debuglevel(self, debuglevel):
259 """Set the debug output level.
260
Barry Warsawa7d9bdf1998-12-22 03:24:27 +0000261 A non-false value results in debug messages for connection and for all
262 messages sent to and received from the server.
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000263
264 """
265 self.debuglevel = debuglevel
266
Facundo Batista366d6262007-03-28 18:25:54 +0000267 def _get_socket(self, port, host, timeout):
Martin v. Löwisee82c0e2006-10-27 07:13:28 +0000268 # This makes it simpler for SMTP_SSL to use the SMTP connect code
269 # and just alter the socket connection bit.
Martin v. Löwisee82c0e2006-10-27 07:13:28 +0000270 if self.debuglevel > 0: print>>stderr, 'connect:', (host, port)
Facundo Batista366d6262007-03-28 18:25:54 +0000271 return socket.create_connection((port, host), timeout)
Martin v. Löwisee82c0e2006-10-27 07:13:28 +0000272
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000273 def connect(self, host='localhost', port = 0):
274 """Connect to a host on a given port.
Guido van Rossum95e6f701998-06-25 02:15:50 +0000275
Barry Warsaw4c4bec81998-12-22 03:02:20 +0000276 If the hostname ends with a colon (`:') followed by a number, and
277 there is no port specified, that suffix will be stripped off and the
278 number interpreted as the port number to use.
Guido van Rossum95e6f701998-06-25 02:15:50 +0000279
Barry Warsawa7d9bdf1998-12-22 03:24:27 +0000280 Note: This method is automatically invoked by __init__, if a host is
281 specified during instantiation.
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000282
283 """
Martin v. Löwis4eb59402001-07-26 13:37:33 +0000284 if not port and (host.find(':') == host.rfind(':')):
Martin v. Löwisa43c2f82001-07-24 20:34:08 +0000285 i = host.rfind(':')
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000286 if i >= 0:
287 host, port = host[:i], host[i+1:]
Eric S. Raymondc013f302001-02-09 05:40:38 +0000288 try: port = int(port)
Eric S. Raymond8d876032001-02-09 10:14:53 +0000289 except ValueError:
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000290 raise socket.error, "nonnumeric port"
Martin v. Löwisee82c0e2006-10-27 07:13:28 +0000291 if not port: port = self.default_port
Brett Cannone6f8a892004-07-10 23:14:30 +0000292 if self.debuglevel > 0: print>>stderr, 'connect:', (host, port)
Facundo Batista366d6262007-03-28 18:25:54 +0000293 self.sock = self._get_socket(host, port, self.timeout)
Martin v. Löwisa43c2f82001-07-24 20:34:08 +0000294 (code, msg) = self.getreply()
Brett Cannone6f8a892004-07-10 23:14:30 +0000295 if self.debuglevel > 0: print>>stderr, "connect:", msg
Martin v. Löwisa43c2f82001-07-24 20:34:08 +0000296 return (code, msg)
Tim Peters495ad3c2001-01-15 01:36:40 +0000297
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000298 def send(self, str):
299 """Send `str' to the server."""
Brett Cannone6f8a892004-07-10 23:14:30 +0000300 if self.debuglevel > 0: print>>stderr, 'send:', repr(str)
Guido van Rossum45e2fbc1998-03-26 21:13:24 +0000301 if self.sock:
Guido van Rossum2880f6e1998-08-10 20:07:00 +0000302 try:
Martin v. Löwise12454f2002-02-16 23:06:19 +0000303 self.sock.sendall(str)
Guido van Rossum2880f6e1998-08-10 20:07:00 +0000304 except socket.error:
Barry Warsaw76750972001-12-14 20:34:20 +0000305 self.close()
Guido van Rossum40233ea1999-01-15 03:23:55 +0000306 raise SMTPServerDisconnected('Server not connected')
Guido van Rossumfc40a831998-01-29 17:26:45 +0000307 else:
Guido van Rossum40233ea1999-01-15 03:23:55 +0000308 raise SMTPServerDisconnected('please run connect() first')
Tim Peters495ad3c2001-01-15 01:36:40 +0000309
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000310 def putcmd(self, cmd, args=""):
Barry Warsawa7d9bdf1998-12-22 03:24:27 +0000311 """Send a command to the server."""
Guido van Rossumdb23d3d1999-06-09 15:13:10 +0000312 if args == "":
313 str = '%s%s' % (cmd, CRLF)
314 else:
315 str = '%s %s%s' % (cmd, args, CRLF)
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000316 self.send(str)
Tim Peters495ad3c2001-01-15 01:36:40 +0000317
Guido van Rossumfcfb6321998-08-04 15:29:54 +0000318 def getreply(self):
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000319 """Get a reply from the server.
Tim Peters495ad3c2001-01-15 01:36:40 +0000320
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000321 Returns a tuple consisting of:
Barry Warsawa7d9bdf1998-12-22 03:24:27 +0000322
323 - server response code (e.g. '250', or such, if all goes well)
324 Note: returns -1 if it can't read response code.
325
326 - server response string corresponding to response code (multiline
327 responses are converted to a single, multiline string).
Guido van Rossumf123f841999-03-29 20:33:21 +0000328
329 Raises SMTPServerDisconnected if end-of-file is reached.
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000330 """
331 resp=[]
Guido van Rossum296e1431999-04-07 15:03:39 +0000332 if self.file is None:
333 self.file = self.sock.makefile('rb')
Guido van Rossum45e2fbc1998-03-26 21:13:24 +0000334 while 1:
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000335 line = self.file.readline()
Guido van Rossum296e1431999-04-07 15:03:39 +0000336 if line == '':
337 self.close()
338 raise SMTPServerDisconnected("Connection unexpectedly closed")
Brett Cannone6f8a892004-07-10 23:14:30 +0000339 if self.debuglevel > 0: print>>stderr, 'reply:', repr(line)
Eric S. Raymondc013f302001-02-09 05:40:38 +0000340 resp.append(line[4:].strip())
Guido van Rossum45e2fbc1998-03-26 21:13:24 +0000341 code=line[:3]
Guido van Rossum296e1431999-04-07 15:03:39 +0000342 # Check that the error code is syntactically correct.
343 # Don't attempt to read a continuation line if it is broken.
344 try:
Eric S. Raymondc013f302001-02-09 05:40:38 +0000345 errcode = int(code)
Guido van Rossum296e1431999-04-07 15:03:39 +0000346 except ValueError:
347 errcode = -1
348 break
Guido van Rossumf123f841999-03-29 20:33:21 +0000349 # Check if multiline response.
Guido van Rossum45e2fbc1998-03-26 21:13:24 +0000350 if line[3:4]!="-":
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000351 break
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000352
Eric S. Raymondc013f302001-02-09 05:40:38 +0000353 errmsg = "\n".join(resp)
Tim Peters495ad3c2001-01-15 01:36:40 +0000354 if self.debuglevel > 0:
Brett Cannone6f8a892004-07-10 23:14:30 +0000355 print>>stderr, 'reply: retcode (%s); Msg: %s' % (errcode,errmsg)
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000356 return errcode, errmsg
Tim Peters495ad3c2001-01-15 01:36:40 +0000357
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000358 def docmd(self, cmd, args=""):
Barry Warsawa7d9bdf1998-12-22 03:24:27 +0000359 """Send a command, and return its response code."""
Guido van Rossum45e2fbc1998-03-26 21:13:24 +0000360 self.putcmd(cmd,args)
Guido van Rossum296e1431999-04-07 15:03:39 +0000361 return self.getreply()
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000362
Barry Warsawa7d9bdf1998-12-22 03:24:27 +0000363 # std smtp commands
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000364 def helo(self, name=''):
Barry Warsawa7d9bdf1998-12-22 03:24:27 +0000365 """SMTP 'helo' command.
366 Hostname to send for this command defaults to the FQDN of the local
367 host.
368 """
Neil Schemenauer6730f262002-03-24 15:30:40 +0000369 self.putcmd("helo", name or self.local_hostname)
Guido van Rossum45e2fbc1998-03-26 21:13:24 +0000370 (code,msg)=self.getreply()
371 self.helo_resp=msg
Guido van Rossum296e1431999-04-07 15:03:39 +0000372 return (code,msg)
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000373
Guido van Rossum95e6f701998-06-25 02:15:50 +0000374 def ehlo(self, name=''):
Barry Warsawa7d9bdf1998-12-22 03:24:27 +0000375 """ SMTP 'ehlo' command.
376 Hostname to send for this command defaults to the FQDN of the local
377 host.
378 """
Guido van Rossumf7fcf5e2001-09-14 16:08:44 +0000379 self.esmtp_features = {}
Martin v. Löwis1190a382007-03-09 15:35:55 +0000380 self.putcmd(self.ehlo_msg, name or self.local_hostname)
Guido van Rossumfcfb6321998-08-04 15:29:54 +0000381 (code,msg)=self.getreply()
Tim Peters495ad3c2001-01-15 01:36:40 +0000382 # According to RFC1869 some (badly written)
383 # MTA's will disconnect on an ehlo. Toss an exception if
Guido van Rossumfcfb6321998-08-04 15:29:54 +0000384 # that happens -ddm
385 if code == -1 and len(msg) == 0:
Barry Warsaw76750972001-12-14 20:34:20 +0000386 self.close()
Guido van Rossum40233ea1999-01-15 03:23:55 +0000387 raise SMTPServerDisconnected("Server not connected")
Guido van Rossum95e6f701998-06-25 02:15:50 +0000388 self.ehlo_resp=msg
Fred Drake8152d322000-12-12 23:20:45 +0000389 if code != 250:
Guido van Rossum296e1431999-04-07 15:03:39 +0000390 return (code,msg)
Guido van Rossumfcfb6321998-08-04 15:29:54 +0000391 self.does_esmtp=1
Thomas Wouters7e474022000-07-16 12:04:32 +0000392 #parse the ehlo response -ddm
Eric S. Raymondc013f302001-02-09 05:40:38 +0000393 resp=self.ehlo_resp.split('\n')
Guido van Rossumfcfb6321998-08-04 15:29:54 +0000394 del resp[0]
Guido van Rossum2880f6e1998-08-10 20:07:00 +0000395 for each in resp:
Piers Lauder385a77a2002-07-27 00:38:30 +0000396 # To be able to communicate with as many SMTP servers as possible,
397 # we have to take the old-style auth advertisement into account,
398 # because:
399 # 1) Else our SMTP feature parser gets confused.
400 # 2) There are some servers that only advertise the auth methods we
401 # support using the old style.
402 auth_match = OLDSTYLE_AUTH.match(each)
403 if auth_match:
404 # This doesn't remove duplicates, but that's no problem
405 self.esmtp_features["auth"] = self.esmtp_features.get("auth", "") \
406 + " " + auth_match.groups(0)[0]
407 continue
408
Barry Warsawbe22ae62002-04-15 20:03:30 +0000409 # RFC 1869 requires a space between ehlo keyword and parameters.
410 # It's actually stricter, in that only spaces are allowed between
411 # parameters, but were not going to check for that here. Note
412 # that the space isn't present if there are no parameters.
413 m=re.match(r'(?P<feature>[A-Za-z0-9][A-Za-z0-9\-]*) ?',each)
Guido van Rossumfcfb6321998-08-04 15:29:54 +0000414 if m:
Eric S. Raymondc013f302001-02-09 05:40:38 +0000415 feature=m.group("feature").lower()
416 params=m.string[m.end("feature"):].strip()
Piers Lauder385a77a2002-07-27 00:38:30 +0000417 if feature == "auth":
418 self.esmtp_features[feature] = self.esmtp_features.get(feature, "") \
419 + " " + params
420 else:
421 self.esmtp_features[feature]=params
Guido van Rossum296e1431999-04-07 15:03:39 +0000422 return (code,msg)
Guido van Rossum95e6f701998-06-25 02:15:50 +0000423
Guido van Rossumfcfb6321998-08-04 15:29:54 +0000424 def has_extn(self, opt):
425 """Does the server support a given SMTP service extension?"""
Raymond Hettinger54f02222002-06-01 14:18:47 +0000426 return opt.lower() in self.esmtp_features
Guido van Rossum95e6f701998-06-25 02:15:50 +0000427
Guido van Rossum18586f41998-04-03 17:03:13 +0000428 def help(self, args=''):
Barry Warsawa7d9bdf1998-12-22 03:24:27 +0000429 """SMTP 'help' command.
430 Returns help text from server."""
Guido van Rossum18586f41998-04-03 17:03:13 +0000431 self.putcmd("help", args)
Kurt B. Kaiser58bd1902005-06-26 18:27:36 +0000432 return self.getreply()[1]
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000433
434 def rset(self):
Barry Warsawa7d9bdf1998-12-22 03:24:27 +0000435 """SMTP 'rset' command -- resets session."""
Guido van Rossum296e1431999-04-07 15:03:39 +0000436 return self.docmd("rset")
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000437
438 def noop(self):
Barry Warsawa7d9bdf1998-12-22 03:24:27 +0000439 """SMTP 'noop' command -- doesn't do anything :>"""
Guido van Rossum296e1431999-04-07 15:03:39 +0000440 return self.docmd("noop")
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000441
Guido van Rossum95e6f701998-06-25 02:15:50 +0000442 def mail(self,sender,options=[]):
Barry Warsawa7d9bdf1998-12-22 03:24:27 +0000443 """SMTP 'mail' command -- begins mail xfer session."""
Guido van Rossumfcfb6321998-08-04 15:29:54 +0000444 optionlist = ''
445 if options and self.does_esmtp:
Eric S. Raymondc013f302001-02-09 05:40:38 +0000446 optionlist = ' ' + ' '.join(options)
Guido van Rossumdb23d3d1999-06-09 15:13:10 +0000447 self.putcmd("mail", "FROM:%s%s" % (quoteaddr(sender) ,optionlist))
Guido van Rossum45e2fbc1998-03-26 21:13:24 +0000448 return self.getreply()
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000449
Guido van Rossumfcfb6321998-08-04 15:29:54 +0000450 def rcpt(self,recip,options=[]):
Barry Warsawa7d9bdf1998-12-22 03:24:27 +0000451 """SMTP 'rcpt' command -- indicates 1 recipient for this mail."""
Guido van Rossumfcfb6321998-08-04 15:29:54 +0000452 optionlist = ''
453 if options and self.does_esmtp:
Eric S. Raymondc013f302001-02-09 05:40:38 +0000454 optionlist = ' ' + ' '.join(options)
Guido van Rossum348fd061999-01-14 04:18:46 +0000455 self.putcmd("rcpt","TO:%s%s" % (quoteaddr(recip),optionlist))
Guido van Rossum45e2fbc1998-03-26 21:13:24 +0000456 return self.getreply()
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000457
458 def data(self,msg):
Tim Peters495ad3c2001-01-15 01:36:40 +0000459 """SMTP 'DATA' command -- sends message data to server.
Guido van Rossum296e1431999-04-07 15:03:39 +0000460
Barry Warsaw4c4bec81998-12-22 03:02:20 +0000461 Automatically quotes lines beginning with a period per rfc821.
Guido van Rossum296e1431999-04-07 15:03:39 +0000462 Raises SMTPDataError if there is an unexpected reply to the
463 DATA command; the return value from this method is the final
464 response code received when the all data is sent.
Barry Warsaw4c4bec81998-12-22 03:02:20 +0000465 """
Guido van Rossum45e2fbc1998-03-26 21:13:24 +0000466 self.putcmd("data")
467 (code,repl)=self.getreply()
Brett Cannone6f8a892004-07-10 23:14:30 +0000468 if self.debuglevel >0 : print>>stderr, "data:", (code,repl)
Fred Drake8152d322000-12-12 23:20:45 +0000469 if code != 354:
Guido van Rossum296e1431999-04-07 15:03:39 +0000470 raise SMTPDataError(code,repl)
Guido van Rossum45e2fbc1998-03-26 21:13:24 +0000471 else:
Guido van Rossum20c92281999-04-21 16:52:20 +0000472 q = quotedata(msg)
473 if q[-2:] != CRLF:
474 q = q + CRLF
475 q = q + "." + CRLF
476 self.send(q)
Guido van Rossum45e2fbc1998-03-26 21:13:24 +0000477 (code,msg)=self.getreply()
Brett Cannone6f8a892004-07-10 23:14:30 +0000478 if self.debuglevel >0 : print>>stderr, "data:", (code,msg)
Guido van Rossum296e1431999-04-07 15:03:39 +0000479 return (code,msg)
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000480
Guido van Rossumfcfb6321998-08-04 15:29:54 +0000481 def verify(self, address):
Barry Warsawa7d9bdf1998-12-22 03:24:27 +0000482 """SMTP 'verify' command -- checks for address validity."""
Guido van Rossumfcfb6321998-08-04 15:29:54 +0000483 self.putcmd("vrfy", quoteaddr(address))
484 return self.getreply()
Barry Warsaw4c4bec81998-12-22 03:02:20 +0000485 # a.k.a.
486 vrfy=verify
Guido van Rossumfcfb6321998-08-04 15:29:54 +0000487
488 def expn(self, address):
Barry Warsawa7d9bdf1998-12-22 03:24:27 +0000489 """SMTP 'verify' command -- checks for address validity."""
Guido van Rossumfcfb6321998-08-04 15:29:54 +0000490 self.putcmd("expn", quoteaddr(address))
491 return self.getreply()
492
Barry Warsaw4c4bec81998-12-22 03:02:20 +0000493 # some useful methods
Guido van Rossumae010462001-09-11 15:57:46 +0000494
Gregory P. Smithbde4ae42008-01-17 08:35:49 +0000495 def ehlo_or_helo_if_needed(self):
496 """Call self.ehlo() and/or self.helo() if needed.
497
498 If there has been no previous EHLO or HELO command this session, this
499 method tries ESMTP EHLO first.
500
501 This method may raise the following exceptions:
502
503 SMTPHeloError The server didn't reply properly to
504 the helo greeting.
505 """
506 if self.helo_resp is None and self.ehlo_resp is None:
507 if not (200 <= self.ehlo()[0] <= 299):
508 (code, resp) = self.helo()
509 if not (200 <= code <= 299):
510 raise SMTPHeloError(code, resp)
511
Guido van Rossumae010462001-09-11 15:57:46 +0000512 def login(self, user, password):
513 """Log in on an SMTP server that requires authentication.
514
515 The arguments are:
516 - user: The user name to authenticate with.
517 - password: The password for the authentication.
518
519 If there has been no previous EHLO or HELO command this session, this
520 method tries ESMTP EHLO first.
521
522 This method will return normally if the authentication was successful.
523
524 This method may raise the following exceptions:
525
526 SMTPHeloError The server didn't reply properly to
527 the helo greeting.
528 SMTPAuthenticationError The server didn't accept the username/
529 password combination.
Fred Drake2f8f4d32001-10-13 18:35:32 +0000530 SMTPException No suitable authentication method was
Guido van Rossumae010462001-09-11 15:57:46 +0000531 found.
532 """
533
534 def encode_cram_md5(challenge, user, password):
535 challenge = base64.decodestring(challenge)
536 response = user + " " + hmac.HMAC(password, challenge).hexdigest()
Piers Lauder385a77a2002-07-27 00:38:30 +0000537 return encode_base64(response, eol="")
Guido van Rossumae010462001-09-11 15:57:46 +0000538
539 def encode_plain(user, password):
Johannes Gijsbers25946dd2004-12-06 21:25:26 +0000540 return encode_base64("\0%s\0%s" % (user, password), eol="")
Tim Peters469cdad2002-08-08 20:19:19 +0000541
Guido van Rossumae010462001-09-11 15:57:46 +0000542
543 AUTH_PLAIN = "PLAIN"
544 AUTH_CRAM_MD5 = "CRAM-MD5"
Piers Lauder385a77a2002-07-27 00:38:30 +0000545 AUTH_LOGIN = "LOGIN"
Guido van Rossumae010462001-09-11 15:57:46 +0000546
Gregory P. Smithbde4ae42008-01-17 08:35:49 +0000547 self.ehlo_or_helo_if_needed()
Guido van Rossumae010462001-09-11 15:57:46 +0000548
549 if not self.has_extn("auth"):
550 raise SMTPException("SMTP AUTH extension not supported by server.")
551
552 # Authentication methods the server supports:
553 authlist = self.esmtp_features["auth"].split()
554
555 # List of authentication methods we support: from preferred to
556 # less preferred methods. Except for the purpose of testing the weaker
557 # ones, we prefer stronger methods like CRAM-MD5:
Piers Lauder385a77a2002-07-27 00:38:30 +0000558 preferred_auths = [AUTH_CRAM_MD5, AUTH_PLAIN, AUTH_LOGIN]
Guido van Rossumae010462001-09-11 15:57:46 +0000559
560 # Determine the authentication method we'll use
561 authmethod = None
562 for method in preferred_auths:
563 if method in authlist:
564 authmethod = method
565 break
Tim Petersb64bec32001-09-18 02:26:39 +0000566
Guido van Rossumae010462001-09-11 15:57:46 +0000567 if authmethod == AUTH_CRAM_MD5:
568 (code, resp) = self.docmd("AUTH", AUTH_CRAM_MD5)
569 if code == 503:
570 # 503 == 'Error: already authenticated'
571 return (code, resp)
572 (code, resp) = self.docmd(encode_cram_md5(resp, user, password))
573 elif authmethod == AUTH_PLAIN:
Tim Petersb64bec32001-09-18 02:26:39 +0000574 (code, resp) = self.docmd("AUTH",
Guido van Rossumae010462001-09-11 15:57:46 +0000575 AUTH_PLAIN + " " + encode_plain(user, password))
Piers Lauder385a77a2002-07-27 00:38:30 +0000576 elif authmethod == AUTH_LOGIN:
577 (code, resp) = self.docmd("AUTH",
578 "%s %s" % (AUTH_LOGIN, encode_base64(user, eol="")))
579 if code != 334:
580 raise SMTPAuthenticationError(code, resp)
Martin v. Löwis49c05d32002-10-06 17:55:08 +0000581 (code, resp) = self.docmd(encode_base64(password, eol=""))
Raymond Hettinger7fdfc2d2002-05-31 17:49:10 +0000582 elif authmethod is None:
Fred Drake2f8f4d32001-10-13 18:35:32 +0000583 raise SMTPException("No suitable authentication method found.")
Raymond Hettingerdbecd932005-02-06 06:57:08 +0000584 if code not in (235, 503):
Guido van Rossumae010462001-09-11 15:57:46 +0000585 # 235 == 'Authentication successful'
586 # 503 == 'Error: already authenticated'
587 raise SMTPAuthenticationError(code, resp)
588 return (code, resp)
589
Guido van Rossumf7fcf5e2001-09-14 16:08:44 +0000590 def starttls(self, keyfile = None, certfile = None):
591 """Puts the connection to the SMTP server into TLS mode.
Tim Petersb64bec32001-09-18 02:26:39 +0000592
Gregory P. Smithbde4ae42008-01-17 08:35:49 +0000593 If there has been no previous EHLO or HELO command this session, this
594 method tries ESMTP EHLO first.
595
Guido van Rossumf7fcf5e2001-09-14 16:08:44 +0000596 If the server supports TLS, this will encrypt the rest of the SMTP
597 session. If you provide the keyfile and certfile parameters,
598 the identity of the SMTP server and client can be checked. This,
599 however, depends on whether the socket module really checks the
600 certificates.
Gregory P. Smithbde4ae42008-01-17 08:35:49 +0000601
602 This method may raise the following exceptions:
603
604 SMTPHeloError The server didn't reply properly to
605 the helo greeting.
Guido van Rossumf7fcf5e2001-09-14 16:08:44 +0000606 """
Gregory P. Smithbde4ae42008-01-17 08:35:49 +0000607 self.ehlo_or_helo_if_needed()
608 if not self.has_extn("starttls"):
609 raise SMTPException("STARTTLS extension not supported by server.")
Tim Petersb64bec32001-09-18 02:26:39 +0000610 (resp, reply) = self.docmd("STARTTLS")
Guido van Rossumf7fcf5e2001-09-14 16:08:44 +0000611 if resp == 220:
Bill Janssen426ea0a2007-08-29 22:35:05 +0000612 if not _have_ssl:
613 raise RuntimeError("No SSL support included in this Python")
Bill Janssen98d19da2007-09-10 21:51:02 +0000614 self.sock = ssl.wrap_socket(self.sock, keyfile, certfile)
Bill Janssen426ea0a2007-08-29 22:35:05 +0000615 self.file = SSLFakeFile(self.sock)
Gregory P. Smith63bfc1d2008-01-17 07:43:20 +0000616 # RFC 3207:
617 # The client MUST discard any knowledge obtained from
618 # the server, such as the list of SMTP service extensions,
619 # which was not obtained from the TLS negotiation itself.
620 self.helo_resp = None
621 self.ehlo_resp = None
622 self.esmtp_features = {}
623 self.does_esmtp = 0
Guido van Rossumf7fcf5e2001-09-14 16:08:44 +0000624 return (resp, reply)
Tim Petersb64bec32001-09-18 02:26:39 +0000625
Jeremy Hylton31bb8ce1998-08-13 19:57:46 +0000626 def sendmail(self, from_addr, to_addrs, msg, mail_options=[],
Tim Peters495ad3c2001-01-15 01:36:40 +0000627 rcpt_options=[]):
628 """This command performs an entire mail transaction.
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000629
Tim Peters495ad3c2001-01-15 01:36:40 +0000630 The arguments are:
Barry Warsaw4c4bec81998-12-22 03:02:20 +0000631 - from_addr : The address sending this mail.
632 - to_addrs : A list of addresses to send this mail to. A bare
633 string will be treated as a list with 1 address.
Tim Peters495ad3c2001-01-15 01:36:40 +0000634 - msg : The message to send.
Barry Warsaw4c4bec81998-12-22 03:02:20 +0000635 - mail_options : List of ESMTP options (such as 8bitmime) for the
636 mail command.
637 - rcpt_options : List of ESMTP options (such as DSN commands) for
638 all the rcpt commands.
639
640 If there has been no previous EHLO or HELO command this session, this
641 method tries ESMTP EHLO first. If the server does ESMTP, message size
642 and each of the specified options will be passed to it. If EHLO
643 fails, HELO will be tried and ESMTP options suppressed.
644
645 This method will return normally if the mail is accepted for at least
Barry Warsawd25c1b71999-11-28 17:11:06 +0000646 one recipient. It returns a dictionary, with one entry for each
647 recipient that was refused. Each entry contains a tuple of the SMTP
648 error code and the accompanying error message sent by the server.
Guido van Rossum296e1431999-04-07 15:03:39 +0000649
650 This method may raise the following exceptions:
651
652 SMTPHeloError The server didn't reply properly to
Tim Peters495ad3c2001-01-15 01:36:40 +0000653 the helo greeting.
Barry Warsawd25c1b71999-11-28 17:11:06 +0000654 SMTPRecipientsRefused The server rejected ALL recipients
Guido van Rossum296e1431999-04-07 15:03:39 +0000655 (no mail was sent).
656 SMTPSenderRefused The server didn't accept the from_addr.
657 SMTPDataError The server replied with an unexpected
658 error code (other than a refusal of
659 a recipient).
660
661 Note: the connection will be open even after an exception is raised.
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000662
Guido van Rossum95e6f701998-06-25 02:15:50 +0000663 Example:
Tim Peters495ad3c2001-01-15 01:36:40 +0000664
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000665 >>> import smtplib
666 >>> s=smtplib.SMTP("localhost")
Guido van Rossumfc40a831998-01-29 17:26:45 +0000667 >>> tolist=["one@one.org","two@two.org","three@three.org","four@four.org"]
Martin v. Löwis301b1cd2002-07-28 16:52:01 +0000668 >>> msg = '''\\
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000669 ... From: Me@my.org
670 ... Subject: testin'...
671 ...
672 ... This is a test '''
673 >>> s.sendmail("me@my.org",tolist,msg)
674 { "three@three.org" : ( 550 ,"User unknown" ) }
675 >>> s.quit()
Tim Peters495ad3c2001-01-15 01:36:40 +0000676
Barry Warsaw4c4bec81998-12-22 03:02:20 +0000677 In the above example, the message was accepted for delivery to three
678 of the four addresses, and one was rejected, with the error code
Barry Warsawd25c1b71999-11-28 17:11:06 +0000679 550. If all addresses are accepted, then the method will return an
Barry Warsaw4c4bec81998-12-22 03:02:20 +0000680 empty dictionary.
681
682 """
Gregory P. Smithbde4ae42008-01-17 08:35:49 +0000683 self.ehlo_or_helo_if_needed()
Guido van Rossum95e6f701998-06-25 02:15:50 +0000684 esmtp_opts = []
Guido van Rossumfcfb6321998-08-04 15:29:54 +0000685 if self.does_esmtp:
686 # Hmmm? what's this? -ddm
687 # self.esmtp_features['7bit']=""
688 if self.has_extn('size'):
Walter Dörwald70a6b492004-02-12 17:35:32 +0000689 esmtp_opts.append("size=%d" % len(msg))
Guido van Rossumfcfb6321998-08-04 15:29:54 +0000690 for option in mail_options:
Guido van Rossum95e6f701998-06-25 02:15:50 +0000691 esmtp_opts.append(option)
Guido van Rossumfcfb6321998-08-04 15:29:54 +0000692
Guido van Rossum95e6f701998-06-25 02:15:50 +0000693 (code,resp) = self.mail(from_addr, esmtp_opts)
Fred Drake8152d322000-12-12 23:20:45 +0000694 if code != 250:
Guido van Rossum45e2fbc1998-03-26 21:13:24 +0000695 self.rset()
Guido van Rossum296e1431999-04-07 15:03:39 +0000696 raise SMTPSenderRefused(code, resp, from_addr)
Guido van Rossum45e2fbc1998-03-26 21:13:24 +0000697 senderrs={}
Walter Dörwald65230a22002-06-03 15:58:32 +0000698 if isinstance(to_addrs, basestring):
Jeremy Hylton31bb8ce1998-08-13 19:57:46 +0000699 to_addrs = [to_addrs]
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000700 for each in to_addrs:
Guido van Rossumfcfb6321998-08-04 15:29:54 +0000701 (code,resp)=self.rcpt(each, rcpt_options)
Fred Drake8152d322000-12-12 23:20:45 +0000702 if (code != 250) and (code != 251):
Guido van Rossumfc40a831998-01-29 17:26:45 +0000703 senderrs[each]=(code,resp)
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000704 if len(senderrs)==len(to_addrs):
Guido van Rossum95e6f701998-06-25 02:15:50 +0000705 # the server refused all our recipients
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000706 self.rset()
Guido van Rossum296e1431999-04-07 15:03:39 +0000707 raise SMTPRecipientsRefused(senderrs)
Fred Drake8152d322000-12-12 23:20:45 +0000708 (code,resp) = self.data(msg)
709 if code != 250:
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000710 self.rset()
Guido van Rossum296e1431999-04-07 15:03:39 +0000711 raise SMTPDataError(code, resp)
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000712 #if we got here then somebody got our mail
Tim Peters495ad3c2001-01-15 01:36:40 +0000713 return senderrs
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000714
715
716 def close(self):
717 """Close the connection to the SMTP server."""
718 if self.file:
719 self.file.close()
720 self.file = None
721 if self.sock:
722 self.sock.close()
723 self.sock = None
724
725
726 def quit(self):
Guido van Rossum95e6f701998-06-25 02:15:50 +0000727 """Terminate the SMTP session."""
Guido van Rossum45e2fbc1998-03-26 21:13:24 +0000728 self.docmd("quit")
729 self.close()
Guido van Rossum95e6f701998-06-25 02:15:50 +0000730
Bill Janssen426ea0a2007-08-29 22:35:05 +0000731if _have_ssl:
Martin v. Löwisee82c0e2006-10-27 07:13:28 +0000732
Bill Janssen426ea0a2007-08-29 22:35:05 +0000733 class SMTP_SSL(SMTP):
734 """ This is a subclass derived from SMTP that connects over an SSL encrypted
735 socket (to use this class you need a socket module that was compiled with SSL
736 support). If host is not specified, '' (the local host) is used. If port is
737 omitted, the standard SMTP-over-SSL port (465) is used. keyfile and certfile
738 are also optional - they can contain a PEM formatted private key and
739 certificate chain file for the SSL connection.
740 """
741 def __init__(self, host='', port=0, local_hostname=None,
742 keyfile=None, certfile=None, timeout=None):
743 self.keyfile = keyfile
744 self.certfile = certfile
745 SMTP.__init__(self, host, port, local_hostname, timeout)
746 self.default_port = SMTP_SSL_PORT
747
748 def _get_socket(self, host, port, timeout):
749 if self.debuglevel > 0: print>>stderr, 'connect:', (host, port)
750 self.sock = socket.create_connection((host, port), timeout)
Bill Janssen98d19da2007-09-10 21:51:02 +0000751 self.sock = ssl.wrap_socket(self.sock, self.keyfile, self.certfile)
Bill Janssen470dcd22007-08-31 19:03:31 +0000752 self.file = SSLFakeFile(self.sock)
Barry Warsaw4c4bec81998-12-22 03:02:20 +0000753
Thomas Woutersa6900e82007-08-30 21:54:39 +0000754 __all__.append("SMTP_SSL")
755
Martin v. Löwis1190a382007-03-09 15:35:55 +0000756#
757# LMTP extension
758#
759LMTP_PORT = 2003
760
761class LMTP(SMTP):
762 """LMTP - Local Mail Transfer Protocol
763
764 The LMTP protocol, which is very similar to ESMTP, is heavily based
765 on the standard SMTP client. It's common to use Unix sockets for LMTP,
766 so our connect() method must support that as well as a regular
767 host:port server. To specify a Unix socket, you must use an absolute
768 path as the host, starting with a '/'.
769
770 Authentication is supported, using the regular SMTP mechanism. When
771 using a Unix socket, LMTP generally don't support or require any
772 authentication, but your mileage might vary."""
773
774 ehlo_msg = "lhlo"
Tim Petersea5962f2007-03-12 18:07:52 +0000775
Martin v. Löwis1190a382007-03-09 15:35:55 +0000776 def __init__(self, host = '', port = LMTP_PORT, local_hostname = None):
777 """Initialize a new instance."""
778 SMTP.__init__(self, host, port, local_hostname)
779
Neal Norwitzc8f6c232007-03-10 03:19:18 +0000780 def connect(self, host = 'localhost', port = 0):
Martin v. Löwis1190a382007-03-09 15:35:55 +0000781 """Connect to the LMTP daemon, on either a Unix or a TCP socket."""
Neal Norwitzc8f6c232007-03-10 03:19:18 +0000782 if host[0] != '/':
Martin v. Löwis1190a382007-03-09 15:35:55 +0000783 return SMTP.connect(self, host, port)
784
Neal Norwitzc8f6c232007-03-10 03:19:18 +0000785 # Handle Unix-domain sockets.
786 try:
787 self.sock = socket.socket(socket.AF_UNIX, socket.SOCK_STREAM)
788 self.sock.connect(host)
789 except socket.error, msg:
790 if self.debuglevel > 0: print>>stderr, 'connect fail:', host
791 if self.sock:
792 self.sock.close()
793 self.sock = None
794 raise socket.error, msg
795 (code, msg) = self.getreply()
796 if self.debuglevel > 0: print>>stderr, "connect:", msg
797 return (code, msg)
798
Martin v. Löwis1190a382007-03-09 15:35:55 +0000799
Guido van Rossum95e6f701998-06-25 02:15:50 +0000800# Test the sendmail method, which tests most of the others.
801# Note: This always sends to localhost.
802if __name__ == '__main__':
Andrew M. Kuchling6be424f2001-08-13 14:41:39 +0000803 import sys
Guido van Rossum95e6f701998-06-25 02:15:50 +0000804
805 def prompt(prompt):
806 sys.stdout.write(prompt + ": ")
Eric S. Raymondc013f302001-02-09 05:40:38 +0000807 return sys.stdin.readline().strip()
Guido van Rossum95e6f701998-06-25 02:15:50 +0000808
809 fromaddr = prompt("From")
Eric S. Raymond38151ed2001-02-09 07:40:17 +0000810 toaddrs = prompt("To").split(',')
Guido van Rossum95e6f701998-06-25 02:15:50 +0000811 print "Enter message, end with ^D:"
812 msg = ''
813 while 1:
814 line = sys.stdin.readline()
815 if not line:
816 break
817 msg = msg + line
Walter Dörwald70a6b492004-02-12 17:35:32 +0000818 print "Message length is %d" % len(msg)
Guido van Rossum95e6f701998-06-25 02:15:50 +0000819
820 server = SMTP('localhost')
821 server.set_debuglevel(1)
822 server.sendmail(fromaddr, toaddrs, msg)
823 server.quit()