Commits

Anonymous committed 687faa9

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.)

Comments (0)

Files changed (1)

Doc/lib/libimaplib.tex

 \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
 
 \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}