From 98d504a0e121b3731a4f10c58d9e594f60b78b94 Mon Sep 17 00:00:00 2001 From: Neal Norwitz Date: Fri, 23 Sep 2005 04:28:23 +0000 Subject: Backport SF #1297059, doc incorrect return type for search() method. (There is a description of returned values at the top, so just remove the sentance and correct an example.) --- Doc/lib/libimaplib.tex | 7 +++---- 1 file changed, 3 insertions(+), 4 deletions(-) diff --git a/Doc/lib/libimaplib.tex b/Doc/lib/libimaplib.tex index 3448ba6..d150629 100644 --- a/Doc/lib/libimaplib.tex +++ b/Doc/lib/libimaplib.tex @@ -322,8 +322,7 @@ data = authobject(response) \end{methoddesc} \begin{methoddesc}{search}{charset, criterion\optional{, ...}} - Search mailbox for matching messages. Returned data contains a space - separated list of matching message numbers. \var{charset} may be + Search mailbox for matching messages. \var{charset} may be \code{None}, in which case no \samp{CHARSET} will be specified in the request to the server. The IMAP protocol requires that at least one criterion be specified; an exception will be raised when the server @@ -333,10 +332,10 @@ data = authobject(response) \begin{verbatim} # M is a connected IMAP4 instance... -msgnums = M.search(None, 'FROM', '"LDJ"') +typ, msgnums = M.search(None, 'FROM', '"LDJ"') # or: -msgnums = M.search(None, '(FROM "LDJ")') +typ, msgnums = M.search(None, '(FROM "LDJ")') \end{verbatim} \end{methoddesc} -- cgit v0.12