Commit 8effea18 authored by R David Murray's avatar R David Murray

#20903: clarify what happens when an smtp connection timeout occurs.

Patch by Milan Oberkirch.
parent bfd77b12
...@@ -32,7 +32,8 @@ Protocol) and :rfc:`1869` (SMTP Service Extensions). ...@@ -32,7 +32,8 @@ Protocol) and :rfc:`1869` (SMTP Service Extensions).
than a success code, an :exc:`SMTPConnectError` is raised. The optional than a success code, an :exc:`SMTPConnectError` is raised. The optional
*timeout* parameter specifies a timeout in seconds for blocking operations *timeout* parameter specifies a timeout in seconds for blocking operations
like the connection attempt (if not specified, the global default timeout like the connection attempt (if not specified, the global default timeout
setting will be used). setting will be used). If the timeout expires, :exc:`socket.timeout`
is raised.
For normal use, you should only require the initialization/connect, For normal use, you should only require the initialization/connect,
:meth:`sendmail`, and :meth:`~smtplib.quit` methods. :meth:`sendmail`, and :meth:`~smtplib.quit` methods.
...@@ -54,7 +55,8 @@ Protocol) and :rfc:`1869` (SMTP Service Extensions). ...@@ -54,7 +55,8 @@ Protocol) and :rfc:`1869` (SMTP Service Extensions).
formatted private key and certificate chain file for the SSL connection. The formatted private key and certificate chain file for the SSL connection. The
optional *timeout* parameter specifies a timeout in seconds for blocking optional *timeout* parameter specifies a timeout in seconds for blocking
operations like the connection attempt (if not specified, the global default operations like the connection attempt (if not specified, the global default
timeout setting will be used). timeout setting will be used). If the timeout expires, :exc:`socket.timeout`
is raised.
.. versionadded:: 2.6 .. versionadded:: 2.6
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment