mirrors/cpython
1
0
Fork 0
mirror of https://github.com/python/cpython.git synced 2025-09-26 10:19:53 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 8

Lots of explicit class names for method and member descs.

Browse source
This commit is contained in:
Georg Brandl 2007-04-01 22:39:10 +00:00
parent b8e8df2e63
commit ae91afdcfb
42 changed files with 489 additions and 489 deletions
Download patch file Download diff file Expand all files Collapse all files

30
Doc/lib/libpoplib.tex
View file

@ -73,7 +73,7 @@ in lower-case; most return the response text sent by the server.
An \class{POP3} instance has the following methods:
\begin{methoddesc}{set_debuglevel}{level}
\begin{methoddesc}[POP3]{set_debuglevel}{level}
Set the instance's debugging level. This controls the amount of
debugging output printed. The default, \code{0}, produces no
debugging output. A value of \code{1} produces a moderate amount of
@ -82,64 +82,64 @@ debugging output, generally a single line per request. A value of
logging each line sent and received on the control connection.
\end{methoddesc}
\begin{methoddesc}{getwelcome}{}
\begin{methoddesc}[POP3]{getwelcome}{}
Returns the greeting string sent by the POP3 server.
\end{methoddesc}
\begin{methoddesc}{user}{username}
\begin{methoddesc}[POP3]{user}{username}
Send user command, response should indicate that a password is required.
\end{methoddesc}
\begin{methoddesc}{pass_}{password}
\begin{methoddesc}[POP3]{pass_}{password}
Send password, response includes message count and mailbox size.
Note: the mailbox on the server is locked until \method{quit()} is
called.
\end{methoddesc}
\begin{methoddesc}{apop}{user, secret}
\begin{methoddesc}[POP3]{apop}{user, secret}
Use the more secure APOP authentication to log into the POP3 server.
\end{methoddesc}
\begin{methoddesc}{rpop}{user}
\begin{methoddesc}[POP3]{rpop}{user}
Use RPOP authentication (similar to UNIX r-commands) to log into POP3 server.
\end{methoddesc}
\begin{methoddesc}{stat}{}
\begin{methoddesc}[POP3]{stat}{}
Get mailbox status. The result is a tuple of 2 integers:
\code{(\var{message count}, \var{mailbox size})}.
\end{methoddesc}
\begin{methoddesc}{list}{\optional{which}}
\begin{methoddesc}[POP3]{list}{\optional{which}}
Request message list, result is in the form
\code{(\var{response}, ['mesg_num octets', ...], \var{octets})}.
If \var{which} is set, it is the message to list.
\end{methoddesc}
\begin{methoddesc}{retr}{which}
\begin{methoddesc}[POP3]{retr}{which}
Retrieve whole message number \var{which}, and set its seen flag.
Result is in form \code{(\var{response}, ['line', ...], \var{octets})}.
\end{methoddesc}
\begin{methoddesc}{dele}{which}
\begin{methoddesc}[POP3]{dele}{which}
Flag message number \var{which} for deletion. On most servers
deletions are not actually performed until QUIT (the major exception is
Eudora QPOP, which deliberately violates the RFCs by doing pending
deletes on any disconnect).
\end{methoddesc}
\begin{methoddesc}{rset}{}
\begin{methoddesc}[POP3]{rset}{}
Remove any deletion marks for the mailbox.
\end{methoddesc}
\begin{methoddesc}{noop}{}
\begin{methoddesc}[POP3]{noop}{}
Do nothing. Might be used as a keep-alive.
\end{methoddesc}
\begin{methoddesc}{quit}{}
\begin{methoddesc}[POP3]{quit}{}
Signoff: commit changes, unlock mailbox, drop connection.
\end{methoddesc}
\begin{methoddesc}{top}{which, howmuch}
\begin{methoddesc}[POP3]{top}{which, howmuch}
Retrieves the message header plus \var{howmuch} lines of the message
after the header of message number \var{which}. Result is in form
\code{(\var{response}, ['line', ...], \var{octets})}.
@ -151,7 +151,7 @@ Test this method by hand against the POP3 servers you will use before
trusting it.
\end{methoddesc}
\begin{methoddesc}{uidl}{\optional{which}}
\begin{methoddesc}[POP3]{uidl}{\optional{which}}
Return message digest (unique id) list.
If \var{which} is specified, result contains the unique id for that
message in the form \code{'\var{response}\ \var{mesgnum}\ \var{uid}},