Copyright (c) 2010-2018 Dovecot authors, see the included COPYING file
DOVEADM-INDEX 1 "2015-05-09" "Dovecot v2.3" "Dovecot"
NAME
doveadm-index - Index mailboxes ------------------------------------------------------------------------
SYNOPSIS
doveadm " [" -Dv "] " index " [" -S socket_path ] [ -q "] [" -n max_recent "] " mailbox -------------------------------------

doveadm " [" -Dv "] " index " [" -S socket_path "] " -A [ -q "] [" -n max_recent "] " mailbox -------------------------------------

doveadm " [" -Dv "] " index " [" -S socket_path "] " -F " file" [ -q "] [" -n max_recent "] " mailbox -------------------------------------

doveadm " [" -Dv "] " index " [" -S socket_path "] " -u user [ -q "] [" -n max_recent "] " mailbox ------------------------------------------------------------------------

DESCRIPTION
Add unindexed messages in a mailbox into index/cache file. If full text search is enabled, also add unindexed messages to the fts database.

The caching adds only the fields that were previously added to the mailbox\(aqs caching decisions, so it won\(aqt do anything useful for mailboxes that user\(aqs client hasn\(aqt accessed yet. You can use doveadm dump command to show a specific mailbox\(aqs current caching decisions.

Messages can also be added automatically to full text search index using:

plugin {
 ...
 fts_autoindex = yes
}
in @pkgsysconfdir@/conf.d/90-plugin.conf . ------------------------------------------------------------------------
@INCLUDE:global-options@ --- command specific options --- "/.

Command specific options : -------------------------------------
@INCLUDE:option-A@ -------------------------------------
@INCLUDE:option-F-file@ -------------------------------------

-n max_recent An integer value, which specifies the maximum number of \(rsRecent messages in mailboxes. If the mailbox contains more than max_recent messages with \(rsRecent flag set, the mailbox will not be indexed. This may be useful to avoid unnecessary indexing for large mailboxes that are never opened. -------------------------------------

-q Queues the indexing to be run by indexer process. Without -q the indexing is done directly by the doveadm (1) process. Some backends like fts-lucene can\(aqt handle multiple processes updating the indexes simultaneously, so -q should usually be used on production. -------------------------------------
@INCLUDE:option-S-socket@ -------------------------------------
@INCLUDE:option-u-user@ ------------------------------------------------------------------------

ARGUMENTS

mailbox The name of the mailbox to index. ------------------------------------------------------------------------

EXAMPLE
Index bob\(aqs INBOX:

 doveadm index -u bob INBOX 
------------------------------------------------------------------------
@INCLUDE:reporting-bugs@ ------------------------------------------------------------------------
SEE ALSO
doveadm (1)