blob: a3213b33d715e54e42fec490d79759568b36501a [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
Giampaolo Rodolà5c12ec62011-02-24 20:43:11 +000052__all__ = ["SMTPException", "SMTPServerDisconnected", "SMTPResponseException",
53 "SMTPSenderRefused", "SMTPRecipientsRefused", "SMTPDataError",
54 "SMTPConnectError", "SMTPHeloError", "SMTPAuthenticationError",
55 "quoteaddr", "quotedata", "SMTP"]
Skip Montanaro0de65802001-02-15 22:15:14 +000056
Guido van Rossumbbe323e1998-01-29 17:24:40 +000057SMTP_PORT = 25
Martin v. Löwisee82c0e2006-10-27 07:13:28 +000058SMTP_SSL_PORT = 465
Giampaolo Rodolà5c12ec62011-02-24 20:43:11 +000059CRLF = "\r\n"
Guido van Rossumbbe323e1998-01-29 17:24:40 +000060
Piers Lauder385a77a2002-07-27 00:38:30 +000061OLDSTYLE_AUTH = re.compile(r"auth=(.*)", re.I)
62
Giampaolo Rodolà5c12ec62011-02-24 20:43:11 +000063
Tim Peters495ad3c2001-01-15 01:36:40 +000064# Exception classes used by this module.
Guido van Rossum296e1431999-04-07 15:03:39 +000065class SMTPException(Exception):
66 """Base class for all exceptions raised by this module."""
67
68class SMTPServerDisconnected(SMTPException):
69 """Not connected to any SMTP server.
70
71 This exception is raised when the server unexpectedly disconnects,
72 or when an attempt is made to use the SMTP instance before
73 connecting it to a server.
74 """
75
76class SMTPResponseException(SMTPException):
77 """Base class for all exceptions that include an SMTP error code.
78
79 These exceptions are generated in some instances when the SMTP
80 server returns an error code. The error code is stored in the
81 `smtp_code' attribute of the error, and the `smtp_error' attribute
82 is set to the error message.
83 """
84
85 def __init__(self, code, msg):
86 self.smtp_code = code
87 self.smtp_error = msg
88 self.args = (code, msg)
89
90class SMTPSenderRefused(SMTPResponseException):
91 """Sender address refused.
Guido van Rossumae010462001-09-11 15:57:46 +000092
Guido van Rossum296e1431999-04-07 15:03:39 +000093 In addition to the attributes set by on all SMTPResponseException
Barry Warsawd25c1b71999-11-28 17:11:06 +000094 exceptions, this sets `sender' to the string that the SMTP refused.
Guido van Rossum296e1431999-04-07 15:03:39 +000095 """
96
97 def __init__(self, code, msg, sender):
98 self.smtp_code = code
99 self.smtp_error = msg
100 self.sender = sender
101 self.args = (code, msg, sender)
102
Guido van Rossum20c92281999-04-21 16:52:20 +0000103class SMTPRecipientsRefused(SMTPException):
Barry Warsawd25c1b71999-11-28 17:11:06 +0000104 """All recipient addresses refused.
Guido van Rossumae010462001-09-11 15:57:46 +0000105
Thomas Wouters7e474022000-07-16 12:04:32 +0000106 The errors for each recipient are accessible through the attribute
Tim Peters495ad3c2001-01-15 01:36:40 +0000107 'recipients', which is a dictionary of exactly the same sort as
108 SMTP.sendmail() returns.
Guido van Rossum296e1431999-04-07 15:03:39 +0000109 """
110
111 def __init__(self, recipients):
112 self.recipients = recipients
Giampaolo Rodolà5c12ec62011-02-24 20:43:11 +0000113 self.args = (recipients,)
Guido van Rossum296e1431999-04-07 15:03:39 +0000114
115
Guido van Rossum296e1431999-04-07 15:03:39 +0000116class SMTPDataError(SMTPResponseException):
117 """The SMTP server didn't accept the data."""
118
119class SMTPConnectError(SMTPResponseException):
Barry Warsawd25c1b71999-11-28 17:11:06 +0000120 """Error during connection establishment."""
Guido van Rossum296e1431999-04-07 15:03:39 +0000121
122class SMTPHeloError(SMTPResponseException):
Barry Warsawd25c1b71999-11-28 17:11:06 +0000123 """The server refused our HELO reply."""
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000124
Guido van Rossumae010462001-09-11 15:57:46 +0000125class SMTPAuthenticationError(SMTPResponseException):
126 """Authentication error.
127
128 Most probably the server didn't accept the username/password
129 combination provided.
130 """
Peter Schneider-Kamp7bc82bb2000-08-10 14:02:23 +0000131
Giampaolo Rodolà5c12ec62011-02-24 20:43:11 +0000132
Guido van Rossum69a79bc1998-07-13 15:18:49 +0000133def quoteaddr(addr):
134 """Quote a subset of the email addresses defined by RFC 821.
135
Barry Warsawa7d9bdf1998-12-22 03:24:27 +0000136 Should be able to handle anything rfc822.parseaddr can handle.
137 """
Raymond Hettinger342456d2002-09-05 01:14:07 +0000138 m = (None, None)
Guido van Rossum69a79bc1998-07-13 15:18:49 +0000139 try:
Georg Brandl5a096e12007-01-22 19:40:21 +0000140 m = email.utils.parseaddr(addr)[1]
Guido van Rossumfcfb6321998-08-04 15:29:54 +0000141 except AttributeError:
142 pass
Giampaolo Rodolà5c12ec62011-02-24 20:43:11 +0000143 if m == (None, None): # Indicates parse failure or AttributeError
Georg Brandlbd3bc4d2006-02-17 09:52:53 +0000144 # something weird here.. punt -ddm
Raymond Hettinger342456d2002-09-05 01:14:07 +0000145 return "<%s>" % addr
Georg Brandlbd3bc4d2006-02-17 09:52:53 +0000146 elif m is None:
147 # the sender wants an empty return address
148 return "<>"
Guido van Rossumfcfb6321998-08-04 15:29:54 +0000149 else:
150 return "<%s>" % m
Guido van Rossum69a79bc1998-07-13 15:18:49 +0000151
R David Murray95225952011-07-18 21:34:04 -0400152def _addr_only(addrstring):
153 displayname, addr = email.utils.parseaddr(addrstring)
154 if (displayname, addr) == ('', ''):
155 # parseaddr couldn't parse it, so use it as is.
156 return addrstring
157 return addr
158
Guido van Rossum69a79bc1998-07-13 15:18:49 +0000159def quotedata(data):
160 """Quote data for email.
161
Barry Warsawd25c1b71999-11-28 17:11:06 +0000162 Double leading '.', and change Unix newline '\\n', or Mac '\\r' into
Barry Warsawa7d9bdf1998-12-22 03:24:27 +0000163 Internet CRLF end-of-line.
164 """
Guido van Rossum69a79bc1998-07-13 15:18:49 +0000165 return re.sub(r'(?m)^\.', '..',
Guido van Rossumfcfb6321998-08-04 15:29:54 +0000166 re.sub(r'(?:\r\n|\n|\r(?!\n))', CRLF, data))
Guido van Rossum69a79bc1998-07-13 15:18:49 +0000167
Peter Schneider-Kamp7bc82bb2000-08-10 14:02:23 +0000168
Bill Janssen426ea0a2007-08-29 22:35:05 +0000169try:
170 import ssl
171except ImportError:
172 _have_ssl = False
173else:
Bill Janssen426ea0a2007-08-29 22:35:05 +0000174 class SSLFakeFile:
175 """A fake file like object that really wraps a SSLObject.
176
177 It only supports what is needed in smtplib.
178 """
179 def __init__(self, sslobj):
180 self.sslobj = sslobj
181
182 def readline(self):
183 str = ""
184 chr = None
185 while chr != "\n":
186 chr = self.sslobj.read(1)
Giampaolo Rodolà5c12ec62011-02-24 20:43:11 +0000187 if not chr:
188 break
Bill Janssen426ea0a2007-08-29 22:35:05 +0000189 str += chr
190 return str
191
192 def close(self):
193 pass
194
195 _have_ssl = True
196
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
Antoine Pitrou21ce8f02011-05-07 19:59:33 +0200232 default_port = SMTP_PORT
Guido van Rossum95e6f701998-06-25 02:15:50 +0000233
Facundo Batista4f1b1ed2008-05-29 16:39:26 +0000234 def __init__(self, host='', port=0, local_hostname=None,
235 timeout=socket._GLOBAL_DEFAULT_TIMEOUT):
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000236 """Initialize a new instance.
237
Barry Warsawa7d9bdf1998-12-22 03:24:27 +0000238 If specified, `host' is the name of the remote host to which to
239 connect. If specified, `port' specifies the port to which to connect.
R David Murray2fc97e62013-04-13 14:37:22 -0400240 By default, smtplib.SMTP_PORT is used. If a host is specified the
241 connect method is called, and if it returns anything other than
242 a success code an SMTPConnectError is raised. If specified,
Tim Peters863ac442002-04-16 01:38:40 +0000243 `local_hostname` is used as the FQDN of the local host. By default,
244 the local hostname is found using socket.getfqdn().
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000245
246 """
Facundo Batista366d6262007-03-28 18:25:54 +0000247 self.timeout = timeout
Guido van Rossumfcfb6321998-08-04 15:29:54 +0000248 self.esmtp_features = {}
Guido van Rossum296e1431999-04-07 15:03:39 +0000249 if host:
250 (code, msg) = self.connect(host, port)
251 if code != 220:
252 raise SMTPConnectError(code, msg)
Raymond Hettingerf13eb552002-06-02 00:40:05 +0000253 if local_hostname is not None:
Barry Warsaw13e34f72002-03-26 20:27:35 +0000254 self.local_hostname = local_hostname
Neil Schemenauer6730f262002-03-24 15:30:40 +0000255 else:
Barry Warsaw13e34f72002-03-26 20:27:35 +0000256 # RFC 2821 says we should use the fqdn in the EHLO/HELO verb, and
257 # if that can't be calculated, that we should use a domain literal
258 # instead (essentially an encoded IP address like [A.B.C.D]).
259 fqdn = socket.getfqdn()
260 if '.' in fqdn:
261 self.local_hostname = fqdn
262 else:
263 # We can't find an fqdn hostname, so use a domain literal
Georg Brandldcdfd222006-03-31 19:34:13 +0000264 addr = '127.0.0.1'
265 try:
266 addr = socket.gethostbyname(socket.gethostname())
267 except socket.gaierror:
268 pass
Barry Warsaw13e34f72002-03-26 20:27:35 +0000269 self.local_hostname = '[%s]' % addr
Tim Peters495ad3c2001-01-15 01:36:40 +0000270
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000271 def set_debuglevel(self, debuglevel):
272 """Set the debug output level.
273
Barry Warsawa7d9bdf1998-12-22 03:24:27 +0000274 A non-false value results in debug messages for connection and for all
275 messages sent to and received from the server.
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000276
277 """
278 self.debuglevel = debuglevel
279
R David Murrayc993a192013-04-02 12:15:07 -0400280 def _get_socket(self, host, port, timeout):
Martin v. Löwisee82c0e2006-10-27 07:13:28 +0000281 # This makes it simpler for SMTP_SSL to use the SMTP connect code
282 # and just alter the socket connection bit.
Giampaolo Rodolà5c12ec62011-02-24 20:43:11 +0000283 if self.debuglevel > 0:
284 print>>stderr, 'connect:', (host, port)
R David Murrayc993a192013-04-02 12:15:07 -0400285 return socket.create_connection((host, port), timeout)
Martin v. Löwisee82c0e2006-10-27 07:13:28 +0000286
Giampaolo Rodolà5c12ec62011-02-24 20:43:11 +0000287 def connect(self, host='localhost', port=0):
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000288 """Connect to a host on a given port.
Guido van Rossum95e6f701998-06-25 02:15:50 +0000289
Barry Warsaw4c4bec81998-12-22 03:02:20 +0000290 If the hostname ends with a colon (`:') followed by a number, and
291 there is no port specified, that suffix will be stripped off and the
292 number interpreted as the port number to use.
Guido van Rossum95e6f701998-06-25 02:15:50 +0000293
Barry Warsawa7d9bdf1998-12-22 03:24:27 +0000294 Note: This method is automatically invoked by __init__, if a host is
295 specified during instantiation.
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000296
297 """
Martin v. Löwis4eb59402001-07-26 13:37:33 +0000298 if not port and (host.find(':') == host.rfind(':')):
Martin v. Löwisa43c2f82001-07-24 20:34:08 +0000299 i = host.rfind(':')
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000300 if i >= 0:
Giampaolo Rodolà5c12ec62011-02-24 20:43:11 +0000301 host, port = host[:i], host[i + 1:]
302 try:
303 port = int(port)
Eric S. Raymond8d876032001-02-09 10:14:53 +0000304 except ValueError:
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000305 raise socket.error, "nonnumeric port"
Giampaolo Rodolà5c12ec62011-02-24 20:43:11 +0000306 if not port:
307 port = self.default_port
308 if self.debuglevel > 0:
309 print>>stderr, 'connect:', (host, port)
Facundo Batista366d6262007-03-28 18:25:54 +0000310 self.sock = self._get_socket(host, port, self.timeout)
Martin v. Löwisa43c2f82001-07-24 20:34:08 +0000311 (code, msg) = self.getreply()
Giampaolo Rodolà5c12ec62011-02-24 20:43:11 +0000312 if self.debuglevel > 0:
313 print>>stderr, "connect:", msg
Martin v. Löwisa43c2f82001-07-24 20:34:08 +0000314 return (code, msg)
Tim Peters495ad3c2001-01-15 01:36:40 +0000315
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000316 def send(self, str):
317 """Send `str' to the server."""
Giampaolo Rodolà5c12ec62011-02-24 20:43:11 +0000318 if self.debuglevel > 0:
319 print>>stderr, 'send:', repr(str)
Facundo Batista16609332008-02-23 12:27:17 +0000320 if hasattr(self, 'sock') and self.sock:
Guido van Rossum2880f6e1998-08-10 20:07:00 +0000321 try:
Martin v. Löwise12454f2002-02-16 23:06:19 +0000322 self.sock.sendall(str)
Guido van Rossum2880f6e1998-08-10 20:07:00 +0000323 except socket.error:
Barry Warsaw76750972001-12-14 20:34:20 +0000324 self.close()
Guido van Rossum40233ea1999-01-15 03:23:55 +0000325 raise SMTPServerDisconnected('Server not connected')
Guido van Rossumfc40a831998-01-29 17:26:45 +0000326 else:
Guido van Rossum40233ea1999-01-15 03:23:55 +0000327 raise SMTPServerDisconnected('please run connect() first')
Tim Peters495ad3c2001-01-15 01:36:40 +0000328
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000329 def putcmd(self, cmd, args=""):
Barry Warsawa7d9bdf1998-12-22 03:24:27 +0000330 """Send a command to the server."""
Guido van Rossumdb23d3d1999-06-09 15:13:10 +0000331 if args == "":
332 str = '%s%s' % (cmd, CRLF)
333 else:
334 str = '%s %s%s' % (cmd, args, CRLF)
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000335 self.send(str)
Tim Peters495ad3c2001-01-15 01:36:40 +0000336
Guido van Rossumfcfb6321998-08-04 15:29:54 +0000337 def getreply(self):
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000338 """Get a reply from the server.
Tim Peters495ad3c2001-01-15 01:36:40 +0000339
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000340 Returns a tuple consisting of:
Barry Warsawa7d9bdf1998-12-22 03:24:27 +0000341
342 - server response code (e.g. '250', or such, if all goes well)
343 Note: returns -1 if it can't read response code.
344
345 - server response string corresponding to response code (multiline
346 responses are converted to a single, multiline string).
Guido van Rossumf123f841999-03-29 20:33:21 +0000347
348 Raises SMTPServerDisconnected if end-of-file is reached.
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000349 """
Giampaolo Rodolà5c12ec62011-02-24 20:43:11 +0000350 resp = []
Guido van Rossum296e1431999-04-07 15:03:39 +0000351 if self.file is None:
352 self.file = self.sock.makefile('rb')
Guido van Rossum45e2fbc1998-03-26 21:13:24 +0000353 while 1:
Kristján Valur Jónsson51a035e2009-01-15 17:20:21 +0000354 try:
355 line = self.file.readline()
Antoine Pitrou0ad73582011-08-28 01:18:31 +0200356 except socket.error as e:
357 self.close()
358 raise SMTPServerDisconnected("Connection unexpectedly closed: "
359 + str(e))
Guido van Rossum296e1431999-04-07 15:03:39 +0000360 if line == '':
361 self.close()
362 raise SMTPServerDisconnected("Connection unexpectedly closed")
Giampaolo Rodolà5c12ec62011-02-24 20:43:11 +0000363 if self.debuglevel > 0:
364 print>>stderr, 'reply:', repr(line)
Eric S. Raymondc013f302001-02-09 05:40:38 +0000365 resp.append(line[4:].strip())
Giampaolo Rodolà5c12ec62011-02-24 20:43:11 +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.
Giampaolo Rodolà5c12ec62011-02-24 20:43:11 +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:
Giampaolo Rodolà5c12ec62011-02-24 20:43:11 +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."""
Giampaolo Rodolà5c12ec62011-02-24 20:43:11 +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)
Giampaolo Rodolà5c12ec62011-02-24 20:43:11 +0000395 (code, msg) = self.getreply()
396 self.helo_resp = msg
397 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)
Giampaolo Rodolà5c12ec62011-02-24 20:43:11 +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")
Giampaolo Rodolà5c12ec62011-02-24 20:43:11 +0000413 self.ehlo_resp = msg
Fred Drake8152d322000-12-12 23:20:45 +0000414 if code != 250:
Giampaolo Rodolà5c12ec62011-02-24 20:43:11 +0000415 return (code, msg)
416 self.does_esmtp = 1
Thomas Wouters7e474022000-07-16 12:04:32 +0000417 #parse the ehlo response -ddm
Giampaolo Rodolà5c12ec62011-02-24 20:43:11 +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.
Giampaolo Rodolà5c12ec62011-02-24 20:43:11 +0000438 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:
Giampaolo Rodolà5c12ec62011-02-24 20:43:11 +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:
Giampaolo Rodolà5c12ec62011-02-24 20:43:11 +0000446 self.esmtp_features[feature] = params
447 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
Giampaolo Rodolà5c12ec62011-02-24 20:43:11 +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)
Giampaolo Rodolà5c12ec62011-02-24 20:43:11 +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
Giampaolo Rodolà5c12ec62011-02-24 20:43:11 +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)
Giampaolo Rodolà5c12ec62011-02-24 20:43:11 +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
Giampaolo Rodolà5c12ec62011-02-24 20:43:11 +0000483 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")
Giampaolo Rodolà5c12ec62011-02-24 20:43:11 +0000492 (code, repl) = self.getreply()
493 if self.debuglevel > 0:
494 print>>stderr, "data:", (code, repl)
Fred Drake8152d322000-12-12 23:20:45 +0000495 if code != 354:
Giampaolo Rodolà5c12ec62011-02-24 20:43:11 +0000496 raise SMTPDataError(code, repl)
Guido van Rossum45e2fbc1998-03-26 21:13:24 +0000497 else:
Guido van Rossum20c92281999-04-21 16:52:20 +0000498 q = quotedata(msg)
499 if q[-2:] != CRLF:
500 q = q + CRLF
501 q = q + "." + CRLF
502 self.send(q)
Giampaolo Rodolà5c12ec62011-02-24 20:43:11 +0000503 (code, msg) = self.getreply()
504 if self.debuglevel > 0:
505 print>>stderr, "data:", (code, msg)
506 return (code, msg)
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000507
Guido van Rossumfcfb6321998-08-04 15:29:54 +0000508 def verify(self, address):
Barry Warsawa7d9bdf1998-12-22 03:24:27 +0000509 """SMTP 'verify' command -- checks for address validity."""
R David Murray95225952011-07-18 21:34:04 -0400510 self.putcmd("vrfy", _addr_only(address))
Guido van Rossumfcfb6321998-08-04 15:29:54 +0000511 return self.getreply()
Barry Warsaw4c4bec81998-12-22 03:02:20 +0000512 # a.k.a.
Giampaolo Rodolà5c12ec62011-02-24 20:43:11 +0000513 vrfy = verify
Guido van Rossumfcfb6321998-08-04 15:29:54 +0000514
515 def expn(self, address):
Facundo Batista16609332008-02-23 12:27:17 +0000516 """SMTP 'expn' command -- expands a mailing list."""
R David Murray95225952011-07-18 21:34:04 -0400517 self.putcmd("expn", _addr_only(address))
Guido van Rossumfcfb6321998-08-04 15:29:54 +0000518 return self.getreply()
519
Barry Warsaw4c4bec81998-12-22 03:02:20 +0000520 # some useful methods
Guido van Rossumae010462001-09-11 15:57:46 +0000521
Gregory P. Smithbde4ae42008-01-17 08:35:49 +0000522 def ehlo_or_helo_if_needed(self):
523 """Call self.ehlo() and/or self.helo() if needed.
524
525 If there has been no previous EHLO or HELO command this session, this
526 method tries ESMTP EHLO first.
527
528 This method may raise the following exceptions:
529
530 SMTPHeloError The server didn't reply properly to
531 the helo greeting.
532 """
533 if self.helo_resp is None and self.ehlo_resp is None:
534 if not (200 <= self.ehlo()[0] <= 299):
535 (code, resp) = self.helo()
536 if not (200 <= code <= 299):
537 raise SMTPHeloError(code, resp)
538
Guido van Rossumae010462001-09-11 15:57:46 +0000539 def login(self, user, password):
540 """Log in on an SMTP server that requires authentication.
541
542 The arguments are:
543 - user: The user name to authenticate with.
544 - password: The password for the authentication.
545
546 If there has been no previous EHLO or HELO command this session, this
547 method tries ESMTP EHLO first.
548
549 This method will return normally if the authentication was successful.
550
551 This method may raise the following exceptions:
552
553 SMTPHeloError The server didn't reply properly to
554 the helo greeting.
555 SMTPAuthenticationError The server didn't accept the username/
556 password combination.
Fred Drake2f8f4d32001-10-13 18:35:32 +0000557 SMTPException No suitable authentication method was
Guido van Rossumae010462001-09-11 15:57:46 +0000558 found.
559 """
560
561 def encode_cram_md5(challenge, user, password):
562 challenge = base64.decodestring(challenge)
563 response = user + " " + hmac.HMAC(password, challenge).hexdigest()
Piers Lauder385a77a2002-07-27 00:38:30 +0000564 return encode_base64(response, eol="")
Guido van Rossumae010462001-09-11 15:57:46 +0000565
566 def encode_plain(user, password):
Johannes Gijsbers25946dd2004-12-06 21:25:26 +0000567 return encode_base64("\0%s\0%s" % (user, password), eol="")
Tim Peters469cdad2002-08-08 20:19:19 +0000568
Guido van Rossumae010462001-09-11 15:57:46 +0000569
570 AUTH_PLAIN = "PLAIN"
571 AUTH_CRAM_MD5 = "CRAM-MD5"
Piers Lauder385a77a2002-07-27 00:38:30 +0000572 AUTH_LOGIN = "LOGIN"
Guido van Rossumae010462001-09-11 15:57:46 +0000573
Gregory P. Smithbde4ae42008-01-17 08:35:49 +0000574 self.ehlo_or_helo_if_needed()
Guido van Rossumae010462001-09-11 15:57:46 +0000575
576 if not self.has_extn("auth"):
577 raise SMTPException("SMTP AUTH extension not supported by server.")
578
579 # Authentication methods the server supports:
580 authlist = self.esmtp_features["auth"].split()
581
582 # List of authentication methods we support: from preferred to
583 # less preferred methods. Except for the purpose of testing the weaker
584 # ones, we prefer stronger methods like CRAM-MD5:
Piers Lauder385a77a2002-07-27 00:38:30 +0000585 preferred_auths = [AUTH_CRAM_MD5, AUTH_PLAIN, AUTH_LOGIN]
Guido van Rossumae010462001-09-11 15:57:46 +0000586
587 # Determine the authentication method we'll use
588 authmethod = None
589 for method in preferred_auths:
590 if method in authlist:
591 authmethod = method
592 break
Tim Petersb64bec32001-09-18 02:26:39 +0000593
Guido van Rossumae010462001-09-11 15:57:46 +0000594 if authmethod == AUTH_CRAM_MD5:
595 (code, resp) = self.docmd("AUTH", AUTH_CRAM_MD5)
596 if code == 503:
597 # 503 == 'Error: already authenticated'
598 return (code, resp)
599 (code, resp) = self.docmd(encode_cram_md5(resp, user, password))
600 elif authmethod == AUTH_PLAIN:
Tim Petersb64bec32001-09-18 02:26:39 +0000601 (code, resp) = self.docmd("AUTH",
Guido van Rossumae010462001-09-11 15:57:46 +0000602 AUTH_PLAIN + " " + encode_plain(user, password))
Piers Lauder385a77a2002-07-27 00:38:30 +0000603 elif authmethod == AUTH_LOGIN:
604 (code, resp) = self.docmd("AUTH",
605 "%s %s" % (AUTH_LOGIN, encode_base64(user, eol="")))
606 if code != 334:
607 raise SMTPAuthenticationError(code, resp)
Martin v. Löwis49c05d32002-10-06 17:55:08 +0000608 (code, resp) = self.docmd(encode_base64(password, eol=""))
Raymond Hettinger7fdfc2d2002-05-31 17:49:10 +0000609 elif authmethod is None:
Fred Drake2f8f4d32001-10-13 18:35:32 +0000610 raise SMTPException("No suitable authentication method found.")
Raymond Hettingerdbecd932005-02-06 06:57:08 +0000611 if code not in (235, 503):
Guido van Rossumae010462001-09-11 15:57:46 +0000612 # 235 == 'Authentication successful'
613 # 503 == 'Error: already authenticated'
614 raise SMTPAuthenticationError(code, resp)
615 return (code, resp)
616
Giampaolo Rodolà5c12ec62011-02-24 20:43:11 +0000617 def starttls(self, keyfile=None, certfile=None):
Guido van Rossumf7fcf5e2001-09-14 16:08:44 +0000618 """Puts the connection to the SMTP server into TLS mode.
Tim Petersb64bec32001-09-18 02:26:39 +0000619
Gregory P. Smithbde4ae42008-01-17 08:35:49 +0000620 If there has been no previous EHLO or HELO command this session, this
621 method tries ESMTP EHLO first.
622
Guido van Rossumf7fcf5e2001-09-14 16:08:44 +0000623 If the server supports TLS, this will encrypt the rest of the SMTP
624 session. If you provide the keyfile and certfile parameters,
625 the identity of the SMTP server and client can be checked. This,
626 however, depends on whether the socket module really checks the
627 certificates.
Gregory P. Smithbde4ae42008-01-17 08:35:49 +0000628
629 This method may raise the following exceptions:
630
631 SMTPHeloError The server didn't reply properly to
632 the helo greeting.
Guido van Rossumf7fcf5e2001-09-14 16:08:44 +0000633 """
Gregory P. Smithbde4ae42008-01-17 08:35:49 +0000634 self.ehlo_or_helo_if_needed()
635 if not self.has_extn("starttls"):
636 raise SMTPException("STARTTLS extension not supported by server.")
Tim Petersb64bec32001-09-18 02:26:39 +0000637 (resp, reply) = self.docmd("STARTTLS")
Guido van Rossumf7fcf5e2001-09-14 16:08:44 +0000638 if resp == 220:
Bill Janssen426ea0a2007-08-29 22:35:05 +0000639 if not _have_ssl:
640 raise RuntimeError("No SSL support included in this Python")
Bill Janssen98d19da2007-09-10 21:51:02 +0000641 self.sock = ssl.wrap_socket(self.sock, keyfile, certfile)
Bill Janssen426ea0a2007-08-29 22:35:05 +0000642 self.file = SSLFakeFile(self.sock)
Gregory P. Smith63bfc1d2008-01-17 07:43:20 +0000643 # RFC 3207:
644 # The client MUST discard any knowledge obtained from
645 # the server, such as the list of SMTP service extensions,
646 # which was not obtained from the TLS negotiation itself.
647 self.helo_resp = None
648 self.ehlo_resp = None
649 self.esmtp_features = {}
650 self.does_esmtp = 0
Guido van Rossumf7fcf5e2001-09-14 16:08:44 +0000651 return (resp, reply)
Tim Petersb64bec32001-09-18 02:26:39 +0000652
Jeremy Hylton31bb8ce1998-08-13 19:57:46 +0000653 def sendmail(self, from_addr, to_addrs, msg, mail_options=[],
Tim Peters495ad3c2001-01-15 01:36:40 +0000654 rcpt_options=[]):
655 """This command performs an entire mail transaction.
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000656
Tim Peters495ad3c2001-01-15 01:36:40 +0000657 The arguments are:
Barry Warsaw4c4bec81998-12-22 03:02:20 +0000658 - from_addr : The address sending this mail.
659 - to_addrs : A list of addresses to send this mail to. A bare
660 string will be treated as a list with 1 address.
Tim Peters495ad3c2001-01-15 01:36:40 +0000661 - msg : The message to send.
Barry Warsaw4c4bec81998-12-22 03:02:20 +0000662 - mail_options : List of ESMTP options (such as 8bitmime) for the
663 mail command.
664 - rcpt_options : List of ESMTP options (such as DSN commands) for
665 all the rcpt commands.
666
667 If there has been no previous EHLO or HELO command this session, this
668 method tries ESMTP EHLO first. If the server does ESMTP, message size
669 and each of the specified options will be passed to it. If EHLO
670 fails, HELO will be tried and ESMTP options suppressed.
671
672 This method will return normally if the mail is accepted for at least
Barry Warsawd25c1b71999-11-28 17:11:06 +0000673 one recipient. It returns a dictionary, with one entry for each
674 recipient that was refused. Each entry contains a tuple of the SMTP
675 error code and the accompanying error message sent by the server.
Guido van Rossum296e1431999-04-07 15:03:39 +0000676
677 This method may raise the following exceptions:
678
679 SMTPHeloError The server didn't reply properly to
Tim Peters495ad3c2001-01-15 01:36:40 +0000680 the helo greeting.
Barry Warsawd25c1b71999-11-28 17:11:06 +0000681 SMTPRecipientsRefused The server rejected ALL recipients
Guido van Rossum296e1431999-04-07 15:03:39 +0000682 (no mail was sent).
683 SMTPSenderRefused The server didn't accept the from_addr.
684 SMTPDataError The server replied with an unexpected
685 error code (other than a refusal of
686 a recipient).
687
688 Note: the connection will be open even after an exception is raised.
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000689
Guido van Rossum95e6f701998-06-25 02:15:50 +0000690 Example:
Tim Peters495ad3c2001-01-15 01:36:40 +0000691
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000692 >>> import smtplib
693 >>> s=smtplib.SMTP("localhost")
Guido van Rossumfc40a831998-01-29 17:26:45 +0000694 >>> tolist=["one@one.org","two@two.org","three@three.org","four@four.org"]
Martin v. Löwis301b1cd2002-07-28 16:52:01 +0000695 >>> msg = '''\\
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000696 ... From: Me@my.org
697 ... Subject: testin'...
698 ...
699 ... This is a test '''
700 >>> s.sendmail("me@my.org",tolist,msg)
701 { "three@three.org" : ( 550 ,"User unknown" ) }
702 >>> s.quit()
Tim Peters495ad3c2001-01-15 01:36:40 +0000703
Barry Warsaw4c4bec81998-12-22 03:02:20 +0000704 In the above example, the message was accepted for delivery to three
705 of the four addresses, and one was rejected, with the error code
Barry Warsawd25c1b71999-11-28 17:11:06 +0000706 550. If all addresses are accepted, then the method will return an
Barry Warsaw4c4bec81998-12-22 03:02:20 +0000707 empty dictionary.
708
709 """
Gregory P. Smithbde4ae42008-01-17 08:35:49 +0000710 self.ehlo_or_helo_if_needed()
Guido van Rossum95e6f701998-06-25 02:15:50 +0000711 esmtp_opts = []
Guido van Rossumfcfb6321998-08-04 15:29:54 +0000712 if self.does_esmtp:
713 # Hmmm? what's this? -ddm
714 # self.esmtp_features['7bit']=""
715 if self.has_extn('size'):
Walter Dörwald70a6b492004-02-12 17:35:32 +0000716 esmtp_opts.append("size=%d" % len(msg))
Guido van Rossumfcfb6321998-08-04 15:29:54 +0000717 for option in mail_options:
Guido van Rossum95e6f701998-06-25 02:15:50 +0000718 esmtp_opts.append(option)
Guido van Rossumfcfb6321998-08-04 15:29:54 +0000719
Giampaolo Rodolà5c12ec62011-02-24 20:43:11 +0000720 (code, resp) = self.mail(from_addr, esmtp_opts)
Fred Drake8152d322000-12-12 23:20:45 +0000721 if code != 250:
Guido van Rossum45e2fbc1998-03-26 21:13:24 +0000722 self.rset()
Guido van Rossum296e1431999-04-07 15:03:39 +0000723 raise SMTPSenderRefused(code, resp, from_addr)
Giampaolo Rodolà5c12ec62011-02-24 20:43:11 +0000724 senderrs = {}
Walter Dörwald65230a22002-06-03 15:58:32 +0000725 if isinstance(to_addrs, basestring):
Jeremy Hylton31bb8ce1998-08-13 19:57:46 +0000726 to_addrs = [to_addrs]
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000727 for each in to_addrs:
Giampaolo Rodolà5c12ec62011-02-24 20:43:11 +0000728 (code, resp) = self.rcpt(each, rcpt_options)
Fred Drake8152d322000-12-12 23:20:45 +0000729 if (code != 250) and (code != 251):
Giampaolo Rodolà5c12ec62011-02-24 20:43:11 +0000730 senderrs[each] = (code, resp)
731 if len(senderrs) == len(to_addrs):
Guido van Rossum95e6f701998-06-25 02:15:50 +0000732 # the server refused all our recipients
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000733 self.rset()
Guido van Rossum296e1431999-04-07 15:03:39 +0000734 raise SMTPRecipientsRefused(senderrs)
Giampaolo Rodolà5c12ec62011-02-24 20:43:11 +0000735 (code, resp) = self.data(msg)
Fred Drake8152d322000-12-12 23:20:45 +0000736 if code != 250:
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000737 self.rset()
Guido van Rossum296e1431999-04-07 15:03:39 +0000738 raise SMTPDataError(code, resp)
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000739 #if we got here then somebody got our mail
Tim Peters495ad3c2001-01-15 01:36:40 +0000740 return senderrs
Guido van Rossumbbe323e1998-01-29 17:24:40 +0000741
742
743 def close(self):
744 """Close the connection to the SMTP server."""
745 if self.file:
746 self.file.close()
747 self.file = None
748 if self.sock:
749 self.sock.close()
750 self.sock = None
751
752
753 def quit(self):
Guido van Rossum95e6f701998-06-25 02:15:50 +0000754 """Terminate the SMTP session."""
Georg Brandldeaf2ca2008-03-27 13:27:31 +0000755 res = self.docmd("quit")
Guido van Rossum45e2fbc1998-03-26 21:13:24 +0000756 self.close()
Georg Brandldeaf2ca2008-03-27 13:27:31 +0000757 return res
Guido van Rossum95e6f701998-06-25 02:15:50 +0000758
Bill Janssen426ea0a2007-08-29 22:35:05 +0000759if _have_ssl:
Martin v. Löwisee82c0e2006-10-27 07:13:28 +0000760
Bill Janssen426ea0a2007-08-29 22:35:05 +0000761 class SMTP_SSL(SMTP):
762 """ This is a subclass derived from SMTP that connects over an SSL encrypted
763 socket (to use this class you need a socket module that was compiled with SSL
764 support). If host is not specified, '' (the local host) is used. If port is
765 omitted, the standard SMTP-over-SSL port (465) is used. keyfile and certfile
766 are also optional - they can contain a PEM formatted private key and
767 certificate chain file for the SSL connection.
768 """
Antoine Pitrou21ce8f02011-05-07 19:59:33 +0200769
770 default_port = SMTP_SSL_PORT
771
Bill Janssen426ea0a2007-08-29 22:35:05 +0000772 def __init__(self, host='', port=0, local_hostname=None,
Facundo Batista4f1b1ed2008-05-29 16:39:26 +0000773 keyfile=None, certfile=None,
774 timeout=socket._GLOBAL_DEFAULT_TIMEOUT):
Bill Janssen426ea0a2007-08-29 22:35:05 +0000775 self.keyfile = keyfile
776 self.certfile = certfile
777 SMTP.__init__(self, host, port, local_hostname, timeout)
Bill Janssen426ea0a2007-08-29 22:35:05 +0000778
779 def _get_socket(self, host, port, timeout):
Giampaolo Rodolà5c12ec62011-02-24 20:43:11 +0000780 if self.debuglevel > 0:
781 print>>stderr, 'connect:', (host, port)
R. David Murrayad3058e2009-05-23 00:48:58 +0000782 new_socket = socket.create_connection((host, port), timeout)
783 new_socket = ssl.wrap_socket(new_socket, self.keyfile, self.certfile)
784 self.file = SSLFakeFile(new_socket)
785 return new_socket
Barry Warsaw4c4bec81998-12-22 03:02:20 +0000786
Thomas Woutersa6900e82007-08-30 21:54:39 +0000787 __all__.append("SMTP_SSL")
788
Martin v. Löwis1190a382007-03-09 15:35:55 +0000789#
790# LMTP extension
791#
792LMTP_PORT = 2003
793
794class LMTP(SMTP):
795 """LMTP - Local Mail Transfer Protocol
796
797 The LMTP protocol, which is very similar to ESMTP, is heavily based
798 on the standard SMTP client. It's common to use Unix sockets for LMTP,
799 so our connect() method must support that as well as a regular
800 host:port server. To specify a Unix socket, you must use an absolute
801 path as the host, starting with a '/'.
802
803 Authentication is supported, using the regular SMTP mechanism. When
804 using a Unix socket, LMTP generally don't support or require any
805 authentication, but your mileage might vary."""
806
807 ehlo_msg = "lhlo"
Tim Petersea5962f2007-03-12 18:07:52 +0000808
Giampaolo Rodolà5c12ec62011-02-24 20:43:11 +0000809 def __init__(self, host='', port=LMTP_PORT, local_hostname=None):
Martin v. Löwis1190a382007-03-09 15:35:55 +0000810 """Initialize a new instance."""
811 SMTP.__init__(self, host, port, local_hostname)
812
Giampaolo Rodolà5c12ec62011-02-24 20:43:11 +0000813 def connect(self, host='localhost', port=0):
Martin v. Löwis1190a382007-03-09 15:35:55 +0000814 """Connect to the LMTP daemon, on either a Unix or a TCP socket."""
Neal Norwitzc8f6c232007-03-10 03:19:18 +0000815 if host[0] != '/':
Martin v. Löwis1190a382007-03-09 15:35:55 +0000816 return SMTP.connect(self, host, port)
817
Neal Norwitzc8f6c232007-03-10 03:19:18 +0000818 # Handle Unix-domain sockets.
819 try:
820 self.sock = socket.socket(socket.AF_UNIX, socket.SOCK_STREAM)
821 self.sock.connect(host)
Andrew Svetloved3f6c62012-12-17 19:06:43 +0200822 except socket.error:
Giampaolo Rodolà5c12ec62011-02-24 20:43:11 +0000823 if self.debuglevel > 0:
824 print>>stderr, 'connect fail:', host
Neal Norwitzc8f6c232007-03-10 03:19:18 +0000825 if self.sock:
826 self.sock.close()
827 self.sock = None
Andrew Svetloved3f6c62012-12-17 19:06:43 +0200828 raise
Neal Norwitzc8f6c232007-03-10 03:19:18 +0000829 (code, msg) = self.getreply()
Giampaolo Rodolà5c12ec62011-02-24 20:43:11 +0000830 if self.debuglevel > 0:
831 print>>stderr, "connect:", msg
Neal Norwitzc8f6c232007-03-10 03:19:18 +0000832 return (code, msg)
833
Martin v. Löwis1190a382007-03-09 15:35:55 +0000834
Guido van Rossum95e6f701998-06-25 02:15:50 +0000835# Test the sendmail method, which tests most of the others.
836# Note: This always sends to localhost.
837if __name__ == '__main__':
Andrew M. Kuchling6be424f2001-08-13 14:41:39 +0000838 import sys
Guido van Rossum95e6f701998-06-25 02:15:50 +0000839
840 def prompt(prompt):
841 sys.stdout.write(prompt + ": ")
Eric S. Raymondc013f302001-02-09 05:40:38 +0000842 return sys.stdin.readline().strip()
Guido van Rossum95e6f701998-06-25 02:15:50 +0000843
844 fromaddr = prompt("From")
Giampaolo Rodolà5c12ec62011-02-24 20:43:11 +0000845 toaddrs = prompt("To").split(',')
Guido van Rossum95e6f701998-06-25 02:15:50 +0000846 print "Enter message, end with ^D:"
847 msg = ''
848 while 1:
849 line = sys.stdin.readline()
850 if not line:
851 break
852 msg = msg + line
Walter Dörwald70a6b492004-02-12 17:35:32 +0000853 print "Message length is %d" % len(msg)
Guido van Rossum95e6f701998-06-25 02:15:50 +0000854
855 server = SMTP('localhost')
856 server.set_debuglevel(1)
857 server.sendmail(fromaddr, toaddrs, msg)
858 server.quit()