1998-12-21 23:02:20 -04:00
|
|
|
#! /usr/bin/env python
|
|
|
|
|
2000-07-09 18:24:31 -03:00
|
|
|
'''SMTP/ESMTP client class.
|
1998-01-29 13:24:40 -04:00
|
|
|
|
2001-09-14 13:08:44 -03:00
|
|
|
This should follow RFC 821 (SMTP), RFC 1869 (ESMTP), RFC 2554 (SMTP
|
|
|
|
Authentication) and RFC 2487 (Secure SMTP over TLS).
|
1998-01-29 13:24:40 -04:00
|
|
|
|
1998-08-04 12:29:54 -03:00
|
|
|
Notes:
|
|
|
|
|
|
|
|
Please remember, when doing ESMTP, that the names of the SMTP service
|
1998-12-21 23:02:20 -04:00
|
|
|
extensions are NOT the same thing as the option keywords for the RCPT
|
1998-08-04 12:29:54 -03:00
|
|
|
and MAIL commands!
|
|
|
|
|
1998-01-29 13:24:40 -04:00
|
|
|
Example:
|
|
|
|
|
1998-12-21 23:24:27 -04:00
|
|
|
>>> import smtplib
|
|
|
|
>>> s=smtplib.SMTP("localhost")
|
|
|
|
>>> print s.help()
|
|
|
|
This is Sendmail version 8.8.4
|
|
|
|
Topics:
|
|
|
|
HELO EHLO MAIL RCPT DATA
|
|
|
|
RSET NOOP QUIT HELP VRFY
|
|
|
|
EXPN VERB ETRN DSN
|
|
|
|
For more info use "HELP <topic>".
|
|
|
|
To report bugs in the implementation send email to
|
|
|
|
sendmail-bugs@sendmail.org.
|
|
|
|
For local information send email to Postmaster at your site.
|
|
|
|
End of HELP info
|
|
|
|
>>> s.putcmd("vrfy","someone@here")
|
|
|
|
>>> s.getreply()
|
|
|
|
(250, "Somebody OverHere <somebody@here.my.org>")
|
|
|
|
>>> s.quit()
|
2000-07-09 18:24:31 -03:00
|
|
|
'''
|
1998-01-29 13:24:40 -04:00
|
|
|
|
2000-02-28 11:12:25 -04:00
|
|
|
# Author: The Dragon De Monsyne <dragondm@integral.org>
|
|
|
|
# ESMTP support, test code and doc fixes added by
|
|
|
|
# Eric S. Raymond <esr@thyrsus.com>
|
|
|
|
# Better RFC 821 compliance (MAIL and RCPT, and CRLF in data)
|
|
|
|
# by Carey Evans <c.evans@clear.net.nz>, for picky mail servers.
|
2001-09-11 12:57:46 -03:00
|
|
|
# RFC 2554 (authentication) support by Gerhard Haering <gerhard@bigfoot.de>.
|
2001-01-14 21:36:40 -04:00
|
|
|
#
|
2000-02-28 11:12:25 -04:00
|
|
|
# This was modified from the Python 1.5 library HTTP lib.
|
|
|
|
|
1998-01-29 13:24:40 -04:00
|
|
|
import socket
|
1998-12-22 16:37:36 -04:00
|
|
|
import re
|
2007-01-22 15:40:21 -04:00
|
|
|
import email.utils
|
2001-09-11 12:57:46 -03:00
|
|
|
import base64
|
|
|
|
import hmac
|
2007-01-22 15:40:21 -04:00
|
|
|
from email.base64mime import encode as encode_base64
|
2004-07-10 20:14:30 -03:00
|
|
|
from sys import stderr
|
1998-01-29 13:24:40 -04:00
|
|
|
|
2011-02-24 16:43:11 -04:00
|
|
|
__all__ = ["SMTPException", "SMTPServerDisconnected", "SMTPResponseException",
|
|
|
|
"SMTPSenderRefused", "SMTPRecipientsRefused", "SMTPDataError",
|
|
|
|
"SMTPConnectError", "SMTPHeloError", "SMTPAuthenticationError",
|
|
|
|
"quoteaddr", "quotedata", "SMTP"]
|
2001-02-15 18:15:14 -04:00
|
|
|
|
1998-01-29 13:24:40 -04:00
|
|
|
SMTP_PORT = 25
|
2006-10-27 04:13:28 -03:00
|
|
|
SMTP_SSL_PORT = 465
|
2011-02-24 16:43:11 -04:00
|
|
|
CRLF = "\r\n"
|
2014-12-05 21:05:18 -04:00
|
|
|
_MAXLINE = 8192 # more than 8 times larger than RFC 821, 4.5.3
|
1998-01-29 13:24:40 -04:00
|
|
|
|
2002-07-26 21:38:30 -03:00
|
|
|
OLDSTYLE_AUTH = re.compile(r"auth=(.*)", re.I)
|
|
|
|
|
2011-02-24 16:43:11 -04:00
|
|
|
|
2001-01-14 21:36:40 -04:00
|
|
|
# Exception classes used by this module.
|
Changes by Per Cederquist and The Dragon.
Per writes:
"""
The application where Signum Support uses smtplib needs to be able to
report good error messages to the user when sending email fails. To
help in diagnosing problems it is useful to be able to report the
entire message sent by the server, not only the SMTP error code of the
offending command.
A lot of the functions in sendmail.py unfortunately discards the
message, leaving only the code. The enclosed patch fixes that
problem.
The enclosed patch also introduces a base class for exceptions that
include an SMTP error code and error message, and make the code and
message available on separate attributes, so that surrounding code can
deal with them in whatever way it sees fit. I've also added some
documentation to the exception classes.
The constructor will now raise an exception if it cannot connect to
the SMTP server.
The data() method will raise an SMTPDataError if it doesn't receive
the expected 354 code in the middle of the exchange.
According to section 5.2.10 of RFC 1123 a smtp client must accept "any
text, including no text at all" after the error code. If the response
of a HELO command contains no text self.helo_resp will be set to the
empty string (""). The patch fixes the test in the sendmail() method
so that helo_resp is tested against None; if it has the empty string
as value the sendmail() method would invoke the helo() method again.
The code no longer accepts a -1 reply from the ehlo() method in
sendmail().
[Text about removing SMTPRecipientsRefused deleted --GvR]
"""
and also:
"""
smtplib.py appends an extra blank line to the outgoing mail if the
`msg' argument to the sendmail method already contains a trailing
newline. This patch should fix the problem.
"""
The Dragon writes:
"""
Mostly I just re-added the SMTPRecipientsRefused exception
(the exeption object now has the appropriate info in it ) [Per had
removed this in his patch --GvR] and tweaked the behavior of the
sendmail method whence it throws the newly added SMTPHeloException (it
was closing the connection, which it shouldn't. whatever catches the
exception should do that. )
I pondered the change of the return values to tuples all around,
and after some thinking I decided that regularizing the return values was
too much of the Right Thing (tm) to not do.
My one concern is that code expecting an integer & getting a tuple
may fail silently.
(i.e. if it's doing :
x.somemethod() >= 400:
expecting an integer, the expression will always be true if it gets a
tuple instead. )
However, most smtplib code I've seen only really uses the
sendmail() method, so this wouldn't bother it. Usually code I've seen
that calls the other methods usually only calls helo() and ehlo() for
doing ESMTP, a feature which was not in the smtplib included with 1.5.1,
and thus I would think not much code uses it yet.
"""
1999-04-07 12:03:39 -03:00
|
|
|
class SMTPException(Exception):
|
|
|
|
"""Base class for all exceptions raised by this module."""
|
|
|
|
|
|
|
|
class SMTPServerDisconnected(SMTPException):
|
|
|
|
"""Not connected to any SMTP server.
|
|
|
|
|
|
|
|
This exception is raised when the server unexpectedly disconnects,
|
|
|
|
or when an attempt is made to use the SMTP instance before
|
|
|
|
connecting it to a server.
|
|
|
|
"""
|
|
|
|
|
|
|
|
class SMTPResponseException(SMTPException):
|
|
|
|
"""Base class for all exceptions that include an SMTP error code.
|
|
|
|
|
|
|
|
These exceptions are generated in some instances when the SMTP
|
|
|
|
server returns an error code. The error code is stored in the
|
|
|
|
`smtp_code' attribute of the error, and the `smtp_error' attribute
|
|
|
|
is set to the error message.
|
|
|
|
"""
|
|
|
|
|
|
|
|
def __init__(self, code, msg):
|
|
|
|
self.smtp_code = code
|
|
|
|
self.smtp_error = msg
|
|
|
|
self.args = (code, msg)
|
|
|
|
|
|
|
|
class SMTPSenderRefused(SMTPResponseException):
|
|
|
|
"""Sender address refused.
|
2001-09-11 12:57:46 -03:00
|
|
|
|
Changes by Per Cederquist and The Dragon.
Per writes:
"""
The application where Signum Support uses smtplib needs to be able to
report good error messages to the user when sending email fails. To
help in diagnosing problems it is useful to be able to report the
entire message sent by the server, not only the SMTP error code of the
offending command.
A lot of the functions in sendmail.py unfortunately discards the
message, leaving only the code. The enclosed patch fixes that
problem.
The enclosed patch also introduces a base class for exceptions that
include an SMTP error code and error message, and make the code and
message available on separate attributes, so that surrounding code can
deal with them in whatever way it sees fit. I've also added some
documentation to the exception classes.
The constructor will now raise an exception if it cannot connect to
the SMTP server.
The data() method will raise an SMTPDataError if it doesn't receive
the expected 354 code in the middle of the exchange.
According to section 5.2.10 of RFC 1123 a smtp client must accept "any
text, including no text at all" after the error code. If the response
of a HELO command contains no text self.helo_resp will be set to the
empty string (""). The patch fixes the test in the sendmail() method
so that helo_resp is tested against None; if it has the empty string
as value the sendmail() method would invoke the helo() method again.
The code no longer accepts a -1 reply from the ehlo() method in
sendmail().
[Text about removing SMTPRecipientsRefused deleted --GvR]
"""
and also:
"""
smtplib.py appends an extra blank line to the outgoing mail if the
`msg' argument to the sendmail method already contains a trailing
newline. This patch should fix the problem.
"""
The Dragon writes:
"""
Mostly I just re-added the SMTPRecipientsRefused exception
(the exeption object now has the appropriate info in it ) [Per had
removed this in his patch --GvR] and tweaked the behavior of the
sendmail method whence it throws the newly added SMTPHeloException (it
was closing the connection, which it shouldn't. whatever catches the
exception should do that. )
I pondered the change of the return values to tuples all around,
and after some thinking I decided that regularizing the return values was
too much of the Right Thing (tm) to not do.
My one concern is that code expecting an integer & getting a tuple
may fail silently.
(i.e. if it's doing :
x.somemethod() >= 400:
expecting an integer, the expression will always be true if it gets a
tuple instead. )
However, most smtplib code I've seen only really uses the
sendmail() method, so this wouldn't bother it. Usually code I've seen
that calls the other methods usually only calls helo() and ehlo() for
doing ESMTP, a feature which was not in the smtplib included with 1.5.1,
and thus I would think not much code uses it yet.
"""
1999-04-07 12:03:39 -03:00
|
|
|
In addition to the attributes set by on all SMTPResponseException
|
1999-11-28 13:11:06 -04:00
|
|
|
exceptions, this sets `sender' to the string that the SMTP refused.
|
Changes by Per Cederquist and The Dragon.
Per writes:
"""
The application where Signum Support uses smtplib needs to be able to
report good error messages to the user when sending email fails. To
help in diagnosing problems it is useful to be able to report the
entire message sent by the server, not only the SMTP error code of the
offending command.
A lot of the functions in sendmail.py unfortunately discards the
message, leaving only the code. The enclosed patch fixes that
problem.
The enclosed patch also introduces a base class for exceptions that
include an SMTP error code and error message, and make the code and
message available on separate attributes, so that surrounding code can
deal with them in whatever way it sees fit. I've also added some
documentation to the exception classes.
The constructor will now raise an exception if it cannot connect to
the SMTP server.
The data() method will raise an SMTPDataError if it doesn't receive
the expected 354 code in the middle of the exchange.
According to section 5.2.10 of RFC 1123 a smtp client must accept "any
text, including no text at all" after the error code. If the response
of a HELO command contains no text self.helo_resp will be set to the
empty string (""). The patch fixes the test in the sendmail() method
so that helo_resp is tested against None; if it has the empty string
as value the sendmail() method would invoke the helo() method again.
The code no longer accepts a -1 reply from the ehlo() method in
sendmail().
[Text about removing SMTPRecipientsRefused deleted --GvR]
"""
and also:
"""
smtplib.py appends an extra blank line to the outgoing mail if the
`msg' argument to the sendmail method already contains a trailing
newline. This patch should fix the problem.
"""
The Dragon writes:
"""
Mostly I just re-added the SMTPRecipientsRefused exception
(the exeption object now has the appropriate info in it ) [Per had
removed this in his patch --GvR] and tweaked the behavior of the
sendmail method whence it throws the newly added SMTPHeloException (it
was closing the connection, which it shouldn't. whatever catches the
exception should do that. )
I pondered the change of the return values to tuples all around,
and after some thinking I decided that regularizing the return values was
too much of the Right Thing (tm) to not do.
My one concern is that code expecting an integer & getting a tuple
may fail silently.
(i.e. if it's doing :
x.somemethod() >= 400:
expecting an integer, the expression will always be true if it gets a
tuple instead. )
However, most smtplib code I've seen only really uses the
sendmail() method, so this wouldn't bother it. Usually code I've seen
that calls the other methods usually only calls helo() and ehlo() for
doing ESMTP, a feature which was not in the smtplib included with 1.5.1,
and thus I would think not much code uses it yet.
"""
1999-04-07 12:03:39 -03:00
|
|
|
"""
|
|
|
|
|
|
|
|
def __init__(self, code, msg, sender):
|
|
|
|
self.smtp_code = code
|
|
|
|
self.smtp_error = msg
|
|
|
|
self.sender = sender
|
|
|
|
self.args = (code, msg, sender)
|
|
|
|
|
1999-04-21 13:52:20 -03:00
|
|
|
class SMTPRecipientsRefused(SMTPException):
|
1999-11-28 13:11:06 -04:00
|
|
|
"""All recipient addresses refused.
|
2001-09-11 12:57:46 -03:00
|
|
|
|
2000-07-16 09:04:32 -03:00
|
|
|
The errors for each recipient are accessible through the attribute
|
2001-01-14 21:36:40 -04:00
|
|
|
'recipients', which is a dictionary of exactly the same sort as
|
|
|
|
SMTP.sendmail() returns.
|
Changes by Per Cederquist and The Dragon.
Per writes:
"""
The application where Signum Support uses smtplib needs to be able to
report good error messages to the user when sending email fails. To
help in diagnosing problems it is useful to be able to report the
entire message sent by the server, not only the SMTP error code of the
offending command.
A lot of the functions in sendmail.py unfortunately discards the
message, leaving only the code. The enclosed patch fixes that
problem.
The enclosed patch also introduces a base class for exceptions that
include an SMTP error code and error message, and make the code and
message available on separate attributes, so that surrounding code can
deal with them in whatever way it sees fit. I've also added some
documentation to the exception classes.
The constructor will now raise an exception if it cannot connect to
the SMTP server.
The data() method will raise an SMTPDataError if it doesn't receive
the expected 354 code in the middle of the exchange.
According to section 5.2.10 of RFC 1123 a smtp client must accept "any
text, including no text at all" after the error code. If the response
of a HELO command contains no text self.helo_resp will be set to the
empty string (""). The patch fixes the test in the sendmail() method
so that helo_resp is tested against None; if it has the empty string
as value the sendmail() method would invoke the helo() method again.
The code no longer accepts a -1 reply from the ehlo() method in
sendmail().
[Text about removing SMTPRecipientsRefused deleted --GvR]
"""
and also:
"""
smtplib.py appends an extra blank line to the outgoing mail if the
`msg' argument to the sendmail method already contains a trailing
newline. This patch should fix the problem.
"""
The Dragon writes:
"""
Mostly I just re-added the SMTPRecipientsRefused exception
(the exeption object now has the appropriate info in it ) [Per had
removed this in his patch --GvR] and tweaked the behavior of the
sendmail method whence it throws the newly added SMTPHeloException (it
was closing the connection, which it shouldn't. whatever catches the
exception should do that. )
I pondered the change of the return values to tuples all around,
and after some thinking I decided that regularizing the return values was
too much of the Right Thing (tm) to not do.
My one concern is that code expecting an integer & getting a tuple
may fail silently.
(i.e. if it's doing :
x.somemethod() >= 400:
expecting an integer, the expression will always be true if it gets a
tuple instead. )
However, most smtplib code I've seen only really uses the
sendmail() method, so this wouldn't bother it. Usually code I've seen
that calls the other methods usually only calls helo() and ehlo() for
doing ESMTP, a feature which was not in the smtplib included with 1.5.1,
and thus I would think not much code uses it yet.
"""
1999-04-07 12:03:39 -03:00
|
|
|
"""
|
|
|
|
|
|
|
|
def __init__(self, recipients):
|
|
|
|
self.recipients = recipients
|
2011-02-24 16:43:11 -04:00
|
|
|
self.args = (recipients,)
|
Changes by Per Cederquist and The Dragon.
Per writes:
"""
The application where Signum Support uses smtplib needs to be able to
report good error messages to the user when sending email fails. To
help in diagnosing problems it is useful to be able to report the
entire message sent by the server, not only the SMTP error code of the
offending command.
A lot of the functions in sendmail.py unfortunately discards the
message, leaving only the code. The enclosed patch fixes that
problem.
The enclosed patch also introduces a base class for exceptions that
include an SMTP error code and error message, and make the code and
message available on separate attributes, so that surrounding code can
deal with them in whatever way it sees fit. I've also added some
documentation to the exception classes.
The constructor will now raise an exception if it cannot connect to
the SMTP server.
The data() method will raise an SMTPDataError if it doesn't receive
the expected 354 code in the middle of the exchange.
According to section 5.2.10 of RFC 1123 a smtp client must accept "any
text, including no text at all" after the error code. If the response
of a HELO command contains no text self.helo_resp will be set to the
empty string (""). The patch fixes the test in the sendmail() method
so that helo_resp is tested against None; if it has the empty string
as value the sendmail() method would invoke the helo() method again.
The code no longer accepts a -1 reply from the ehlo() method in
sendmail().
[Text about removing SMTPRecipientsRefused deleted --GvR]
"""
and also:
"""
smtplib.py appends an extra blank line to the outgoing mail if the
`msg' argument to the sendmail method already contains a trailing
newline. This patch should fix the problem.
"""
The Dragon writes:
"""
Mostly I just re-added the SMTPRecipientsRefused exception
(the exeption object now has the appropriate info in it ) [Per had
removed this in his patch --GvR] and tweaked the behavior of the
sendmail method whence it throws the newly added SMTPHeloException (it
was closing the connection, which it shouldn't. whatever catches the
exception should do that. )
I pondered the change of the return values to tuples all around,
and after some thinking I decided that regularizing the return values was
too much of the Right Thing (tm) to not do.
My one concern is that code expecting an integer & getting a tuple
may fail silently.
(i.e. if it's doing :
x.somemethod() >= 400:
expecting an integer, the expression will always be true if it gets a
tuple instead. )
However, most smtplib code I've seen only really uses the
sendmail() method, so this wouldn't bother it. Usually code I've seen
that calls the other methods usually only calls helo() and ehlo() for
doing ESMTP, a feature which was not in the smtplib included with 1.5.1,
and thus I would think not much code uses it yet.
"""
1999-04-07 12:03:39 -03:00
|
|
|
|
|
|
|
|
|
|
|
class SMTPDataError(SMTPResponseException):
|
|
|
|
"""The SMTP server didn't accept the data."""
|
|
|
|
|
|
|
|
class SMTPConnectError(SMTPResponseException):
|
1999-11-28 13:11:06 -04:00
|
|
|
"""Error during connection establishment."""
|
Changes by Per Cederquist and The Dragon.
Per writes:
"""
The application where Signum Support uses smtplib needs to be able to
report good error messages to the user when sending email fails. To
help in diagnosing problems it is useful to be able to report the
entire message sent by the server, not only the SMTP error code of the
offending command.
A lot of the functions in sendmail.py unfortunately discards the
message, leaving only the code. The enclosed patch fixes that
problem.
The enclosed patch also introduces a base class for exceptions that
include an SMTP error code and error message, and make the code and
message available on separate attributes, so that surrounding code can
deal with them in whatever way it sees fit. I've also added some
documentation to the exception classes.
The constructor will now raise an exception if it cannot connect to
the SMTP server.
The data() method will raise an SMTPDataError if it doesn't receive
the expected 354 code in the middle of the exchange.
According to section 5.2.10 of RFC 1123 a smtp client must accept "any
text, including no text at all" after the error code. If the response
of a HELO command contains no text self.helo_resp will be set to the
empty string (""). The patch fixes the test in the sendmail() method
so that helo_resp is tested against None; if it has the empty string
as value the sendmail() method would invoke the helo() method again.
The code no longer accepts a -1 reply from the ehlo() method in
sendmail().
[Text about removing SMTPRecipientsRefused deleted --GvR]
"""
and also:
"""
smtplib.py appends an extra blank line to the outgoing mail if the
`msg' argument to the sendmail method already contains a trailing
newline. This patch should fix the problem.
"""
The Dragon writes:
"""
Mostly I just re-added the SMTPRecipientsRefused exception
(the exeption object now has the appropriate info in it ) [Per had
removed this in his patch --GvR] and tweaked the behavior of the
sendmail method whence it throws the newly added SMTPHeloException (it
was closing the connection, which it shouldn't. whatever catches the
exception should do that. )
I pondered the change of the return values to tuples all around,
and after some thinking I decided that regularizing the return values was
too much of the Right Thing (tm) to not do.
My one concern is that code expecting an integer & getting a tuple
may fail silently.
(i.e. if it's doing :
x.somemethod() >= 400:
expecting an integer, the expression will always be true if it gets a
tuple instead. )
However, most smtplib code I've seen only really uses the
sendmail() method, so this wouldn't bother it. Usually code I've seen
that calls the other methods usually only calls helo() and ehlo() for
doing ESMTP, a feature which was not in the smtplib included with 1.5.1,
and thus I would think not much code uses it yet.
"""
1999-04-07 12:03:39 -03:00
|
|
|
|
|
|
|
class SMTPHeloError(SMTPResponseException):
|
1999-11-28 13:11:06 -04:00
|
|
|
"""The server refused our HELO reply."""
|
1998-01-29 13:24:40 -04:00
|
|
|
|
2001-09-11 12:57:46 -03:00
|
|
|
class SMTPAuthenticationError(SMTPResponseException):
|
|
|
|
"""Authentication error.
|
|
|
|
|
|
|
|
Most probably the server didn't accept the username/password
|
|
|
|
combination provided.
|
|
|
|
"""
|
2000-08-10 11:02:23 -03:00
|
|
|
|
2011-02-24 16:43:11 -04:00
|
|
|
|
1998-07-13 12:18:49 -03:00
|
|
|
def quoteaddr(addr):
|
|
|
|
"""Quote a subset of the email addresses defined by RFC 821.
|
|
|
|
|
1998-12-21 23:24:27 -04:00
|
|
|
Should be able to handle anything rfc822.parseaddr can handle.
|
|
|
|
"""
|
2002-09-04 22:14:07 -03:00
|
|
|
m = (None, None)
|
1998-07-13 12:18:49 -03:00
|
|
|
try:
|
2007-01-22 15:40:21 -04:00
|
|
|
m = email.utils.parseaddr(addr)[1]
|
1998-08-04 12:29:54 -03:00
|
|
|
except AttributeError:
|
|
|
|
pass
|
2011-02-24 16:43:11 -04:00
|
|
|
if m == (None, None): # Indicates parse failure or AttributeError
|
2006-02-17 05:52:53 -04:00
|
|
|
# something weird here.. punt -ddm
|
2002-09-04 22:14:07 -03:00
|
|
|
return "<%s>" % addr
|
2006-02-17 05:52:53 -04:00
|
|
|
elif m is None:
|
|
|
|
# the sender wants an empty return address
|
|
|
|
return "<>"
|
1998-08-04 12:29:54 -03:00
|
|
|
else:
|
|
|
|
return "<%s>" % m
|
1998-07-13 12:18:49 -03:00
|
|
|
|
2011-07-18 22:34:04 -03:00
|
|
|
def _addr_only(addrstring):
|
|
|
|
displayname, addr = email.utils.parseaddr(addrstring)
|
|
|
|
if (displayname, addr) == ('', ''):
|
|
|
|
# parseaddr couldn't parse it, so use it as is.
|
|
|
|
return addrstring
|
|
|
|
return addr
|
|
|
|
|
1998-07-13 12:18:49 -03:00
|
|
|
def quotedata(data):
|
|
|
|
"""Quote data for email.
|
|
|
|
|
1999-11-28 13:11:06 -04:00
|
|
|
Double leading '.', and change Unix newline '\\n', or Mac '\\r' into
|
1998-12-21 23:24:27 -04:00
|
|
|
Internet CRLF end-of-line.
|
|
|
|
"""
|
1998-07-13 12:18:49 -03:00
|
|
|
return re.sub(r'(?m)^\.', '..',
|
1998-08-04 12:29:54 -03:00
|
|
|
re.sub(r'(?:\r\n|\n|\r(?!\n))', CRLF, data))
|
1998-07-13 12:18:49 -03:00
|
|
|
|
2000-08-10 11:02:23 -03:00
|
|
|
|
2007-08-29 19:35:05 -03:00
|
|
|
try:
|
|
|
|
import ssl
|
|
|
|
except ImportError:
|
|
|
|
_have_ssl = False
|
|
|
|
else:
|
|
|
|
class SSLFakeFile:
|
|
|
|
"""A fake file like object that really wraps a SSLObject.
|
|
|
|
|
|
|
|
It only supports what is needed in smtplib.
|
|
|
|
"""
|
|
|
|
def __init__(self, sslobj):
|
|
|
|
self.sslobj = sslobj
|
|
|
|
|
2014-12-05 21:05:18 -04:00
|
|
|
def readline(self, size=-1):
|
|
|
|
if size < 0:
|
|
|
|
size = None
|
2007-08-29 19:35:05 -03:00
|
|
|
str = ""
|
|
|
|
chr = None
|
|
|
|
while chr != "\n":
|
2014-12-05 21:05:18 -04:00
|
|
|
if size is not None and len(str) >= size:
|
|
|
|
break
|
2007-08-29 19:35:05 -03:00
|
|
|
chr = self.sslobj.read(1)
|
2011-02-24 16:43:11 -04:00
|
|
|
if not chr:
|
|
|
|
break
|
2007-08-29 19:35:05 -03:00
|
|
|
str += chr
|
|
|
|
return str
|
|
|
|
|
|
|
|
def close(self):
|
|
|
|
pass
|
|
|
|
|
|
|
|
_have_ssl = True
|
|
|
|
|
1998-01-29 13:24:40 -04:00
|
|
|
class SMTP:
|
1998-08-04 12:29:54 -03:00
|
|
|
"""This class manages a connection to an SMTP or ESMTP server.
|
|
|
|
SMTP Objects:
|
2001-01-14 21:36:40 -04:00
|
|
|
SMTP objects have the following attributes:
|
|
|
|
helo_resp
|
|
|
|
This is the message given by the server in response to the
|
1998-08-04 12:29:54 -03:00
|
|
|
most recent HELO command.
|
2001-01-14 21:36:40 -04:00
|
|
|
|
1998-08-04 12:29:54 -03:00
|
|
|
ehlo_resp
|
2001-01-14 21:36:40 -04:00
|
|
|
This is the message given by the server in response to the
|
1998-08-04 12:29:54 -03:00
|
|
|
most recent EHLO command. This is usually multiline.
|
|
|
|
|
2001-01-14 21:36:40 -04:00
|
|
|
does_esmtp
|
1998-08-04 12:29:54 -03:00
|
|
|
This is a True value _after you do an EHLO command_, if the
|
|
|
|
server supports ESMTP.
|
|
|
|
|
2001-01-14 21:36:40 -04:00
|
|
|
esmtp_features
|
1998-08-04 12:29:54 -03:00
|
|
|
This is a dictionary, which, if the server supports ESMTP,
|
1999-11-28 13:11:06 -04:00
|
|
|
will _after you do an EHLO command_, contain the names of the
|
|
|
|
SMTP service extensions this server supports, and their
|
1998-08-04 12:29:54 -03:00
|
|
|
parameters (if any).
|
1999-11-28 13:11:06 -04:00
|
|
|
|
2001-01-14 21:36:40 -04:00
|
|
|
Note, all extension names are mapped to lower case in the
|
|
|
|
dictionary.
|
1998-08-04 12:29:54 -03:00
|
|
|
|
1999-11-28 13:11:06 -04:00
|
|
|
See each method's docstrings for details. In general, there is a
|
|
|
|
method of the same name to perform each SMTP command. There is also a
|
|
|
|
method called 'sendmail' that will do an entire mail transaction.
|
|
|
|
"""
|
1998-06-24 23:15:50 -03:00
|
|
|
debuglevel = 0
|
|
|
|
file = None
|
|
|
|
helo_resp = None
|
2007-03-09 11:35:55 -04:00
|
|
|
ehlo_msg = "ehlo"
|
1998-06-24 23:15:50 -03:00
|
|
|
ehlo_resp = None
|
1998-08-04 12:29:54 -03:00
|
|
|
does_esmtp = 0
|
2011-05-07 14:59:33 -03:00
|
|
|
default_port = SMTP_PORT
|
1998-06-24 23:15:50 -03:00
|
|
|
|
2008-05-29 13:39:26 -03:00
|
|
|
def __init__(self, host='', port=0, local_hostname=None,
|
|
|
|
timeout=socket._GLOBAL_DEFAULT_TIMEOUT):
|
1998-01-29 13:24:40 -04:00
|
|
|
"""Initialize a new instance.
|
|
|
|
|
1998-12-21 23:24:27 -04:00
|
|
|
If specified, `host' is the name of the remote host to which to
|
|
|
|
connect. If specified, `port' specifies the port to which to connect.
|
2013-04-13 15:37:22 -03:00
|
|
|
By default, smtplib.SMTP_PORT is used. If a host is specified the
|
2013-06-23 17:10:37 -03:00
|
|
|
connect method is called, and if it returns anything other than a
|
|
|
|
success code an SMTPConnectError is raised. If specified,
|
2013-06-23 17:02:34 -03:00
|
|
|
`local_hostname` is used as the FQDN of the local host for the
|
2013-06-23 17:10:37 -03:00
|
|
|
HELO/EHLO command. Otherwise, the local hostname is found using
|
|
|
|
socket.getfqdn().
|
1998-01-29 13:24:40 -04:00
|
|
|
|
|
|
|
"""
|
2007-03-28 15:25:54 -03:00
|
|
|
self.timeout = timeout
|
1998-08-04 12:29:54 -03:00
|
|
|
self.esmtp_features = {}
|
Changes by Per Cederquist and The Dragon.
Per writes:
"""
The application where Signum Support uses smtplib needs to be able to
report good error messages to the user when sending email fails. To
help in diagnosing problems it is useful to be able to report the
entire message sent by the server, not only the SMTP error code of the
offending command.
A lot of the functions in sendmail.py unfortunately discards the
message, leaving only the code. The enclosed patch fixes that
problem.
The enclosed patch also introduces a base class for exceptions that
include an SMTP error code and error message, and make the code and
message available on separate attributes, so that surrounding code can
deal with them in whatever way it sees fit. I've also added some
documentation to the exception classes.
The constructor will now raise an exception if it cannot connect to
the SMTP server.
The data() method will raise an SMTPDataError if it doesn't receive
the expected 354 code in the middle of the exchange.
According to section 5.2.10 of RFC 1123 a smtp client must accept "any
text, including no text at all" after the error code. If the response
of a HELO command contains no text self.helo_resp will be set to the
empty string (""). The patch fixes the test in the sendmail() method
so that helo_resp is tested against None; if it has the empty string
as value the sendmail() method would invoke the helo() method again.
The code no longer accepts a -1 reply from the ehlo() method in
sendmail().
[Text about removing SMTPRecipientsRefused deleted --GvR]
"""
and also:
"""
smtplib.py appends an extra blank line to the outgoing mail if the
`msg' argument to the sendmail method already contains a trailing
newline. This patch should fix the problem.
"""
The Dragon writes:
"""
Mostly I just re-added the SMTPRecipientsRefused exception
(the exeption object now has the appropriate info in it ) [Per had
removed this in his patch --GvR] and tweaked the behavior of the
sendmail method whence it throws the newly added SMTPHeloException (it
was closing the connection, which it shouldn't. whatever catches the
exception should do that. )
I pondered the change of the return values to tuples all around,
and after some thinking I decided that regularizing the return values was
too much of the Right Thing (tm) to not do.
My one concern is that code expecting an integer & getting a tuple
may fail silently.
(i.e. if it's doing :
x.somemethod() >= 400:
expecting an integer, the expression will always be true if it gets a
tuple instead. )
However, most smtplib code I've seen only really uses the
sendmail() method, so this wouldn't bother it. Usually code I've seen
that calls the other methods usually only calls helo() and ehlo() for
doing ESMTP, a feature which was not in the smtplib included with 1.5.1,
and thus I would think not much code uses it yet.
"""
1999-04-07 12:03:39 -03:00
|
|
|
if host:
|
|
|
|
(code, msg) = self.connect(host, port)
|
|
|
|
if code != 220:
|
2017-05-24 15:24:27 -03:00
|
|
|
self.close()
|
Changes by Per Cederquist and The Dragon.
Per writes:
"""
The application where Signum Support uses smtplib needs to be able to
report good error messages to the user when sending email fails. To
help in diagnosing problems it is useful to be able to report the
entire message sent by the server, not only the SMTP error code of the
offending command.
A lot of the functions in sendmail.py unfortunately discards the
message, leaving only the code. The enclosed patch fixes that
problem.
The enclosed patch also introduces a base class for exceptions that
include an SMTP error code and error message, and make the code and
message available on separate attributes, so that surrounding code can
deal with them in whatever way it sees fit. I've also added some
documentation to the exception classes.
The constructor will now raise an exception if it cannot connect to
the SMTP server.
The data() method will raise an SMTPDataError if it doesn't receive
the expected 354 code in the middle of the exchange.
According to section 5.2.10 of RFC 1123 a smtp client must accept "any
text, including no text at all" after the error code. If the response
of a HELO command contains no text self.helo_resp will be set to the
empty string (""). The patch fixes the test in the sendmail() method
so that helo_resp is tested against None; if it has the empty string
as value the sendmail() method would invoke the helo() method again.
The code no longer accepts a -1 reply from the ehlo() method in
sendmail().
[Text about removing SMTPRecipientsRefused deleted --GvR]
"""
and also:
"""
smtplib.py appends an extra blank line to the outgoing mail if the
`msg' argument to the sendmail method already contains a trailing
newline. This patch should fix the problem.
"""
The Dragon writes:
"""
Mostly I just re-added the SMTPRecipientsRefused exception
(the exeption object now has the appropriate info in it ) [Per had
removed this in his patch --GvR] and tweaked the behavior of the
sendmail method whence it throws the newly added SMTPHeloException (it
was closing the connection, which it shouldn't. whatever catches the
exception should do that. )
I pondered the change of the return values to tuples all around,
and after some thinking I decided that regularizing the return values was
too much of the Right Thing (tm) to not do.
My one concern is that code expecting an integer & getting a tuple
may fail silently.
(i.e. if it's doing :
x.somemethod() >= 400:
expecting an integer, the expression will always be true if it gets a
tuple instead. )
However, most smtplib code I've seen only really uses the
sendmail() method, so this wouldn't bother it. Usually code I've seen
that calls the other methods usually only calls helo() and ehlo() for
doing ESMTP, a feature which was not in the smtplib included with 1.5.1,
and thus I would think not much code uses it yet.
"""
1999-04-07 12:03:39 -03:00
|
|
|
raise SMTPConnectError(code, msg)
|
2002-06-01 21:40:05 -03:00
|
|
|
if local_hostname is not None:
|
2002-03-26 16:27:35 -04:00
|
|
|
self.local_hostname = local_hostname
|
2002-03-24 11:30:40 -04:00
|
|
|
else:
|
2002-03-26 16:27:35 -04:00
|
|
|
# RFC 2821 says we should use the fqdn in the EHLO/HELO verb, and
|
|
|
|
# if that can't be calculated, that we should use a domain literal
|
|
|
|
# instead (essentially an encoded IP address like [A.B.C.D]).
|
|
|
|
fqdn = socket.getfqdn()
|
|
|
|
if '.' in fqdn:
|
|
|
|
self.local_hostname = fqdn
|
|
|
|
else:
|
|
|
|
# We can't find an fqdn hostname, so use a domain literal
|
2006-03-31 15:34:13 -04:00
|
|
|
addr = '127.0.0.1'
|
|
|
|
try:
|
|
|
|
addr = socket.gethostbyname(socket.gethostname())
|
|
|
|
except socket.gaierror:
|
|
|
|
pass
|
2002-03-26 16:27:35 -04:00
|
|
|
self.local_hostname = '[%s]' % addr
|
2001-01-14 21:36:40 -04:00
|
|
|
|
1998-01-29 13:24:40 -04:00
|
|
|
def set_debuglevel(self, debuglevel):
|
|
|
|
"""Set the debug output level.
|
|
|
|
|
1998-12-21 23:24:27 -04:00
|
|
|
A non-false value results in debug messages for connection and for all
|
|
|
|
messages sent to and received from the server.
|
1998-01-29 13:24:40 -04:00
|
|
|
|
|
|
|
"""
|
|
|
|
self.debuglevel = debuglevel
|
|
|
|
|
2013-04-02 13:15:07 -03:00
|
|
|
def _get_socket(self, host, port, timeout):
|
2006-10-27 04:13:28 -03:00
|
|
|
# This makes it simpler for SMTP_SSL to use the SMTP connect code
|
|
|
|
# and just alter the socket connection bit.
|
2011-02-24 16:43:11 -04:00
|
|
|
if self.debuglevel > 0:
|
|
|
|
print>>stderr, 'connect:', (host, port)
|
2013-04-02 13:15:07 -03:00
|
|
|
return socket.create_connection((host, port), timeout)
|
2006-10-27 04:13:28 -03:00
|
|
|
|
2011-02-24 16:43:11 -04:00
|
|
|
def connect(self, host='localhost', port=0):
|
1998-01-29 13:24:40 -04:00
|
|
|
"""Connect to a host on a given port.
|
1998-06-24 23:15:50 -03:00
|
|
|
|
1998-12-21 23:02:20 -04:00
|
|
|
If the hostname ends with a colon (`:') followed by a number, and
|
|
|
|
there is no port specified, that suffix will be stripped off and the
|
|
|
|
number interpreted as the port number to use.
|
1998-06-24 23:15:50 -03:00
|
|
|
|
1998-12-21 23:24:27 -04:00
|
|
|
Note: This method is automatically invoked by __init__, if a host is
|
|
|
|
specified during instantiation.
|
1998-01-29 13:24:40 -04:00
|
|
|
|
|
|
|
"""
|
2001-07-26 10:37:33 -03:00
|
|
|
if not port and (host.find(':') == host.rfind(':')):
|
2001-07-24 17:34:08 -03:00
|
|
|
i = host.rfind(':')
|
1998-01-29 13:24:40 -04:00
|
|
|
if i >= 0:
|
2011-02-24 16:43:11 -04:00
|
|
|
host, port = host[:i], host[i + 1:]
|
|
|
|
try:
|
|
|
|
port = int(port)
|
2001-02-09 06:14:53 -04:00
|
|
|
except ValueError:
|
1998-01-29 13:24:40 -04:00
|
|
|
raise socket.error, "nonnumeric port"
|
2011-02-24 16:43:11 -04:00
|
|
|
if not port:
|
|
|
|
port = self.default_port
|
|
|
|
if self.debuglevel > 0:
|
|
|
|
print>>stderr, 'connect:', (host, port)
|
2007-03-28 15:25:54 -03:00
|
|
|
self.sock = self._get_socket(host, port, self.timeout)
|
2001-07-24 17:34:08 -03:00
|
|
|
(code, msg) = self.getreply()
|
2011-02-24 16:43:11 -04:00
|
|
|
if self.debuglevel > 0:
|
|
|
|
print>>stderr, "connect:", msg
|
2001-07-24 17:34:08 -03:00
|
|
|
return (code, msg)
|
2001-01-14 21:36:40 -04:00
|
|
|
|
1998-01-29 13:24:40 -04:00
|
|
|
def send(self, str):
|
|
|
|
"""Send `str' to the server."""
|
2011-02-24 16:43:11 -04:00
|
|
|
if self.debuglevel > 0:
|
|
|
|
print>>stderr, 'send:', repr(str)
|
2008-02-23 08:27:17 -04:00
|
|
|
if hasattr(self, 'sock') and self.sock:
|
1998-08-10 17:07:00 -03:00
|
|
|
try:
|
2002-02-16 19:06:19 -04:00
|
|
|
self.sock.sendall(str)
|
1998-08-10 17:07:00 -03:00
|
|
|
except socket.error:
|
2001-12-14 16:34:20 -04:00
|
|
|
self.close()
|
1999-01-14 23:23:55 -04:00
|
|
|
raise SMTPServerDisconnected('Server not connected')
|
1998-01-29 13:26:45 -04:00
|
|
|
else:
|
1999-01-14 23:23:55 -04:00
|
|
|
raise SMTPServerDisconnected('please run connect() first')
|
2001-01-14 21:36:40 -04:00
|
|
|
|
1998-01-29 13:24:40 -04:00
|
|
|
def putcmd(self, cmd, args=""):
|
1998-12-21 23:24:27 -04:00
|
|
|
"""Send a command to the server."""
|
1999-06-09 12:13:10 -03:00
|
|
|
if args == "":
|
|
|
|
str = '%s%s' % (cmd, CRLF)
|
|
|
|
else:
|
|
|
|
str = '%s %s%s' % (cmd, args, CRLF)
|
1998-01-29 13:24:40 -04:00
|
|
|
self.send(str)
|
2001-01-14 21:36:40 -04:00
|
|
|
|
1998-08-04 12:29:54 -03:00
|
|
|
def getreply(self):
|
1998-01-29 13:24:40 -04:00
|
|
|
"""Get a reply from the server.
|
2001-01-14 21:36:40 -04:00
|
|
|
|
1998-01-29 13:24:40 -04:00
|
|
|
Returns a tuple consisting of:
|
1998-12-21 23:24:27 -04:00
|
|
|
|
|
|
|
- server response code (e.g. '250', or such, if all goes well)
|
|
|
|
Note: returns -1 if it can't read response code.
|
|
|
|
|
|
|
|
- server response string corresponding to response code (multiline
|
|
|
|
responses are converted to a single, multiline string).
|
1999-03-29 16:33:21 -04:00
|
|
|
|
|
|
|
Raises SMTPServerDisconnected if end-of-file is reached.
|
1998-01-29 13:24:40 -04:00
|
|
|
"""
|
2011-02-24 16:43:11 -04:00
|
|
|
resp = []
|
Changes by Per Cederquist and The Dragon.
Per writes:
"""
The application where Signum Support uses smtplib needs to be able to
report good error messages to the user when sending email fails. To
help in diagnosing problems it is useful to be able to report the
entire message sent by the server, not only the SMTP error code of the
offending command.
A lot of the functions in sendmail.py unfortunately discards the
message, leaving only the code. The enclosed patch fixes that
problem.
The enclosed patch also introduces a base class for exceptions that
include an SMTP error code and error message, and make the code and
message available on separate attributes, so that surrounding code can
deal with them in whatever way it sees fit. I've also added some
documentation to the exception classes.
The constructor will now raise an exception if it cannot connect to
the SMTP server.
The data() method will raise an SMTPDataError if it doesn't receive
the expected 354 code in the middle of the exchange.
According to section 5.2.10 of RFC 1123 a smtp client must accept "any
text, including no text at all" after the error code. If the response
of a HELO command contains no text self.helo_resp will be set to the
empty string (""). The patch fixes the test in the sendmail() method
so that helo_resp is tested against None; if it has the empty string
as value the sendmail() method would invoke the helo() method again.
The code no longer accepts a -1 reply from the ehlo() method in
sendmail().
[Text about removing SMTPRecipientsRefused deleted --GvR]
"""
and also:
"""
smtplib.py appends an extra blank line to the outgoing mail if the
`msg' argument to the sendmail method already contains a trailing
newline. This patch should fix the problem.
"""
The Dragon writes:
"""
Mostly I just re-added the SMTPRecipientsRefused exception
(the exeption object now has the appropriate info in it ) [Per had
removed this in his patch --GvR] and tweaked the behavior of the
sendmail method whence it throws the newly added SMTPHeloException (it
was closing the connection, which it shouldn't. whatever catches the
exception should do that. )
I pondered the change of the return values to tuples all around,
and after some thinking I decided that regularizing the return values was
too much of the Right Thing (tm) to not do.
My one concern is that code expecting an integer & getting a tuple
may fail silently.
(i.e. if it's doing :
x.somemethod() >= 400:
expecting an integer, the expression will always be true if it gets a
tuple instead. )
However, most smtplib code I've seen only really uses the
sendmail() method, so this wouldn't bother it. Usually code I've seen
that calls the other methods usually only calls helo() and ehlo() for
doing ESMTP, a feature which was not in the smtplib included with 1.5.1,
and thus I would think not much code uses it yet.
"""
1999-04-07 12:03:39 -03:00
|
|
|
if self.file is None:
|
|
|
|
self.file = self.sock.makefile('rb')
|
1998-03-26 17:13:24 -04:00
|
|
|
while 1:
|
2009-01-15 13:20:21 -04:00
|
|
|
try:
|
2014-12-05 21:05:18 -04:00
|
|
|
line = self.file.readline(_MAXLINE + 1)
|
2011-08-27 20:18:31 -03:00
|
|
|
except socket.error as e:
|
|
|
|
self.close()
|
|
|
|
raise SMTPServerDisconnected("Connection unexpectedly closed: "
|
|
|
|
+ str(e))
|
Changes by Per Cederquist and The Dragon.
Per writes:
"""
The application where Signum Support uses smtplib needs to be able to
report good error messages to the user when sending email fails. To
help in diagnosing problems it is useful to be able to report the
entire message sent by the server, not only the SMTP error code of the
offending command.
A lot of the functions in sendmail.py unfortunately discards the
message, leaving only the code. The enclosed patch fixes that
problem.
The enclosed patch also introduces a base class for exceptions that
include an SMTP error code and error message, and make the code and
message available on separate attributes, so that surrounding code can
deal with them in whatever way it sees fit. I've also added some
documentation to the exception classes.
The constructor will now raise an exception if it cannot connect to
the SMTP server.
The data() method will raise an SMTPDataError if it doesn't receive
the expected 354 code in the middle of the exchange.
According to section 5.2.10 of RFC 1123 a smtp client must accept "any
text, including no text at all" after the error code. If the response
of a HELO command contains no text self.helo_resp will be set to the
empty string (""). The patch fixes the test in the sendmail() method
so that helo_resp is tested against None; if it has the empty string
as value the sendmail() method would invoke the helo() method again.
The code no longer accepts a -1 reply from the ehlo() method in
sendmail().
[Text about removing SMTPRecipientsRefused deleted --GvR]
"""
and also:
"""
smtplib.py appends an extra blank line to the outgoing mail if the
`msg' argument to the sendmail method already contains a trailing
newline. This patch should fix the problem.
"""
The Dragon writes:
"""
Mostly I just re-added the SMTPRecipientsRefused exception
(the exeption object now has the appropriate info in it ) [Per had
removed this in his patch --GvR] and tweaked the behavior of the
sendmail method whence it throws the newly added SMTPHeloException (it
was closing the connection, which it shouldn't. whatever catches the
exception should do that. )
I pondered the change of the return values to tuples all around,
and after some thinking I decided that regularizing the return values was
too much of the Right Thing (tm) to not do.
My one concern is that code expecting an integer & getting a tuple
may fail silently.
(i.e. if it's doing :
x.somemethod() >= 400:
expecting an integer, the expression will always be true if it gets a
tuple instead. )
However, most smtplib code I've seen only really uses the
sendmail() method, so this wouldn't bother it. Usually code I've seen
that calls the other methods usually only calls helo() and ehlo() for
doing ESMTP, a feature which was not in the smtplib included with 1.5.1,
and thus I would think not much code uses it yet.
"""
1999-04-07 12:03:39 -03:00
|
|
|
if line == '':
|
|
|
|
self.close()
|
|
|
|
raise SMTPServerDisconnected("Connection unexpectedly closed")
|
2011-02-24 16:43:11 -04:00
|
|
|
if self.debuglevel > 0:
|
|
|
|
print>>stderr, 'reply:', repr(line)
|
2014-12-05 21:05:18 -04:00
|
|
|
if len(line) > _MAXLINE:
|
|
|
|
raise SMTPResponseException(500, "Line too long.")
|
2001-02-09 01:40:38 -04:00
|
|
|
resp.append(line[4:].strip())
|
2011-02-24 16:43:11 -04:00
|
|
|
code = line[:3]
|
Changes by Per Cederquist and The Dragon.
Per writes:
"""
The application where Signum Support uses smtplib needs to be able to
report good error messages to the user when sending email fails. To
help in diagnosing problems it is useful to be able to report the
entire message sent by the server, not only the SMTP error code of the
offending command.
A lot of the functions in sendmail.py unfortunately discards the
message, leaving only the code. The enclosed patch fixes that
problem.
The enclosed patch also introduces a base class for exceptions that
include an SMTP error code and error message, and make the code and
message available on separate attributes, so that surrounding code can
deal with them in whatever way it sees fit. I've also added some
documentation to the exception classes.
The constructor will now raise an exception if it cannot connect to
the SMTP server.
The data() method will raise an SMTPDataError if it doesn't receive
the expected 354 code in the middle of the exchange.
According to section 5.2.10 of RFC 1123 a smtp client must accept "any
text, including no text at all" after the error code. If the response
of a HELO command contains no text self.helo_resp will be set to the
empty string (""). The patch fixes the test in the sendmail() method
so that helo_resp is tested against None; if it has the empty string
as value the sendmail() method would invoke the helo() method again.
The code no longer accepts a -1 reply from the ehlo() method in
sendmail().
[Text about removing SMTPRecipientsRefused deleted --GvR]
"""
and also:
"""
smtplib.py appends an extra blank line to the outgoing mail if the
`msg' argument to the sendmail method already contains a trailing
newline. This patch should fix the problem.
"""
The Dragon writes:
"""
Mostly I just re-added the SMTPRecipientsRefused exception
(the exeption object now has the appropriate info in it ) [Per had
removed this in his patch --GvR] and tweaked the behavior of the
sendmail method whence it throws the newly added SMTPHeloException (it
was closing the connection, which it shouldn't. whatever catches the
exception should do that. )
I pondered the change of the return values to tuples all around,
and after some thinking I decided that regularizing the return values was
too much of the Right Thing (tm) to not do.
My one concern is that code expecting an integer & getting a tuple
may fail silently.
(i.e. if it's doing :
x.somemethod() >= 400:
expecting an integer, the expression will always be true if it gets a
tuple instead. )
However, most smtplib code I've seen only really uses the
sendmail() method, so this wouldn't bother it. Usually code I've seen
that calls the other methods usually only calls helo() and ehlo() for
doing ESMTP, a feature which was not in the smtplib included with 1.5.1,
and thus I would think not much code uses it yet.
"""
1999-04-07 12:03:39 -03:00
|
|
|
# Check that the error code is syntactically correct.
|
|
|
|
# Don't attempt to read a continuation line if it is broken.
|
|
|
|
try:
|
2001-02-09 01:40:38 -04:00
|
|
|
errcode = int(code)
|
Changes by Per Cederquist and The Dragon.
Per writes:
"""
The application where Signum Support uses smtplib needs to be able to
report good error messages to the user when sending email fails. To
help in diagnosing problems it is useful to be able to report the
entire message sent by the server, not only the SMTP error code of the
offending command.
A lot of the functions in sendmail.py unfortunately discards the
message, leaving only the code. The enclosed patch fixes that
problem.
The enclosed patch also introduces a base class for exceptions that
include an SMTP error code and error message, and make the code and
message available on separate attributes, so that surrounding code can
deal with them in whatever way it sees fit. I've also added some
documentation to the exception classes.
The constructor will now raise an exception if it cannot connect to
the SMTP server.
The data() method will raise an SMTPDataError if it doesn't receive
the expected 354 code in the middle of the exchange.
According to section 5.2.10 of RFC 1123 a smtp client must accept "any
text, including no text at all" after the error code. If the response
of a HELO command contains no text self.helo_resp will be set to the
empty string (""). The patch fixes the test in the sendmail() method
so that helo_resp is tested against None; if it has the empty string
as value the sendmail() method would invoke the helo() method again.
The code no longer accepts a -1 reply from the ehlo() method in
sendmail().
[Text about removing SMTPRecipientsRefused deleted --GvR]
"""
and also:
"""
smtplib.py appends an extra blank line to the outgoing mail if the
`msg' argument to the sendmail method already contains a trailing
newline. This patch should fix the problem.
"""
The Dragon writes:
"""
Mostly I just re-added the SMTPRecipientsRefused exception
(the exeption object now has the appropriate info in it ) [Per had
removed this in his patch --GvR] and tweaked the behavior of the
sendmail method whence it throws the newly added SMTPHeloException (it
was closing the connection, which it shouldn't. whatever catches the
exception should do that. )
I pondered the change of the return values to tuples all around,
and after some thinking I decided that regularizing the return values was
too much of the Right Thing (tm) to not do.
My one concern is that code expecting an integer & getting a tuple
may fail silently.
(i.e. if it's doing :
x.somemethod() >= 400:
expecting an integer, the expression will always be true if it gets a
tuple instead. )
However, most smtplib code I've seen only really uses the
sendmail() method, so this wouldn't bother it. Usually code I've seen
that calls the other methods usually only calls helo() and ehlo() for
doing ESMTP, a feature which was not in the smtplib included with 1.5.1,
and thus I would think not much code uses it yet.
"""
1999-04-07 12:03:39 -03:00
|
|
|
except ValueError:
|
|
|
|
errcode = -1
|
|
|
|
break
|
1999-03-29 16:33:21 -04:00
|
|
|
# Check if multiline response.
|
2011-02-24 16:43:11 -04:00
|
|
|
if line[3:4] != "-":
|
1998-01-29 13:24:40 -04:00
|
|
|
break
|
|
|
|
|
2001-02-09 01:40:38 -04:00
|
|
|
errmsg = "\n".join(resp)
|
2001-01-14 21:36:40 -04:00
|
|
|
if self.debuglevel > 0:
|
2011-02-24 16:43:11 -04:00
|
|
|
print>>stderr, 'reply: retcode (%s); Msg: %s' % (errcode, errmsg)
|
1998-01-29 13:24:40 -04:00
|
|
|
return errcode, errmsg
|
2001-01-14 21:36:40 -04:00
|
|
|
|
1998-01-29 13:24:40 -04:00
|
|
|
def docmd(self, cmd, args=""):
|
1998-12-21 23:24:27 -04:00
|
|
|
"""Send a command, and return its response code."""
|
2011-02-24 16:43:11 -04:00
|
|
|
self.putcmd(cmd, args)
|
Changes by Per Cederquist and The Dragon.
Per writes:
"""
The application where Signum Support uses smtplib needs to be able to
report good error messages to the user when sending email fails. To
help in diagnosing problems it is useful to be able to report the
entire message sent by the server, not only the SMTP error code of the
offending command.
A lot of the functions in sendmail.py unfortunately discards the
message, leaving only the code. The enclosed patch fixes that
problem.
The enclosed patch also introduces a base class for exceptions that
include an SMTP error code and error message, and make the code and
message available on separate attributes, so that surrounding code can
deal with them in whatever way it sees fit. I've also added some
documentation to the exception classes.
The constructor will now raise an exception if it cannot connect to
the SMTP server.
The data() method will raise an SMTPDataError if it doesn't receive
the expected 354 code in the middle of the exchange.
According to section 5.2.10 of RFC 1123 a smtp client must accept "any
text, including no text at all" after the error code. If the response
of a HELO command contains no text self.helo_resp will be set to the
empty string (""). The patch fixes the test in the sendmail() method
so that helo_resp is tested against None; if it has the empty string
as value the sendmail() method would invoke the helo() method again.
The code no longer accepts a -1 reply from the ehlo() method in
sendmail().
[Text about removing SMTPRecipientsRefused deleted --GvR]
"""
and also:
"""
smtplib.py appends an extra blank line to the outgoing mail if the
`msg' argument to the sendmail method already contains a trailing
newline. This patch should fix the problem.
"""
The Dragon writes:
"""
Mostly I just re-added the SMTPRecipientsRefused exception
(the exeption object now has the appropriate info in it ) [Per had
removed this in his patch --GvR] and tweaked the behavior of the
sendmail method whence it throws the newly added SMTPHeloException (it
was closing the connection, which it shouldn't. whatever catches the
exception should do that. )
I pondered the change of the return values to tuples all around,
and after some thinking I decided that regularizing the return values was
too much of the Right Thing (tm) to not do.
My one concern is that code expecting an integer & getting a tuple
may fail silently.
(i.e. if it's doing :
x.somemethod() >= 400:
expecting an integer, the expression will always be true if it gets a
tuple instead. )
However, most smtplib code I've seen only really uses the
sendmail() method, so this wouldn't bother it. Usually code I've seen
that calls the other methods usually only calls helo() and ehlo() for
doing ESMTP, a feature which was not in the smtplib included with 1.5.1,
and thus I would think not much code uses it yet.
"""
1999-04-07 12:03:39 -03:00
|
|
|
return self.getreply()
|
1998-01-29 13:24:40 -04:00
|
|
|
|
1998-12-21 23:24:27 -04:00
|
|
|
# std smtp commands
|
1998-01-29 13:24:40 -04:00
|
|
|
def helo(self, name=''):
|
1998-12-21 23:24:27 -04:00
|
|
|
"""SMTP 'helo' command.
|
|
|
|
Hostname to send for this command defaults to the FQDN of the local
|
|
|
|
host.
|
|
|
|
"""
|
2002-03-24 11:30:40 -04:00
|
|
|
self.putcmd("helo", name or self.local_hostname)
|
2011-02-24 16:43:11 -04:00
|
|
|
(code, msg) = self.getreply()
|
|
|
|
self.helo_resp = msg
|
|
|
|
return (code, msg)
|
1998-01-29 13:24:40 -04:00
|
|
|
|
1998-06-24 23:15:50 -03:00
|
|
|
def ehlo(self, name=''):
|
1998-12-21 23:24:27 -04:00
|
|
|
""" SMTP 'ehlo' command.
|
|
|
|
Hostname to send for this command defaults to the FQDN of the local
|
|
|
|
host.
|
|
|
|
"""
|
2001-09-14 13:08:44 -03:00
|
|
|
self.esmtp_features = {}
|
2007-03-09 11:35:55 -04:00
|
|
|
self.putcmd(self.ehlo_msg, name or self.local_hostname)
|
2011-02-24 16:43:11 -04:00
|
|
|
(code, msg) = self.getreply()
|
2001-01-14 21:36:40 -04:00
|
|
|
# According to RFC1869 some (badly written)
|
|
|
|
# MTA's will disconnect on an ehlo. Toss an exception if
|
1998-08-04 12:29:54 -03:00
|
|
|
# that happens -ddm
|
|
|
|
if code == -1 and len(msg) == 0:
|
2001-12-14 16:34:20 -04:00
|
|
|
self.close()
|
1999-01-14 23:23:55 -04:00
|
|
|
raise SMTPServerDisconnected("Server not connected")
|
2011-02-24 16:43:11 -04:00
|
|
|
self.ehlo_resp = msg
|
2000-12-12 19:20:45 -04:00
|
|
|
if code != 250:
|
2011-02-24 16:43:11 -04:00
|
|
|
return (code, msg)
|
|
|
|
self.does_esmtp = 1
|
2000-07-16 09:04:32 -03:00
|
|
|
#parse the ehlo response -ddm
|
2011-02-24 16:43:11 -04:00
|
|
|
resp = self.ehlo_resp.split('\n')
|
1998-08-04 12:29:54 -03:00
|
|
|
del resp[0]
|
1998-08-10 17:07:00 -03:00
|
|
|
for each in resp:
|
2002-07-26 21:38:30 -03:00
|
|
|
# To be able to communicate with as many SMTP servers as possible,
|
|
|
|
# we have to take the old-style auth advertisement into account,
|
|
|
|
# because:
|
|
|
|
# 1) Else our SMTP feature parser gets confused.
|
|
|
|
# 2) There are some servers that only advertise the auth methods we
|
|
|
|
# support using the old style.
|
|
|
|
auth_match = OLDSTYLE_AUTH.match(each)
|
|
|
|
if auth_match:
|
|
|
|
# This doesn't remove duplicates, but that's no problem
|
|
|
|
self.esmtp_features["auth"] = self.esmtp_features.get("auth", "") \
|
|
|
|
+ " " + auth_match.groups(0)[0]
|
|
|
|
continue
|
|
|
|
|
2002-04-15 17:03:30 -03:00
|
|
|
# RFC 1869 requires a space between ehlo keyword and parameters.
|
|
|
|
# It's actually stricter, in that only spaces are allowed between
|
|
|
|
# parameters, but were not going to check for that here. Note
|
|
|
|
# that the space isn't present if there are no parameters.
|
2011-02-24 16:43:11 -04:00
|
|
|
m = re.match(r'(?P<feature>[A-Za-z0-9][A-Za-z0-9\-]*) ?', each)
|
1998-08-04 12:29:54 -03:00
|
|
|
if m:
|
2011-02-24 16:43:11 -04:00
|
|
|
feature = m.group("feature").lower()
|
|
|
|
params = m.string[m.end("feature"):].strip()
|
2002-07-26 21:38:30 -03:00
|
|
|
if feature == "auth":
|
|
|
|
self.esmtp_features[feature] = self.esmtp_features.get(feature, "") \
|
|
|
|
+ " " + params
|
|
|
|
else:
|
2011-02-24 16:43:11 -04:00
|
|
|
self.esmtp_features[feature] = params
|
|
|
|
return (code, msg)
|
1998-06-24 23:15:50 -03:00
|
|
|
|
1998-08-04 12:29:54 -03:00
|
|
|
def has_extn(self, opt):
|
|
|
|
"""Does the server support a given SMTP service extension?"""
|
2002-06-01 11:18:47 -03:00
|
|
|
return opt.lower() in self.esmtp_features
|
1998-06-24 23:15:50 -03:00
|
|
|
|
1998-04-03 13:03:13 -04:00
|
|
|
def help(self, args=''):
|
1998-12-21 23:24:27 -04:00
|
|
|
"""SMTP 'help' command.
|
|
|
|
Returns help text from server."""
|
1998-04-03 13:03:13 -04:00
|
|
|
self.putcmd("help", args)
|
2005-06-26 15:27:36 -03:00
|
|
|
return self.getreply()[1]
|
1998-01-29 13:24:40 -04:00
|
|
|
|
|
|
|
def rset(self):
|
1998-12-21 23:24:27 -04:00
|
|
|
"""SMTP 'rset' command -- resets session."""
|
Changes by Per Cederquist and The Dragon.
Per writes:
"""
The application where Signum Support uses smtplib needs to be able to
report good error messages to the user when sending email fails. To
help in diagnosing problems it is useful to be able to report the
entire message sent by the server, not only the SMTP error code of the
offending command.
A lot of the functions in sendmail.py unfortunately discards the
message, leaving only the code. The enclosed patch fixes that
problem.
The enclosed patch also introduces a base class for exceptions that
include an SMTP error code and error message, and make the code and
message available on separate attributes, so that surrounding code can
deal with them in whatever way it sees fit. I've also added some
documentation to the exception classes.
The constructor will now raise an exception if it cannot connect to
the SMTP server.
The data() method will raise an SMTPDataError if it doesn't receive
the expected 354 code in the middle of the exchange.
According to section 5.2.10 of RFC 1123 a smtp client must accept "any
text, including no text at all" after the error code. If the response
of a HELO command contains no text self.helo_resp will be set to the
empty string (""). The patch fixes the test in the sendmail() method
so that helo_resp is tested against None; if it has the empty string
as value the sendmail() method would invoke the helo() method again.
The code no longer accepts a -1 reply from the ehlo() method in
sendmail().
[Text about removing SMTPRecipientsRefused deleted --GvR]
"""
and also:
"""
smtplib.py appends an extra blank line to the outgoing mail if the
`msg' argument to the sendmail method already contains a trailing
newline. This patch should fix the problem.
"""
The Dragon writes:
"""
Mostly I just re-added the SMTPRecipientsRefused exception
(the exeption object now has the appropriate info in it ) [Per had
removed this in his patch --GvR] and tweaked the behavior of the
sendmail method whence it throws the newly added SMTPHeloException (it
was closing the connection, which it shouldn't. whatever catches the
exception should do that. )
I pondered the change of the return values to tuples all around,
and after some thinking I decided that regularizing the return values was
too much of the Right Thing (tm) to not do.
My one concern is that code expecting an integer & getting a tuple
may fail silently.
(i.e. if it's doing :
x.somemethod() >= 400:
expecting an integer, the expression will always be true if it gets a
tuple instead. )
However, most smtplib code I've seen only really uses the
sendmail() method, so this wouldn't bother it. Usually code I've seen
that calls the other methods usually only calls helo() and ehlo() for
doing ESMTP, a feature which was not in the smtplib included with 1.5.1,
and thus I would think not much code uses it yet.
"""
1999-04-07 12:03:39 -03:00
|
|
|
return self.docmd("rset")
|
1998-01-29 13:24:40 -04:00
|
|
|
|
|
|
|
def noop(self):
|
1998-12-21 23:24:27 -04:00
|
|
|
"""SMTP 'noop' command -- doesn't do anything :>"""
|
Changes by Per Cederquist and The Dragon.
Per writes:
"""
The application where Signum Support uses smtplib needs to be able to
report good error messages to the user when sending email fails. To
help in diagnosing problems it is useful to be able to report the
entire message sent by the server, not only the SMTP error code of the
offending command.
A lot of the functions in sendmail.py unfortunately discards the
message, leaving only the code. The enclosed patch fixes that
problem.
The enclosed patch also introduces a base class for exceptions that
include an SMTP error code and error message, and make the code and
message available on separate attributes, so that surrounding code can
deal with them in whatever way it sees fit. I've also added some
documentation to the exception classes.
The constructor will now raise an exception if it cannot connect to
the SMTP server.
The data() method will raise an SMTPDataError if it doesn't receive
the expected 354 code in the middle of the exchange.
According to section 5.2.10 of RFC 1123 a smtp client must accept "any
text, including no text at all" after the error code. If the response
of a HELO command contains no text self.helo_resp will be set to the
empty string (""). The patch fixes the test in the sendmail() method
so that helo_resp is tested against None; if it has the empty string
as value the sendmail() method would invoke the helo() method again.
The code no longer accepts a -1 reply from the ehlo() method in
sendmail().
[Text about removing SMTPRecipientsRefused deleted --GvR]
"""
and also:
"""
smtplib.py appends an extra blank line to the outgoing mail if the
`msg' argument to the sendmail method already contains a trailing
newline. This patch should fix the problem.
"""
The Dragon writes:
"""
Mostly I just re-added the SMTPRecipientsRefused exception
(the exeption object now has the appropriate info in it ) [Per had
removed this in his patch --GvR] and tweaked the behavior of the
sendmail method whence it throws the newly added SMTPHeloException (it
was closing the connection, which it shouldn't. whatever catches the
exception should do that. )
I pondered the change of the return values to tuples all around,
and after some thinking I decided that regularizing the return values was
too much of the Right Thing (tm) to not do.
My one concern is that code expecting an integer & getting a tuple
may fail silently.
(i.e. if it's doing :
x.somemethod() >= 400:
expecting an integer, the expression will always be true if it gets a
tuple instead. )
However, most smtplib code I've seen only really uses the
sendmail() method, so this wouldn't bother it. Usually code I've seen
that calls the other methods usually only calls helo() and ehlo() for
doing ESMTP, a feature which was not in the smtplib included with 1.5.1,
and thus I would think not much code uses it yet.
"""
1999-04-07 12:03:39 -03:00
|
|
|
return self.docmd("noop")
|
1998-01-29 13:24:40 -04:00
|
|
|
|
2011-02-24 16:43:11 -04:00
|
|
|
def mail(self, sender, options=[]):
|
1998-12-21 23:24:27 -04:00
|
|
|
"""SMTP 'mail' command -- begins mail xfer session."""
|
1998-08-04 12:29:54 -03:00
|
|
|
optionlist = ''
|
|
|
|
if options and self.does_esmtp:
|
2001-02-09 01:40:38 -04:00
|
|
|
optionlist = ' ' + ' '.join(options)
|
2011-02-24 16:43:11 -04:00
|
|
|
self.putcmd("mail", "FROM:%s%s" % (quoteaddr(sender), optionlist))
|
1998-03-26 17:13:24 -04:00
|
|
|
return self.getreply()
|
1998-01-29 13:24:40 -04:00
|
|
|
|
2011-02-24 16:43:11 -04:00
|
|
|
def rcpt(self, recip, options=[]):
|
1998-12-21 23:24:27 -04:00
|
|
|
"""SMTP 'rcpt' command -- indicates 1 recipient for this mail."""
|
1998-08-04 12:29:54 -03:00
|
|
|
optionlist = ''
|
|
|
|
if options and self.does_esmtp:
|
2001-02-09 01:40:38 -04:00
|
|
|
optionlist = ' ' + ' '.join(options)
|
2011-02-24 16:43:11 -04:00
|
|
|
self.putcmd("rcpt", "TO:%s%s" % (quoteaddr(recip), optionlist))
|
1998-03-26 17:13:24 -04:00
|
|
|
return self.getreply()
|
1998-01-29 13:24:40 -04:00
|
|
|
|
2011-02-24 16:43:11 -04:00
|
|
|
def data(self, msg):
|
2001-01-14 21:36:40 -04:00
|
|
|
"""SMTP 'DATA' command -- sends message data to server.
|
Changes by Per Cederquist and The Dragon.
Per writes:
"""
The application where Signum Support uses smtplib needs to be able to
report good error messages to the user when sending email fails. To
help in diagnosing problems it is useful to be able to report the
entire message sent by the server, not only the SMTP error code of the
offending command.
A lot of the functions in sendmail.py unfortunately discards the
message, leaving only the code. The enclosed patch fixes that
problem.
The enclosed patch also introduces a base class for exceptions that
include an SMTP error code and error message, and make the code and
message available on separate attributes, so that surrounding code can
deal with them in whatever way it sees fit. I've also added some
documentation to the exception classes.
The constructor will now raise an exception if it cannot connect to
the SMTP server.
The data() method will raise an SMTPDataError if it doesn't receive
the expected 354 code in the middle of the exchange.
According to section 5.2.10 of RFC 1123 a smtp client must accept "any
text, including no text at all" after the error code. If the response
of a HELO command contains no text self.helo_resp will be set to the
empty string (""). The patch fixes the test in the sendmail() method
so that helo_resp is tested against None; if it has the empty string
as value the sendmail() method would invoke the helo() method again.
The code no longer accepts a -1 reply from the ehlo() method in
sendmail().
[Text about removing SMTPRecipientsRefused deleted --GvR]
"""
and also:
"""
smtplib.py appends an extra blank line to the outgoing mail if the
`msg' argument to the sendmail method already contains a trailing
newline. This patch should fix the problem.
"""
The Dragon writes:
"""
Mostly I just re-added the SMTPRecipientsRefused exception
(the exeption object now has the appropriate info in it ) [Per had
removed this in his patch --GvR] and tweaked the behavior of the
sendmail method whence it throws the newly added SMTPHeloException (it
was closing the connection, which it shouldn't. whatever catches the
exception should do that. )
I pondered the change of the return values to tuples all around,
and after some thinking I decided that regularizing the return values was
too much of the Right Thing (tm) to not do.
My one concern is that code expecting an integer & getting a tuple
may fail silently.
(i.e. if it's doing :
x.somemethod() >= 400:
expecting an integer, the expression will always be true if it gets a
tuple instead. )
However, most smtplib code I've seen only really uses the
sendmail() method, so this wouldn't bother it. Usually code I've seen
that calls the other methods usually only calls helo() and ehlo() for
doing ESMTP, a feature which was not in the smtplib included with 1.5.1,
and thus I would think not much code uses it yet.
"""
1999-04-07 12:03:39 -03:00
|
|
|
|
1998-12-21 23:02:20 -04:00
|
|
|
Automatically quotes lines beginning with a period per rfc821.
|
Changes by Per Cederquist and The Dragon.
Per writes:
"""
The application where Signum Support uses smtplib needs to be able to
report good error messages to the user when sending email fails. To
help in diagnosing problems it is useful to be able to report the
entire message sent by the server, not only the SMTP error code of the
offending command.
A lot of the functions in sendmail.py unfortunately discards the
message, leaving only the code. The enclosed patch fixes that
problem.
The enclosed patch also introduces a base class for exceptions that
include an SMTP error code and error message, and make the code and
message available on separate attributes, so that surrounding code can
deal with them in whatever way it sees fit. I've also added some
documentation to the exception classes.
The constructor will now raise an exception if it cannot connect to
the SMTP server.
The data() method will raise an SMTPDataError if it doesn't receive
the expected 354 code in the middle of the exchange.
According to section 5.2.10 of RFC 1123 a smtp client must accept "any
text, including no text at all" after the error code. If the response
of a HELO command contains no text self.helo_resp will be set to the
empty string (""). The patch fixes the test in the sendmail() method
so that helo_resp is tested against None; if it has the empty string
as value the sendmail() method would invoke the helo() method again.
The code no longer accepts a -1 reply from the ehlo() method in
sendmail().
[Text about removing SMTPRecipientsRefused deleted --GvR]
"""
and also:
"""
smtplib.py appends an extra blank line to the outgoing mail if the
`msg' argument to the sendmail method already contains a trailing
newline. This patch should fix the problem.
"""
The Dragon writes:
"""
Mostly I just re-added the SMTPRecipientsRefused exception
(the exeption object now has the appropriate info in it ) [Per had
removed this in his patch --GvR] and tweaked the behavior of the
sendmail method whence it throws the newly added SMTPHeloException (it
was closing the connection, which it shouldn't. whatever catches the
exception should do that. )
I pondered the change of the return values to tuples all around,
and after some thinking I decided that regularizing the return values was
too much of the Right Thing (tm) to not do.
My one concern is that code expecting an integer & getting a tuple
may fail silently.
(i.e. if it's doing :
x.somemethod() >= 400:
expecting an integer, the expression will always be true if it gets a
tuple instead. )
However, most smtplib code I've seen only really uses the
sendmail() method, so this wouldn't bother it. Usually code I've seen
that calls the other methods usually only calls helo() and ehlo() for
doing ESMTP, a feature which was not in the smtplib included with 1.5.1,
and thus I would think not much code uses it yet.
"""
1999-04-07 12:03:39 -03:00
|
|
|
Raises SMTPDataError if there is an unexpected reply to the
|
|
|
|
DATA command; the return value from this method is the final
|
|
|
|
response code received when the all data is sent.
|
1998-12-21 23:02:20 -04:00
|
|
|
"""
|
1998-03-26 17:13:24 -04:00
|
|
|
self.putcmd("data")
|
2011-02-24 16:43:11 -04:00
|
|
|
(code, repl) = self.getreply()
|
|
|
|
if self.debuglevel > 0:
|
|
|
|
print>>stderr, "data:", (code, repl)
|
2000-12-12 19:20:45 -04:00
|
|
|
if code != 354:
|
2011-02-24 16:43:11 -04:00
|
|
|
raise SMTPDataError(code, repl)
|
1998-03-26 17:13:24 -04:00
|
|
|
else:
|
1999-04-21 13:52:20 -03:00
|
|
|
q = quotedata(msg)
|
|
|
|
if q[-2:] != CRLF:
|
|
|
|
q = q + CRLF
|
|
|
|
q = q + "." + CRLF
|
|
|
|
self.send(q)
|
2011-02-24 16:43:11 -04:00
|
|
|
(code, msg) = self.getreply()
|
|
|
|
if self.debuglevel > 0:
|
|
|
|
print>>stderr, "data:", (code, msg)
|
|
|
|
return (code, msg)
|
1998-01-29 13:24:40 -04:00
|
|
|
|
1998-08-04 12:29:54 -03:00
|
|
|
def verify(self, address):
|
1998-12-21 23:24:27 -04:00
|
|
|
"""SMTP 'verify' command -- checks for address validity."""
|
2011-07-18 22:34:04 -03:00
|
|
|
self.putcmd("vrfy", _addr_only(address))
|
1998-08-04 12:29:54 -03:00
|
|
|
return self.getreply()
|
1998-12-21 23:02:20 -04:00
|
|
|
# a.k.a.
|
2011-02-24 16:43:11 -04:00
|
|
|
vrfy = verify
|
1998-08-04 12:29:54 -03:00
|
|
|
|
|
|
|
def expn(self, address):
|
2008-02-23 08:27:17 -04:00
|
|
|
"""SMTP 'expn' command -- expands a mailing list."""
|
2011-07-18 22:34:04 -03:00
|
|
|
self.putcmd("expn", _addr_only(address))
|
1998-08-04 12:29:54 -03:00
|
|
|
return self.getreply()
|
|
|
|
|
1998-12-21 23:02:20 -04:00
|
|
|
# some useful methods
|
2001-09-11 12:57:46 -03:00
|
|
|
|
2008-01-17 04:35:49 -04:00
|
|
|
def ehlo_or_helo_if_needed(self):
|
|
|
|
"""Call self.ehlo() and/or self.helo() if needed.
|
|
|
|
|
|
|
|
If there has been no previous EHLO or HELO command this session, this
|
|
|
|
method tries ESMTP EHLO first.
|
|
|
|
|
|
|
|
This method may raise the following exceptions:
|
|
|
|
|
|
|
|
SMTPHeloError The server didn't reply properly to
|
|
|
|
the helo greeting.
|
|
|
|
"""
|
|
|
|
if self.helo_resp is None and self.ehlo_resp is None:
|
|
|
|
if not (200 <= self.ehlo()[0] <= 299):
|
|
|
|
(code, resp) = self.helo()
|
|
|
|
if not (200 <= code <= 299):
|
|
|
|
raise SMTPHeloError(code, resp)
|
|
|
|
|
2001-09-11 12:57:46 -03:00
|
|
|
def login(self, user, password):
|
|
|
|
"""Log in on an SMTP server that requires authentication.
|
|
|
|
|
|
|
|
The arguments are:
|
|
|
|
- user: The user name to authenticate with.
|
|
|
|
- password: The password for the authentication.
|
|
|
|
|
|
|
|
If there has been no previous EHLO or HELO command this session, this
|
|
|
|
method tries ESMTP EHLO first.
|
|
|
|
|
|
|
|
This method will return normally if the authentication was successful.
|
|
|
|
|
|
|
|
This method may raise the following exceptions:
|
|
|
|
|
|
|
|
SMTPHeloError The server didn't reply properly to
|
|
|
|
the helo greeting.
|
|
|
|
SMTPAuthenticationError The server didn't accept the username/
|
|
|
|
password combination.
|
2001-10-13 15:35:32 -03:00
|
|
|
SMTPException No suitable authentication method was
|
2001-09-11 12:57:46 -03:00
|
|
|
found.
|
|
|
|
"""
|
|
|
|
|
|
|
|
def encode_cram_md5(challenge, user, password):
|
|
|
|
challenge = base64.decodestring(challenge)
|
|
|
|
response = user + " " + hmac.HMAC(password, challenge).hexdigest()
|
2002-07-26 21:38:30 -03:00
|
|
|
return encode_base64(response, eol="")
|
2001-09-11 12:57:46 -03:00
|
|
|
|
|
|
|
def encode_plain(user, password):
|
2004-12-06 17:25:26 -04:00
|
|
|
return encode_base64("\0%s\0%s" % (user, password), eol="")
|
2002-08-08 17:19:19 -03:00
|
|
|
|
2001-09-11 12:57:46 -03:00
|
|
|
|
|
|
|
AUTH_PLAIN = "PLAIN"
|
|
|
|
AUTH_CRAM_MD5 = "CRAM-MD5"
|
2002-07-26 21:38:30 -03:00
|
|
|
AUTH_LOGIN = "LOGIN"
|
2001-09-11 12:57:46 -03:00
|
|
|
|
2008-01-17 04:35:49 -04:00
|
|
|
self.ehlo_or_helo_if_needed()
|
2001-09-11 12:57:46 -03:00
|
|
|
|
|
|
|
if not self.has_extn("auth"):
|
|
|
|
raise SMTPException("SMTP AUTH extension not supported by server.")
|
|
|
|
|
|
|
|
# Authentication methods the server supports:
|
|
|
|
authlist = self.esmtp_features["auth"].split()
|
|
|
|
|
|
|
|
# List of authentication methods we support: from preferred to
|
|
|
|
# less preferred methods. Except for the purpose of testing the weaker
|
|
|
|
# ones, we prefer stronger methods like CRAM-MD5:
|
2002-07-26 21:38:30 -03:00
|
|
|
preferred_auths = [AUTH_CRAM_MD5, AUTH_PLAIN, AUTH_LOGIN]
|
2001-09-11 12:57:46 -03:00
|
|
|
|
|
|
|
# Determine the authentication method we'll use
|
|
|
|
authmethod = None
|
|
|
|
for method in preferred_auths:
|
|
|
|
if method in authlist:
|
|
|
|
authmethod = method
|
|
|
|
break
|
2001-09-17 23:26:39 -03:00
|
|
|
|
2001-09-11 12:57:46 -03:00
|
|
|
if authmethod == AUTH_CRAM_MD5:
|
|
|
|
(code, resp) = self.docmd("AUTH", AUTH_CRAM_MD5)
|
|
|
|
if code == 503:
|
|
|
|
# 503 == 'Error: already authenticated'
|
|
|
|
return (code, resp)
|
|
|
|
(code, resp) = self.docmd(encode_cram_md5(resp, user, password))
|
|
|
|
elif authmethod == AUTH_PLAIN:
|
2001-09-17 23:26:39 -03:00
|
|
|
(code, resp) = self.docmd("AUTH",
|
2001-09-11 12:57:46 -03:00
|
|
|
AUTH_PLAIN + " " + encode_plain(user, password))
|
2002-07-26 21:38:30 -03:00
|
|
|
elif authmethod == AUTH_LOGIN:
|
|
|
|
(code, resp) = self.docmd("AUTH",
|
|
|
|
"%s %s" % (AUTH_LOGIN, encode_base64(user, eol="")))
|
|
|
|
if code != 334:
|
|
|
|
raise SMTPAuthenticationError(code, resp)
|
2002-10-06 14:55:08 -03:00
|
|
|
(code, resp) = self.docmd(encode_base64(password, eol=""))
|
2002-05-31 14:49:10 -03:00
|
|
|
elif authmethod is None:
|
2001-10-13 15:35:32 -03:00
|
|
|
raise SMTPException("No suitable authentication method found.")
|
2005-02-06 02:57:08 -04:00
|
|
|
if code not in (235, 503):
|
2001-09-11 12:57:46 -03:00
|
|
|
# 235 == 'Authentication successful'
|
|
|
|
# 503 == 'Error: already authenticated'
|
|
|
|
raise SMTPAuthenticationError(code, resp)
|
|
|
|
return (code, resp)
|
|
|
|
|
2011-02-24 16:43:11 -04:00
|
|
|
def starttls(self, keyfile=None, certfile=None):
|
2001-09-14 13:08:44 -03:00
|
|
|
"""Puts the connection to the SMTP server into TLS mode.
|
2001-09-17 23:26:39 -03:00
|
|
|
|
2008-01-17 04:35:49 -04:00
|
|
|
If there has been no previous EHLO or HELO command this session, this
|
|
|
|
method tries ESMTP EHLO first.
|
|
|
|
|
2001-09-14 13:08:44 -03:00
|
|
|
If the server supports TLS, this will encrypt the rest of the SMTP
|
|
|
|
session. If you provide the keyfile and certfile parameters,
|
|
|
|
the identity of the SMTP server and client can be checked. This,
|
|
|
|
however, depends on whether the socket module really checks the
|
|
|
|
certificates.
|
2008-01-17 04:35:49 -04:00
|
|
|
|
|
|
|
This method may raise the following exceptions:
|
|
|
|
|
|
|
|
SMTPHeloError The server didn't reply properly to
|
|
|
|
the helo greeting.
|
2001-09-14 13:08:44 -03:00
|
|
|
"""
|
2008-01-17 04:35:49 -04:00
|
|
|
self.ehlo_or_helo_if_needed()
|
|
|
|
if not self.has_extn("starttls"):
|
|
|
|
raise SMTPException("STARTTLS extension not supported by server.")
|
2001-09-17 23:26:39 -03:00
|
|
|
(resp, reply) = self.docmd("STARTTLS")
|
2001-09-14 13:08:44 -03:00
|
|
|
if resp == 220:
|
2007-08-29 19:35:05 -03:00
|
|
|
if not _have_ssl:
|
|
|
|
raise RuntimeError("No SSL support included in this Python")
|
2007-09-10 18:51:02 -03:00
|
|
|
self.sock = ssl.wrap_socket(self.sock, keyfile, certfile)
|
2007-08-29 19:35:05 -03:00
|
|
|
self.file = SSLFakeFile(self.sock)
|
2008-01-17 03:43:20 -04:00
|
|
|
# RFC 3207:
|
|
|
|
# The client MUST discard any knowledge obtained from
|
|
|
|
# the server, such as the list of SMTP service extensions,
|
|
|
|
# which was not obtained from the TLS negotiation itself.
|
|
|
|
self.helo_resp = None
|
|
|
|
self.ehlo_resp = None
|
|
|
|
self.esmtp_features = {}
|
|
|
|
self.does_esmtp = 0
|
2016-06-11 17:16:42 -03:00
|
|
|
else:
|
|
|
|
# RFC 3207:
|
|
|
|
# 501 Syntax error (no parameters allowed)
|
|
|
|
# 454 TLS not available due to temporary reason
|
|
|
|
raise SMTPResponseException(resp, reply)
|
2001-09-14 13:08:44 -03:00
|
|
|
return (resp, reply)
|
2001-09-17 23:26:39 -03:00
|
|
|
|
1998-08-13 16:57:46 -03:00
|
|
|
def sendmail(self, from_addr, to_addrs, msg, mail_options=[],
|
2001-01-14 21:36:40 -04:00
|
|
|
rcpt_options=[]):
|
|
|
|
"""This command performs an entire mail transaction.
|
1998-12-21 23:02:20 -04:00
|
|
|
|
2001-01-14 21:36:40 -04:00
|
|
|
The arguments are:
|
1998-12-21 23:02:20 -04:00
|
|
|
- from_addr : The address sending this mail.
|
|
|
|
- to_addrs : A list of addresses to send this mail to. A bare
|
|
|
|
string will be treated as a list with 1 address.
|
2001-01-14 21:36:40 -04:00
|
|
|
- msg : The message to send.
|
1998-12-21 23:02:20 -04:00
|
|
|
- mail_options : List of ESMTP options (such as 8bitmime) for the
|
|
|
|
mail command.
|
|
|
|
- rcpt_options : List of ESMTP options (such as DSN commands) for
|
|
|
|
all the rcpt commands.
|
|
|
|
|
|
|
|
If there has been no previous EHLO or HELO command this session, this
|
|
|
|
method tries ESMTP EHLO first. If the server does ESMTP, message size
|
|
|
|
and each of the specified options will be passed to it. If EHLO
|
|
|
|
fails, HELO will be tried and ESMTP options suppressed.
|
|
|
|
|
|
|
|
This method will return normally if the mail is accepted for at least
|
1999-11-28 13:11:06 -04:00
|
|
|
one recipient. It returns a dictionary, with one entry for each
|
|
|
|
recipient that was refused. Each entry contains a tuple of the SMTP
|
|
|
|
error code and the accompanying error message sent by the server.
|
Changes by Per Cederquist and The Dragon.
Per writes:
"""
The application where Signum Support uses smtplib needs to be able to
report good error messages to the user when sending email fails. To
help in diagnosing problems it is useful to be able to report the
entire message sent by the server, not only the SMTP error code of the
offending command.
A lot of the functions in sendmail.py unfortunately discards the
message, leaving only the code. The enclosed patch fixes that
problem.
The enclosed patch also introduces a base class for exceptions that
include an SMTP error code and error message, and make the code and
message available on separate attributes, so that surrounding code can
deal with them in whatever way it sees fit. I've also added some
documentation to the exception classes.
The constructor will now raise an exception if it cannot connect to
the SMTP server.
The data() method will raise an SMTPDataError if it doesn't receive
the expected 354 code in the middle of the exchange.
According to section 5.2.10 of RFC 1123 a smtp client must accept "any
text, including no text at all" after the error code. If the response
of a HELO command contains no text self.helo_resp will be set to the
empty string (""). The patch fixes the test in the sendmail() method
so that helo_resp is tested against None; if it has the empty string
as value the sendmail() method would invoke the helo() method again.
The code no longer accepts a -1 reply from the ehlo() method in
sendmail().
[Text about removing SMTPRecipientsRefused deleted --GvR]
"""
and also:
"""
smtplib.py appends an extra blank line to the outgoing mail if the
`msg' argument to the sendmail method already contains a trailing
newline. This patch should fix the problem.
"""
The Dragon writes:
"""
Mostly I just re-added the SMTPRecipientsRefused exception
(the exeption object now has the appropriate info in it ) [Per had
removed this in his patch --GvR] and tweaked the behavior of the
sendmail method whence it throws the newly added SMTPHeloException (it
was closing the connection, which it shouldn't. whatever catches the
exception should do that. )
I pondered the change of the return values to tuples all around,
and after some thinking I decided that regularizing the return values was
too much of the Right Thing (tm) to not do.
My one concern is that code expecting an integer & getting a tuple
may fail silently.
(i.e. if it's doing :
x.somemethod() >= 400:
expecting an integer, the expression will always be true if it gets a
tuple instead. )
However, most smtplib code I've seen only really uses the
sendmail() method, so this wouldn't bother it. Usually code I've seen
that calls the other methods usually only calls helo() and ehlo() for
doing ESMTP, a feature which was not in the smtplib included with 1.5.1,
and thus I would think not much code uses it yet.
"""
1999-04-07 12:03:39 -03:00
|
|
|
|
|
|
|
This method may raise the following exceptions:
|
|
|
|
|
|
|
|
SMTPHeloError The server didn't reply properly to
|
2001-01-14 21:36:40 -04:00
|
|
|
the helo greeting.
|
1999-11-28 13:11:06 -04:00
|
|
|
SMTPRecipientsRefused The server rejected ALL recipients
|
Changes by Per Cederquist and The Dragon.
Per writes:
"""
The application where Signum Support uses smtplib needs to be able to
report good error messages to the user when sending email fails. To
help in diagnosing problems it is useful to be able to report the
entire message sent by the server, not only the SMTP error code of the
offending command.
A lot of the functions in sendmail.py unfortunately discards the
message, leaving only the code. The enclosed patch fixes that
problem.
The enclosed patch also introduces a base class for exceptions that
include an SMTP error code and error message, and make the code and
message available on separate attributes, so that surrounding code can
deal with them in whatever way it sees fit. I've also added some
documentation to the exception classes.
The constructor will now raise an exception if it cannot connect to
the SMTP server.
The data() method will raise an SMTPDataError if it doesn't receive
the expected 354 code in the middle of the exchange.
According to section 5.2.10 of RFC 1123 a smtp client must accept "any
text, including no text at all" after the error code. If the response
of a HELO command contains no text self.helo_resp will be set to the
empty string (""). The patch fixes the test in the sendmail() method
so that helo_resp is tested against None; if it has the empty string
as value the sendmail() method would invoke the helo() method again.
The code no longer accepts a -1 reply from the ehlo() method in
sendmail().
[Text about removing SMTPRecipientsRefused deleted --GvR]
"""
and also:
"""
smtplib.py appends an extra blank line to the outgoing mail if the
`msg' argument to the sendmail method already contains a trailing
newline. This patch should fix the problem.
"""
The Dragon writes:
"""
Mostly I just re-added the SMTPRecipientsRefused exception
(the exeption object now has the appropriate info in it ) [Per had
removed this in his patch --GvR] and tweaked the behavior of the
sendmail method whence it throws the newly added SMTPHeloException (it
was closing the connection, which it shouldn't. whatever catches the
exception should do that. )
I pondered the change of the return values to tuples all around,
and after some thinking I decided that regularizing the return values was
too much of the Right Thing (tm) to not do.
My one concern is that code expecting an integer & getting a tuple
may fail silently.
(i.e. if it's doing :
x.somemethod() >= 400:
expecting an integer, the expression will always be true if it gets a
tuple instead. )
However, most smtplib code I've seen only really uses the
sendmail() method, so this wouldn't bother it. Usually code I've seen
that calls the other methods usually only calls helo() and ehlo() for
doing ESMTP, a feature which was not in the smtplib included with 1.5.1,
and thus I would think not much code uses it yet.
"""
1999-04-07 12:03:39 -03:00
|
|
|
(no mail was sent).
|
|
|
|
SMTPSenderRefused The server didn't accept the from_addr.
|
|
|
|
SMTPDataError The server replied with an unexpected
|
|
|
|
error code (other than a refusal of
|
|
|
|
a recipient).
|
|
|
|
|
|
|
|
Note: the connection will be open even after an exception is raised.
|
1998-01-29 13:24:40 -04:00
|
|
|
|
1998-06-24 23:15:50 -03:00
|
|
|
Example:
|
2001-01-14 21:36:40 -04:00
|
|
|
|
1998-01-29 13:24:40 -04:00
|
|
|
>>> import smtplib
|
|
|
|
>>> s=smtplib.SMTP("localhost")
|
1998-01-29 13:26:45 -04:00
|
|
|
>>> tolist=["one@one.org","two@two.org","three@three.org","four@four.org"]
|
2002-07-28 13:52:01 -03:00
|
|
|
>>> msg = '''\\
|
1998-01-29 13:24:40 -04:00
|
|
|
... From: Me@my.org
|
|
|
|
... Subject: testin'...
|
|
|
|
...
|
|
|
|
... This is a test '''
|
|
|
|
>>> s.sendmail("me@my.org",tolist,msg)
|
|
|
|
{ "three@three.org" : ( 550 ,"User unknown" ) }
|
|
|
|
>>> s.quit()
|
2001-01-14 21:36:40 -04:00
|
|
|
|
1998-12-21 23:02:20 -04:00
|
|
|
In the above example, the message was accepted for delivery to three
|
|
|
|
of the four addresses, and one was rejected, with the error code
|
1999-11-28 13:11:06 -04:00
|
|
|
550. If all addresses are accepted, then the method will return an
|
1998-12-21 23:02:20 -04:00
|
|
|
empty dictionary.
|
|
|
|
|
|
|
|
"""
|
2008-01-17 04:35:49 -04:00
|
|
|
self.ehlo_or_helo_if_needed()
|
1998-06-24 23:15:50 -03:00
|
|
|
esmtp_opts = []
|
1998-08-04 12:29:54 -03:00
|
|
|
if self.does_esmtp:
|
|
|
|
# Hmmm? what's this? -ddm
|
|
|
|
# self.esmtp_features['7bit']=""
|
|
|
|
if self.has_extn('size'):
|
2004-02-12 13:35:32 -04:00
|
|
|
esmtp_opts.append("size=%d" % len(msg))
|
1998-08-04 12:29:54 -03:00
|
|
|
for option in mail_options:
|
1998-06-24 23:15:50 -03:00
|
|
|
esmtp_opts.append(option)
|
1998-08-04 12:29:54 -03:00
|
|
|
|
2011-02-24 16:43:11 -04:00
|
|
|
(code, resp) = self.mail(from_addr, esmtp_opts)
|
2000-12-12 19:20:45 -04:00
|
|
|
if code != 250:
|
1998-03-26 17:13:24 -04:00
|
|
|
self.rset()
|
Changes by Per Cederquist and The Dragon.
Per writes:
"""
The application where Signum Support uses smtplib needs to be able to
report good error messages to the user when sending email fails. To
help in diagnosing problems it is useful to be able to report the
entire message sent by the server, not only the SMTP error code of the
offending command.
A lot of the functions in sendmail.py unfortunately discards the
message, leaving only the code. The enclosed patch fixes that
problem.
The enclosed patch also introduces a base class for exceptions that
include an SMTP error code and error message, and make the code and
message available on separate attributes, so that surrounding code can
deal with them in whatever way it sees fit. I've also added some
documentation to the exception classes.
The constructor will now raise an exception if it cannot connect to
the SMTP server.
The data() method will raise an SMTPDataError if it doesn't receive
the expected 354 code in the middle of the exchange.
According to section 5.2.10 of RFC 1123 a smtp client must accept "any
text, including no text at all" after the error code. If the response
of a HELO command contains no text self.helo_resp will be set to the
empty string (""). The patch fixes the test in the sendmail() method
so that helo_resp is tested against None; if it has the empty string
as value the sendmail() method would invoke the helo() method again.
The code no longer accepts a -1 reply from the ehlo() method in
sendmail().
[Text about removing SMTPRecipientsRefused deleted --GvR]
"""
and also:
"""
smtplib.py appends an extra blank line to the outgoing mail if the
`msg' argument to the sendmail method already contains a trailing
newline. This patch should fix the problem.
"""
The Dragon writes:
"""
Mostly I just re-added the SMTPRecipientsRefused exception
(the exeption object now has the appropriate info in it ) [Per had
removed this in his patch --GvR] and tweaked the behavior of the
sendmail method whence it throws the newly added SMTPHeloException (it
was closing the connection, which it shouldn't. whatever catches the
exception should do that. )
I pondered the change of the return values to tuples all around,
and after some thinking I decided that regularizing the return values was
too much of the Right Thing (tm) to not do.
My one concern is that code expecting an integer & getting a tuple
may fail silently.
(i.e. if it's doing :
x.somemethod() >= 400:
expecting an integer, the expression will always be true if it gets a
tuple instead. )
However, most smtplib code I've seen only really uses the
sendmail() method, so this wouldn't bother it. Usually code I've seen
that calls the other methods usually only calls helo() and ehlo() for
doing ESMTP, a feature which was not in the smtplib included with 1.5.1,
and thus I would think not much code uses it yet.
"""
1999-04-07 12:03:39 -03:00
|
|
|
raise SMTPSenderRefused(code, resp, from_addr)
|
2011-02-24 16:43:11 -04:00
|
|
|
senderrs = {}
|
Remove uses of the string and types modules:
x in string.whitespace => x.isspace()
type(x) in types.StringTypes => isinstance(x, basestring)
isinstance(x, types.StringTypes) => isinstance(x, basestring)
type(x) is types.StringType => isinstance(x, str)
type(x) == types.StringType => isinstance(x, str)
string.split(x, ...) => x.split(...)
string.join(x, y) => y.join(x)
string.zfill(x, ...) => x.zfill(...)
string.count(x, ...) => x.count(...)
hasattr(types, "UnicodeType") => try: unicode except NameError:
type(x) != types.TupleTuple => not isinstance(x, tuple)
isinstance(x, types.TupleType) => isinstance(x, tuple)
type(x) is types.IntType => isinstance(x, int)
Do not mention the string module in the rlcompleter docstring.
This partially applies SF patch http://www.python.org/sf/562373
(with basestring instead of string). (It excludes the changes to
unittest.py and does not change the os.stat stuff.)
2002-06-03 12:58:32 -03:00
|
|
|
if isinstance(to_addrs, basestring):
|
1998-08-13 16:57:46 -03:00
|
|
|
to_addrs = [to_addrs]
|
1998-01-29 13:24:40 -04:00
|
|
|
for each in to_addrs:
|
2011-02-24 16:43:11 -04:00
|
|
|
(code, resp) = self.rcpt(each, rcpt_options)
|
2000-12-12 19:20:45 -04:00
|
|
|
if (code != 250) and (code != 251):
|
2011-02-24 16:43:11 -04:00
|
|
|
senderrs[each] = (code, resp)
|
|
|
|
if len(senderrs) == len(to_addrs):
|
1998-06-24 23:15:50 -03:00
|
|
|
# the server refused all our recipients
|
1998-01-29 13:24:40 -04:00
|
|
|
self.rset()
|
Changes by Per Cederquist and The Dragon.
Per writes:
"""
The application where Signum Support uses smtplib needs to be able to
report good error messages to the user when sending email fails. To
help in diagnosing problems it is useful to be able to report the
entire message sent by the server, not only the SMTP error code of the
offending command.
A lot of the functions in sendmail.py unfortunately discards the
message, leaving only the code. The enclosed patch fixes that
problem.
The enclosed patch also introduces a base class for exceptions that
include an SMTP error code and error message, and make the code and
message available on separate attributes, so that surrounding code can
deal with them in whatever way it sees fit. I've also added some
documentation to the exception classes.
The constructor will now raise an exception if it cannot connect to
the SMTP server.
The data() method will raise an SMTPDataError if it doesn't receive
the expected 354 code in the middle of the exchange.
According to section 5.2.10 of RFC 1123 a smtp client must accept "any
text, including no text at all" after the error code. If the response
of a HELO command contains no text self.helo_resp will be set to the
empty string (""). The patch fixes the test in the sendmail() method
so that helo_resp is tested against None; if it has the empty string
as value the sendmail() method would invoke the helo() method again.
The code no longer accepts a -1 reply from the ehlo() method in
sendmail().
[Text about removing SMTPRecipientsRefused deleted --GvR]
"""
and also:
"""
smtplib.py appends an extra blank line to the outgoing mail if the
`msg' argument to the sendmail method already contains a trailing
newline. This patch should fix the problem.
"""
The Dragon writes:
"""
Mostly I just re-added the SMTPRecipientsRefused exception
(the exeption object now has the appropriate info in it ) [Per had
removed this in his patch --GvR] and tweaked the behavior of the
sendmail method whence it throws the newly added SMTPHeloException (it
was closing the connection, which it shouldn't. whatever catches the
exception should do that. )
I pondered the change of the return values to tuples all around,
and after some thinking I decided that regularizing the return values was
too much of the Right Thing (tm) to not do.
My one concern is that code expecting an integer & getting a tuple
may fail silently.
(i.e. if it's doing :
x.somemethod() >= 400:
expecting an integer, the expression will always be true if it gets a
tuple instead. )
However, most smtplib code I've seen only really uses the
sendmail() method, so this wouldn't bother it. Usually code I've seen
that calls the other methods usually only calls helo() and ehlo() for
doing ESMTP, a feature which was not in the smtplib included with 1.5.1,
and thus I would think not much code uses it yet.
"""
1999-04-07 12:03:39 -03:00
|
|
|
raise SMTPRecipientsRefused(senderrs)
|
2011-02-24 16:43:11 -04:00
|
|
|
(code, resp) = self.data(msg)
|
2000-12-12 19:20:45 -04:00
|
|
|
if code != 250:
|
1998-01-29 13:24:40 -04:00
|
|
|
self.rset()
|
Changes by Per Cederquist and The Dragon.
Per writes:
"""
The application where Signum Support uses smtplib needs to be able to
report good error messages to the user when sending email fails. To
help in diagnosing problems it is useful to be able to report the
entire message sent by the server, not only the SMTP error code of the
offending command.
A lot of the functions in sendmail.py unfortunately discards the
message, leaving only the code. The enclosed patch fixes that
problem.
The enclosed patch also introduces a base class for exceptions that
include an SMTP error code and error message, and make the code and
message available on separate attributes, so that surrounding code can
deal with them in whatever way it sees fit. I've also added some
documentation to the exception classes.
The constructor will now raise an exception if it cannot connect to
the SMTP server.
The data() method will raise an SMTPDataError if it doesn't receive
the expected 354 code in the middle of the exchange.
According to section 5.2.10 of RFC 1123 a smtp client must accept "any
text, including no text at all" after the error code. If the response
of a HELO command contains no text self.helo_resp will be set to the
empty string (""). The patch fixes the test in the sendmail() method
so that helo_resp is tested against None; if it has the empty string
as value the sendmail() method would invoke the helo() method again.
The code no longer accepts a -1 reply from the ehlo() method in
sendmail().
[Text about removing SMTPRecipientsRefused deleted --GvR]
"""
and also:
"""
smtplib.py appends an extra blank line to the outgoing mail if the
`msg' argument to the sendmail method already contains a trailing
newline. This patch should fix the problem.
"""
The Dragon writes:
"""
Mostly I just re-added the SMTPRecipientsRefused exception
(the exeption object now has the appropriate info in it ) [Per had
removed this in his patch --GvR] and tweaked the behavior of the
sendmail method whence it throws the newly added SMTPHeloException (it
was closing the connection, which it shouldn't. whatever catches the
exception should do that. )
I pondered the change of the return values to tuples all around,
and after some thinking I decided that regularizing the return values was
too much of the Right Thing (tm) to not do.
My one concern is that code expecting an integer & getting a tuple
may fail silently.
(i.e. if it's doing :
x.somemethod() >= 400:
expecting an integer, the expression will always be true if it gets a
tuple instead. )
However, most smtplib code I've seen only really uses the
sendmail() method, so this wouldn't bother it. Usually code I've seen
that calls the other methods usually only calls helo() and ehlo() for
doing ESMTP, a feature which was not in the smtplib included with 1.5.1,
and thus I would think not much code uses it yet.
"""
1999-04-07 12:03:39 -03:00
|
|
|
raise SMTPDataError(code, resp)
|
1998-01-29 13:24:40 -04:00
|
|
|
#if we got here then somebody got our mail
|
2001-01-14 21:36:40 -04:00
|
|
|
return senderrs
|
1998-01-29 13:24:40 -04:00
|
|
|
|
|
|
|
|
|
|
|
def close(self):
|
|
|
|
"""Close the connection to the SMTP server."""
|
2015-04-10 07:24:10 -03:00
|
|
|
try:
|
|
|
|
file = self.file
|
|
|
|
self.file = None
|
|
|
|
if file:
|
|
|
|
file.close()
|
|
|
|
finally:
|
|
|
|
sock = self.sock
|
|
|
|
self.sock = None
|
|
|
|
if sock:
|
|
|
|
sock.close()
|
1998-01-29 13:24:40 -04:00
|
|
|
|
|
|
|
|
|
|
|
def quit(self):
|
1998-06-24 23:15:50 -03:00
|
|
|
"""Terminate the SMTP session."""
|
2008-03-27 10:27:31 -03:00
|
|
|
res = self.docmd("quit")
|
2014-08-30 17:56:49 -03:00
|
|
|
# A new EHLO is required after reconnecting with connect()
|
|
|
|
self.ehlo_resp = self.helo_resp = None
|
|
|
|
self.esmtp_features = {}
|
|
|
|
self.does_esmtp = False
|
1998-03-26 17:13:24 -04:00
|
|
|
self.close()
|
2008-03-27 10:27:31 -03:00
|
|
|
return res
|
1998-06-24 23:15:50 -03:00
|
|
|
|
2007-08-29 19:35:05 -03:00
|
|
|
if _have_ssl:
|
|
|
|
|
|
|
|
class SMTP_SSL(SMTP):
|
2013-06-23 17:10:37 -03:00
|
|
|
""" This is a subclass derived from SMTP that connects over an SSL
|
|
|
|
encrypted socket (to use this class you need a socket module that was
|
|
|
|
compiled with SSL support). If host is not specified, '' (the local
|
|
|
|
host) is used. If port is omitted, the standard SMTP-over-SSL port
|
|
|
|
(465) is used. local_hostname has the same meaning as it does in the
|
|
|
|
SMTP class. keyfile and certfile are also optional - they can contain
|
|
|
|
a PEM formatted private key and certificate chain file for the SSL
|
|
|
|
connection.
|
|
|
|
|
2007-08-29 19:35:05 -03:00
|
|
|
"""
|
2011-05-07 14:59:33 -03:00
|
|
|
|
|
|
|
default_port = SMTP_SSL_PORT
|
|
|
|
|
2007-08-29 19:35:05 -03:00
|
|
|
def __init__(self, host='', port=0, local_hostname=None,
|
2008-05-29 13:39:26 -03:00
|
|
|
keyfile=None, certfile=None,
|
|
|
|
timeout=socket._GLOBAL_DEFAULT_TIMEOUT):
|
2007-08-29 19:35:05 -03:00
|
|
|
self.keyfile = keyfile
|
|
|
|
self.certfile = certfile
|
|
|
|
SMTP.__init__(self, host, port, local_hostname, timeout)
|
|
|
|
|
|
|
|
def _get_socket(self, host, port, timeout):
|
2011-02-24 16:43:11 -04:00
|
|
|
if self.debuglevel > 0:
|
|
|
|
print>>stderr, 'connect:', (host, port)
|
2009-05-22 21:48:58 -03:00
|
|
|
new_socket = socket.create_connection((host, port), timeout)
|
|
|
|
new_socket = ssl.wrap_socket(new_socket, self.keyfile, self.certfile)
|
|
|
|
self.file = SSLFakeFile(new_socket)
|
|
|
|
return new_socket
|
1998-12-21 23:02:20 -04:00
|
|
|
|
2007-08-30 18:54:39 -03:00
|
|
|
__all__.append("SMTP_SSL")
|
|
|
|
|
2007-03-09 11:35:55 -04:00
|
|
|
#
|
|
|
|
# LMTP extension
|
|
|
|
#
|
|
|
|
LMTP_PORT = 2003
|
|
|
|
|
|
|
|
class LMTP(SMTP):
|
|
|
|
"""LMTP - Local Mail Transfer Protocol
|
|
|
|
|
|
|
|
The LMTP protocol, which is very similar to ESMTP, is heavily based
|
2013-06-23 17:10:37 -03:00
|
|
|
on the standard SMTP client. It's common to use Unix sockets for
|
|
|
|
LMTP, so our connect() method must support that as well as a regular
|
|
|
|
host:port server. local_hostname has the same meaning as it does in
|
|
|
|
the SMTP class. To specify a Unix socket, you must use an absolute
|
2007-03-09 11:35:55 -04:00
|
|
|
path as the host, starting with a '/'.
|
|
|
|
|
|
|
|
Authentication is supported, using the regular SMTP mechanism. When
|
|
|
|
using a Unix socket, LMTP generally don't support or require any
|
|
|
|
authentication, but your mileage might vary."""
|
|
|
|
|
|
|
|
ehlo_msg = "lhlo"
|
2007-03-12 15:07:52 -03:00
|
|
|
|
2011-02-24 16:43:11 -04:00
|
|
|
def __init__(self, host='', port=LMTP_PORT, local_hostname=None):
|
2007-03-09 11:35:55 -04:00
|
|
|
"""Initialize a new instance."""
|
|
|
|
SMTP.__init__(self, host, port, local_hostname)
|
|
|
|
|
2011-02-24 16:43:11 -04:00
|
|
|
def connect(self, host='localhost', port=0):
|
2007-03-09 11:35:55 -04:00
|
|
|
"""Connect to the LMTP daemon, on either a Unix or a TCP socket."""
|
2007-03-09 23:19:18 -04:00
|
|
|
if host[0] != '/':
|
2007-03-09 11:35:55 -04:00
|
|
|
return SMTP.connect(self, host, port)
|
|
|
|
|
2007-03-09 23:19:18 -04:00
|
|
|
# Handle Unix-domain sockets.
|
|
|
|
try:
|
|
|
|
self.sock = socket.socket(socket.AF_UNIX, socket.SOCK_STREAM)
|
|
|
|
self.sock.connect(host)
|
2012-12-17 13:06:43 -04:00
|
|
|
except socket.error:
|
2011-02-24 16:43:11 -04:00
|
|
|
if self.debuglevel > 0:
|
|
|
|
print>>stderr, 'connect fail:', host
|
2007-03-09 23:19:18 -04:00
|
|
|
if self.sock:
|
|
|
|
self.sock.close()
|
|
|
|
self.sock = None
|
2012-12-17 13:06:43 -04:00
|
|
|
raise
|
2007-03-09 23:19:18 -04:00
|
|
|
(code, msg) = self.getreply()
|
2011-02-24 16:43:11 -04:00
|
|
|
if self.debuglevel > 0:
|
|
|
|
print>>stderr, "connect:", msg
|
2007-03-09 23:19:18 -04:00
|
|
|
return (code, msg)
|
|
|
|
|
2007-03-09 11:35:55 -04:00
|
|
|
|
1998-06-24 23:15:50 -03:00
|
|
|
# Test the sendmail method, which tests most of the others.
|
|
|
|
# Note: This always sends to localhost.
|
|
|
|
if __name__ == '__main__':
|
2001-08-13 11:41:39 -03:00
|
|
|
import sys
|
1998-06-24 23:15:50 -03:00
|
|
|
|
|
|
|
def prompt(prompt):
|
|
|
|
sys.stdout.write(prompt + ": ")
|
2001-02-09 01:40:38 -04:00
|
|
|
return sys.stdin.readline().strip()
|
1998-06-24 23:15:50 -03:00
|
|
|
|
|
|
|
fromaddr = prompt("From")
|
2011-02-24 16:43:11 -04:00
|
|
|
toaddrs = prompt("To").split(',')
|
1998-06-24 23:15:50 -03:00
|
|
|
print "Enter message, end with ^D:"
|
|
|
|
msg = ''
|
|
|
|
while 1:
|
|
|
|
line = sys.stdin.readline()
|
|
|
|
if not line:
|
|
|
|
break
|
|
|
|
msg = msg + line
|
2004-02-12 13:35:32 -04:00
|
|
|
print "Message length is %d" % len(msg)
|
1998-06-24 23:15:50 -03:00
|
|
|
|
|
|
|
server = SMTP('localhost')
|
|
|
|
server.set_debuglevel(1)
|
|
|
|
server.sendmail(fromaddr, toaddrs, msg)
|
|
|
|
server.quit()
|