smtplib
index
/usr/lib/python2.2/smtplib.py

SMTP/ESMTP client class.
 
This should follow RFC 821 (SMTP), RFC 1869 (ESMTP), RFC 2554 (SMTP
Authentication) and RFC 2487 (Secure SMTP over TLS).
 
Notes:
 
Please remember, when doing ESMTP, that the names of the SMTP service
extensions are NOT the same thing as the option keywords for the RCPT
and MAIL commands!
 
Example:
 
  >>> 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()

 
Modules
            
base64
hmac
re
rfc822
socket
types
 
Classes
            
exceptions.Exception
SMTPException
SMTPRecipientsRefused
SMTPResponseException
SMTPAuthenticationError
SMTPConnectError
SMTPDataError
SMTPHeloError
SMTPSenderRefused
SMTPServerDisconnected
SMTP
SSLFakeFile
SSLFakeSocket
 
class SMTP
      This class manages a connection to an SMTP or ESMTP server.
SMTP Objects:
    SMTP objects have the following attributes:
        helo_resp
            This is the message given by the server in response to the
            most recent HELO command.
 
        ehlo_resp
            This is the message given by the server in response to the
            most recent EHLO command. This is usually multiline.
 
        does_esmtp
            This is a True value _after you do an EHLO command_, if the
            server supports ESMTP.
 
        esmtp_features
            This is a dictionary, which, if the server supports ESMTP,
            will _after you do an EHLO command_, contain the names of the
            SMTP service extensions this server supports, and their
            parameters (if any).
 
            Note, all extension names are mapped to lower case in the
            dictionary.
 
    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.
 
   Methods defined here:
__init__(self, host='', port=0)
Initialize a new instance.
 
If specified, `host' is the name of the remote host to which to
connect.  If specified, `port' specifies the port to which to connect.
By default, smtplib.SMTP_PORT is used.  An SMTPConnectError is raised
if the specified `host' doesn't respond correctly.
close(self)
Close the connection to the SMTP server.
connect(self, host='localhost', port=0)
Connect to a host on a given port.
 
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.
 
Note: This method is automatically invoked by __init__, if a host is
specified during instantiation.
data(self, msg)
SMTP 'DATA' command -- sends message data to server.
 
Automatically quotes lines beginning with a period per rfc821.
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.
docmd(self, cmd, args='')
Send a command, and return its response code.
ehlo(self, name='')
 SMTP 'ehlo' command.
Hostname to send for this command defaults to the FQDN of the local
host.
expn(self, address)
SMTP 'verify' command -- checks for address validity.
getreply(self)
Get a reply from the server.
 
Returns a tuple consisting of:
 
  - 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).
 
Raises SMTPServerDisconnected if end-of-file is reached.
has_extn(self, opt)
Does the server support a given SMTP service extension?
helo(self, name='')
SMTP 'helo' command.
Hostname to send for this command defaults to the FQDN of the local
host.
help(self, args='')
SMTP 'help' command.
Returns help text from server.
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.
 SMTPException            No suitable authentication method was
                          found.
mail(self, sender, options=[])
SMTP 'mail' command -- begins mail xfer session.
noop(self)
SMTP 'noop' command -- doesn't do anything :>
putcmd(self, cmd, args='')
Send a command to the server.
quit(self)
Terminate the SMTP session.
rcpt(self, recip, options=[])
SMTP 'rcpt' command -- indicates 1 recipient for this mail.
rset(self)
SMTP 'rset' command -- resets session.
send(self, str)
Send `str' to the server.
sendmail(self, from_addr, to_addrs, msg, mail_options=[], rcpt_options=[])
This command performs an entire mail transaction.
 
The arguments are:
    - 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.
    - msg          : The message to send.
    - 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
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.
 
