diff options
| author | Georg Brandl <georg@python.org> | 2009-09-02 20:34:52 (GMT) |
|---|---|---|
| committer | Georg Brandl <georg@python.org> | 2009-09-02 20:34:52 (GMT) |
| commit | 1824415470243ab8fb08172e2b32b4efe73e0295 (patch) | |
| tree | 6246f8f0cd792ee5325bb49a87e9e46969963dda /Doc/library/poplib.rst | |
| parent | 0bb1cc72c8e37a5ac53b800667693c4330beb5a3 (diff) | |
| download | cpython-1824415470243ab8fb08172e2b32b4efe73e0295.zip cpython-1824415470243ab8fb08172e2b32b4efe73e0295.tar.gz cpython-1824415470243ab8fb08172e2b32b4efe73e0295.tar.bz2 | |
Switch more function arguments docs to new-style.
Diffstat (limited to 'Doc/library/poplib.rst')
| -rw-r--r-- | Doc/library/poplib.rst | 8 |
1 files changed, 4 insertions, 4 deletions
diff --git a/Doc/library/poplib.rst b/Doc/library/poplib.rst index 0b2c033..b397b4b 100644 --- a/Doc/library/poplib.rst +++ b/Doc/library/poplib.rst @@ -1,4 +1,3 @@ - :mod:`poplib` --- POP3 protocol client ====================================== @@ -24,7 +23,7 @@ mailserver supports IMAP, you would be better off using the A single class is provided by the :mod:`poplib` module: -.. class:: POP3(host[, port[, timeout]]) +.. class:: POP3(host, port=POP3_PORT[, timeout]) This class implements the actual POP3 protocol. The connection is created when the instance is initialized. If *port* is omitted, the standard POP3 port (110) @@ -33,12 +32,13 @@ A single class is provided by the :mod:`poplib` module: be used). -.. class:: POP3_SSL(host[, port[, keyfile[, certfile]]]) +.. class:: POP3_SSL(host, port=POP3_SSL_PORT, keyfile=None, certfile=None[, timeout]) This is a subclass of :class:`POP3` that connects to the server over an SSL encrypted socket. If *port* is not specified, 995, the standard POP3-over-SSL port is used. *keyfile* and *certfile* are also optional - they can contain a PEM formatted private key and certificate chain file for the SSL connection. + *timeout* works as in the :class:`POP3` constructor. One exception is defined as an attribute of the :mod:`poplib` module: @@ -160,7 +160,7 @@ An :class:`POP3` instance has the following methods: POP3 servers you will use before trusting it. -.. method:: POP3.uidl([which]) +.. method:: POP3.uidl(which=None) Return message digest (unique id) list. If *which* is specified, result contains the unique id for that message in the form ``'response mesgnum uid``, otherwise |