summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorNeal Norwitz <nnorwitz@gmail.com>2005-09-23 04:26:24 (GMT)
committerNeal Norwitz <nnorwitz@gmail.com>2005-09-23 04:26:24 (GMT)
commit02cfa0bae5dcb6151ef61d1d0b0a92638e782378 (patch)
tree264833755d2059c3953058337627d7ea9c5943b6
parent5a13e91f72be7e632b738228bfca065b1aabccf4 (diff)
downloadcpython-02cfa0bae5dcb6151ef61d1d0b0a92638e782378.zip
cpython-02cfa0bae5dcb6151ef61d1d0b0a92638e782378.tar.gz
cpython-02cfa0bae5dcb6151ef61d1d0b0a92638e782378.tar.bz2
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.)
-rw-r--r--Doc/lib/libimaplib.tex7
1 files changed, 3 insertions, 4 deletions
diff --git a/Doc/lib/libimaplib.tex b/Doc/lib/libimaplib.tex
index 2c4555d..6f09551 100644
--- a/Doc/lib/libimaplib.tex
+++ b/Doc/lib/libimaplib.tex
@@ -327,8 +327,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
@@ -338,10 +337,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}