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] [-q] [-n max_recent] mailbox
10       doveadm [-Dv] index [-S socket_path] -A [-q] [-n max_recent] mailbox
11       doveadm [-Dv] index [-S socket_path] -F file [-q] [-n max_recent] mail‐
12       box
13       doveadm [-Dv] index [-S socket_path] -u user [-q] [-n max_recent] mail‐
14       box
15

DESCRIPTION

17       Add unindexed messages in a mailbox into index/cache file. If full text
18       search is enabled, also add unindexed messages to the fts database.
19
20       The caching adds only the fields that  were  previously  added  to  the
21       mailbox's  caching  decisions, so it won't do anything useful for mail‐
22       boxes that user's client hasn't accessed yet. You can use doveadm  dump
23       command to show a specific mailbox's current caching decisions.
24
25       Messages  can  also  be  added  automatically to full text search index
26       using:
27
28       plugin {
29         ...
30         fts_autoindex = yes
31       }
32       in /etc/dovecot/conf.d/90-plugin.conf.
33

OPTIONS

35       Global doveadm(1) options:
36
37       -D     Enables verbosity and debug messages.
38
39       -o setting=value
40              Overrides  the  configuration  setting  from  /etc/dovecot/dove‐
41              cot.conf  and from the userdb with the given value.  In order to
42              override multiple settings, the -o option may be specified  mul‐
43              tiple times.
44
45       -v     Enables verbosity, including progress counter.
46
47       Command specific options:
48
49       -A     If  the  -A option is present, the command will be performed for
50              all users.  Using this option in combination with  system  users
51              from  userdb  { driver = passwd } is not recommended, because it
52              contains also users with a lower UID  than  the  one  configured
53              with the first_valid_uid setting.
54
55              When  the  SQL  userdb  module  is used make sure that the iter‐
56              ate_query setting in  /etc/dovecot/dovecot-sql.conf.ext  matches
57              your  database  layout.  When using the LDAP userdb module, make
58              sure that  the  iterate_attrs  and  iterate_filter  settings  in
59              /etc/dovecot/dovecot-ldap.conf.ext match your LDAP schema.  Oth‐
60              erwise doveadm(1) will be unable to iterate over all users.
61
62       -F file
63              Execute the command for all the users in the file.  This is sim‐
64              ilar  to the -A option, but instead of getting the list of users
65              from the userdb, they are read from the given  file.   The  file
66              contains one username per line.
67
68       -n max_recent
69              An  integer value, which specifies the maximum number of \Recent
70              messages in  mailboxes.   If  the  mailbox  contains  more  than
71              max_recent  messages with \Recent flag set, the mailbox will not
72              be indexed.  This may be useful to  avoid  unnecessary  indexing
73              for large mailboxes that are never opened.
74
75       -q     Queues  the  indexing  to be run by indexer process.  Without -q
76              the indexing is done directly by the doveadm(1)  process.   Some
77              backends  like fts-lucene can't handle multiple processes updat‐
78              ing the indexes simultaneously, so -q should usually be used  on
79              production.
80
81       -S socket_path
82              The option's argument is either an absolute path to a local UNIX
83              domain socket, or a hostname and port (hostname:port), in  order
84              to connect a remote host via a TCP socket.
85
86              This allows an administrator to execute doveadm(1) mail commands
87              through the given socket.
88
89       -u user/mask
90              Run the command only for the given user.  It's also possible  to
91              use '*' and '?' wildcards (e.g. -u *@example.org).
92              When  neither  the  -A  option,  nor the -F file option, nor the
93              -u user was specified, the command will  be  executed  with  the
94              environment of the currently logged in user.
95

ARGUMENTS

97       mailbox
98              The name of the mailbox to index.
99

EXAMPLE

101       Index bob's INBOX:
102
103       doveadm index -u bob INBOX
104

REPORTING BUGS

106       Report  bugs, including doveconf -n output, to the Dovecot Mailing List
107       <dovecot@dovecot.org>.  Information about reporting bugs  is  available
108       at: http://dovecot.org/bugreport.html
109

SEE ALSO

111       doveadm(1)
112
113
114
115Dovecot v2.3                      2015-05-09                  DOVEADM-INDEX(1)
Impressum