blob: 2b7befb7718d8f2d02beb60a222490167017facb [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
Barry Warsaw2cc1f6d2007-08-30 14:28:55 +000049from email.base64mime import body_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 Wouters47b49bf2007-08-30 22:15:33 +000055 "quoteaddr","quotedata","SMTP"]
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 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:
Thomas Woutersb2137042007-02-01 18:02:27 +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
Thomas Wouters47b49bf2007-08-30 22:15:33 +0000159try:
160 import ssl
161except ImportError:
162 _have_ssl = False
163else:
Thomas Wouters47b49bf2007-08-30 22:15:33 +0000164 class SSLFakeFile:
165 """A fake file like object that really wraps a SSLObject.
166
167 It only supports what is needed in smtplib.
168 """
169 def __init__(self, sslobj):
170 self.sslobj = sslobj
171
172 def readline(self):
173 str = b""
174 chr = None
175 while chr != b"\n":
176 chr = self.sslobj.read(1)
177 str += chr
178 return str
179
180 def close(self):
181 pass
182
183 _have_ssl = True
184
Peter Schneider-Kamp7bc82bb2000-08-10 14:02:23 +0000185
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
Guido van Rossumd8faa362007-04-27 19:54:29 +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
Guido van Rossumd8faa362007-04-27 19:54:29 +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 """
Guido van Rossumd8faa362007-04-27 19:54:29 +0000233 self.timeout = timeout
Guido van Rossumfcfb6321998-08-04 15:29:54 +0000234 self.esmtp_features = {}
Thomas Wouters89f507f2006-12-13 04:49:30 +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
Thomas Wouters49fd7fa2006-04-21 10:40:58 +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
Guido van Rossumd8faa362007-04-27 19:54:29 +0000267 def _get_socket(self, port, host, timeout):
Thomas Wouters89f507f2006-12-13 04:49:30 +0000268 # This makes it simpler for SMTP_SSL to use the SMTP connect code
269 # and just alter the socket connection bit.
Guido van Rossumbe19ed72007-02-09 05:37:30 +0000270 if self.debuglevel > 0: print('connect:', (host, port), file=stderr)
Guido van Rossumd8faa362007-04-27 19:54:29 +0000271 return socket.create_connection((port, host), timeout)
Thomas Wouters89f507f2006-12-13 04:49:30 +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 Rossumd8faa362007-04-27 19:54:29 +0000290 raise socket.error("nonnumeric port")
Thomas Wouters89f507f2006-12-13 04:49:30 +0000291 if not port: port = self.default_port
Guido van Rossumbe19ed72007-02-09 05:37:30 +0000292 if self.debuglevel > 0: print('connect:', (host, port), file=stderr)
Guido van Rossumd8faa362007-04-27 19:54:29 +0000293 self.sock = self._get_socket(host, port, self.timeout)
Martin v. Löwisa43c2f82001-07-24 20:34:08 +0000294 (code, msg) = self.getreply()
Guido van Rossumbe19ed72007-02-09 05:37:30 +0000295 if self.debuglevel > 0: print("connect:", msg, file=stderr)
Martin v. Löwisa43c2f82001-07-24 20:34:08 +0000296 return (code, msg)
Tim Peters495ad3c2001-01-15 01:36:40 +0000297
Guido van Rossum8a392d72007-11-21 22:09:45 +0000298 def send(self, s):
299 """Send `s' to the server."""
300 if self.debuglevel > 0: print('send:', repr(s), file=stderr)
Guido van Rossum45e2fbc1998-03-26 21:13:24 +0000301 if self.sock:
Guido van Rossum8a392d72007-11-21 22:09:45 +0000302 if isinstance(s, str):
303 s = s.encode("ascii")
Guido van Rossum2880f6e1998-08-10 20:07:00 +0000304 try:
Guido van Rossum8a392d72007-11-21 22:09:45 +0000305 self.sock.sendall(s)
Guido van Rossum2880f6e1998-08-10 20:07:00 +0000306 except socket.error:
Barry Warsaw76750972001-12-14 20:34:20 +0000307 self.close()
Guido van Rossum40233ea1999-01-15 03:23:55 +0000308 raise SMTPServerDisconnected('Server not connected')
Guido van Rossumfc40a831998-01-29 17:26:45 +0000309 else:
Guido van Rossum40233ea1999-01-15 03:23:55 +0000310 raise SMTPServerDisconnected('please run connect() first')
Tim Peters495ad3c2001-01-15 01:36:40 +0000311
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000312 def putcmd(self, cmd, args=""):
Barry Warsawa7d9bdf1998-12-22 03:24:27 +0000313 """Send a command to the server."""
Guido van Rossumdb23d3d1999-06-09 15:13:10 +0000314 if args == "":
315 str = '%s%s' % (cmd, CRLF)
316 else:
317 str = '%s %s%s' % (cmd, args, CRLF)
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000318 self.send(str)
Tim Peters495ad3c2001-01-15 01:36:40 +0000319
Guido van Rossumfcfb6321998-08-04 15:29:54 +0000320 def getreply(self):
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000321 """Get a reply from the server.
Tim Peters495ad3c2001-01-15 01:36:40 +0000322
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000323 Returns a tuple consisting of:
Barry Warsawa7d9bdf1998-12-22 03:24:27 +0000324
325 - server response code (e.g. '250', or such, if all goes well)
326 Note: returns -1 if it can't read response code.
327
328 - server response string corresponding to response code (multiline
329 responses are converted to a single, multiline string).
Guido van Rossumf123f841999-03-29 20:33:21 +0000330
331 Raises SMTPServerDisconnected if end-of-file is reached.
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000332 """
333 resp=[]
Guido van Rossum296e1431999-04-07 15:03:39 +0000334 if self.file is None:
335 self.file = self.sock.makefile('rb')
Guido van Rossum45e2fbc1998-03-26 21:13:24 +0000336 while 1:
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000337 line = self.file.readline()
Guido van Rossum806c2462007-08-06 23:33:07 +0000338 if not line:
Guido van Rossum296e1431999-04-07 15:03:39 +0000339 self.close()
340 raise SMTPServerDisconnected("Connection unexpectedly closed")
Guido van Rossumbe19ed72007-02-09 05:37:30 +0000341 if self.debuglevel > 0: print('reply:', repr(line), file=stderr)
Guido van Rossum806c2462007-08-06 23:33:07 +0000342 resp.append(line[4:].strip(b' \t\r\n'))
Guido van Rossum45e2fbc1998-03-26 21:13:24 +0000343 code=line[:3]
Guido van Rossum296e1431999-04-07 15:03:39 +0000344 # Check that the error code is syntactically correct.
345 # Don't attempt to read a continuation line if it is broken.
346 try:
Eric S. Raymondc013f302001-02-09 05:40:38 +0000347 errcode = int(code)
Guido van Rossum296e1431999-04-07 15:03:39 +0000348 except ValueError:
349 errcode = -1
350 break
Guido van Rossumf123f841999-03-29 20:33:21 +0000351 # Check if multiline response.
Guido van Rossum806c2462007-08-06 23:33:07 +0000352 if line[3:4] != b"-":
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000353 break
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000354
Guido van Rossumc43e79f2007-06-18 18:26:36 +0000355 errmsg = b"\n".join(resp)
Tim Peters495ad3c2001-01-15 01:36:40 +0000356 if self.debuglevel > 0:
Guido van Rossumbe19ed72007-02-09 05:37:30 +0000357 print('reply: retcode (%s); Msg: %s' % (errcode,errmsg), file=stderr)
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000358 return errcode, errmsg
Tim Peters495ad3c2001-01-15 01:36:40 +0000359
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000360 def docmd(self, cmd, args=""):
Barry Warsawa7d9bdf1998-12-22 03:24:27 +0000361 """Send a command, and return its response code."""
Guido van Rossum45e2fbc1998-03-26 21:13:24 +0000362 self.putcmd(cmd,args)
Guido van Rossum296e1431999-04-07 15:03:39 +0000363 return self.getreply()
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000364
Barry Warsawa7d9bdf1998-12-22 03:24:27 +0000365 # std smtp commands
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000366 def helo(self, name=''):
Barry Warsawa7d9bdf1998-12-22 03:24:27 +0000367 """SMTP 'helo' command.
368 Hostname to send for this command defaults to the FQDN of the local
369 host.
370 """
Neil Schemenauer6730f262002-03-24 15:30:40 +0000371 self.putcmd("helo", name or self.local_hostname)
Guido van Rossum45e2fbc1998-03-26 21:13:24 +0000372 (code,msg)=self.getreply()
373 self.helo_resp=msg
Guido van Rossum296e1431999-04-07 15:03:39 +0000374 return (code,msg)
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000375
Guido van Rossum95e6f701998-06-25 02:15:50 +0000376 def ehlo(self, name=''):
Barry Warsawa7d9bdf1998-12-22 03:24:27 +0000377 """ SMTP 'ehlo' command.
378 Hostname to send for this command defaults to the FQDN of the local
379 host.
380 """
Guido van Rossumf7fcf5e2001-09-14 16:08:44 +0000381 self.esmtp_features = {}
Guido van Rossumd8faa362007-04-27 19:54:29 +0000382 self.putcmd(self.ehlo_msg, name or self.local_hostname)
Guido van Rossumfcfb6321998-08-04 15:29:54 +0000383 (code,msg)=self.getreply()
Tim Peters495ad3c2001-01-15 01:36:40 +0000384 # According to RFC1869 some (badly written)
385 # MTA's will disconnect on an ehlo. Toss an exception if
Guido van Rossumfcfb6321998-08-04 15:29:54 +0000386 # that happens -ddm
387 if code == -1 and len(msg) == 0:
Barry Warsaw76750972001-12-14 20:34:20 +0000388 self.close()
Guido van Rossum40233ea1999-01-15 03:23:55 +0000389 raise SMTPServerDisconnected("Server not connected")
Guido van Rossum95e6f701998-06-25 02:15:50 +0000390 self.ehlo_resp=msg
Fred Drake8152d322000-12-12 23:20:45 +0000391 if code != 250:
Guido van Rossum296e1431999-04-07 15:03:39 +0000392 return (code,msg)
Guido van Rossumfcfb6321998-08-04 15:29:54 +0000393 self.does_esmtp=1
Thomas Wouters7e474022000-07-16 12:04:32 +0000394 #parse the ehlo response -ddm
Guido van Rossum04110fb2007-08-24 16:32:05 +0000395 assert isinstance(self.ehlo_resp, bytes), repr(self.ehlo_resp)
396 resp=self.ehlo_resp.decode("latin-1").split('\n')
Guido van Rossumfcfb6321998-08-04 15:29:54 +0000397 del resp[0]
Guido van Rossum2880f6e1998-08-10 20:07:00 +0000398 for each in resp:
Piers Lauder385a77a2002-07-27 00:38:30 +0000399 # To be able to communicate with as many SMTP servers as possible,
400 # we have to take the old-style auth advertisement into account,
401 # because:
402 # 1) Else our SMTP feature parser gets confused.
403 # 2) There are some servers that only advertise the auth methods we
404 # support using the old style.
405 auth_match = OLDSTYLE_AUTH.match(each)
406 if auth_match:
407 # This doesn't remove duplicates, but that's no problem
408 self.esmtp_features["auth"] = self.esmtp_features.get("auth", "") \
409 + " " + auth_match.groups(0)[0]
410 continue
411
Barry Warsawbe22ae62002-04-15 20:03:30 +0000412 # RFC 1869 requires a space between ehlo keyword and parameters.
413 # It's actually stricter, in that only spaces are allowed between
414 # parameters, but were not going to check for that here. Note
415 # that the space isn't present if there are no parameters.
416 m=re.match(r'(?P<feature>[A-Za-z0-9][A-Za-z0-9\-]*) ?',each)
Guido van Rossumfcfb6321998-08-04 15:29:54 +0000417 if m:
Eric S. Raymondc013f302001-02-09 05:40:38 +0000418 feature=m.group("feature").lower()
419 params=m.string[m.end("feature"):].strip()
Piers Lauder385a77a2002-07-27 00:38:30 +0000420 if feature == "auth":
421 self.esmtp_features[feature] = self.esmtp_features.get(feature, "") \
422 + " " + params
423 else:
424 self.esmtp_features[feature]=params
Guido van Rossum296e1431999-04-07 15:03:39 +0000425 return (code,msg)
Guido van Rossum95e6f701998-06-25 02:15:50 +0000426
Guido van Rossumfcfb6321998-08-04 15:29:54 +0000427 def has_extn(self, opt):
428 """Does the server support a given SMTP service extension?"""
Raymond Hettinger54f02222002-06-01 14:18:47 +0000429 return opt.lower() in self.esmtp_features
Guido van Rossum95e6f701998-06-25 02:15:50 +0000430
Guido van Rossum18586f41998-04-03 17:03:13 +0000431 def help(self, args=''):
Barry Warsawa7d9bdf1998-12-22 03:24:27 +0000432 """SMTP 'help' command.
433 Returns help text from server."""
Guido van Rossum18586f41998-04-03 17:03:13 +0000434 self.putcmd("help", args)
Kurt B. Kaiser58bd1902005-06-26 18:27:36 +0000435 return self.getreply()[1]
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000436
437 def rset(self):
Barry Warsawa7d9bdf1998-12-22 03:24:27 +0000438 """SMTP 'rset' command -- resets session."""
Guido van Rossum296e1431999-04-07 15:03:39 +0000439 return self.docmd("rset")
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000440
441 def noop(self):
Barry Warsawa7d9bdf1998-12-22 03:24:27 +0000442 """SMTP 'noop' command -- doesn't do anything :>"""
Guido van Rossum296e1431999-04-07 15:03:39 +0000443 return self.docmd("noop")
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000444
Guido van Rossum95e6f701998-06-25 02:15:50 +0000445 def mail(self,sender,options=[]):
Barry Warsawa7d9bdf1998-12-22 03:24:27 +0000446 """SMTP 'mail' command -- begins mail xfer session."""
Guido van Rossumfcfb6321998-08-04 15:29:54 +0000447 optionlist = ''
448 if options and self.does_esmtp:
Eric S. Raymondc013f302001-02-09 05:40:38 +0000449 optionlist = ' ' + ' '.join(options)
Guido van Rossumdb23d3d1999-06-09 15:13:10 +0000450 self.putcmd("mail", "FROM:%s%s" % (quoteaddr(sender) ,optionlist))
Guido van Rossum45e2fbc1998-03-26 21:13:24 +0000451 return self.getreply()
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000452
Guido van Rossumfcfb6321998-08-04 15:29:54 +0000453 def rcpt(self,recip,options=[]):
Barry Warsawa7d9bdf1998-12-22 03:24:27 +0000454 """SMTP 'rcpt' command -- indicates 1 recipient for this mail."""
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 Rossum348fd061999-01-14 04:18:46 +0000458 self.putcmd("rcpt","TO:%s%s" % (quoteaddr(recip),optionlist))
Guido van Rossum45e2fbc1998-03-26 21:13:24 +0000459 return self.getreply()
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000460
461 def data(self,msg):
Tim Peters495ad3c2001-01-15 01:36:40 +0000462 """SMTP 'DATA' command -- sends message data to server.
Guido van Rossum296e1431999-04-07 15:03:39 +0000463
Barry Warsaw4c4bec81998-12-22 03:02:20 +0000464 Automatically quotes lines beginning with a period per rfc821.
Guido van Rossum296e1431999-04-07 15:03:39 +0000465 Raises SMTPDataError if there is an unexpected reply to the
466 DATA command; the return value from this method is the final
467 response code received when the all data is sent.
Barry Warsaw4c4bec81998-12-22 03:02:20 +0000468 """
Guido van Rossum45e2fbc1998-03-26 21:13:24 +0000469 self.putcmd("data")
470 (code,repl)=self.getreply()
Guido van Rossumbe19ed72007-02-09 05:37:30 +0000471 if self.debuglevel >0 : print("data:", (code,repl), file=stderr)
Fred Drake8152d322000-12-12 23:20:45 +0000472 if code != 354:
Guido van Rossum296e1431999-04-07 15:03:39 +0000473 raise SMTPDataError(code,repl)
Guido van Rossum45e2fbc1998-03-26 21:13:24 +0000474 else:
Guido van Rossum20c92281999-04-21 16:52:20 +0000475 q = quotedata(msg)
476 if q[-2:] != CRLF:
477 q = q + CRLF
478 q = q + "." + CRLF
479 self.send(q)
Guido van Rossum45e2fbc1998-03-26 21:13:24 +0000480 (code,msg)=self.getreply()
Guido van Rossumbe19ed72007-02-09 05:37:30 +0000481 if self.debuglevel >0 : print("data:", (code,msg), file=stderr)
Guido van Rossum296e1431999-04-07 15:03:39 +0000482 return (code,msg)
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000483
Guido van Rossumfcfb6321998-08-04 15:29:54 +0000484 def verify(self, address):
Barry Warsawa7d9bdf1998-12-22 03:24:27 +0000485 """SMTP 'verify' command -- checks for address validity."""
Guido van Rossumfcfb6321998-08-04 15:29:54 +0000486 self.putcmd("vrfy", quoteaddr(address))
487 return self.getreply()
Barry Warsaw4c4bec81998-12-22 03:02:20 +0000488 # a.k.a.
489 vrfy=verify
Guido van Rossumfcfb6321998-08-04 15:29:54 +0000490
491 def expn(self, address):
Barry Warsawa7d9bdf1998-12-22 03:24:27 +0000492 """SMTP 'verify' command -- checks for address validity."""
Guido van Rossumfcfb6321998-08-04 15:29:54 +0000493 self.putcmd("expn", quoteaddr(address))
494 return self.getreply()
495
Barry Warsaw4c4bec81998-12-22 03:02:20 +0000496 # some useful methods
Guido van Rossumae010462001-09-11 15:57:46 +0000497
Christian Heimes679db4a2008-01-18 09:56:22 +0000498 def ehlo_or_helo_if_needed(self):
499 """Call self.ehlo() and/or self.helo() if needed.
500
501 If there has been no previous EHLO or HELO command this session, this
502 method tries ESMTP EHLO first.
503
504 This method may raise the following exceptions:
505
506 SMTPHeloError The server didn't reply properly to
507 the helo greeting.
508 """
509 if self.helo_resp is None and self.ehlo_resp is None:
510 if not (200 <= self.ehlo()[0] <= 299):
511 (code, resp) = self.helo()
512 if not (200 <= code <= 299):
513 raise SMTPHeloError(code, resp)
514
Guido van Rossumae010462001-09-11 15:57:46 +0000515 def login(self, user, password):
516 """Log in on an SMTP server that requires authentication.
517
518 The arguments are:
519 - user: The user name to authenticate with.
520 - password: The password for the authentication.
521
522 If there has been no previous EHLO or HELO command this session, this
523 method tries ESMTP EHLO first.
524
525 This method will return normally if the authentication was successful.
526
527 This method may raise the following exceptions:
528
529 SMTPHeloError The server didn't reply properly to
530 the helo greeting.
531 SMTPAuthenticationError The server didn't accept the username/
532 password combination.
Fred Drake2f8f4d32001-10-13 18:35:32 +0000533 SMTPException No suitable authentication method was
Guido van Rossumae010462001-09-11 15:57:46 +0000534 found.
535 """
536
537 def encode_cram_md5(challenge, user, password):
538 challenge = base64.decodestring(challenge)
539 response = user + " " + hmac.HMAC(password, challenge).hexdigest()
Barry Warsaw2cc1f6d2007-08-30 14:28:55 +0000540 return encode_base64(response)
Guido van Rossumae010462001-09-11 15:57:46 +0000541
542 def encode_plain(user, password):
Barry Warsaw2cc1f6d2007-08-30 14:28:55 +0000543 return encode_base64("\0%s\0%s" % (user, password))
Tim Peters469cdad2002-08-08 20:19:19 +0000544
Guido van Rossumae010462001-09-11 15:57:46 +0000545
546 AUTH_PLAIN = "PLAIN"
547 AUTH_CRAM_MD5 = "CRAM-MD5"
Piers Lauder385a77a2002-07-27 00:38:30 +0000548 AUTH_LOGIN = "LOGIN"
Guido van Rossumae010462001-09-11 15:57:46 +0000549
Christian Heimes679db4a2008-01-18 09:56:22 +0000550 self.ehlo_or_helo_if_needed()
Guido van Rossumae010462001-09-11 15:57:46 +0000551
552 if not self.has_extn("auth"):
553 raise SMTPException("SMTP AUTH extension not supported by server.")
554
555 # Authentication methods the server supports:
556 authlist = self.esmtp_features["auth"].split()
557
558 # List of authentication methods we support: from preferred to
559 # less preferred methods. Except for the purpose of testing the weaker
560 # ones, we prefer stronger methods like CRAM-MD5:
Piers Lauder385a77a2002-07-27 00:38:30 +0000561 preferred_auths = [AUTH_CRAM_MD5, AUTH_PLAIN, AUTH_LOGIN]
Guido van Rossumae010462001-09-11 15:57:46 +0000562
563 # Determine the authentication method we'll use
564 authmethod = None
565 for method in preferred_auths:
566 if method in authlist:
567 authmethod = method
568 break
Tim Petersb64bec32001-09-18 02:26:39 +0000569
Guido van Rossumae010462001-09-11 15:57:46 +0000570 if authmethod == AUTH_CRAM_MD5:
571 (code, resp) = self.docmd("AUTH", AUTH_CRAM_MD5)
572 if code == 503:
573 # 503 == 'Error: already authenticated'
574 return (code, resp)
575 (code, resp) = self.docmd(encode_cram_md5(resp, user, password))
576 elif authmethod == AUTH_PLAIN:
Tim Petersb64bec32001-09-18 02:26:39 +0000577 (code, resp) = self.docmd("AUTH",
Guido van Rossumae010462001-09-11 15:57:46 +0000578 AUTH_PLAIN + " " + encode_plain(user, password))
Piers Lauder385a77a2002-07-27 00:38:30 +0000579 elif authmethod == AUTH_LOGIN:
580 (code, resp) = self.docmd("AUTH",
Barry Warsaw2cc1f6d2007-08-30 14:28:55 +0000581 "%s %s" % (AUTH_LOGIN, encode_base64(user)))
Piers Lauder385a77a2002-07-27 00:38:30 +0000582 if code != 334:
583 raise SMTPAuthenticationError(code, resp)
Barry Warsaw2cc1f6d2007-08-30 14:28:55 +0000584 (code, resp) = self.docmd(encode_base64(password))
Raymond Hettinger7fdfc2d2002-05-31 17:49:10 +0000585 elif authmethod is None:
Fred Drake2f8f4d32001-10-13 18:35:32 +0000586 raise SMTPException("No suitable authentication method found.")
Raymond Hettingerdbecd932005-02-06 06:57:08 +0000587 if code not in (235, 503):
Guido van Rossumae010462001-09-11 15:57:46 +0000588 # 235 == 'Authentication successful'
589 # 503 == 'Error: already authenticated'
590 raise SMTPAuthenticationError(code, resp)
591 return (code, resp)
592
Guido van Rossumf7fcf5e2001-09-14 16:08:44 +0000593 def starttls(self, keyfile = None, certfile = None):
594 """Puts the connection to the SMTP server into TLS mode.
Tim Petersb64bec32001-09-18 02:26:39 +0000595
Christian Heimes679db4a2008-01-18 09:56:22 +0000596 If there has been no previous EHLO or HELO command this session, this
597 method tries ESMTP EHLO first.
598
Guido van Rossumf7fcf5e2001-09-14 16:08:44 +0000599 If the server supports TLS, this will encrypt the rest of the SMTP
600 session. If you provide the keyfile and certfile parameters,
601 the identity of the SMTP server and client can be checked. This,
602 however, depends on whether the socket module really checks the
603 certificates.
Christian Heimes679db4a2008-01-18 09:56:22 +0000604
605 This method may raise the following exceptions:
606
607 SMTPHeloError The server didn't reply properly to
608 the helo greeting.
Guido van Rossumf7fcf5e2001-09-14 16:08:44 +0000609 """
Christian Heimes679db4a2008-01-18 09:56:22 +0000610 self.ehlo_or_helo_if_needed()
611 if not self.has_extn("starttls"):
612 raise SMTPException("STARTTLS extension not supported by server.")
Tim Petersb64bec32001-09-18 02:26:39 +0000613 (resp, reply) = self.docmd("STARTTLS")
Guido van Rossumf7fcf5e2001-09-14 16:08:44 +0000614 if resp == 220:
Thomas Wouters47b49bf2007-08-30 22:15:33 +0000615 if not _have_ssl:
616 raise RuntimeError("No SSL support included in this Python")
Thomas Wouters1b7f8912007-09-19 03:06:30 +0000617 self.sock = ssl.wrap_socket(self.sock, keyfile, certfile)
Thomas Wouters47b49bf2007-08-30 22:15:33 +0000618 self.file = SSLFakeFile(self.sock)
Christian Heimes679db4a2008-01-18 09:56:22 +0000619 # RFC 3207:
620 # The client MUST discard any knowledge obtained from
621 # the server, such as the list of SMTP service extensions,
622 # which was not obtained from the TLS negotiation itself.
623 self.helo_resp = None
624 self.ehlo_resp = None
625 self.esmtp_features = {}
626 self.does_esmtp = 0
Guido van Rossumf7fcf5e2001-09-14 16:08:44 +0000627 return (resp, reply)
Tim Petersb64bec32001-09-18 02:26:39 +0000628
Jeremy Hylton31bb8ce1998-08-13 19:57:46 +0000629 def sendmail(self, from_addr, to_addrs, msg, mail_options=[],
Tim Peters495ad3c2001-01-15 01:36:40 +0000630 rcpt_options=[]):
631 """This command performs an entire mail transaction.
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000632
Tim Peters495ad3c2001-01-15 01:36:40 +0000633 The arguments are:
Barry Warsaw4c4bec81998-12-22 03:02:20 +0000634 - from_addr : The address sending this mail.
635 - to_addrs : A list of addresses to send this mail to. A bare
636 string will be treated as a list with 1 address.
Tim Peters495ad3c2001-01-15 01:36:40 +0000637 - msg : The message to send.
Barry Warsaw4c4bec81998-12-22 03:02:20 +0000638 - mail_options : List of ESMTP options (such as 8bitmime) for the
639 mail command.
640 - rcpt_options : List of ESMTP options (such as DSN commands) for
641 all the rcpt commands.
642
643 If there has been no previous EHLO or HELO command this session, this
644 method tries ESMTP EHLO first. If the server does ESMTP, message size
645 and each of the specified options will be passed to it. If EHLO
646 fails, HELO will be tried and ESMTP options suppressed.
647
648 This method will return normally if the mail is accepted for at least
Barry Warsawd25c1b71999-11-28 17:11:06 +0000649 one recipient. It returns a dictionary, with one entry for each
650 recipient that was refused. Each entry contains a tuple of the SMTP
651 error code and the accompanying error message sent by the server.
Guido van Rossum296e1431999-04-07 15:03:39 +0000652
653 This method may raise the following exceptions:
654
655 SMTPHeloError The server didn't reply properly to
Tim Peters495ad3c2001-01-15 01:36:40 +0000656 the helo greeting.
Barry Warsawd25c1b71999-11-28 17:11:06 +0000657 SMTPRecipientsRefused The server rejected ALL recipients
Guido van Rossum296e1431999-04-07 15:03:39 +0000658 (no mail was sent).
659 SMTPSenderRefused The server didn't accept the from_addr.
660 SMTPDataError The server replied with an unexpected
661 error code (other than a refusal of
662 a recipient).
663
664 Note: the connection will be open even after an exception is raised.
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000665
Guido van Rossum95e6f701998-06-25 02:15:50 +0000666 Example:
Tim Peters495ad3c2001-01-15 01:36:40 +0000667
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000668 >>> import smtplib
669 >>> s=smtplib.SMTP("localhost")
Guido van Rossumfc40a831998-01-29 17:26:45 +0000670 >>> tolist=["one@one.org","two@two.org","three@three.org","four@four.org"]
Martin v. Löwis301b1cd2002-07-28 16:52:01 +0000671 >>> msg = '''\\
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000672 ... From: Me@my.org
673 ... Subject: testin'...
674 ...
675 ... This is a test '''
676 >>> s.sendmail("me@my.org",tolist,msg)
677 { "three@three.org" : ( 550 ,"User unknown" ) }
678 >>> s.quit()
Tim Peters495ad3c2001-01-15 01:36:40 +0000679
Barry Warsaw4c4bec81998-12-22 03:02:20 +0000680 In the above example, the message was accepted for delivery to three
681 of the four addresses, and one was rejected, with the error code
Barry Warsawd25c1b71999-11-28 17:11:06 +0000682 550. If all addresses are accepted, then the method will return an
Barry Warsaw4c4bec81998-12-22 03:02:20 +0000683 empty dictionary.
684
685 """
Christian Heimes679db4a2008-01-18 09:56:22 +0000686 self.ehlo_or_helo_if_needed()
Guido van Rossum95e6f701998-06-25 02:15:50 +0000687 esmtp_opts = []
Guido van Rossumfcfb6321998-08-04 15:29:54 +0000688 if self.does_esmtp:
689 # Hmmm? what's this? -ddm
690 # self.esmtp_features['7bit']=""
691 if self.has_extn('size'):
Walter Dörwald70a6b492004-02-12 17:35:32 +0000692 esmtp_opts.append("size=%d" % len(msg))
Guido van Rossumfcfb6321998-08-04 15:29:54 +0000693 for option in mail_options:
Guido van Rossum95e6f701998-06-25 02:15:50 +0000694 esmtp_opts.append(option)
Guido van Rossumfcfb6321998-08-04 15:29:54 +0000695
Guido van Rossum95e6f701998-06-25 02:15:50 +0000696 (code,resp) = self.mail(from_addr, esmtp_opts)
Fred Drake8152d322000-12-12 23:20:45 +0000697 if code != 250:
Guido van Rossum45e2fbc1998-03-26 21:13:24 +0000698 self.rset()
Guido van Rossum296e1431999-04-07 15:03:39 +0000699 raise SMTPSenderRefused(code, resp, from_addr)
Guido van Rossum45e2fbc1998-03-26 21:13:24 +0000700 senderrs={}
Guido van Rossum3172c5d2007-10-16 18:12:55 +0000701 if isinstance(to_addrs, str):
Jeremy Hylton31bb8ce1998-08-13 19:57:46 +0000702 to_addrs = [to_addrs]
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000703 for each in to_addrs:
Guido van Rossumfcfb6321998-08-04 15:29:54 +0000704 (code,resp)=self.rcpt(each, rcpt_options)
Fred Drake8152d322000-12-12 23:20:45 +0000705 if (code != 250) and (code != 251):
Guido van Rossumfc40a831998-01-29 17:26:45 +0000706 senderrs[each]=(code,resp)
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000707 if len(senderrs)==len(to_addrs):
Guido van Rossum95e6f701998-06-25 02:15:50 +0000708 # the server refused all our recipients
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000709 self.rset()
Guido van Rossum296e1431999-04-07 15:03:39 +0000710 raise SMTPRecipientsRefused(senderrs)
Fred Drake8152d322000-12-12 23:20:45 +0000711 (code,resp) = self.data(msg)
712 if code != 250:
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000713 self.rset()
Guido van Rossum296e1431999-04-07 15:03:39 +0000714 raise SMTPDataError(code, resp)
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000715 #if we got here then somebody got our mail
Tim Peters495ad3c2001-01-15 01:36:40 +0000716 return senderrs
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000717
718
719 def close(self):
720 """Close the connection to the SMTP server."""
721 if self.file:
722 self.file.close()
723 self.file = None
724 if self.sock:
725 self.sock.close()
726 self.sock = None
727
728
729 def quit(self):
Guido van Rossum95e6f701998-06-25 02:15:50 +0000730 """Terminate the SMTP session."""
Guido van Rossum45e2fbc1998-03-26 21:13:24 +0000731 self.docmd("quit")
732 self.close()
Guido van Rossum95e6f701998-06-25 02:15:50 +0000733
Thomas Wouters47b49bf2007-08-30 22:15:33 +0000734if _have_ssl:
Thomas Wouters89f507f2006-12-13 04:49:30 +0000735
Thomas Wouters47b49bf2007-08-30 22:15:33 +0000736 class SMTP_SSL(SMTP):
737 """ This is a subclass derived from SMTP that connects over an SSL encrypted
738 socket (to use this class you need a socket module that was compiled with SSL
739 support). If host is not specified, '' (the local host) is used. If port is
740 omitted, the standard SMTP-over-SSL port (465) is used. keyfile and certfile
741 are also optional - they can contain a PEM formatted private key and
742 certificate chain file for the SSL connection.
743 """
744 def __init__(self, host='', port=0, local_hostname=None,
745 keyfile=None, certfile=None, timeout=None):
746 self.keyfile = keyfile
747 self.certfile = certfile
748 SMTP.__init__(self, host, port, local_hostname, timeout)
749 self.default_port = SMTP_SSL_PORT
750
751 def _get_socket(self, host, port, timeout):
752 if self.debuglevel > 0: print('connect:', (host, port), file=stderr)
753 self.sock = socket.create_connection((host, port), timeout)
Thomas Wouters1b7f8912007-09-19 03:06:30 +0000754 self.sock = ssl.wrap_socket(self.sock, self.keyfile, self.certfile)
Thomas Wouters89d996e2007-09-08 17:39:28 +0000755 self.file = SSLFakeFile(self.sock)
Thomas Wouters47b49bf2007-08-30 22:15:33 +0000756
757 __all__.append("SMTP_SSL")
Barry Warsaw4c4bec81998-12-22 03:02:20 +0000758
Guido van Rossumd8faa362007-04-27 19:54:29 +0000759#
760# LMTP extension
761#
762LMTP_PORT = 2003
763
764class LMTP(SMTP):
765 """LMTP - Local Mail Transfer Protocol
766
767 The LMTP protocol, which is very similar to ESMTP, is heavily based
768 on the standard SMTP client. It's common to use Unix sockets for LMTP,
769 so our connect() method must support that as well as a regular
770 host:port server. To specify a Unix socket, you must use an absolute
771 path as the host, starting with a '/'.
772
773 Authentication is supported, using the regular SMTP mechanism. When
774 using a Unix socket, LMTP generally don't support or require any
775 authentication, but your mileage might vary."""
776
777 ehlo_msg = "lhlo"
778
779 def __init__(self, host = '', port = LMTP_PORT, local_hostname = None):
780 """Initialize a new instance."""
781 SMTP.__init__(self, host, port, local_hostname)
782
783 def connect(self, host = 'localhost', port = 0):
784 """Connect to the LMTP daemon, on either a Unix or a TCP socket."""
785 if host[0] != '/':
786 return SMTP.connect(self, host, port)
787
788 # Handle Unix-domain sockets.
789 try:
790 self.sock = socket.socket(socket.AF_UNIX, socket.SOCK_STREAM)
791 self.sock.connect(host)
792 except socket.error as msg:
793 if self.debuglevel > 0: print>>stderr, 'connect fail:', host
794 if self.sock:
795 self.sock.close()
796 self.sock = None
797 raise socket.error(msg)
798 (code, msg) = self.getreply()
799 if self.debuglevel > 0: print>>stderr, "connect:", msg
800 return (code, msg)
801
802
Guido van Rossum95e6f701998-06-25 02:15:50 +0000803# Test the sendmail method, which tests most of the others.
804# Note: This always sends to localhost.
805if __name__ == '__main__':
Andrew M. Kuchling6be424f2001-08-13 14:41:39 +0000806 import sys
Guido van Rossum95e6f701998-06-25 02:15:50 +0000807
808 def prompt(prompt):
809 sys.stdout.write(prompt + ": ")
Eric S. Raymondc013f302001-02-09 05:40:38 +0000810 return sys.stdin.readline().strip()
Guido van Rossum95e6f701998-06-25 02:15:50 +0000811
812 fromaddr = prompt("From")
Eric S. Raymond38151ed2001-02-09 07:40:17 +0000813 toaddrs = prompt("To").split(',')
Guido van Rossumbe19ed72007-02-09 05:37:30 +0000814 print("Enter message, end with ^D:")
Guido van Rossum95e6f701998-06-25 02:15:50 +0000815 msg = ''
816 while 1:
817 line = sys.stdin.readline()
818 if not line:
819 break
820 msg = msg + line
Guido van Rossumbe19ed72007-02-09 05:37:30 +0000821 print("Message length is %d" % len(msg))
Guido van Rossum95e6f701998-06-25 02:15:50 +0000822
823 server = SMTP('localhost')
824 server.set_debuglevel(1)
825 server.sendmail(fromaddr, toaddrs, msg)
826 server.quit()