[Python-checkins] python/dist/src/Doc/lib libimaplib.tex,1.24,1.25

Mon Nov 10 01:44:46 EST 2003

Update of /cvsroot/python/python/dist/src/Doc/lib
In directory sc8-pr-cvs1:/tmp/cvs-serv16560/Doc/lib
Modified Files:
	libimaplib.tex 
Log Message:
Patch #798297: Add IMAP THREAD command.
Index: libimaplib.tex
===================================================================
RCS file: /cvsroot/python/python/dist/src/Doc/lib/libimaplib.tex,v
retrieving revision 1.24
retrieving revision 1.25
diff -C2 -d -r1.24 -r1.25
*** libimaplib.tex	27 Mar 2003 16:59:38 -0000	1.24
--- libimaplib.tex	10 Nov 2003 06:44:43 -0000	1.25
***************
*** 356,359 ****
--- 356,381 ----
 \end{methoddesc}
 
+ \begin{methoddesc}{thread}{threading_algorithm, charset, search_criterion\optional{, ...}}
+ The \code{thread} command is a variant of \code{search} with threading semantics for
+ the results. Returned data contains a space
+ separated list of thread members.
+ 
+ Thread members consist of zero or more messages numbers, delimited by spaces,
+ indicating successive parent and child.
+ 
+ Thread has two arguments before the \var{search_criterion}
+ argument(s); a \var{threading_algorithm}, and the searching \var{charset}.
+ Note that unlike \code{search}, the searching \var{charset} argument is mandatory.
+ There is also a \code{uid thread} command which corresponds to \code{thread} the way
+ that \code{uid search} corresponds to \code{search}.
+ The \code{thread} command first searches the mailbox for messages that
+ match the given searching criteria using the charset argument for
+ the interpretation of strings in the searching criteria. It thren
+ returns the matching messages threaded according to the specified
+ threading algorithm.
+ 
+ This is an \samp{IMAP4rev1} extension command. \versionadded{2.4}
+ \end{methoddesc}
+ 
 \begin{methoddesc}{uid}{command, arg\optional{, ...}}
 Execute command args with messages identified by UID, rather than