doveadm-rebuild(1)

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

NAME

6       doveadm-rebuild  -  Commands  related  to rebuilding various aspects of
7       mails matching given search query.
8

SYNOPSIS

10       doveadm  [-Dv]  [-f  formatter]  rebuild <command>   [-S   socket_path]
11       search_query
12       doveadm   [-Dv]   [-f  formatter]  rebuild <command>  [-S  socket_path]
13       -A search_query
14       doveadm [-Dv] [-f formatter] rebuild <command> [-S socket_path] -F file
15       search_query
16       doveadm [-Dv] [-f formatter] rebuild <command> [-S socket_path] -u user
17       search_query
18

DESCRIPTION

20       The rebuild attachments command is used to  rebuilds  attachment  pres‐
21       ence.  doveadm(1) will print the message's uid for each match.
22       When used with the -A or -u wildcard options, doveadm(1) will print the
23       fields username and uid for each matching message.
24
25       In the first form, doveadm(1) will execute the rebuild action with  the
26       environment of the logged in system user.
27
28       In the second form, the command will be performed for all users.
29
30       In  the  third form, the command will be performed for all users listed
31       in the given file.
32
33       In the fourth form, only matching mails of the given  user(s)  will  be
34       rebuilded
35

OPTIONS

37       Global doveadm(1) options:
38
39       -D     Enables verbosity and debug messages.
40
41       -f formatter
42              Specifies  the  formatter  for formatting the output.  Supported
43              formatters are:
44
45              flow   prints each line with key=value pairs.
46
47              pager  prints each key: value pair on its own line and separates
48                     records with form feed character (^L).
49
50              tab    prints  a  table  header  followed by tab separated value
51                     lines.
52
53              table  prints a table header followed by adjusted value lines.
54
55       -o setting=value
56              Overrides  the  configuration  setting  from  /etc/dovecot/dove‐
57              cot.conf  and from the userdb with the given value.  In order to
58              override multiple settings, the -o option may be specified  mul‐
59              tiple times.
60
61       -v     Enables verbosity, including progress counter.
62
63       This  command  uses  by  default the output formatter flow (without the
64       key= prefix).
65
66       Command specific options:
67
68       -A     If the -A option is present, the command will be  performed  for
69              all  users.   Using this option in combination with system users
70              from userdb { driver = passwd } is not recommended,  because  it
71              contains  also  users  with  a lower UID than the one configured
72              with the first_valid_uid setting.
73
74              When the SQL userdb module is used  make  sure  that  the  iter‐
75              ate_query  setting  in /etc/dovecot/dovecot-sql.conf.ext matches
76              your database layout.  When using the LDAP userdb  module,  make
77              sure  that  the  iterate_attrs  and  iterate_filter  settings in
78              /etc/dovecot/dovecot-ldap.conf.ext match your LDAP schema.  Oth‐
79              erwise doveadm(1) will be unable to iterate over all users.
80
81       -F file
82              Execute the command for all the users in the file.  This is sim‐
83              ilar to the -A option, but instead of getting the list of  users
84              from  the  userdb,  they are read from the given file.  The file
85              contains one username per line.
86
87       -S socket_path
88              The option's argument is either an absolute path to a local UNIX
89              domain  socket, or a hostname and port (hostname:port), in order
90              to connect a remote host via a TCP socket.
91
92              This allows an administrator to execute doveadm(1) mail commands
93              through the given socket.
94
95       -u user/mask
96              Run  the command only for the given user.  It's also possible to
97              use '*' and '?' wildcards (e.g. -u *@example.org).
98              When neither the -A option, nor  the  -F file  option,  nor  the
99              -u user  was  specified,  the  command will be executed with the
100              environment of the currently logged in user.
101

ARGUMENTS

103       search_query
104              Resets attachment indicator for messages  matching  this  search
105              query.  See doveadm-search-query(7) for details.
106

EXAMPLE

108       This example demonstrates how to rebuild user bob's attachment status.
109
110       doveadm rebuild attachments -u bob ALL
111       1
112       2
113       3
114

REPORTING BUGS

116       Report  bugs, including doveconf -n output, to the Dovecot Mailing List
117       <dovecot@dovecot.org>.  Information about reporting bugs  is  available
118       at: http://dovecot.org/bugreport.html
119