creates a new SQUAT index for one or more IMAP mailboxes. The SQUAT
index is a unified index of all of the header and body text of each
message a given mailbox. This index is used to significantly reduce
IMAP SEARCH times on a mailbox.
creates an index of ALL messages in the mailbox, not just those since
the last time that it was run (i.e., it does NOT do incremental
updates). Any messages appended to the mailbox after
is run, will NOT be included in the index. To include new messages in
must be run again.
For large and active mailboxes, it is recommended to run
periodically as an EVENT in
Messages and mailboxes that have not been indexed CAN still be
SEARCHed, just not as quickly as those with a SQUAT index.
reads its configuration options out of the
file unless specified otherwise by -C.
Read configuration options from config-file.
Recursively create indexes for all sub-mailboxes of the mailboxes or
mailbox prefixes given as arguments.
Skip mailboxes whose index file is older than their current squat file
(within a small time delta).
Incremental updates where squat indexes already exist.
Only create indexes for mailboxes which have the shared
/vendor/cmu/cyrus-imapd/squat annotation set to "true".
The value of the /vendor/cmu/cyrus-imapd/squat annotation is
inherited by all children of the given mailbox, so an entire mailbox
tree can be indexed (or not indexed) by setting a single annotation on
the root of that tree with a value of "true" (or "false"). If a
mailbox does not have a /vendor/cmu/cyrus-imapd/squat annotation
set on it (or does not inherit one), then the mailbox is not indexed.
In other words, the implicit value of
/vendor/cmu/cyrus-imapd/squat is "false".
Increase the verbosity of progress/status messages.