blob: 67904a2f7a0499fba4208ad5435fec45b8e36d17 [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")
Guido van Rossum7131f842007-02-09 20:13:25 +000018 >>> print(s.help())
Barry Warsawa7d9bdf1998-12-22 03:24:27 +000019 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
Thomas Woutersb2137042007-02-01 18:02:27 +000046import email.utils
Guido van Rossumae010462001-09-11 15:57:46 +000047import base64
48import hmac
Thomas Woutersb2137042007-02-01 18:02:27 +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 Wouters89f507f2006-12-13 04:49:30 +000055 "quoteaddr","quotedata","SMTP","SMTP_SSL"]
Skip Montanaro0de65802001-02-15 22:15:14 +000056
Guido van Rossumbbe323e1998-01-29 17:24:40 +000057SMTP_PORT = 25
Thomas Wouters89f507f2006-12-13 04:49:30 +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 Rossumf7fcf5e2001-09-14 16:08:44 +0000131class SSLFakeSocket:
132 """A fake socket object that really wraps a SSLObject.
Tim Petersb64bec32001-09-18 02:26:39 +0000133
Guido van Rossumf7fcf5e2001-09-14 16:08:44 +0000134 It only supports what is needed in smtplib.
135 """
136 def __init__(self, realsock, sslobj):
137 self.realsock = realsock
138 self.sslobj = sslobj
139
140 def send(self, str):
141 self.sslobj.write(str)
142 return len(str)
143
Martin v. Löwis9ea6c192002-06-02 12:33:22 +0000144 sendall = send
145
Guido van Rossumf7fcf5e2001-09-14 16:08:44 +0000146 def close(self):
147 self.realsock.close()
148
149class SSLFakeFile:
150 """A fake file like object that really wraps a SSLObject.
Tim Petersb64bec32001-09-18 02:26:39 +0000151
Guido van Rossumf7fcf5e2001-09-14 16:08:44 +0000152 It only supports what is needed in smtplib.
153 """
Thomas Wouters73e5a5b2006-06-08 15:35:45 +0000154 def __init__(self, sslobj):
Guido van Rossumf7fcf5e2001-09-14 16:08:44 +0000155 self.sslobj = sslobj
156
157 def readline(self):
158 str = ""
159 chr = None
160 while chr != "\n":
161 chr = self.sslobj.read(1)
162 str += chr
163 return str
164
165 def close(self):
166 pass
167
Guido van Rossum69a79bc1998-07-13 15:18:49 +0000168def quoteaddr(addr):
169 """Quote a subset of the email addresses defined by RFC 821.
170
Barry Warsawa7d9bdf1998-12-22 03:24:27 +0000171 Should be able to handle anything rfc822.parseaddr can handle.
172 """
Raymond Hettinger342456d2002-09-05 01:14:07 +0000173 m = (None, None)
Guido van Rossum69a79bc1998-07-13 15:18:49 +0000174 try:
Thomas Woutersb2137042007-02-01 18:02:27 +0000175 m = email.utils.parseaddr(addr)[1]
Guido van Rossumfcfb6321998-08-04 15:29:54 +0000176 except AttributeError:
177 pass
Raymond Hettinger342456d2002-09-05 01:14:07 +0000178 if m == (None, None): # Indicates parse failure or AttributeError
Georg Brandlbd3bc4d2006-02-17 09:52:53 +0000179 # something weird here.. punt -ddm
Raymond Hettinger342456d2002-09-05 01:14:07 +0000180 return "<%s>" % addr
Georg Brandlbd3bc4d2006-02-17 09:52:53 +0000181 elif m is None:
182 # the sender wants an empty return address
183 return "<>"
Guido van Rossumfcfb6321998-08-04 15:29:54 +0000184 else:
185 return "<%s>" % m
Guido van Rossum69a79bc1998-07-13 15:18:49 +0000186
187def quotedata(data):
188 """Quote data for email.
189
Barry Warsawd25c1b71999-11-28 17:11:06 +0000190 Double leading '.', and change Unix newline '\\n', or Mac '\\r' into
Barry Warsawa7d9bdf1998-12-22 03:24:27 +0000191 Internet CRLF end-of-line.
192 """
Guido van Rossum69a79bc1998-07-13 15:18:49 +0000193 return re.sub(r'(?m)^\.', '..',
Guido van Rossumfcfb6321998-08-04 15:29:54 +0000194 re.sub(r'(?:\r\n|\n|\r(?!\n))', CRLF, data))
Guido van Rossum69a79bc1998-07-13 15:18:49 +0000195
Peter Schneider-Kamp7bc82bb2000-08-10 14:02:23 +0000196
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000197class SMTP:
Guido van Rossumfcfb6321998-08-04 15:29:54 +0000198 """This class manages a connection to an SMTP or ESMTP server.
199 SMTP Objects:
Tim Peters495ad3c2001-01-15 01:36:40 +0000200 SMTP objects have the following attributes:
201 helo_resp
202 This is the message given by the server in response to the
Guido van Rossumfcfb6321998-08-04 15:29:54 +0000203 most recent HELO command.
Tim Peters495ad3c2001-01-15 01:36:40 +0000204
Guido van Rossumfcfb6321998-08-04 15:29:54 +0000205 ehlo_resp
Tim Peters495ad3c2001-01-15 01:36:40 +0000206 This is the message given by the server in response to the
Guido van Rossumfcfb6321998-08-04 15:29:54 +0000207 most recent EHLO command. This is usually multiline.
208
Tim Peters495ad3c2001-01-15 01:36:40 +0000209 does_esmtp
Guido van Rossumfcfb6321998-08-04 15:29:54 +0000210 This is a True value _after you do an EHLO command_, if the
211 server supports ESMTP.
212
Tim Peters495ad3c2001-01-15 01:36:40 +0000213 esmtp_features
Guido van Rossumfcfb6321998-08-04 15:29:54 +0000214 This is a dictionary, which, if the server supports ESMTP,
Barry Warsawd25c1b71999-11-28 17:11:06 +0000215 will _after you do an EHLO command_, contain the names of the
216 SMTP service extensions this server supports, and their
Guido van Rossumfcfb6321998-08-04 15:29:54 +0000217 parameters (if any).
Barry Warsawd25c1b71999-11-28 17:11:06 +0000218
Tim Peters495ad3c2001-01-15 01:36:40 +0000219 Note, all extension names are mapped to lower case in the
220 dictionary.
Guido van Rossumfcfb6321998-08-04 15:29:54 +0000221
Barry Warsawd25c1b71999-11-28 17:11:06 +0000222 See each method's docstrings for details. In general, there is a
223 method of the same name to perform each SMTP command. There is also a
224 method called 'sendmail' that will do an entire mail transaction.
225 """
Guido van Rossum95e6f701998-06-25 02:15:50 +0000226 debuglevel = 0
227 file = None
228 helo_resp = None
Guido van Rossumd8faa362007-04-27 19:54:29 +0000229 ehlo_msg = "ehlo"
Guido van Rossum95e6f701998-06-25 02:15:50 +0000230 ehlo_resp = None
Guido van Rossumfcfb6321998-08-04 15:29:54 +0000231 does_esmtp = 0
Guido van Rossum95e6f701998-06-25 02:15:50 +0000232
Guido van Rossumd8faa362007-04-27 19:54:29 +0000233 def __init__(self, host='', port=0, local_hostname=None, timeout=None):
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000234 """Initialize a new instance.
235
Barry Warsawa7d9bdf1998-12-22 03:24:27 +0000236 If specified, `host' is the name of the remote host to which to
237 connect. If specified, `port' specifies the port to which to connect.
Barry Warsawd25c1b71999-11-28 17:11:06 +0000238 By default, smtplib.SMTP_PORT is used. An SMTPConnectError is raised
Neil Schemenauer6730f262002-03-24 15:30:40 +0000239 if the specified `host' doesn't respond correctly. If specified,
Tim Peters863ac442002-04-16 01:38:40 +0000240 `local_hostname` is used as the FQDN of the local host. By default,
241 the local hostname is found using socket.getfqdn().
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000242
243 """
Guido van Rossumd8faa362007-04-27 19:54:29 +0000244 self.timeout = timeout
Guido van Rossumfcfb6321998-08-04 15:29:54 +0000245 self.esmtp_features = {}
Thomas Wouters89f507f2006-12-13 04:49:30 +0000246 self.default_port = SMTP_PORT
Guido van Rossum296e1431999-04-07 15:03:39 +0000247 if host:
248 (code, msg) = self.connect(host, port)
249 if code != 220:
250 raise SMTPConnectError(code, msg)
Raymond Hettingerf13eb552002-06-02 00:40:05 +0000251 if local_hostname is not None:
Barry Warsaw13e34f72002-03-26 20:27:35 +0000252 self.local_hostname = local_hostname
Neil Schemenauer6730f262002-03-24 15:30:40 +0000253 else:
Barry Warsaw13e34f72002-03-26 20:27:35 +0000254 # RFC 2821 says we should use the fqdn in the EHLO/HELO verb, and
255 # if that can't be calculated, that we should use a domain literal
256 # instead (essentially an encoded IP address like [A.B.C.D]).
257 fqdn = socket.getfqdn()
258 if '.' in fqdn:
259 self.local_hostname = fqdn
260 else:
261 # We can't find an fqdn hostname, so use a domain literal
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000262 addr = '127.0.0.1'
263 try:
264 addr = socket.gethostbyname(socket.gethostname())
265 except socket.gaierror:
266 pass
Barry Warsaw13e34f72002-03-26 20:27:35 +0000267 self.local_hostname = '[%s]' % addr
Tim Peters495ad3c2001-01-15 01:36:40 +0000268
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000269 def set_debuglevel(self, debuglevel):
270 """Set the debug output level.
271
Barry Warsawa7d9bdf1998-12-22 03:24:27 +0000272 A non-false value results in debug messages for connection and for all
273 messages sent to and received from the server.
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000274
275 """
276 self.debuglevel = debuglevel
277
Guido van Rossumd8faa362007-04-27 19:54:29 +0000278 def _get_socket(self, port, host, timeout):
Thomas Wouters89f507f2006-12-13 04:49:30 +0000279 # This makes it simpler for SMTP_SSL to use the SMTP connect code
280 # and just alter the socket connection bit.
Guido van Rossumbe19ed72007-02-09 05:37:30 +0000281 if self.debuglevel > 0: print('connect:', (host, port), file=stderr)
Guido van Rossumd8faa362007-04-27 19:54:29 +0000282 return socket.create_connection((port, host), timeout)
Thomas Wouters89f507f2006-12-13 04:49:30 +0000283
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000284 def connect(self, host='localhost', port = 0):
285 """Connect to a host on a given port.
Guido van Rossum95e6f701998-06-25 02:15:50 +0000286
Barry Warsaw4c4bec81998-12-22 03:02:20 +0000287 If the hostname ends with a colon (`:') followed by a number, and
288 there is no port specified, that suffix will be stripped off and the
289 number interpreted as the port number to use.
Guido van Rossum95e6f701998-06-25 02:15:50 +0000290
Barry Warsawa7d9bdf1998-12-22 03:24:27 +0000291 Note: This method is automatically invoked by __init__, if a host is
292 specified during instantiation.
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000293
294 """
Martin v. Löwis4eb59402001-07-26 13:37:33 +0000295 if not port and (host.find(':') == host.rfind(':')):
Martin v. Löwisa43c2f82001-07-24 20:34:08 +0000296 i = host.rfind(':')
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000297 if i >= 0:
298 host, port = host[:i], host[i+1:]
Eric S. Raymondc013f302001-02-09 05:40:38 +0000299 try: port = int(port)
Eric S. Raymond8d876032001-02-09 10:14:53 +0000300 except ValueError:
Guido van Rossumd8faa362007-04-27 19:54:29 +0000301 raise socket.error("nonnumeric port")
Thomas Wouters89f507f2006-12-13 04:49:30 +0000302 if not port: port = self.default_port
Guido van Rossumbe19ed72007-02-09 05:37:30 +0000303 if self.debuglevel > 0: print('connect:', (host, port), file=stderr)
Guido van Rossumd8faa362007-04-27 19:54:29 +0000304 self.sock = self._get_socket(host, port, self.timeout)
Martin v. Löwisa43c2f82001-07-24 20:34:08 +0000305 (code, msg) = self.getreply()
Guido van Rossumbe19ed72007-02-09 05:37:30 +0000306 if self.debuglevel > 0: print("connect:", msg, file=stderr)
Martin v. Löwisa43c2f82001-07-24 20:34:08 +0000307 return (code, msg)
Tim Peters495ad3c2001-01-15 01:36:40 +0000308
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000309 def send(self, str):
310 """Send `str' to the server."""
Guido van Rossumbe19ed72007-02-09 05:37:30 +0000311 if self.debuglevel > 0: print('send:', repr(str), file=stderr)
Guido van Rossum45e2fbc1998-03-26 21:13:24 +0000312 if self.sock:
Guido van Rossum2880f6e1998-08-10 20:07:00 +0000313 try:
Martin v. Löwise12454f2002-02-16 23:06:19 +0000314 self.sock.sendall(str)
Guido van Rossum2880f6e1998-08-10 20:07:00 +0000315 except socket.error:
Barry Warsaw76750972001-12-14 20:34:20 +0000316 self.close()
Guido van Rossum40233ea1999-01-15 03:23:55 +0000317 raise SMTPServerDisconnected('Server not connected')
Guido van Rossumfc40a831998-01-29 17:26:45 +0000318 else:
Guido van Rossum40233ea1999-01-15 03:23:55 +0000319 raise SMTPServerDisconnected('please run connect() first')
Tim Peters495ad3c2001-01-15 01:36:40 +0000320
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000321 def putcmd(self, cmd, args=""):
Barry Warsawa7d9bdf1998-12-22 03:24:27 +0000322 """Send a command to the server."""
Guido van Rossumdb23d3d1999-06-09 15:13:10 +0000323 if args == "":
324 str = '%s%s' % (cmd, CRLF)
325 else:
326 str = '%s %s%s' % (cmd, args, CRLF)
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000327 self.send(str)
Tim Peters495ad3c2001-01-15 01:36:40 +0000328
Guido van Rossumfcfb6321998-08-04 15:29:54 +0000329 def getreply(self):
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000330 """Get a reply from the server.
Tim Peters495ad3c2001-01-15 01:36:40 +0000331
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000332 Returns a tuple consisting of:
Barry Warsawa7d9bdf1998-12-22 03:24:27 +0000333
334 - server response code (e.g. '250', or such, if all goes well)
335 Note: returns -1 if it can't read response code.
336
337 - server response string corresponding to response code (multiline
338 responses are converted to a single, multiline string).
Guido van Rossumf123f841999-03-29 20:33:21 +0000339
340 Raises SMTPServerDisconnected if end-of-file is reached.
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000341 """
342 resp=[]
Guido van Rossum296e1431999-04-07 15:03:39 +0000343 if self.file is None:
344 self.file = self.sock.makefile('rb')
Guido van Rossum45e2fbc1998-03-26 21:13:24 +0000345 while 1:
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000346 line = self.file.readline()
Guido van Rossum296e1431999-04-07 15:03:39 +0000347 if line == '':
348 self.close()
349 raise SMTPServerDisconnected("Connection unexpectedly closed")
Guido van Rossumbe19ed72007-02-09 05:37:30 +0000350 if self.debuglevel > 0: print('reply:', repr(line), file=stderr)
Guido van Rossumc43e79f2007-06-18 18:26:36 +0000351 resp.append(line[4:].strip(b' \t\n'))
Guido van Rossum45e2fbc1998-03-26 21:13:24 +0000352 code=line[:3]
Guido van Rossum296e1431999-04-07 15:03:39 +0000353 # Check that the error code is syntactically correct.
354 # Don't attempt to read a continuation line if it is broken.
355 try:
Eric S. Raymondc013f302001-02-09 05:40:38 +0000356 errcode = int(code)
Guido van Rossum296e1431999-04-07 15:03:39 +0000357 except ValueError:
358 errcode = -1
359 break
Guido van Rossumf123f841999-03-29 20:33:21 +0000360 # Check if multiline response.
Guido van Rossum45e2fbc1998-03-26 21:13:24 +0000361 if line[3:4]!="-":
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000362 break
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000363
Guido van Rossumc43e79f2007-06-18 18:26:36 +0000364 errmsg = b"\n".join(resp)
Tim Peters495ad3c2001-01-15 01:36:40 +0000365 if self.debuglevel > 0:
Guido van Rossumbe19ed72007-02-09 05:37:30 +0000366 print('reply: retcode (%s); Msg: %s' % (errcode,errmsg), file=stderr)
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000367 return errcode, errmsg
Tim Peters495ad3c2001-01-15 01:36:40 +0000368
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000369 def docmd(self, cmd, args=""):
Barry Warsawa7d9bdf1998-12-22 03:24:27 +0000370 """Send a command, and return its response code."""
Guido van Rossum45e2fbc1998-03-26 21:13:24 +0000371 self.putcmd(cmd,args)
Guido van Rossum296e1431999-04-07 15:03:39 +0000372 return self.getreply()
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000373
Barry Warsawa7d9bdf1998-12-22 03:24:27 +0000374 # std smtp commands
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000375 def helo(self, name=''):
Barry Warsawa7d9bdf1998-12-22 03:24:27 +0000376 """SMTP 'helo' command.
377 Hostname to send for this command defaults to the FQDN of the local
378 host.
379 """
Neil Schemenauer6730f262002-03-24 15:30:40 +0000380 self.putcmd("helo", name or self.local_hostname)
Guido van Rossum45e2fbc1998-03-26 21:13:24 +0000381 (code,msg)=self.getreply()
382 self.helo_resp=msg
Guido van Rossum296e1431999-04-07 15:03:39 +0000383 return (code,msg)
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000384
Guido van Rossum95e6f701998-06-25 02:15:50 +0000385 def ehlo(self, name=''):
Barry Warsawa7d9bdf1998-12-22 03:24:27 +0000386 """ SMTP 'ehlo' command.
387 Hostname to send for this command defaults to the FQDN of the local
388 host.
389 """
Guido van Rossumf7fcf5e2001-09-14 16:08:44 +0000390 self.esmtp_features = {}
Guido van Rossumd8faa362007-04-27 19:54:29 +0000391 self.putcmd(self.ehlo_msg, name or self.local_hostname)
Guido van Rossumfcfb6321998-08-04 15:29:54 +0000392 (code,msg)=self.getreply()
Tim Peters495ad3c2001-01-15 01:36:40 +0000393 # According to RFC1869 some (badly written)
394 # MTA's will disconnect on an ehlo. Toss an exception if
Guido van Rossumfcfb6321998-08-04 15:29:54 +0000395 # that happens -ddm
396 if code == -1 and len(msg) == 0:
Barry Warsaw76750972001-12-14 20:34:20 +0000397 self.close()
Guido van Rossum40233ea1999-01-15 03:23:55 +0000398 raise SMTPServerDisconnected("Server not connected")
Guido van Rossum95e6f701998-06-25 02:15:50 +0000399 self.ehlo_resp=msg
Fred Drake8152d322000-12-12 23:20:45 +0000400 if code != 250:
Guido van Rossum296e1431999-04-07 15:03:39 +0000401 return (code,msg)
Guido van Rossumfcfb6321998-08-04 15:29:54 +0000402 self.does_esmtp=1
Thomas Wouters7e474022000-07-16 12:04:32 +0000403 #parse the ehlo response -ddm
Eric S. Raymondc013f302001-02-09 05:40:38 +0000404 resp=self.ehlo_resp.split('\n')
Guido van Rossumfcfb6321998-08-04 15:29:54 +0000405 del resp[0]
Guido van Rossum2880f6e1998-08-10 20:07:00 +0000406 for each in resp:
Piers Lauder385a77a2002-07-27 00:38:30 +0000407 # To be able to communicate with as many SMTP servers as possible,
408 # we have to take the old-style auth advertisement into account,
409 # because:
410 # 1) Else our SMTP feature parser gets confused.
411 # 2) There are some servers that only advertise the auth methods we
412 # support using the old style.
413 auth_match = OLDSTYLE_AUTH.match(each)
414 if auth_match:
415 # This doesn't remove duplicates, but that's no problem
416 self.esmtp_features["auth"] = self.esmtp_features.get("auth", "") \
417 + " " + auth_match.groups(0)[0]
418 continue
419
Barry Warsawbe22ae62002-04-15 20:03:30 +0000420 # RFC 1869 requires a space between ehlo keyword and parameters.
421 # It's actually stricter, in that only spaces are allowed between
422 # parameters, but were not going to check for that here. Note
423 # that the space isn't present if there are no parameters.
424 m=re.match(r'(?P<feature>[A-Za-z0-9][A-Za-z0-9\-]*) ?',each)
Guido van Rossumfcfb6321998-08-04 15:29:54 +0000425 if m:
Eric S. Raymondc013f302001-02-09 05:40:38 +0000426 feature=m.group("feature").lower()
427 params=m.string[m.end("feature"):].strip()
Piers Lauder385a77a2002-07-27 00:38:30 +0000428 if feature == "auth":
429 self.esmtp_features[feature] = self.esmtp_features.get(feature, "") \
430 + " " + params
431 else:
432 self.esmtp_features[feature]=params
Guido van Rossum296e1431999-04-07 15:03:39 +0000433 return (code,msg)
Guido van Rossum95e6f701998-06-25 02:15:50 +0000434
Guido van Rossumfcfb6321998-08-04 15:29:54 +0000435 def has_extn(self, opt):
436 """Does the server support a given SMTP service extension?"""
Raymond Hettinger54f02222002-06-01 14:18:47 +0000437 return opt.lower() in self.esmtp_features
Guido van Rossum95e6f701998-06-25 02:15:50 +0000438
Guido van Rossum18586f41998-04-03 17:03:13 +0000439 def help(self, args=''):
Barry Warsawa7d9bdf1998-12-22 03:24:27 +0000440 """SMTP 'help' command.
441 Returns help text from server."""
Guido van Rossum18586f41998-04-03 17:03:13 +0000442 self.putcmd("help", args)
Kurt B. Kaiser58bd1902005-06-26 18:27:36 +0000443 return self.getreply()[1]
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000444
445 def rset(self):
Barry Warsawa7d9bdf1998-12-22 03:24:27 +0000446 """SMTP 'rset' command -- resets session."""
Guido van Rossum296e1431999-04-07 15:03:39 +0000447 return self.docmd("rset")
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000448
449 def noop(self):
Barry Warsawa7d9bdf1998-12-22 03:24:27 +0000450 """SMTP 'noop' command -- doesn't do anything :>"""
Guido van Rossum296e1431999-04-07 15:03:39 +0000451 return self.docmd("noop")
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000452
Guido van Rossum95e6f701998-06-25 02:15:50 +0000453 def mail(self,sender,options=[]):
Barry Warsawa7d9bdf1998-12-22 03:24:27 +0000454 """SMTP 'mail' command -- begins mail xfer session."""
Guido van Rossumfcfb6321998-08-04 15:29:54 +0000455 optionlist = ''
456 if options and self.does_esmtp:
Eric S. Raymondc013f302001-02-09 05:40:38 +0000457 optionlist = ' ' + ' '.join(options)
Guido van Rossumdb23d3d1999-06-09 15:13:10 +0000458 self.putcmd("mail", "FROM:%s%s" % (quoteaddr(sender) ,optionlist))
Guido van Rossum45e2fbc1998-03-26 21:13:24 +0000459 return self.getreply()
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000460
Guido van Rossumfcfb6321998-08-04 15:29:54 +0000461 def rcpt(self,recip,options=[]):
Barry Warsawa7d9bdf1998-12-22 03:24:27 +0000462 """SMTP 'rcpt' command -- indicates 1 recipient for this mail."""
Guido van Rossumfcfb6321998-08-04 15:29:54 +0000463 optionlist = ''
464 if options and self.does_esmtp:
Eric S. Raymondc013f302001-02-09 05:40:38 +0000465 optionlist = ' ' + ' '.join(options)
Guido van Rossum348fd061999-01-14 04:18:46 +0000466 self.putcmd("rcpt","TO:%s%s" % (quoteaddr(recip),optionlist))
Guido van Rossum45e2fbc1998-03-26 21:13:24 +0000467 return self.getreply()
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000468
469 def data(self,msg):
Tim Peters495ad3c2001-01-15 01:36:40 +0000470 """SMTP 'DATA' command -- sends message data to server.
Guido van Rossum296e1431999-04-07 15:03:39 +0000471
Barry Warsaw4c4bec81998-12-22 03:02:20 +0000472 Automatically quotes lines beginning with a period per rfc821.
Guido van Rossum296e1431999-04-07 15:03:39 +0000473 Raises SMTPDataError if there is an unexpected reply to the
474 DATA command; the return value from this method is the final
475 response code received when the all data is sent.
Barry Warsaw4c4bec81998-12-22 03:02:20 +0000476 """
Guido van Rossum45e2fbc1998-03-26 21:13:24 +0000477 self.putcmd("data")
478 (code,repl)=self.getreply()
Guido van Rossumbe19ed72007-02-09 05:37:30 +0000479 if self.debuglevel >0 : print("data:", (code,repl), file=stderr)
Fred Drake8152d322000-12-12 23:20:45 +0000480 if code != 354:
Guido van Rossum296e1431999-04-07 15:03:39 +0000481 raise SMTPDataError(code,repl)
Guido van Rossum45e2fbc1998-03-26 21:13:24 +0000482 else:
Guido van Rossum20c92281999-04-21 16:52:20 +0000483 q = quotedata(msg)
484 if q[-2:] != CRLF:
485 q = q + CRLF
486 q = q + "." + CRLF
487 self.send(q)
Guido van Rossum45e2fbc1998-03-26 21:13:24 +0000488 (code,msg)=self.getreply()
Guido van Rossumbe19ed72007-02-09 05:37:30 +0000489 if self.debuglevel >0 : print("data:", (code,msg), file=stderr)
Guido van Rossum296e1431999-04-07 15:03:39 +0000490 return (code,msg)
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000491
Guido van Rossumfcfb6321998-08-04 15:29:54 +0000492 def verify(self, address):
Barry Warsawa7d9bdf1998-12-22 03:24:27 +0000493 """SMTP 'verify' command -- checks for address validity."""
Guido van Rossumfcfb6321998-08-04 15:29:54 +0000494 self.putcmd("vrfy", quoteaddr(address))
495 return self.getreply()
Barry Warsaw4c4bec81998-12-22 03:02:20 +0000496 # a.k.a.
497 vrfy=verify
Guido van Rossumfcfb6321998-08-04 15:29:54 +0000498
499 def expn(self, address):
Barry Warsawa7d9bdf1998-12-22 03:24:27 +0000500 """SMTP 'verify' command -- checks for address validity."""
Guido van Rossumfcfb6321998-08-04 15:29:54 +0000501 self.putcmd("expn", quoteaddr(address))
502 return self.getreply()
503
Barry Warsaw4c4bec81998-12-22 03:02:20 +0000504 # some useful methods
Guido van Rossumae010462001-09-11 15:57:46 +0000505
506 def login(self, user, password):
507 """Log in on an SMTP server that requires authentication.
508
509 The arguments are:
510 - user: The user name to authenticate with.
511 - password: The password for the authentication.
512
513 If there has been no previous EHLO or HELO command this session, this
514 method tries ESMTP EHLO first.
515
516 This method will return normally if the authentication was successful.
517
518 This method may raise the following exceptions:
519
520 SMTPHeloError The server didn't reply properly to
521 the helo greeting.
522 SMTPAuthenticationError The server didn't accept the username/
523 password combination.
Fred Drake2f8f4d32001-10-13 18:35:32 +0000524 SMTPException No suitable authentication method was
Guido van Rossumae010462001-09-11 15:57:46 +0000525 found.
526 """
527
528 def encode_cram_md5(challenge, user, password):
529 challenge = base64.decodestring(challenge)
530 response = user + " " + hmac.HMAC(password, challenge).hexdigest()
Piers Lauder385a77a2002-07-27 00:38:30 +0000531 return encode_base64(response, eol="")
Guido van Rossumae010462001-09-11 15:57:46 +0000532
533 def encode_plain(user, password):
Johannes Gijsbers25946dd2004-12-06 21:25:26 +0000534 return encode_base64("\0%s\0%s" % (user, password), eol="")
Tim Peters469cdad2002-08-08 20:19:19 +0000535
Guido van Rossumae010462001-09-11 15:57:46 +0000536
537 AUTH_PLAIN = "PLAIN"
538 AUTH_CRAM_MD5 = "CRAM-MD5"
Piers Lauder385a77a2002-07-27 00:38:30 +0000539 AUTH_LOGIN = "LOGIN"
Guido van Rossumae010462001-09-11 15:57:46 +0000540
541 if self.helo_resp is None and self.ehlo_resp is None:
542 if not (200 <= self.ehlo()[0] <= 299):
543 (code, resp) = self.helo()
544 if not (200 <= code <= 299):
545 raise SMTPHeloError(code, resp)
546
547 if not self.has_extn("auth"):
548 raise SMTPException("SMTP AUTH extension not supported by server.")
549
550 # Authentication methods the server supports:
551 authlist = self.esmtp_features["auth"].split()
552
553 # List of authentication methods we support: from preferred to
554 # less preferred methods. Except for the purpose of testing the weaker
555 # ones, we prefer stronger methods like CRAM-MD5:
Piers Lauder385a77a2002-07-27 00:38:30 +0000556 preferred_auths = [AUTH_CRAM_MD5, AUTH_PLAIN, AUTH_LOGIN]
Guido van Rossumae010462001-09-11 15:57:46 +0000557
558 # Determine the authentication method we'll use
559 authmethod = None
560 for method in preferred_auths:
561 if method in authlist:
562 authmethod = method
563 break
Tim Petersb64bec32001-09-18 02:26:39 +0000564
Guido van Rossumae010462001-09-11 15:57:46 +0000565 if authmethod == AUTH_CRAM_MD5:
566 (code, resp) = self.docmd("AUTH", AUTH_CRAM_MD5)
567 if code == 503:
568 # 503 == 'Error: already authenticated'
569 return (code, resp)
570 (code, resp) = self.docmd(encode_cram_md5(resp, user, password))
571 elif authmethod == AUTH_PLAIN:
Tim Petersb64bec32001-09-18 02:26:39 +0000572 (code, resp) = self.docmd("AUTH",
Guido van Rossumae010462001-09-11 15:57:46 +0000573 AUTH_PLAIN + " " + encode_plain(user, password))
Piers Lauder385a77a2002-07-27 00:38:30 +0000574 elif authmethod == AUTH_LOGIN:
575 (code, resp) = self.docmd("AUTH",
576 "%s %s" % (AUTH_LOGIN, encode_base64(user, eol="")))
577 if code != 334:
578 raise SMTPAuthenticationError(code, resp)
Martin v. Löwis49c05d32002-10-06 17:55:08 +0000579 (code, resp) = self.docmd(encode_base64(password, eol=""))
Raymond Hettinger7fdfc2d2002-05-31 17:49:10 +0000580 elif authmethod is None:
Fred Drake2f8f4d32001-10-13 18:35:32 +0000581 raise SMTPException("No suitable authentication method found.")
Raymond Hettingerdbecd932005-02-06 06:57:08 +0000582 if code not in (235, 503):
Guido van Rossumae010462001-09-11 15:57:46 +0000583 # 235 == 'Authentication successful'
584 # 503 == 'Error: already authenticated'
585 raise SMTPAuthenticationError(code, resp)
586 return (code, resp)
587
Guido van Rossumf7fcf5e2001-09-14 16:08:44 +0000588 def starttls(self, keyfile = None, certfile = None):
589 """Puts the connection to the SMTP server into TLS mode.
Tim Petersb64bec32001-09-18 02:26:39 +0000590
Guido van Rossumf7fcf5e2001-09-14 16:08:44 +0000591 If the server supports TLS, this will encrypt the rest of the SMTP
592 session. If you provide the keyfile and certfile parameters,
593 the identity of the SMTP server and client can be checked. This,
594 however, depends on whether the socket module really checks the
595 certificates.
596 """
Tim Petersb64bec32001-09-18 02:26:39 +0000597 (resp, reply) = self.docmd("STARTTLS")
Guido van Rossumf7fcf5e2001-09-14 16:08:44 +0000598 if resp == 220:
599 sslobj = socket.ssl(self.sock, keyfile, certfile)
600 self.sock = SSLFakeSocket(self.sock, sslobj)
601 self.file = SSLFakeFile(sslobj)
602 return (resp, reply)
Tim Petersb64bec32001-09-18 02:26:39 +0000603
Jeremy Hylton31bb8ce1998-08-13 19:57:46 +0000604 def sendmail(self, from_addr, to_addrs, msg, mail_options=[],
Tim Peters495ad3c2001-01-15 01:36:40 +0000605 rcpt_options=[]):
606 """This command performs an entire mail transaction.
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000607
Tim Peters495ad3c2001-01-15 01:36:40 +0000608 The arguments are:
Barry Warsaw4c4bec81998-12-22 03:02:20 +0000609 - from_addr : The address sending this mail.
610 - to_addrs : A list of addresses to send this mail to. A bare
611 string will be treated as a list with 1 address.
Tim Peters495ad3c2001-01-15 01:36:40 +0000612 - msg : The message to send.
Barry Warsaw4c4bec81998-12-22 03:02:20 +0000613 - mail_options : List of ESMTP options (such as 8bitmime) for the
614 mail command.
615 - rcpt_options : List of ESMTP options (such as DSN commands) for
616 all the rcpt commands.
617
618 If there has been no previous EHLO or HELO command this session, this
619 method tries ESMTP EHLO first. If the server does ESMTP, message size
620 and each of the specified options will be passed to it. If EHLO
621 fails, HELO will be tried and ESMTP options suppressed.
622
623 This method will return normally if the mail is accepted for at least
Barry Warsawd25c1b71999-11-28 17:11:06 +0000624 one recipient. It returns a dictionary, with one entry for each
625 recipient that was refused. Each entry contains a tuple of the SMTP
626 error code and the accompanying error message sent by the server.
Guido van Rossum296e1431999-04-07 15:03:39 +0000627
628 This method may raise the following exceptions:
629
630 SMTPHeloError The server didn't reply properly to
Tim Peters495ad3c2001-01-15 01:36:40 +0000631 the helo greeting.
Barry Warsawd25c1b71999-11-28 17:11:06 +0000632 SMTPRecipientsRefused The server rejected ALL recipients
Guido van Rossum296e1431999-04-07 15:03:39 +0000633 (no mail was sent).
634 SMTPSenderRefused The server didn't accept the from_addr.
635 SMTPDataError The server replied with an unexpected
636 error code (other than a refusal of
637 a recipient).
638
639 Note: the connection will be open even after an exception is raised.
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000640
Guido van Rossum95e6f701998-06-25 02:15:50 +0000641 Example:
Tim Peters495ad3c2001-01-15 01:36:40 +0000642
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000643 >>> import smtplib
644 >>> s=smtplib.SMTP("localhost")
Guido van Rossumfc40a831998-01-29 17:26:45 +0000645 >>> tolist=["one@one.org","two@two.org","three@three.org","four@four.org"]
Martin v. Löwis301b1cd2002-07-28 16:52:01 +0000646 >>> msg = '''\\
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000647 ... From: Me@my.org
648 ... Subject: testin'...
649 ...
650 ... This is a test '''
651 >>> s.sendmail("me@my.org",tolist,msg)
652 { "three@three.org" : ( 550 ,"User unknown" ) }
653 >>> s.quit()
Tim Peters495ad3c2001-01-15 01:36:40 +0000654
Barry Warsaw4c4bec81998-12-22 03:02:20 +0000655 In the above example, the message was accepted for delivery to three
656 of the four addresses, and one was rejected, with the error code
Barry Warsawd25c1b71999-11-28 17:11:06 +0000657 550. If all addresses are accepted, then the method will return an
Barry Warsaw4c4bec81998-12-22 03:02:20 +0000658 empty dictionary.
659
660 """
Guido van Rossum296e1431999-04-07 15:03:39 +0000661 if self.helo_resp is None and self.ehlo_resp is None:
662 if not (200 <= self.ehlo()[0] <= 299):
663 (code,resp) = self.helo()
664 if not (200 <= code <= 299):
665 raise SMTPHeloError(code, resp)
Guido van Rossum95e6f701998-06-25 02:15:50 +0000666 esmtp_opts = []
Guido van Rossumfcfb6321998-08-04 15:29:54 +0000667 if self.does_esmtp:
668 # Hmmm? what's this? -ddm
669 # self.esmtp_features['7bit']=""
670 if self.has_extn('size'):
Walter Dörwald70a6b492004-02-12 17:35:32 +0000671 esmtp_opts.append("size=%d" % len(msg))
Guido van Rossumfcfb6321998-08-04 15:29:54 +0000672 for option in mail_options:
Guido van Rossum95e6f701998-06-25 02:15:50 +0000673 esmtp_opts.append(option)
Guido van Rossumfcfb6321998-08-04 15:29:54 +0000674
Guido van Rossum95e6f701998-06-25 02:15:50 +0000675 (code,resp) = self.mail(from_addr, esmtp_opts)
Fred Drake8152d322000-12-12 23:20:45 +0000676 if code != 250:
Guido van Rossum45e2fbc1998-03-26 21:13:24 +0000677 self.rset()
Guido van Rossum296e1431999-04-07 15:03:39 +0000678 raise SMTPSenderRefused(code, resp, from_addr)
Guido van Rossum45e2fbc1998-03-26 21:13:24 +0000679 senderrs={}
Walter Dörwald65230a22002-06-03 15:58:32 +0000680 if isinstance(to_addrs, basestring):
Jeremy Hylton31bb8ce1998-08-13 19:57:46 +0000681 to_addrs = [to_addrs]
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000682 for each in to_addrs:
Guido van Rossumfcfb6321998-08-04 15:29:54 +0000683 (code,resp)=self.rcpt(each, rcpt_options)
Fred Drake8152d322000-12-12 23:20:45 +0000684 if (code != 250) and (code != 251):
Guido van Rossumfc40a831998-01-29 17:26:45 +0000685 senderrs[each]=(code,resp)
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000686 if len(senderrs)==len(to_addrs):
Guido van Rossum95e6f701998-06-25 02:15:50 +0000687 # the server refused all our recipients
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000688 self.rset()
Guido van Rossum296e1431999-04-07 15:03:39 +0000689 raise SMTPRecipientsRefused(senderrs)
Fred Drake8152d322000-12-12 23:20:45 +0000690 (code,resp) = self.data(msg)
691 if code != 250:
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000692 self.rset()
Guido van Rossum296e1431999-04-07 15:03:39 +0000693 raise SMTPDataError(code, resp)
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000694 #if we got here then somebody got our mail
Tim Peters495ad3c2001-01-15 01:36:40 +0000695 return senderrs
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000696
697
698 def close(self):
699 """Close the connection to the SMTP server."""
700 if self.file:
701 self.file.close()
702 self.file = None
703 if self.sock:
704 self.sock.close()
705 self.sock = None
706
707
708 def quit(self):
Guido van Rossum95e6f701998-06-25 02:15:50 +0000709 """Terminate the SMTP session."""
Guido van Rossum45e2fbc1998-03-26 21:13:24 +0000710 self.docmd("quit")
711 self.close()
Guido van Rossum95e6f701998-06-25 02:15:50 +0000712
Thomas Wouters89f507f2006-12-13 04:49:30 +0000713class SMTP_SSL(SMTP):
714 """ This is a subclass derived from SMTP that connects over an SSL encrypted
715 socket (to use this class you need a socket module that was compiled with SSL
716 support). If host is not specified, '' (the local host) is used. If port is
717 omitted, the standard SMTP-over-SSL port (465) is used. keyfile and certfile
718 are also optional - they can contain a PEM formatted private key and
719 certificate chain file for the SSL connection.
720 """
Guido van Rossumd8faa362007-04-27 19:54:29 +0000721 def __init__(self, host='', port=0, local_hostname=None,
722 keyfile=None, certfile=None, timeout=None):
Thomas Wouters89f507f2006-12-13 04:49:30 +0000723 self.keyfile = keyfile
724 self.certfile = certfile
Guido van Rossumd8faa362007-04-27 19:54:29 +0000725 SMTP.__init__(self, host, port, local_hostname, timeout)
Thomas Wouters89f507f2006-12-13 04:49:30 +0000726 self.default_port = SMTP_SSL_PORT
727
Guido van Rossumd8faa362007-04-27 19:54:29 +0000728 def _get_socket(self, host, port, timeout):
Guido van Rossumbe19ed72007-02-09 05:37:30 +0000729 if self.debuglevel > 0: print('connect:', (host, port), file=stderr)
Guido van Rossumd8faa362007-04-27 19:54:29 +0000730 self.sock = socket.create_connection((host, port), timeout)
Thomas Wouters89f507f2006-12-13 04:49:30 +0000731 sslobj = socket.ssl(self.sock, self.keyfile, self.certfile)
732 self.sock = SSLFakeSocket(self.sock, sslobj)
733 self.file = SSLFakeFile(sslobj)
Barry Warsaw4c4bec81998-12-22 03:02:20 +0000734
Guido van Rossumd8faa362007-04-27 19:54:29 +0000735#
736# LMTP extension
737#
738LMTP_PORT = 2003
739
740class LMTP(SMTP):
741 """LMTP - Local Mail Transfer Protocol
742
743 The LMTP protocol, which is very similar to ESMTP, is heavily based
744 on the standard SMTP client. It's common to use Unix sockets for LMTP,
745 so our connect() method must support that as well as a regular
746 host:port server. To specify a Unix socket, you must use an absolute
747 path as the host, starting with a '/'.
748
749 Authentication is supported, using the regular SMTP mechanism. When
750 using a Unix socket, LMTP generally don't support or require any
751 authentication, but your mileage might vary."""
752
753 ehlo_msg = "lhlo"
754
755 def __init__(self, host = '', port = LMTP_PORT, local_hostname = None):
756 """Initialize a new instance."""
757 SMTP.__init__(self, host, port, local_hostname)
758
759 def connect(self, host = 'localhost', port = 0):
760 """Connect to the LMTP daemon, on either a Unix or a TCP socket."""
761 if host[0] != '/':
762 return SMTP.connect(self, host, port)
763
764 # Handle Unix-domain sockets.
765 try:
766 self.sock = socket.socket(socket.AF_UNIX, socket.SOCK_STREAM)
767 self.sock.connect(host)
768 except socket.error as msg:
769 if self.debuglevel > 0: print>>stderr, 'connect fail:', host
770 if self.sock:
771 self.sock.close()
772 self.sock = None
773 raise socket.error(msg)
774 (code, msg) = self.getreply()
775 if self.debuglevel > 0: print>>stderr, "connect:", msg
776 return (code, msg)
777
778
Guido van Rossum95e6f701998-06-25 02:15:50 +0000779# Test the sendmail method, which tests most of the others.
780# Note: This always sends to localhost.
781if __name__ == '__main__':
Andrew M. Kuchling6be424f2001-08-13 14:41:39 +0000782 import sys
Guido van Rossum95e6f701998-06-25 02:15:50 +0000783
784 def prompt(prompt):
785 sys.stdout.write(prompt + ": ")
Eric S. Raymondc013f302001-02-09 05:40:38 +0000786 return sys.stdin.readline().strip()
Guido van Rossum95e6f701998-06-25 02:15:50 +0000787
788 fromaddr = prompt("From")
Eric S. Raymond38151ed2001-02-09 07:40:17 +0000789 toaddrs = prompt("To").split(',')
Guido van Rossumbe19ed72007-02-09 05:37:30 +0000790 print("Enter message, end with ^D:")
Guido van Rossum95e6f701998-06-25 02:15:50 +0000791 msg = ''
792 while 1:
793 line = sys.stdin.readline()
794 if not line:
795 break
796 msg = msg + line
Guido van Rossumbe19ed72007-02-09 05:37:30 +0000797 print("Message length is %d" % len(msg))
Guido van Rossum95e6f701998-06-25 02:15:50 +0000798
799 server = SMTP('localhost')
800 server.set_debuglevel(1)
801 server.sendmail(fromaddr, toaddrs, msg)
802 server.quit()