summaryrefslogtreecommitdiff
path: root/Doc/library/smtplib.rst
diff options
context:
space:
mode:
authorR David Murray <rdmurray@bitdance.com>2013-04-13 14:40:33 -0400
committerR David Murray <rdmurray@bitdance.com>2013-04-13 14:40:33 -0400
commit14ee3cf244aad69d138159cf70715eedb95ce00f (patch)
tree44f57d38085300318b1471abc160b9f68e11f686 /Doc/library/smtplib.rst
parent4bb17348f5507f42f62d15b16ca0672e802f619c (diff)
downloadcpython-git-14ee3cf244aad69d138159cf70715eedb95ce00f.tar.gz
#2118: clarify smtplib exception documentation.
Diffstat (limited to 'Doc/library/smtplib.rst')
-rw-r--r--Doc/library/smtplib.rst28
1 files changed, 16 insertions, 12 deletions
diff --git a/Doc/library/smtplib.rst b/Doc/library/smtplib.rst
index 40b2561c6b..38d5f31098 100644
--- a/Doc/library/smtplib.rst
+++ b/Doc/library/smtplib.rst
@@ -25,8 +25,9 @@ Protocol) and :rfc:`1869` (SMTP Service Extensions).
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 @@ A nice selection of exceptions is defined as well:
.. 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 @@ An :class:`SMTP` instance has the following methods:
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 @@ An :class:`SMTP` instance has the following methods:
: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