.TH "DOVEADM-INDEX" "1" "March 2025" "78ffb79" "Dovecot"
.SH "NAME"
\fBdoveadm-index\fR - Index mailboxes
.SH "SYNOPSIS"
.P
\fBdoveadm\fR \[lB]\fIGLOBAL OPTIONS\fR\[rB] \fBindex\fR \[lB]\fB-S\fR \fIsocket_path\fR\[rB] \fB-A\fR \[lB]\fB-q\fR\[rB] \[lB]\fB-n\fR \fImax_recent\fR\[rB] \fImailbox\fR
.P
\fBdoveadm\fR \[lB]\fIGLOBAL OPTIONS\fR\[rB] \fBindex\fR \[lB]\fB-S\fR \fIsocket_path\fR\[rB] \fB-F\fR \fIfile\fR \[lB]\fB-q\fR\[rB] \[lB]\fB-n\fR \fImax_recent\fR\[rB] \fImailbox\fR
.P
\fBdoveadm\fR \[lB]\fIGLOBAL OPTIONS\fR\[rB] \fBindex\fR \[lB]\fB-S\fR \fIsocket_path\fR\[rB] \fB--no-userdb-lookup\fR \[lB]\fB-q\fR\[rB] \[lB]\fB-n\fR \fImax_recent\fR\[rB] \fImailbox\fR
.P
\fBdoveadm\fR \[lB]\fIGLOBAL OPTIONS\fR\[rB] \fBindex\fR \[lB]\fB-S\fR \fIsocket_path\fR\[rB] \fB-u\fR \fIuser\fR \[lB]\fB-q\fR\[rB] \[lB]\fB-n\fR \fImax_recent\fR\[rB] \fImailbox\fR
.SH "DESCRIPTION"
.P
Add unindexed messages in a mailbox into index/cache file. If full text search is enabled, also add unindexed messages to the fts database.
.P
The caching adds only the fields that were previously added to the mailbox's caching decisions, so it won't do anything useful for mailboxes that user's client hasn't accessed yet. You can use \fBdoveadm dump\fR command to show a specific mailbox's current caching decisions.
.P
Messages can also be added automatically to full text search index using:
.P
.RS 2
.nf
fts_autoindex = yes
.fi
.RE
.SH "GLOBAL OPTIONS"
.P
Global doveadm(1) 
.P
\fB-D\fR
.RS 0
.RS 4
.P
Enables \fIverbosity\fR and debug messages.
.RE 0

.RE 0

.P
\fB-O\fR
.RS 0
.RS 4
.P
Do not read any config file, just use defaults. The \fBdovecot_storage_version\fR setting defaults to the latest version, but can be overridden with 
.RE 0

.RE 0

.P
\fB-k\fR
.RS 0
.RS 4
.P
Preserve entire environment for doveadm, not just \fBimport_environment\fR setting.
.RE 0

.RE 0

.P
\fB-v\fR
.RS 0
.RS 4
.P
Enables verbosity, including progress counter.
.RE 0

.RE 0

.P
\fB-i\fR \fIinstance-name\fR
.RS 0
.RS 4
.P
If using multiple Dovecot instances, choose the config file based on this instance name.
.P
See \fBinstance_name\fR setting for more information.
.RE 0

.RE 0

.P
\fB-c\fR \fIconfig-file\fR
.RS 0
.RS 4
.P
Read configuration from the given \fIconfig-file\fR. By default it first reads config socket, and then falls back to \fI/etc/dovecot/dovecot.conf\fR. You can also point this to config socket of some instance running compatible version.
.RE 0

.RE 0

.P
\fB-o\fR \fIsetting\fR\fB=\fR\fIvalue\fR
.RS 0
.RS 4
.P
Overrides the configuration \fIsetting\fR from \fI/etc/dovecot/dovecot.conf\fR and from the userdb with the given \fIvalue\fR. In order to override multiple settings, the \fB-o\fR option may be specified multiple times.
.RE 0

.RE 0

.SH "OPTIONS"
.P
\fB-A\fR
.RS 0
.RS 4
.P
If the \fB-A\fR option is present, the \fIcommand\fR will be performed for all users. Using this option in combination with system users from \fBuserdb { driver = passwd }\fR is not recommended, because it contains also users with a lower UID than the one configured with the \fBfirst_valid_uid\fR setting.
.P
When the SQL userdb module is used, make sure that the \fBuserdb_sql_iterate_query\fR setting setting matches your database layout.
.P
When using the LDAP userdb module, make sure that the \fBuserdb_fields\fR setting and \fBuserdb_ldap_iterate_fields\fR setting settings match your LDAP schema. Otherwise doveadm(1) will be unable to iterate over all users.
.RE 0

.RE 0

.P
\fB-F\fR \fIfile\fR
.RS 0
.RS 4
.P
Execute the \fIcommand\fR for all the users in the \fIfile\fR. This is similar to the \fB-A\fR option, but instead of getting the list of users from the userdb, they are read from the given \fIfile\fR. The \fIfile\fR contains one username per line.
.RE 0

.RE 0

.P
\fB-n\fR \fImax_recent\fR
.RS 0
.RS 4
.P
An integer value, which specifies the maximum number of \[rs]Recent messages in mailboxes. If the mailbox contains more than \fImax_recent\fR messages with \[rs]Recent flag set, the mailbox will not be indexed. This may be useful to avoid unnecessary indexing for large mailboxes that are never opened.
.RE 0

.RE 0

.P
\fB--no-userdb-lookup\fR
.RS 0
.RS 4
.P
Do not perform userdb lookup. Use the \fBUSER\fR environment variable to specify the username.
.RE 0

.RE 0

.P
\fB-q\fR
.RS 0
.RS 4
.P
Queues the indexing to be run by indexer process. Without -q the indexing is done directly by the doveadm(1) process. Some drivers can't handle multiple processes updating the indexes simultaneously, so -q should usually be used on production.
.RE 0

.RE 0

.P
\fB-S\fR \fIsocket_path\fR
.RS 0
.RS 4
.P
The option's argument is either an absolute path to a local UNIX domain socket, or a hostname and port (\fIhostname\fR:\fIport\fR), in order to connect a remote host via a TCP socket.
.P
This allows an administrator to execute doveadm(1) mail commands through the given socket.
.RE 0

.RE 0

.P
\fB-u\fR \fIuser/mask\fR
.RS 0
.RS 4
.P
Run the \fIcommand\fR only for the given \fIuser\fR. It's also possible to use '\fB*\fR' and '\fB?\fR' wildcards (e.g. -u *@example.org).
.RE 0

.RE 0

.SH "ARGUMENTS"
.P
\fImailbox\fR
.RS 0
.RS 4
.P
The name of the mailbox to index.
.RE 0

.RE 0

.SH "EXAMPLE"
.P
Index bob's INBOX:
.P
.RS 2
.nf
doveadm index -u bob INBOX
.fi
.RE
.SH "REPORTING BUGS"
.P
Report bugs, including \fIdoveconf -n\fR output, to the Dovecot Mailing List \fI\(ladovecot@dovecot.org\(ra\fR. Information about reporting bugs is available at: https://dovecot.org/bugreport.html
.SH "SEE ALSO"
.P
doveadm(1)