Added description for authenticate and namespace
This commit is contained in:
parent
c1e32b6518
commit
8bc81fc5c7
|
@ -138,12 +138,26 @@ An \class{IMAP4} instance has the following methods:
|
||||||
|
|
||||||
|
|
||||||
\begin{methoddesc}{append}{mailbox, flags, date_time, message}
|
\begin{methoddesc}{append}{mailbox, flags, date_time, message}
|
||||||
Append message to named mailbox.
|
Append \var{message} to named mailbox.
|
||||||
\end{methoddesc}
|
\end{methoddesc}
|
||||||
|
|
||||||
\begin{methoddesc}{authenticate}{func}
|
\begin{methoddesc}{authenticate}{mechanism, authobject}
|
||||||
Authenticate command --- requires response processing. This is
|
Authenticate command --- requires response processing.
|
||||||
currently unimplemented, and raises an exception.
|
|
||||||
|
\var{mechanism} specifies which authentication mechanism is to
|
||||||
|
be used - it should appear in the instance variable \code{capabilities} in the
|
||||||
|
form \code{AUTH=mechanism}.
|
||||||
|
|
||||||
|
\var{authobject} must be a callable object:
|
||||||
|
|
||||||
|
\begin{verbatim}
|
||||||
|
data = authobject(response)
|
||||||
|
\end{verbatim}
|
||||||
|
|
||||||
|
It will be called to process server continuation responses.
|
||||||
|
It should return \code{data} that will be encoded and sent to server.
|
||||||
|
It should return \code{None} if the client abort response \samp{*} should
|
||||||
|
be sent instead.
|
||||||
\end{methoddesc}
|
\end{methoddesc}
|
||||||
|
|
||||||
\begin{methoddesc}{check}{}
|
\begin{methoddesc}{check}{}
|
||||||
|
@ -228,6 +242,11 @@ An \class{IMAP4} instance has the following methods:
|
||||||
Returned data are tuples of message part envelope and data.
|
Returned data are tuples of message part envelope and data.
|
||||||
\end{methoddesc}
|
\end{methoddesc}
|
||||||
|
|
||||||
|
\begin{methoddesc}{namespace}{}
|
||||||
|
Returns IMAP namespaces as defined in RFC2342.
|
||||||
|
\versionadded{2.3}
|
||||||
|
\end{methoddesc}
|
||||||
|
|
||||||
\begin{methoddesc}{noop}{}
|
\begin{methoddesc}{noop}{}
|
||||||
Send \samp{NOOP} to server.
|
Send \samp{NOOP} to server.
|
||||||
\end{methoddesc}
|
\end{methoddesc}
|
||||||
|
|
Loading…
Reference in New Issue