summaryrefslogtreecommitdiffstats
path: root/Doc
diff options
context:
space:
mode:
authorFacundo Batista <facundobatista@gmail.com>2007-03-27 18:23:21 (GMT)
committerFacundo Batista <facundobatista@gmail.com>2007-03-27 18:23:21 (GMT)
commit1b1c347311edcddac3381b6c2cfe2f86e82e2d60 (patch)
tree386ec37379cff7189ee952aa3b37562798a0c268 /Doc
parent3f100992896b61b52209b5c7c57b06b805347e78 (diff)
downloadcpython-1b1c347311edcddac3381b6c2cfe2f86e82e2d60.zip
cpython-1b1c347311edcddac3381b6c2cfe2f86e82e2d60.tar.gz
cpython-1b1c347311edcddac3381b6c2cfe2f86e82e2d60.tar.bz2
Added an optional timeout to poplib.POP3. Also created a
test_poplib.py file with a basic test and the timeout ones. Docs are also updated.
Diffstat (limited to 'Doc')
-rw-r--r--Doc/lib/libpoplib.tex5
1 files changed, 4 insertions, 1 deletions
diff --git a/Doc/lib/libpoplib.tex b/Doc/lib/libpoplib.tex
index 25570ae..71c4040 100644
--- a/Doc/lib/libpoplib.tex
+++ b/Doc/lib/libpoplib.tex
@@ -28,10 +28,13 @@ servers tend to be better implemented.
A single class is provided by the \module{poplib} module:
-\begin{classdesc}{POP3}{host\optional{, port}}
+\begin{classdesc}{POP3}{host\optional{, port\optional{, timeout}}}
This class implements the actual POP3 protocol. The connection is
created when the instance is initialized.
If \var{port} is omitted, the standard POP3 port (110) is used.
+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}{POP3_SSL}{host\optional{, port\optional{, keyfile\optional{, certfile}}}}