summaryrefslogtreecommitdiffstats
path: root/Doc
diff options
context:
space:
mode:
authorR David Murray <rdmurray@bitdance.com>2014-06-09 20:41:06 (GMT)
committerR David Murray <rdmurray@bitdance.com>2014-06-09 20:41:06 (GMT)
commit6ceca4e3d850ef2ba81d5f51aac3fe6c0c85284e (patch)
treef7148c9a3afd5506842c02a0ec6d36f6b004f2d7 /Doc
parentf10063e3c3dcd5fe5b99858fc618c574b6df7bf2 (diff)
downloadcpython-6ceca4e3d850ef2ba81d5f51aac3fe6c0c85284e.zip
cpython-6ceca4e3d850ef2ba81d5f51aac3fe6c0c85284e.tar.gz
cpython-6ceca4e3d850ef2ba81d5f51aac3fe6c0c85284e.tar.bz2
#20903: clarify what happens when an smtp connection timeout occurs.
Patch by Milan Oberkirch.
Diffstat (limited to 'Doc')
-rw-r--r--Doc/library/smtplib.rst3
1 files changed, 2 insertions, 1 deletions
diff --git a/Doc/library/smtplib.rst b/Doc/library/smtplib.rst
index 46cfa36..8e1bfb5 100644
--- a/Doc/library/smtplib.rst
+++ b/Doc/library/smtplib.rst
@@ -32,7 +32,8 @@ Protocol) and :rfc:`1869` (SMTP Service Extensions).
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
+ setting will be used). If the timeout expires, :exc:`socket.timeout` is
+ raised. The optional source_address parameter allows to bind
to some specific source address in a machine with multiple network
interfaces, and/or to some specific source TCP port. It takes a 2-tuple
(host, port), for the socket to bind to as its source address before