CLI zmmboxsearch (Cross mailbox search): Difference between revisions
(Adding category) |
No edit summary |
||
| (7 intermediate revisions by 4 users not shown) | |||
| Line 1: | Line 1: | ||
{{BC|Certified}} | |||
__FORCETOC__ | |||
<div class="col-md-12 ibox-content"> | |||
=CLI zmmboxsearch (Cross mailbox search)= | |||
{{KB|{{ZC}}|{{ZCS 7.0}}|{{ZCS 6.0}}|}} | |||
{{Archive}}{{WIP}}{{Article Infobox|{{admin}}|{{ZCS 7.0}}|{{ZCS 6.0}}|{{ZCS 5.0}}}} | |||
For the most recent information on this CLI, including syntax and description, see [http://www.zimbra.com/docs/ne/latest/administration_guide/A_app-command-line.20.1.html ZCS Administrator's Guide Network Edition > Appendix A Command-Line Utilities]. | |||
=ZCS 6.0.x= | |||
==zmmboxsearch== | |||
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. | |||
=== | ===Syntax=== | ||
zmmboxsearch {-m <arg>} {- q <arg>} [-o <arg>] [-l <arg>] [-d <arg>] [options] | |||
===Description=== | |||
{|style="width:100%" border="1" cellpadding="5" cellspacing="0" | |||
= | ! align="left" bgcolor="tan" |Long Name | ||
! align="left" bgcolor="tan" |Short Name | |||
! align="left" bgcolor="tan"|Description | |||
| | |||
|- | |- | ||
| | |style="background=white" |<nowiki>--dir</nowiki> | ||
< | |<nowiki>-d</nowiki> | ||
| | |'''<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'''. | ||
< | |||
| | |||
< | |||
|- | |- | ||
| | |<nowiki>--help</nowiki> | ||
< | |<nowiki>-h</nowiki> | ||
| | |Displays help information | ||
< | |||
| | |||
|- | |- | ||
| | |<nowiki>--limit</nowiki> | ||
< | |<nowiki>-l</nowiki> | ||
| | |Sets the limit for the number of results returned. The default is 25. | ||
< | |||
| | |||
|- | |- | ||
| | |<nowiki>--mbox</nowiki> | ||
< | |<nowiki>-m</nowiki> | ||
| | |'''<arg>''' Comma-separated list of mailboxes to search. UIDs or email-address or /SERVER/MAILBOXID or <nowiki>*</nowiki>. | ||
< | |||
| | |||
|- | |- | ||
| | |<nowiki>--offset</nowiki> | ||
< | |<nowiki>-o</nowiki> | ||
| | |'''<arg>''' Specify where the hit list should start. The default is 0. | ||
< | |||
| | |||
|- | |- | ||
| | |<nowiki>--query</nowiki> | ||
< | |<nowiki>-q</nowiki> | ||
| | |'''<arg>''' The query string for the search. | ||
< | |||
| | |||
|- | |- | ||
| | |<nowiki>--server</nowiki> | ||
< | |<nowiki>-s</nowiki> | ||
| | |'''<arg>''' Mail server hostname. Default is the localhost. | ||
< | |||
| | |||
|- | |- | ||
| | |<nowiki>--verbose</nowiki> | ||
< | |<nowiki>-v</nowiki> | ||
| | |Request that the status message print while the search is being executed | ||
< | |||
| | |||
|} | |} | ||
=== | ===Examples=== | ||
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 user1@yourdomain.com,user2@yourdomain.com -q “in:inbox” -d /var/tmp | |||
Here is an example that includes results for the phrase "vacation rental" in the message body: | |||
zmmboxsearch -m user1@yourdomain.com,user2@yourdomain.com -q “content:(\"vacation rental\")” -d /var/tmp | |||
Here is "vacation rental" in the Inbox: | |||
zmmboxsearch -m user1@yourdomain.com,user2@yourdomain.com -q “in:inbox content:(\"vacation rental\")” -d /var/tmp | |||
"vacation rental" in the Inbox from Thom: | |||
zmmboxsearch -m user1@yourdomain.com,user2@yourdomain.com -q “in:inbox from:Thom content:(\"vacation rental\")” -d /var/tmp | |||
=ZCS 5.0.x= | |||
*[http://www.zimbra.com/docs/ne/5.0.19/administration_guide/A_app-command-line.18.18.html#1268684 ZCS Administrator's Guide Network Edition 5.0 > Appendix A Command-Line Utilities > zmmboxsearch] | |||
=ZCS 4.5.x= | |||
*[http://www.zimbra.com/docs/ne/4.5.10/administration_guide/A_app-command-line.14.13.html#1173981 ZCS Administrator's Guide Network Edition 4.5 > Appendix A Command-Line Utilities > zmmboxsearch] | |||
{{Article Footer|ZCS 6.0|5/3/2006}} | |||
[[Category:Command Line Interface]] | [[Category:Command Line Interface]] | ||
[[Category:ZCS 7.0]] | |||
[[Category:ZCS 6.0]] | |||
Latest revision as of 16:04, 11 July 2015
CLI zmmboxsearch (Cross mailbox search)
- 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.
 Article Information |
|---|
| This article applies to the following ZCS versions. |
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
zmmboxsearch
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.
Syntax
zmmboxsearch {-m <arg>} {- q <arg>} [-o <arg>] [-l <arg>] [-d <arg>] [options]
Description
| 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 |
Examples
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 user1@yourdomain.com,user2@yourdomain.com -q “in:inbox” -d /var/tmp
Here is an example that includes results for the phrase "vacation rental" in the message body:
zmmboxsearch -m user1@yourdomain.com,user2@yourdomain.com -q “content:(\"vacation rental\")” -d /var/tmp
Here is "vacation rental" in the Inbox:
zmmboxsearch -m user1@yourdomain.com,user2@yourdomain.com -q “in:inbox content:(\"vacation rental\")” -d /var/tmp
"vacation rental" in the Inbox from Thom:
zmmboxsearch -m user1@yourdomain.com,user2@yourdomain.com -q “in:inbox from:Thom content:(\"vacation rental\")” -d /var/tmp
ZCS 5.0.x
ZCS 4.5.x