This method may raise the following exceptions:
 
 SMTPHeloError          The server didn't reply properly to
                        the helo greeting.
 SMTPRecipientsRefused  The server rejected ALL recipients
                        (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.
 
Example:
 
 >>> import smtplib
 >>> s=smtplib.SMTP("localhost")
 >>> tolist=["one@one.org","two@two.org","three@three.org","four@four.org"]
 >>> msg = '''
 ... 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()
 
In the above example, the message was accepted for delivery to three
of the four addresses, and one was rejected, with the error code
550.  If all addresses are accepted, then the method will return an
empty dictionary.
set_debuglevel(self, debuglevel)
Set the debug output level.
 
A non-false value results in debug messages for connection and for all
messages sent to and received from the server.
starttls(self, keyfile=None, certfile=None)
Puts the connection to the SMTP server into TLS mode.
 
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.
verify(self, address)
SMTP 'verify' command -- checks for address validity.
vrfy = verify(self, address)

Data and non-method functions defined here:
__doc__ = 'This class manages a connection to an SMTP or E...at will do an entire mail transaction.\n '
__module__ = 'smtplib'
debuglevel = 0
does_esmtp = 0
ehlo_resp = None
file = None
helo_resp = None
 
class SMTPAuthenticationError(SMTPResponseException)
      Authentication error.
 
Most probably the server didn't accept the username/password
combination provided.
 
  
Method resolution order:
SMTPAuthenticationError
SMTPResponseException
SMTPException
exceptions.Exception

Data and non-method functions defined here:
__doc__ = 'Authentication error.\n\n Most probably the ...ername/password\n combination provided.\n '
__module__ = 'smtplib'

Methods inherited from SMTPResponseException:
__init__(self, code, msg)

Methods inherited from exceptions.Exception:
__getitem__(...)
__str__(...)
 
class SMTPConnectError(SMTPResponseException)
      Error during connection establishment.
 
  
Method resolution order:
SMTPConnectError
SMTPResponseException
SMTPException
exceptions.Exception

Data and non-method functions defined here:
__doc__ = 'Error during connection establishment.'
__module__ = 'smtplib'

Methods inherited from SMTPResponseException:
__init__(self, code, msg)

Methods inherited from exceptions.Exception:
__getitem__(...)
__str__(...)
 
class SMTPDataError(SMTPResponseException)
      The SMTP server didn't accept the data.
 
  
Method resolution order:
SMTPDataError
SMTPResponseException
SMTPException
exceptions.Exception

Data and non-method functions defined here:
__doc__ = "The SMTP server didn't accept the data."
__module__ = 'smtplib'

Methods inherited from SMTPResponseException:
__init__(self, code, msg)

Methods inherited from exceptions.Exception:
__getitem__(...)
__str__(...)
 
class SMTPException(exceptions.Exception)
      Base class for all exceptions raised by this module.
 
   Data and non-method functions defined here:
__doc__ = 'Base class for all exceptions raised by this module.'
__module__ = 'smtplib'

Methods inherited from exceptions.Exception:
__getitem__(...)
__init__(...)
__str__(...)
 
class SMTPHeloError(SMTPResponseException)
      The server refused our HELO reply.
 
  
Method resolution order:
SMTPHeloError
SMTPResponseException
SMTPException
exceptions.Exception

Data and non-method functions defined here:
__doc__ = 'The server refused our HELO reply.'
__module__ = 'smtplib'

Methods inherited from SMTPResponseException:
__init__(self, code, msg)

Methods inherited from exceptions.Exception:
__getitem__(...)
__str__(...)
 
class SMTPRecipientsRefused(SMTPException)
      All recipient addresses refused.
 
The errors for each recipient are accessible through the attribute
'recipients', which is a dictionary of exactly the same sort as
SMTP.sendmail() returns.
 
  
Method resolution order:
SMTPRecipientsRefused
SMTPException
exceptions.Exception

Methods defined here:
__init__(self, recipients)

Data and non-method functions defined here:
__doc__ = 'All recipient addresses refused.\n\n The err...same sort as\n SMTP.sendmail() returns.\n '
__module__ = 'smtplib'

Methods inherited from exceptions.Exception:
__getitem__(...)
__str__(...)
 
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.
 
  
Method resolution order:
SMTPResponseException
SMTPException
exceptions.Exception

Methods defined here:
__init__(self, code, msg)

Data and non-method functions defined here:
__doc__ = "Base class for all exceptions that include an S...ttribute\n is set to the error message.\n "
__module__ = 'smtplib'

Methods inherited from exceptions.Exception:
__getitem__(...)
__str__(...)
 
class SMTPSenderRefused(SMTPResponseException)
      Sender address refused.
 
In addition to the attributes set by on all SMTPResponseException
exceptions, this sets `sender' to the string that the SMTP refused.
 
  
Method resolution order:
SMTPSenderRefused
SMTPResponseException
SMTPException
exceptions.Exception

Methods defined here:
__init__(self, code, msg, sender)

Data and non-method functions defined here:
__doc__ = "Sender address refused.\n\n In addition to t...nder' to the string that the SMTP refused.\n "
__module__ = 'smtplib'

Methods inherited from exceptions.Exception:
__getitem__(...)
__str__(...)
 
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.
 
  
Method resolution order:
SMTPServerDisconnected
SMTPException
exceptions.Exception

Data and non-method functions defined here:
__doc__ = 'Not connected to any SMTP server.\n\n This e...nce before\n connecting it to a server.\n '
__module__ = 'smtplib'

Methods inherited from exceptions.Exception:
__getitem__(...)
__init__(...)
__str__(...)
 
class SSLFakeFile
      A fake file like object that really wraps a SSLObject.
 
It only supports what is needed in smtplib.
 
   Methods defined here:
__init__(self, sslobj)
close(self)
readline(self)

Data and non-method functions defined here:
__doc__ = 'A fake file like object that really wraps a SSL...t only supports what is needed in smtplib.\n '
__module__ = 'smtplib'
 
class SSLFakeSocket
      A fake socket object that really wraps a SSLObject.
 
It only supports what is needed in smtplib.
 
   Methods defined here:
__init__(self, realsock, sslobj)
close(self)
send(self, str)

Data and non-method functions defined here:
__doc__ = 'A fake socket object that really wraps a SSLObj...t only supports what is needed in smtplib.\n '
__module__ = 'smtplib'
 
Functions
            
quoteaddr(addr)
Quote a subset of the email addresses defined by RFC 821.
 
Should be able to handle anything rfc822.parseaddr can handle.
quotedata(data)
Quote data for email.
 
Double leading '.', and change Unix newline '\n', or Mac '\r' into
Internet CRLF end-of-line.
 
Data
             CRLF = '\r\n'
SMTP_PORT = 25
__all__ = ['SMTPException', 'SMTPServerDisconnected', 'SMTPResponseException', 'SMTPSenderRefused', 'SMTPRecipientsRefused', 'SMTPDataError', 'SMTPConnectError', 'SMTPHeloError', 'SMTPAuthenticationError', 'quoteaddr', 'quotedata', 'SMTP']
__file__ = '/usr/lib/python2.2/smtplib.pyc'
__name__ = 'smtplib'