Skip to content

Commit 02cfa0b

Browse files
committed
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.)
1 parent 5a13e91 commit 02cfa0b

1 file changed

Lines changed: 3 additions & 4 deletions

File tree

Doc/lib/libimaplib.tex

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -327,8 +327,7 @@ \subsection{IMAP4 Objects \label{imap4-objects}}
327327
\end{methoddesc}
328328

329329
\begin{methoddesc}{search}{charset, criterion\optional{, ...}}
330-
Search mailbox for matching messages. Returned data contains a space
331-
separated list of matching message numbers. \var{charset} may be
330+
Search mailbox for matching messages. \var{charset} may be
332331
\code{None}, in which case no \samp{CHARSET} will be specified in the
333332
request to the server. The IMAP protocol requires that at least one
334333
criterion be specified; an exception will be raised when the server
@@ -338,10 +337,10 @@ \subsection{IMAP4 Objects \label{imap4-objects}}
338337

339338
\begin{verbatim}
340339
# M is a connected IMAP4 instance...
341-
msgnums = M.search(None, 'FROM', '"LDJ"')
340+
typ, msgnums = M.search(None, 'FROM', '"LDJ"')
342341
343342
# or:
344-
msgnums = M.search(None, '(FROM "LDJ")')
343+
typ, msgnums = M.search(None, '(FROM "LDJ")')
345344
\end{verbatim}
346345
\end{methoddesc}
347346

0 commit comments

Comments
 (0)