summaryrefslogtreecommitdiffstats
path: root/Doc
diff options
context:
space:
mode:
authorFacundo Batista <facundobatista@gmail.com>2007-03-28 18:25:54 (GMT)
committerFacundo Batista <facundobatista@gmail.com>2007-03-28 18:25:54 (GMT)
commit366d6262f810ea58a869f2039683871c7b7186fa (patch)
treecaa080f10f03abd20a656353e1e257482c0c3733 /Doc
parent1fe9f968a21843175c3cbd6adf632aa95d2f2bef (diff)
downloadcpython-366d6262f810ea58a869f2039683871c7b7186fa.zip
cpython-366d6262f810ea58a869f2039683871c7b7186fa.tar.gz
cpython-366d6262f810ea58a869f2039683871c7b7186fa.tar.bz2
Added timeout to smtplib (to SMTP and SMTP_SSL). Also created
the test_smtplib.py file, with a basic test and the timeout ones. Docs are updated too.
Diffstat (limited to 'Doc')
-rw-r--r--Doc/lib/libsmtplib.tex10
1 files changed, 8 insertions, 2 deletions
diff --git a/Doc/lib/libsmtplib.tex b/Doc/lib/libsmtplib.tex
index f7b8098..aaa8ddd 100644
--- a/Doc/lib/libsmtplib.tex
+++ b/Doc/lib/libsmtplib.tex
@@ -15,13 +15,16 @@ listener daemon. For details of SMTP and ESMTP operation, consult
(\citetitle{SMTP Service Extensions}).
\begin{classdesc}{SMTP}{\optional{host\optional{, port\optional{,
- local_hostname}}}}
+ local_hostname\optional{, timeout}}}}}
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 \method{connect()} method is called with those parameters during
initialization. An \exception{SMTPConnectError} is raised if the
specified host doesn't respond correctly.
+The optional \var{timeout} parameter specifies a timeout in seconds for the
+connection attempt (if not specified, or passed as None, the global
+default timeout setting will be used).
For normal use, you should only require the initialization/connect,
\method{sendmail()}, and \method{quit()} methods. An example is
@@ -31,7 +34,7 @@ included below.
\begin{classdesc}{SMTP_SSL}{\optional{host\optional{, port\optional{,
local_hostname\optional{,
keyfile\optional{,
- certfile}}}}}}
+ certfile\optional{, timeout}}}}}}}
A \class{SMTP_SSL} instance behaves exactly the same as instances of \class{SMTP}.
\class{SMTP_SSL} should be used for situations where SSL is required from
the beginning of the connection and using \method{starttls()} is not appropriate.
@@ -39,6 +42,9 @@ If \var{host} is not specified, the local host is used. If \var{port} is
omitted, the standard SMTP-over-SSL port (465) is used. \var{keyfile} and \var{certfile}
are also optional, and can contain a PEM formatted private key and
certificate chain file for the SSL connection.
+The optional \var{timeout} parameter specifies a timeout in seconds for the
+connection attempt (if not specified, or passed as None, the global
+default timeout setting will be used).
\end{classdesc}
\begin{classdesc}{LMTP}{\optional{host\optional{, port\optional{,