DOVEADM-INDEX(1)                                             Dovecot                                            DOVEADM-INDEX(1)



NAME
       doveadm-index - Index mailboxes

SYNOPSIS
       doveadm [-Dv] index [-S socket_path] mailbox
       doveadm [-Dv] index [-S socket_path] -A mailbox
       doveadm [-Dv] index [-S socket_path] -u user 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's caching decisions, so it won't  do  anything
       useful  for  mailboxes  that user's client hasn't accessed yet. You can use doveadm dump command to show a specific mail-
       box's current caching decisions.

OPTIONS
       Global doveadm(1) options:

       -D     Enables verbosity and debug messages.

       -v     Enables verbosity, including progress counter.

       Command specific options:

       -A     If the -A option is present, the command will be performed for all users.  Using this option in  combination  with
              system  users  from userdb { driver = passwd } is not recommended, because it contains also users with a lower UID
              than the one configured with the first_valid_uid setting.

              When the SQL userdb module is used make sure that the iterate_query setting  in  /etc/dovecot/dovecot-sql.conf.ext
              matches  your  database  layout.   When  using  the LDAP userdb module, make sure that the iterate_attrs and iter-
              ate_filter settings in /etc/dovecot/dovecot-ldap.conf.ext match your LDAP schema.  Otherwise  doveadm(1)  will  be
              unable to iterate over all users.

       -S socket_path
              The  option's  argument  is  either  an absolute path to a local UNIX domain socket, or a hostname and port (host-
              name:port), in order to connect a remote host via a TCP socket.

              This allows an administrator to execute doveadm(1) mail commands through the given socket.

       -u user/mask
              Run the command only for the given user.  It's also possible to use '*' and '?' wildcards (e.g. -u *@example.org).
              When neither the -A option nor -u user was specified, the command will be executed with  the  environment  of  the
              currently logged in user.

ARGUMENTS
       mailbox
              The name of the mailbox to index.

EXAMPLE
       Index bob's INBOX:

       doveadm index -u bob INBOX

REPORTING BUGS
       Report  bugs, including doveconf -n output, to the Dovecot Mailing List <dovecotATdovecot.org>.  Information about report-
       ing bugs is available at: http://dovecot.org/bugreport.html

SEE ALSO
       doveadm(1)



Dovecot v2.0                                               2011-05-11                                           DOVEADM-INDEX(1)