(original) (raw)

changeset: 83307:36d07a877f33 branch: 3.3 parent: 83303:2673d207c524 user: R David Murray rdmurray@bitdance.com date: Sat Apr 13 14:40:33 2013 -0400 files: Doc/library/smtplib.rst Lib/smtplib.py description: #2118: clarify smtplib exception documentation. diff -r 2673d207c524 -r 36d07a877f33 Doc/library/smtplib.rst --- a/Doc/library/smtplib.rst Sat Apr 13 21:15:47 2013 +0300 +++ b/Doc/library/smtplib.rst Sat Apr 13 14:40:33 2013 -0400 @@ -25,8 +25,9 @@ A :class:`SMTP` instance encapsulates an SMTP connection. It has methods that support a full repertoire of SMTP and ESMTP operations. If the optional host and port parameters are given, the SMTP :meth:`connect` method is called - with those parameters during initialization. An :exc:`SMTPConnectError` is - raised if the specified host doesn't respond correctly. The optional + with those parameters during initialization. If the :meth:`connect` call + returns anything other than a success code, an :exc:`SMTPConnectError` is + raised. The optional *timeout* parameter specifies a timeout in seconds for blocking operations like the connection attempt (if not specified, the global default timeout setting will be used). The optional source_address parameter allows to bind to some @@ -103,7 +104,8 @@ .. exception:: SMTPException - Base exception class for all exceptions raised by this module. + The base exception class for all the other excpetions provided by this + module. .. exception:: SMTPServerDisconnected @@ -182,15 +184,6 @@ for connection and for all messages sent to and received from the server. -.. method:: SMTP.connect(host='localhost', port=0) - - Connect to a host on a given port. The defaults are to connect to the local - host at the standard SMTP port (25). If the hostname ends with a colon (``':'``) - followed by a number, that suffix will be stripped off and the number - interpreted as the port number to use. This method is automatically invoked by - the constructor if a host is specified during instantiation. - - .. method:: SMTP.docmd(cmd, args='') Send a command *cmd* to the server. The optional argument *args* is simply @@ -207,6 +200,17 @@ :exc:`SMTPServerDisconnected` will be raised. +.. method:: SMTP.connect(host='localhost', port=0) + + Connect to a host on a given port. The defaults are to connect to the local + host at the standard SMTP port (25). If the hostname ends with a colon (``':'``) + followed by a number, that suffix will be stripped off and the number + interpreted as the port number to use. This method is automatically invoked by + the constructor if a host is specified during instantiation. Returns a + 2-tuple of the response code and message sent by the server in its + connection response. + + .. method:: SMTP.helo(name='') Identify yourself to the SMTP server using ``HELO``. The hostname argument diff -r 2673d207c524 -r 36d07a877f33 Lib/smtplib.py --- a/Lib/smtplib.py Sat Apr 13 21:15:47 2013 +0300 +++ b/Lib/smtplib.py Sat Apr 13 14:40:33 2013 -0400 @@ -221,8 +221,9 @@ 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. If specified, + By default, smtplib.SMTP_PORT is used. If a host is specified the + connect method is called, and if it returns anything other than + a success code an SMTPConnectError is raised. If specified, `local_hostname` is used as the FQDN of the local host. By default, the local hostname is found using socket.getfqdn(). The `source_address` parameter takes a 2-tuple (host, port) for the socket /rdmurray@bitdance.com