CLI zmmboxsearch (Cross mailbox search)

CLI zmmboxsearch (Cross mailbox search)

   KB 1491        Last updated on 07/11/2015  

(0 votes)
Article-check.png  - This is certified documentation and is protected for editing by Zimbra Employees & Moderators only.
 - This is archive documentation, which means it is not supported or valid for recent versions of Zimbra Collaboration.
 - This article is a Work in Progress, and may be unfinished or missing sections.
Admin Article

Article Information

This article applies to the following ZCS versions.

ZCS 7.0 Article ZCS 7.0 ZCS 6.0 Article ZCS 6.0 ZCS 5.0 Article ZCS 5.0

For the most recent information on this CLI, including syntax and description, see ZCS Administrator's Guide Network Edition > Appendix A Command-Line Utilities.

ZCS 6.0.x


The CLI command zmmboxsearch is used to search across mailboxes. You can search across mailboxes to find messages and attachments that match specific criteria and save copies of these messages to a directory.


zmmboxsearch {-m <arg>} {- q <arg>} [-o <arg>] [-l <arg>] [-d <arg>] [options]


Long Name Short Name Description
--dir -d <arg> Directory to write the messages to. If none is specified, then only the headers are fetched. Files names are generated in the form RESULTNUM_ACCOUNT-ID_ MAILITEMID.
--help -h Displays help information
--limit -l Sets the limit for the number of results returned. The default is 25.
--mbox -m <arg> Comma-separated list of mailboxes to search. UIDs or email-address or /SERVER/MAILBOXID or *.
--offset -o <arg> Specify where the hit list should start. The default is 0.
--query -q <arg> The query string for the search.
--server -s <arg> Mail server hostname. Default is the localhost.
--verbose -v Request that the status message print while the search is being executed


The following example is to do a cross-mailbox search in the inbox folder of two different mailboxes on the specified server and put a copy of the message in to the specified directory.

zmmboxsearch -m, -q “in:inbox” -d /var/tmp

Here is an example that includes results for the phrase "vacation rental" in the message body:

zmmboxsearch -m, -q “content:(\"vacation rental\")” -d /var/tmp

Here is "vacation rental" in the Inbox:

zmmboxsearch -m, -q “in:inbox content:(\"vacation rental\")” -d /var/tmp

"vacation rental" in the Inbox from Thom:

zmmboxsearch -m, -q “in:inbox from:Thom content:(\"vacation rental\")” -d /var/tmp

ZCS 5.0.x

ZCS 4.5.x

Verified Against: ZCS 6.0 Date Created: 5/3/2006
Article ID: Date Modified: 07/11/2015

Try Zimbra

Try Zimbra Collaboration with a 60-day free trial.
Get it now »

Want to get involved?

You can contribute in the Community, Wiki, Code, or development of Zimlets.
Find out more. »

Looking for a Video?

Visit our YouTube channel to get the latest webinars, technology news, product overviews, and so much more.
Go to the YouTube channel »

Jump to: navigation, search