doveadm-rebuild1
Commands related to rebuilding various aspects of mails matching given search query.
Usage
doveadm [GLOBAL
OPTIONS]
[-f
formatter]
rebuild
<command>
[-S
socket_path]
-A
search_query
doveadm [GLOBAL
OPTIONS]
[-f
formatter]
rebuild
<command>
[-S
socket_path]
-F
file
search_query
doveadm [GLOBAL
OPTIONS]
[-f
formatter]
rebuild
<command>
[-S
socket_path]
--no-userdb-lookup
search_query
doveadm [GLOBAL
OPTIONS]
[-f
formatter]
rebuild
<command>
[-S
socket_path]
-u
user
search_query
Overview
The rebuild attachments command is used to rebuilds attachment presence. doveadm(1) will print the message's uid for each match.
When used with the -A or -u wildcard options, doveadm(1) will print the fields username and uid for each matching message.
In the first form, doveadm(1) will execute the rebuild action for all users.
In the second form, the command will be performed for all users listed in the given file.
In the third form, the command will be performed for the user contained in the USER environment variable.
In the last form, only matching mails of the given user (s) will be rebuilt
Options
Global doveadm(1) options:
-
-D -
Enables verbosity and debug messages.
-
-O -
Do not read any config file, just use defaults. The
dovecot_storage_versionsetting defaults to the latest version, but can be overridden with-o.
-
-k -
Preserve entire environment for doveadm, not just
import_environmentsetting.
-
-v -
Enables verbosity, including progress counter.
-
-i instance-name -
If using multiple Dovecot instances, choose the config file based on this instance name.
See
instance_namesetting for more information.
-
-c config-file -
Read configuration from the given config-file. By default it first reads config socket, and then falls back to /etc/dovecot/dovecot.conf. You can also point this to config socket of some instance running compatible version.
-
-o setting=value -
Overrides the configuration setting from /etc/dovecot/dovecot.conf and from the userdb with the given value. In order to override multiple settings, the
-ooption may be specified multiple times.
-
-f formatter -
Specifies the formatter for formatting the output. Supported formatters are:
flowprints each line with key=value pairs.
jsonprints a JSON array of JSON objects.
pagerprints each key: value pair on its own line and separates records with form feed character (^L).
tabprints a table header followed by tab separated value lines.
tableprints a table header followed by adjusted value lines.
This command uses by default the output formatter flow (without the key = prefix).
Options
-
-A -
If the
-Aoption 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 thefirst_valid_uidsetting.When the SQL userdb module is used, make sure that the
userdb_sql_iterate_querysetting setting matches your database layout.When using the LDAP userdb module, make sure that the
userdb_fieldssetting anduserdb_ldap_iterate_fieldssetting settings match your LDAP schema. Otherwise doveadm(1) will be unable to iterate over all users.
-
-F file -
Execute the command for all the users in the file. This is similar to the
-Aoption, but instead of getting the list of users from the userdb, they are read from the given file. The file contains one username per line.
-
--no-userdb-lookup -
Do not perform userdb lookup. Use the USER environment variable to specify the username.
-
-S socket_path -
The option's argument is either an absolute path to a local UNIX domain socket, or a hostname and port (hostname: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).
Arguments
search_query
Resets attachment indicator for messages matching this search query. See doveadm-search-query(7) for details.
Examples
Rebuild user bob's attachment status:
doveadm rebuild attachments -u bob ALL
1 2 3
Releases
5 releases since Debian 10 (Buster); the text changed 2 times.
--no-userdb-lookup since Debian 13 (Trixie);
-O since Debian 13 (Trixie);
-c since Debian 13 (Trixie);
-i since Debian 13 (Trixie);
-k since Debian 13 (Trixie).