blob: 4618671726e19beb6272592289c90c6256e63371 [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",
Martin v. Löwisee82c0e2006-10-27 07:13:28 +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
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 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 """
Martin Blais215f13d2006-06-06 12:46:55 +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:
Georg Brandl5a096e12007-01-22 19:40:21 +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
Martin v. Löwis1190a382007-03-09 15:35:55 +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
Neil Schemenauer6730f262002-03-24 15:30:40 +0000233 def __init__(self, host = '', port = 0, local_hostname = 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 Rossumfcfb6321998-08-04 15:29:54 +0000244 self.esmtp_features = {}
Martin v. Löwisee82c0e2006-10-27 07:13:28 +0000245 self.default_port = SMTP_PORT
Guido van Rossum296e1431999-04-07 15:03:39 +0000246 if host:
247 (code, msg) = self.connect(host, port)
248 if code != 220:
249 raise SMTPConnectError(code, msg)
Raymond Hettingerf13eb552002-06-02 00:40:05 +0000250 if local_hostname is not None:
Barry Warsaw13e34f72002-03-26 20:27:35 +0000251 self.local_hostname = local_hostname
Neil Schemenauer6730f262002-03-24 15:30:40 +0000252 else:
Barry Warsaw13e34f72002-03-26 20:27:35 +0000253 # RFC 2821 says we should use the fqdn in the EHLO/HELO verb, and
254 # if that can't be calculated, that we should use a domain literal
255 # instead (essentially an encoded IP address like [A.B.C.D]).
256 fqdn = socket.getfqdn()
257 if '.' in fqdn:
258 self.local_hostname = fqdn
259 else:
260 # We can't find an fqdn hostname, so use a domain literal
Georg Brandldcdfd222006-03-31 19:34:13 +0000261 addr = '127.0.0.1'
262 try:
263 addr = socket.gethostbyname(socket.gethostname())
264 except socket.gaierror:
265 pass
Barry Warsaw13e34f72002-03-26 20:27:35 +0000266 self.local_hostname = '[%s]' % addr
Tim Peters495ad3c2001-01-15 01:36:40 +0000267
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000268 def set_debuglevel(self, debuglevel):
269 """Set the debug output level.
270
Barry Warsawa7d9bdf1998-12-22 03:24:27 +0000271 A non-false value results in debug messages for connection and for all
272 messages sent to and received from the server.
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000273
274 """
275 self.debuglevel = debuglevel
276
Martin v. Löwisee82c0e2006-10-27 07:13:28 +0000277 def _get_socket(self,af, socktype, proto,sa):
278 # This makes it simpler for SMTP_SSL to use the SMTP connect code
279 # and just alter the socket connection bit.
280 self.sock = socket.socket(af, socktype, proto)
281 if self.debuglevel > 0: print>>stderr, 'connect:', (host, port)
282 self.sock.connect(sa)
283
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 Rossumbbe323e1998-01-29 17:24:40 +0000301 raise socket.error, "nonnumeric port"
Martin v. Löwisee82c0e2006-10-27 07:13:28 +0000302 if not port: port = self.default_port
Brett Cannone6f8a892004-07-10 23:14:30 +0000303 if self.debuglevel > 0: print>>stderr, 'connect:', (host, port)
Martin v. Löwis2ad25692001-07-31 08:40:21 +0000304 msg = "getaddrinfo returns an empty list"
Martin v. Löwis322c0d12001-10-07 08:53:32 +0000305 self.sock = None
Martin v. Löwis4eb59402001-07-26 13:37:33 +0000306 for res in socket.getaddrinfo(host, port, 0, socket.SOCK_STREAM):
307 af, socktype, proto, canonname, sa = res
308 try:
Martin v. Löwisee82c0e2006-10-27 07:13:28 +0000309 self._get_socket(af,socktype,proto,sa)
Martin v. Löwis4eb59402001-07-26 13:37:33 +0000310 except socket.error, msg:
Johannes Gijsbers59546232005-01-16 13:04:30 +0000311 if self.debuglevel > 0: print>>stderr, 'connect fail:', msg
Martin v. Löwis322c0d12001-10-07 08:53:32 +0000312 if self.sock:
313 self.sock.close()
Martin v. Löwis4eb59402001-07-26 13:37:33 +0000314 self.sock = None
315 continue
316 break
317 if not self.sock:
318 raise socket.error, msg
Martin v. Löwisa43c2f82001-07-24 20:34:08 +0000319 (code, msg) = self.getreply()
Brett Cannone6f8a892004-07-10 23:14:30 +0000320 if self.debuglevel > 0: print>>stderr, "connect:", msg
Martin v. Löwisa43c2f82001-07-24 20:34:08 +0000321 return (code, msg)
Tim Peters495ad3c2001-01-15 01:36:40 +0000322
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000323 def send(self, str):
324 """Send `str' to the server."""
Brett Cannone6f8a892004-07-10 23:14:30 +0000325 if self.debuglevel > 0: print>>stderr, 'send:', repr(str)
Guido van Rossum45e2fbc1998-03-26 21:13:24 +0000326 if self.sock:
Guido van Rossum2880f6e1998-08-10 20:07:00 +0000327 try:
Martin v. Löwise12454f2002-02-16 23:06:19 +0000328 self.sock.sendall(str)
Guido van Rossum2880f6e1998-08-10 20:07:00 +0000329 except socket.error:
Barry Warsaw76750972001-12-14 20:34:20 +0000330 self.close()
Guido van Rossum40233ea1999-01-15 03:23:55 +0000331 raise SMTPServerDisconnected('Server not connected')
Guido van Rossumfc40a831998-01-29 17:26:45 +0000332 else:
Guido van Rossum40233ea1999-01-15 03:23:55 +0000333 raise SMTPServerDisconnected('please run connect() first')
Tim Peters495ad3c2001-01-15 01:36:40 +0000334
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000335 def putcmd(self, cmd, args=""):
Barry Warsawa7d9bdf1998-12-22 03:24:27 +0000336 """Send a command to the server."""
Guido van Rossumdb23d3d1999-06-09 15:13:10 +0000337 if args == "":
338 str = '%s%s' % (cmd, CRLF)
339 else:
340 str = '%s %s%s' % (cmd, args, CRLF)
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000341 self.send(str)
Tim Peters495ad3c2001-01-15 01:36:40 +0000342
Guido van Rossumfcfb6321998-08-04 15:29:54 +0000343 def getreply(self):
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000344 """Get a reply from the server.
Tim Peters495ad3c2001-01-15 01:36:40 +0000345
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000346 Returns a tuple consisting of:
Barry Warsawa7d9bdf1998-12-22 03:24:27 +0000347
348 - server response code (e.g. '250', or such, if all goes well)
349 Note: returns -1 if it can't read response code.
350
351 - server response string corresponding to response code (multiline
352 responses are converted to a single, multiline string).
Guido van Rossumf123f841999-03-29 20:33:21 +0000353
354 Raises SMTPServerDisconnected if end-of-file is reached.
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000355 """
356 resp=[]
Guido van Rossum296e1431999-04-07 15:03:39 +0000357 if self.file is None:
358 self.file = self.sock.makefile('rb')
Guido van Rossum45e2fbc1998-03-26 21:13:24 +0000359 while 1:
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000360 line = self.file.readline()
Guido van Rossum296e1431999-04-07 15:03:39 +0000361 if line == '':
362 self.close()
363 raise SMTPServerDisconnected("Connection unexpectedly closed")
Brett Cannone6f8a892004-07-10 23:14:30 +0000364 if self.debuglevel > 0: print>>stderr, 'reply:', repr(line)
Eric S. Raymondc013f302001-02-09 05:40:38 +0000365 resp.append(line[4:].strip())
Guido van Rossum45e2fbc1998-03-26 21:13:24 +0000366 code=line[:3]
Guido van Rossum296e1431999-04-07 15:03:39 +0000367 # Check that the error code is syntactically correct.
368 # Don't attempt to read a continuation line if it is broken.
369 try:
Eric S. Raymondc013f302001-02-09 05:40:38 +0000370 errcode = int(code)
Guido van Rossum296e1431999-04-07 15:03:39 +0000371 except ValueError:
372 errcode = -1
373 break
Guido van Rossumf123f841999-03-29 20:33:21 +0000374 # Check if multiline response.
Guido van Rossum45e2fbc1998-03-26 21:13:24 +0000375 if line[3:4]!="-":
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000376 break
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000377
Eric S. Raymondc013f302001-02-09 05:40:38 +0000378 errmsg = "\n".join(resp)
Tim Peters495ad3c2001-01-15 01:36:40 +0000379 if self.debuglevel > 0:
Brett Cannone6f8a892004-07-10 23:14:30 +0000380 print>>stderr, 'reply: retcode (%s); Msg: %s' % (errcode,errmsg)
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000381 return errcode, errmsg
Tim Peters495ad3c2001-01-15 01:36:40 +0000382
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000383 def docmd(self, cmd, args=""):
Barry Warsawa7d9bdf1998-12-22 03:24:27 +0000384 """Send a command, and return its response code."""
Guido van Rossum45e2fbc1998-03-26 21:13:24 +0000385 self.putcmd(cmd,args)
Guido van Rossum296e1431999-04-07 15:03:39 +0000386 return self.getreply()
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000387
Barry Warsawa7d9bdf1998-12-22 03:24:27 +0000388 # std smtp commands
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000389 def helo(self, name=''):
Barry Warsawa7d9bdf1998-12-22 03:24:27 +0000390 """SMTP 'helo' command.
391 Hostname to send for this command defaults to the FQDN of the local
392 host.
393 """
Neil Schemenauer6730f262002-03-24 15:30:40 +0000394 self.putcmd("helo", name or self.local_hostname)
Guido van Rossum45e2fbc1998-03-26 21:13:24 +0000395 (code,msg)=self.getreply()
396 self.helo_resp=msg
Guido van Rossum296e1431999-04-07 15:03:39 +0000397 return (code,msg)
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000398
Guido van Rossum95e6f701998-06-25 02:15:50 +0000399 def ehlo(self, name=''):
Barry Warsawa7d9bdf1998-12-22 03:24:27 +0000400 """ SMTP 'ehlo' command.
401 Hostname to send for this command defaults to the FQDN of the local
402 host.
403 """
Guido van Rossumf7fcf5e2001-09-14 16:08:44 +0000404 self.esmtp_features = {}
Martin v. Löwis1190a382007-03-09 15:35:55 +0000405 self.putcmd(self.ehlo_msg, name or self.local_hostname)
Guido van Rossumfcfb6321998-08-04 15:29:54 +0000406 (code,msg)=self.getreply()
Tim Peters495ad3c2001-01-15 01:36:40 +0000407 # According to RFC1869 some (badly written)
408 # MTA's will disconnect on an ehlo. Toss an exception if
Guido van Rossumfcfb6321998-08-04 15:29:54 +0000409 # that happens -ddm
410 if code == -1 and len(msg) == 0:
Barry Warsaw76750972001-12-14 20:34:20 +0000411 self.close()
Guido van Rossum40233ea1999-01-15 03:23:55 +0000412 raise SMTPServerDisconnected("Server not connected")
Guido van Rossum95e6f701998-06-25 02:15:50 +0000413 self.ehlo_resp=msg
Fred Drake8152d322000-12-12 23:20:45 +0000414 if code != 250:
Guido van Rossum296e1431999-04-07 15:03:39 +0000415 return (code,msg)
Guido van Rossumfcfb6321998-08-04 15:29:54 +0000416 self.does_esmtp=1
Thomas Wouters7e474022000-07-16 12:04:32 +0000417 #parse the ehlo response -ddm
Eric S. Raymondc013f302001-02-09 05:40:38 +0000418 resp=self.ehlo_resp.split('\n')
Guido van Rossumfcfb6321998-08-04 15:29:54 +0000419 del resp[0]
Guido van Rossum2880f6e1998-08-10 20:07:00 +0000420 for each in resp:
Piers Lauder385a77a2002-07-27 00:38:30 +0000421 # To be able to communicate with as many SMTP servers as possible,
422 # we have to take the old-style auth advertisement into account,
423 # because:
424 # 1) Else our SMTP feature parser gets confused.
425 # 2) There are some servers that only advertise the auth methods we
426 # support using the old style.
427 auth_match = OLDSTYLE_AUTH.match(each)
428 if auth_match:
429 # This doesn't remove duplicates, but that's no problem
430 self.esmtp_features["auth"] = self.esmtp_features.get("auth", "") \
431 + " " + auth_match.groups(0)[0]
432 continue
433
Barry Warsawbe22ae62002-04-15 20:03:30 +0000434 # RFC 1869 requires a space between ehlo keyword and parameters.
435 # It's actually stricter, in that only spaces are allowed between
436 # parameters, but were not going to check for that here. Note
437 # that the space isn't present if there are no parameters.
438 m=re.match(r'(?P<feature>[A-Za-z0-9][A-Za-z0-9\-]*) ?',each)
Guido van Rossumfcfb6321998-08-04 15:29:54 +0000439 if m:
Eric S. Raymondc013f302001-02-09 05:40:38 +0000440 feature=m.group("feature").lower()
441 params=m.string[m.end("feature"):].strip()
Piers Lauder385a77a2002-07-27 00:38:30 +0000442 if feature == "auth":
443 self.esmtp_features[feature] = self.esmtp_features.get(feature, "") \
444 + " " + params
445 else:
446 self.esmtp_features[feature]=params
Guido van Rossum296e1431999-04-07 15:03:39 +0000447 return (code,msg)
Guido van Rossum95e6f701998-06-25 02:15:50 +0000448
Guido van Rossumfcfb6321998-08-04 15:29:54 +0000449 def has_extn(self, opt):
450 """Does the server support a given SMTP service extension?"""
Raymond Hettinger54f02222002-06-01 14:18:47 +0000451 return opt.lower() in self.esmtp_features
Guido van Rossum95e6f701998-06-25 02:15:50 +0000452
Guido van Rossum18586f41998-04-03 17:03:13 +0000453 def help(self, args=''):
Barry Warsawa7d9bdf1998-12-22 03:24:27 +0000454 """SMTP 'help' command.
455 Returns help text from server."""
Guido van Rossum18586f41998-04-03 17:03:13 +0000456 self.putcmd("help", args)
Kurt B. Kaiser58bd1902005-06-26 18:27:36 +0000457 return self.getreply()[1]
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000458
459 def rset(self):
Barry Warsawa7d9bdf1998-12-22 03:24:27 +0000460 """SMTP 'rset' command -- resets session."""
Guido van Rossum296e1431999-04-07 15:03:39 +0000461 return self.docmd("rset")
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000462
463 def noop(self):
Barry Warsawa7d9bdf1998-12-22 03:24:27 +0000464 """SMTP 'noop' command -- doesn't do anything :>"""
Guido van Rossum296e1431999-04-07 15:03:39 +0000465 return self.docmd("noop")
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000466
Guido van Rossum95e6f701998-06-25 02:15:50 +0000467 def mail(self,sender,options=[]):
Barry Warsawa7d9bdf1998-12-22 03:24:27 +0000468 """SMTP 'mail' command -- begins mail xfer session."""
Guido van Rossumfcfb6321998-08-04 15:29:54 +0000469 optionlist = ''
470 if options and self.does_esmtp:
Eric S. Raymondc013f302001-02-09 05:40:38 +0000471 optionlist = ' ' + ' '.join(options)
Guido van Rossumdb23d3d1999-06-09 15:13:10 +0000472 self.putcmd("mail", "FROM:%s%s" % (quoteaddr(sender) ,optionlist))
Guido van Rossum45e2fbc1998-03-26 21:13:24 +0000473 return self.getreply()
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000474
Guido van Rossumfcfb6321998-08-04 15:29:54 +0000475 def rcpt(self,recip,options=[]):
Barry Warsawa7d9bdf1998-12-22 03:24:27 +0000476 """SMTP 'rcpt' command -- indicates 1 recipient for this mail."""
Guido van Rossumfcfb6321998-08-04 15:29:54 +0000477 optionlist = ''
478 if options and self.does_esmtp:
Eric S. Raymondc013f302001-02-09 05:40:38 +0000479 optionlist = ' ' + ' '.join(options)
Guido van Rossum348fd061999-01-14 04:18:46 +0000480 self.putcmd("rcpt","TO:%s%s" % (quoteaddr(recip),optionlist))
Guido van Rossum45e2fbc1998-03-26 21:13:24 +0000481 return self.getreply()
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000482
483 def data(self,msg):
Tim Peters495ad3c2001-01-15 01:36:40 +0000484 """SMTP 'DATA' command -- sends message data to server.
Guido van Rossum296e1431999-04-07 15:03:39 +0000485
Barry Warsaw4c4bec81998-12-22 03:02:20 +0000486 Automatically quotes lines beginning with a period per rfc821.
Guido van Rossum296e1431999-04-07 15:03:39 +0000487 Raises SMTPDataError if there is an unexpected reply to the
488 DATA command; the return value from this method is the final
489 response code received when the all data is sent.
Barry Warsaw4c4bec81998-12-22 03:02:20 +0000490 """
Guido van Rossum45e2fbc1998-03-26 21:13:24 +0000491 self.putcmd("data")
492 (code,repl)=self.getreply()
Brett Cannone6f8a892004-07-10 23:14:30 +0000493 if self.debuglevel >0 : print>>stderr, "data:", (code,repl)
Fred Drake8152d322000-12-12 23:20:45 +0000494 if code != 354:
Guido van Rossum296e1431999-04-07 15:03:39 +0000495 raise SMTPDataError(code,repl)
Guido van Rossum45e2fbc1998-03-26 21:13:24 +0000496 else:
Guido van Rossum20c92281999-04-21 16:52:20 +0000497 q = quotedata(msg)
498 if q[-2:] != CRLF:
499 q = q + CRLF
500 q = q + "." + CRLF
501 self.send(q)
Guido van Rossum45e2fbc1998-03-26 21:13:24 +0000502 (code,msg)=self.getreply()
Brett Cannone6f8a892004-07-10 23:14:30 +0000503 if self.debuglevel >0 : print>>stderr, "data:", (code,msg)
Guido van Rossum296e1431999-04-07 15:03:39 +0000504 return (code,msg)
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000505
Guido van Rossumfcfb6321998-08-04 15:29:54 +0000506 def verify(self, address):
Barry Warsawa7d9bdf1998-12-22 03:24:27 +0000507 """SMTP 'verify' command -- checks for address validity."""
Guido van Rossumfcfb6321998-08-04 15:29:54 +0000508 self.putcmd("vrfy", quoteaddr(address))
509 return self.getreply()
Barry Warsaw4c4bec81998-12-22 03:02:20 +0000510 # a.k.a.
511 vrfy=verify
Guido van Rossumfcfb6321998-08-04 15:29:54 +0000512
513 def expn(self, address):
Barry Warsawa7d9bdf1998-12-22 03:24:27 +0000514 """SMTP 'verify' command -- checks for address validity."""
Guido van Rossumfcfb6321998-08-04 15:29:54 +0000515 self.putcmd("expn", quoteaddr(address))
516 return self.getreply()
517
Barry Warsaw4c4bec81998-12-22 03:02:20 +0000518 # some useful methods
Guido van Rossumae010462001-09-11 15:57:46 +0000519
520 def login(self, user, password):
521 """Log in on an SMTP server that requires authentication.
522
523 The arguments are:
524 - user: The user name to authenticate with.
525 - password: The password for the authentication.
526
527 If there has been no previous EHLO or HELO command this session, this
528 method tries ESMTP EHLO first.
529
530 This method will return normally if the authentication was successful.
531
532 This method may raise the following exceptions:
533
534 SMTPHeloError The server didn't reply properly to
535 the helo greeting.
536 SMTPAuthenticationError The server didn't accept the username/
537 password combination.
Fred Drake2f8f4d32001-10-13 18:35:32 +0000538 SMTPException No suitable authentication method was
Guido van Rossumae010462001-09-11 15:57:46 +0000539 found.
540 """
541
542 def encode_cram_md5(challenge, user, password):
543 challenge = base64.decodestring(challenge)
544 response = user + " " + hmac.HMAC(password, challenge).hexdigest()
Piers Lauder385a77a2002-07-27 00:38:30 +0000545 return encode_base64(response, eol="")
Guido van Rossumae010462001-09-11 15:57:46 +0000546
547 def encode_plain(user, password):
Johannes Gijsbers25946dd2004-12-06 21:25:26 +0000548 return encode_base64("\0%s\0%s" % (user, password), eol="")
Tim Peters469cdad2002-08-08 20:19:19 +0000549
Guido van Rossumae010462001-09-11 15:57:46 +0000550
551 AUTH_PLAIN = "PLAIN"
552 AUTH_CRAM_MD5 = "CRAM-MD5"
Piers Lauder385a77a2002-07-27 00:38:30 +0000553 AUTH_LOGIN = "LOGIN"
Guido van Rossumae010462001-09-11 15:57:46 +0000554
555 if self.helo_resp is None and self.ehlo_resp is None:
556 if not (200 <= self.ehlo()[0] <= 299):
557 (code, resp) = self.helo()
558 if not (200 <= code <= 299):
559 raise SMTPHeloError(code, resp)
560
561 if not self.has_extn("auth"):
562 raise SMTPException("SMTP AUTH extension not supported by server.")
563
564 # Authentication methods the server supports:
565 authlist = self.esmtp_features["auth"].split()
566
567 # List of authentication methods we support: from preferred to
568 # less preferred methods. Except for the purpose of testing the weaker
569 # ones, we prefer stronger methods like CRAM-MD5:
Piers Lauder385a77a2002-07-27 00:38:30 +0000570 preferred_auths = [AUTH_CRAM_MD5, AUTH_PLAIN, AUTH_LOGIN]
Guido van Rossumae010462001-09-11 15:57:46 +0000571
572 # Determine the authentication method we'll use
573 authmethod = None
574 for method in preferred_auths:
575 if method in authlist:
576 authmethod = method
577 break
Tim Petersb64bec32001-09-18 02:26:39 +0000578
Guido van Rossumae010462001-09-11 15:57:46 +0000579 if authmethod == AUTH_CRAM_MD5:
580 (code, resp) = self.docmd("AUTH", AUTH_CRAM_MD5)
581 if code == 503:
582 # 503 == 'Error: already authenticated'
583 return (code, resp)
584 (code, resp) = self.docmd(encode_cram_md5(resp, user, password))
585 elif authmethod == AUTH_PLAIN:
Tim Petersb64bec32001-09-18 02:26:39 +0000586 (code, resp) = self.docmd("AUTH",
Guido van Rossumae010462001-09-11 15:57:46 +0000587 AUTH_PLAIN + " " + encode_plain(user, password))
Piers Lauder385a77a2002-07-27 00:38:30 +0000588 elif authmethod == AUTH_LOGIN:
589 (code, resp) = self.docmd("AUTH",
590 "%s %s" % (AUTH_LOGIN, encode_base64(user, eol="")))
591 if code != 334:
592 raise SMTPAuthenticationError(code, resp)
Martin v. Löwis49c05d32002-10-06 17:55:08 +0000593 (code, resp) = self.docmd(encode_base64(password, eol=""))
Raymond Hettinger7fdfc2d2002-05-31 17:49:10 +0000594 elif authmethod is None:
Fred Drake2f8f4d32001-10-13 18:35:32 +0000595 raise SMTPException("No suitable authentication method found.")
Raymond Hettingerdbecd932005-02-06 06:57:08 +0000596 if code not in (235, 503):
Guido van Rossumae010462001-09-11 15:57:46 +0000597 # 235 == 'Authentication successful'
598 # 503 == 'Error: already authenticated'
599 raise SMTPAuthenticationError(code, resp)
600 return (code, resp)
601
Guido van Rossumf7fcf5e2001-09-14 16:08:44 +0000602 def starttls(self, keyfile = None, certfile = None):
603 """Puts the connection to the SMTP server into TLS mode.
Tim Petersb64bec32001-09-18 02:26:39 +0000604
Guido van Rossumf7fcf5e2001-09-14 16:08:44 +0000605 If the server supports TLS, this will encrypt the rest of the SMTP
606 session. If you provide the keyfile and certfile parameters,
607 the identity of the SMTP server and client can be checked. This,
608 however, depends on whether the socket module really checks the
609 certificates.
610 """
Tim Petersb64bec32001-09-18 02:26:39 +0000611 (resp, reply) = self.docmd("STARTTLS")
Guido van Rossumf7fcf5e2001-09-14 16:08:44 +0000612 if resp == 220:
613 sslobj = socket.ssl(self.sock, keyfile, certfile)
614 self.sock = SSLFakeSocket(self.sock, sslobj)
615 self.file = SSLFakeFile(sslobj)
616 return (resp, reply)
Tim Petersb64bec32001-09-18 02:26:39 +0000617
Jeremy Hylton31bb8ce1998-08-13 19:57:46 +0000618 def sendmail(self, from_addr, to_addrs, msg, mail_options=[],
Tim Peters495ad3c2001-01-15 01:36:40 +0000619 rcpt_options=[]):
620 """This command performs an entire mail transaction.
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000621
Tim Peters495ad3c2001-01-15 01:36:40 +0000622 The arguments are:
Barry Warsaw4c4bec81998-12-22 03:02:20 +0000623 - from_addr : The address sending this mail.
624 - to_addrs : A list of addresses to send this mail to. A bare
625 string will be treated as a list with 1 address.
Tim Peters495ad3c2001-01-15 01:36:40 +0000626 - msg : The message to send.
Barry Warsaw4c4bec81998-12-22 03:02:20 +0000627 - mail_options : List of ESMTP options (such as 8bitmime) for the
628 mail command.
629 - rcpt_options : List of ESMTP options (such as DSN commands) for
630 all the rcpt commands.
631
632 If there has been no previous EHLO or HELO command this session, this
633 method tries ESMTP EHLO first. If the server does ESMTP, message size
634 and each of the specified options will be passed to it. If EHLO
635 fails, HELO will be tried and ESMTP options suppressed.
636
637 This method will return normally if the mail is accepted for at least
Barry Warsawd25c1b71999-11-28 17:11:06 +0000638 one recipient. It returns a dictionary, with one entry for each
639 recipient that was refused. Each entry contains a tuple of the SMTP
640 error code and the accompanying error message sent by the server.
Guido van Rossum296e1431999-04-07 15:03:39 +0000641
642 This method may raise the following exceptions:
643
644 SMTPHeloError The server didn't reply properly to
Tim Peters495ad3c2001-01-15 01:36:40 +0000645 the helo greeting.
Barry Warsawd25c1b71999-11-28 17:11:06 +0000646 SMTPRecipientsRefused The server rejected ALL recipients
Guido van Rossum296e1431999-04-07 15:03:39 +0000647 (no mail was sent).
648 SMTPSenderRefused The server didn't accept the from_addr.
649 SMTPDataError The server replied with an unexpected
650 error code (other than a refusal of
651 a recipient).
652
653 Note: the connection will be open even after an exception is raised.
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000654
Guido van Rossum95e6f701998-06-25 02:15:50 +0000655 Example:
Tim Peters495ad3c2001-01-15 01:36:40 +0000656
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000657 >>> import smtplib
658 >>> s=smtplib.SMTP("localhost")
Guido van Rossumfc40a831998-01-29 17:26:45 +0000659 >>> tolist=["one@one.org","two@two.org","three@three.org","four@four.org"]
Martin v. Löwis301b1cd2002-07-28 16:52:01 +0000660 >>> msg = '''\\
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000661 ... From: Me@my.org
662 ... Subject: testin'...
663 ...
664 ... This is a test '''
665 >>> s.sendmail("me@my.org",tolist,msg)
666 { "three@three.org" : ( 550 ,"User unknown" ) }
667 >>> s.quit()
Tim Peters495ad3c2001-01-15 01:36:40 +0000668
Barry Warsaw4c4bec81998-12-22 03:02:20 +0000669 In the above example, the message was accepted for delivery to three
670 of the four addresses, and one was rejected, with the error code
Barry Warsawd25c1b71999-11-28 17:11:06 +0000671 550. If all addresses are accepted, then the method will return an
Barry Warsaw4c4bec81998-12-22 03:02:20 +0000672 empty dictionary.
673
674 """
Guido van Rossum296e1431999-04-07 15:03:39 +0000675 if self.helo_resp is None and self.ehlo_resp is None:
676 if not (200 <= self.ehlo()[0] <= 299):
677 (code,resp) = self.helo()
678 if not (200 <= code <= 299):
679 raise SMTPHeloError(code, resp)
Guido van Rossum95e6f701998-06-25 02:15:50 +0000680 esmtp_opts = []
Guido van Rossumfcfb6321998-08-04 15:29:54 +0000681 if self.does_esmtp:
682 # Hmmm? what's this? -ddm
683 # self.esmtp_features['7bit']=""
684 if self.has_extn('size'):
Walter Dörwald70a6b492004-02-12 17:35:32 +0000685 esmtp_opts.append("size=%d" % len(msg))
Guido van Rossumfcfb6321998-08-04 15:29:54 +0000686 for option in mail_options:
Guido van Rossum95e6f701998-06-25 02:15:50 +0000687 esmtp_opts.append(option)
Guido van Rossumfcfb6321998-08-04 15:29:54 +0000688
Guido van Rossum95e6f701998-06-25 02:15:50 +0000689 (code,resp) = self.mail(from_addr, esmtp_opts)
Fred Drake8152d322000-12-12 23:20:45 +0000690 if code != 250:
Guido van Rossum45e2fbc1998-03-26 21:13:24 +0000691 self.rset()
Guido van Rossum296e1431999-04-07 15:03:39 +0000692 raise SMTPSenderRefused(code, resp, from_addr)
Guido van Rossum45e2fbc1998-03-26 21:13:24 +0000693 senderrs={}
Walter Dörwald65230a22002-06-03 15:58:32 +0000694 if isinstance(to_addrs, basestring):
Jeremy Hylton31bb8ce1998-08-13 19:57:46 +0000695 to_addrs = [to_addrs]
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000696 for each in to_addrs:
Guido van Rossumfcfb6321998-08-04 15:29:54 +0000697 (code,resp)=self.rcpt(each, rcpt_options)
Fred Drake8152d322000-12-12 23:20:45 +0000698 if (code != 250) and (code != 251):
Guido van Rossumfc40a831998-01-29 17:26:45 +0000699 senderrs[each]=(code,resp)
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000700 if len(senderrs)==len(to_addrs):
Guido van Rossum95e6f701998-06-25 02:15:50 +0000701 # the server refused all our recipients
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000702 self.rset()
Guido van Rossum296e1431999-04-07 15:03:39 +0000703 raise SMTPRecipientsRefused(senderrs)
Fred Drake8152d322000-12-12 23:20:45 +0000704 (code,resp) = self.data(msg)
705 if code != 250:
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000706 self.rset()
Guido van Rossum296e1431999-04-07 15:03:39 +0000707 raise SMTPDataError(code, resp)
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000708 #if we got here then somebody got our mail
Tim Peters495ad3c2001-01-15 01:36:40 +0000709 return senderrs
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000710
711
712 def close(self):
713 """Close the connection to the SMTP server."""
714 if self.file:
715 self.file.close()
716 self.file = None
717 if self.sock:
718 self.sock.close()
719 self.sock = None
720
721
722 def quit(self):
Guido van Rossum95e6f701998-06-25 02:15:50 +0000723 """Terminate the SMTP session."""
Guido van Rossum45e2fbc1998-03-26 21:13:24 +0000724 self.docmd("quit")
725 self.close()
Guido van Rossum95e6f701998-06-25 02:15:50 +0000726
Martin v. Löwisee82c0e2006-10-27 07:13:28 +0000727class SMTP_SSL(SMTP):
728 """ This is a subclass derived from SMTP that connects over an SSL encrypted
729 socket (to use this class you need a socket module that was compiled with SSL
730 support). If host is not specified, '' (the local host) is used. If port is
731 omitted, the standard SMTP-over-SSL port (465) is used. keyfile and certfile
732 are also optional - they can contain a PEM formatted private key and
Tim Petersabd8a332006-11-03 02:32:46 +0000733 certificate chain file for the SSL connection.
Martin v. Löwisee82c0e2006-10-27 07:13:28 +0000734 """
735 def __init__(self, host = '', port = 0, local_hostname = None,
736 keyfile = None, certfile = None):
737 self.keyfile = keyfile
738 self.certfile = certfile
739 SMTP.__init__(self,host,port,local_hostname)
740 self.default_port = SMTP_SSL_PORT
741
742 def _get_socket(self,af, socktype, proto,sa):
743 self.sock = socket.socket(af, socktype, proto)
744 if self.debuglevel > 0: print>>stderr, 'connect:', (host, port)
745 self.sock.connect(sa)
746 sslobj = socket.ssl(self.sock, self.keyfile, self.certfile)
747 self.sock = SSLFakeSocket(self.sock, sslobj)
748 self.file = SSLFakeFile(sslobj)
Barry Warsaw4c4bec81998-12-22 03:02:20 +0000749
Martin v. Löwis1190a382007-03-09 15:35:55 +0000750#
751# LMTP extension
752#
753LMTP_PORT = 2003
754
755class LMTP(SMTP):
756 """LMTP - Local Mail Transfer Protocol
757
758 The LMTP protocol, which is very similar to ESMTP, is heavily based
759 on the standard SMTP client. It's common to use Unix sockets for LMTP,
760 so our connect() method must support that as well as a regular
761 host:port server. To specify a Unix socket, you must use an absolute
762 path as the host, starting with a '/'.
763
764 Authentication is supported, using the regular SMTP mechanism. When
765 using a Unix socket, LMTP generally don't support or require any
766 authentication, but your mileage might vary."""
767
768 ehlo_msg = "lhlo"
Tim Petersea5962f2007-03-12 18:07:52 +0000769
Martin v. Löwis1190a382007-03-09 15:35:55 +0000770 def __init__(self, host = '', port = LMTP_PORT, local_hostname = None):
771 """Initialize a new instance."""
772 SMTP.__init__(self, host, port, local_hostname)
773
Neal Norwitzc8f6c232007-03-10 03:19:18 +0000774 def connect(self, host = 'localhost', port = 0):
Martin v. Löwis1190a382007-03-09 15:35:55 +0000775 """Connect to the LMTP daemon, on either a Unix or a TCP socket."""
Neal Norwitzc8f6c232007-03-10 03:19:18 +0000776 if host[0] != '/':
Martin v. Löwis1190a382007-03-09 15:35:55 +0000777 return SMTP.connect(self, host, port)
778
Neal Norwitzc8f6c232007-03-10 03:19:18 +0000779 # Handle Unix-domain sockets.
780 try:
781 self.sock = socket.socket(socket.AF_UNIX, socket.SOCK_STREAM)
782 self.sock.connect(host)
783 except socket.error, msg:
784 if self.debuglevel > 0: print>>stderr, 'connect fail:', host
785 if self.sock:
786 self.sock.close()
787 self.sock = None
788 raise socket.error, msg
789 (code, msg) = self.getreply()
790 if self.debuglevel > 0: print>>stderr, "connect:", msg
791 return (code, msg)
792
Martin v. Löwis1190a382007-03-09 15:35:55 +0000793
Guido van Rossum95e6f701998-06-25 02:15:50 +0000794# Test the sendmail method, which tests most of the others.
795# Note: This always sends to localhost.
796if __name__ == '__main__':
Andrew M. Kuchling6be424f2001-08-13 14:41:39 +0000797 import sys
Guido van Rossum95e6f701998-06-25 02:15:50 +0000798
799 def prompt(prompt):
800 sys.stdout.write(prompt + ": ")
Eric S. Raymondc013f302001-02-09 05:40:38 +0000801 return sys.stdin.readline().strip()
Guido van Rossum95e6f701998-06-25 02:15:50 +0000802
803 fromaddr = prompt("From")
Eric S. Raymond38151ed2001-02-09 07:40:17 +0000804 toaddrs = prompt("To").split(',')
Guido van Rossum95e6f701998-06-25 02:15:50 +0000805 print "Enter message, end with ^D:"
806 msg = ''
807 while 1:
808 line = sys.stdin.readline()
809 if not line:
810 break
811 msg = msg + line
Walter Dörwald70a6b492004-02-12 17:35:32 +0000812 print "Message length is %d" % len(msg)
Guido van Rossum95e6f701998-06-25 02:15:50 +0000813
814 server = SMTP('localhost')
815 server.set_debuglevel(1)
816 server.sendmail(fromaddr, toaddrs, msg)
817 server.quit()