diff options
| author | Antoine Pitrou <solipsis@pitrou.net> | 2011-02-07 15:58:11 +0000 |
|---|---|---|
| committer | Antoine Pitrou <solipsis@pitrou.net> | 2011-02-07 15:58:11 +0000 |
| commit | fdded56a469880a8230c44232cd7ce36edc99f3a (patch) | |
| tree | 1da563e69c96bde3170273432ab01606a67bc2d9 /Doc/library/imaplib.rst | |
| parent | 7a0afd3f070a490788c0d760f017624bded8ed46 (diff) | |
| download | cpython-git-fdded56a469880a8230c44232cd7ce36edc99f3a.tar.gz | |
Clarify that IMAP4() implicitly calls open(), and that logout() implicitly calls shutdown().
Diffstat (limited to 'Doc/library/imaplib.rst')
| -rw-r--r-- | Doc/library/imaplib.rst | 8 |
1 files changed, 5 insertions, 3 deletions
diff --git a/Doc/library/imaplib.rst b/Doc/library/imaplib.rst index 78adcf8a5a..1d92fe5339 100644 --- a/Doc/library/imaplib.rst +++ b/Doc/library/imaplib.rst @@ -298,9 +298,10 @@ An :class:`IMAP4` instance has the following methods: .. method:: IMAP4.open(host, port) - Opens socket to *port* at *host*. The connection objects established by this + Opens socket to *port* at *host*. This method is implicitly called by + the :class:`IMAP4` constructor. The connection objects established by this method will be used in the ``read``, ``readline``, ``send``, and ``shutdown`` - methods. You may override this method. + methods. You may override this method. .. method:: IMAP4.partial(message_num, message_part, start, length) @@ -390,7 +391,8 @@ An :class:`IMAP4` instance has the following methods: .. method:: IMAP4.shutdown() - Close connection established in ``open``. You may override this method. + Close connection established in ``open``. This method is implicitly + called by :meth:`IMAP4.logout`. You may override this method. .. method:: IMAP4.socket() |