doveadm-index(1)

1DOVEADM-INDEX(1)                    Dovecot                   DOVEADM-INDEX(1)
2
3
4

NAME

6       doveadm-index - Index mailboxes
7

SYNOPSIS

9       doveadm [-Dv] index [-S socket_path] mailbox
10       doveadm [-Dv] index [-S socket_path] -A mailbox
11       doveadm [-Dv] index [-S socket_path] -u user mailbox
12

DESCRIPTION

14       Add unindexed messages in a mailbox into index/cache file. If full text
15       search is enabled, also add unindexed messages to the fts database.
16
17       The caching adds only the fields that  were  previously  added  to  the
18       mailbox's  caching  decisions, so it won't do anything useful for mail‐
19       boxes that user's client hasn't accessed yet. You can use doveadm  dump
20       command to show a specific mailbox's current caching decisions.
21

OPTIONS

23       Global doveadm(1) options:
24
25       -D     Enables verbosity and debug messages.
26
27       -v     Enables verbosity, including progress counter.
28
29       Command specific options:
30
31       -A     If  the  -A option is present, the command will be performed for
32              all users.  Using this option in combination with  system  users
33              from  userdb  { driver = passwd } is not recommended, because it
34              contains also users with a lower UID  than  the  one  configured
35              with the first_valid_uid setting.
36
37              When  the  SQL  userdb  module  is used make sure that the iter‐
38              ate_query setting in  /etc/dovecot/dovecot-sql.conf.ext  matches
39              your  database  layout.  When using the LDAP userdb module, make
40              sure that  the  iterate_attrs  and  iterate_filter  settings  in
41              /etc/dovecot/dovecot-ldap.conf.ext match your LDAP schema.  Oth‐
42              erwise doveadm(1) will be unable to iterate over all users.
43
44       -S socket_path
45              The option's argument is either an absolute path to a local UNIX
46              domain  socket, or a hostname and port (hostname:port), in order
47              to connect a remote host via a TCP socket.
48
49              This allows an administrator to execute doveadm(1) mail commands
50              through the given socket.
51
52       -u user/mask
53              Run  the command only for the given user.  It's also possible to
54              use '*' and '?' wildcards (e.g. -u *@example.org).
55              When neither the -A option nor -u user was specified,  the  com‐
56              mand  will  be  executed  with  the environment of the currently
57              logged in user.
58

ARGUMENTS

60       mailbox
61              The name of the mailbox to index.
62

EXAMPLE

64       Index bob's INBOX:
65
66       doveadm index -u bob INBOX
67

REPORTING BUGS

69       Report bugs, including doveconf -n output, to the Dovecot Mailing  List
70       <dovecot@dovecot.org>.   Information  about reporting bugs is available
71       at: http://dovecot.org/bugreport.html
72