Search K
Appearance
Appearance
doveadm [GLOBAL OPTIONS] obox command [arguments]
doveadm obox can be used to run actions that interact with and modify Dovecot's obox mailbox format.
Global doveadm(1)
options:
Enables verbosity and debug messages.
Do not read any config file, just use defaults. The dovecot_storage_version
defaults to the latest version, but can be overridden with -o.
Preserve entire environment for doveadm, not just import_environment
.
Enables verbosity, including progress counter.
If using multiple Dovecot instances, choose the config file based on this instance name.
See instance_name
for more information.
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.
Overrides the configuration setting from /etc/dovecot/dovecot.conf and from the userdb with the given value. In order to override multiple settings, the -o option may be specified multiple times.
Specifies the formatter for formatting the output. Supported formatters are:
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 userdb_sql_iterate_query
setting matches your database layout.
When using the LDAP userdb module, make sure that the userdb_fields
and userdb_ldap_iterate_fields
settings match your LDAP schema. Otherwise doveadm(1)
will be unable to iterate over all users.
Execute the command for all the users in the file. This is similar to the -A option, 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.
Do not perform userdb lookup. Use the USER
environment variable to specify the username.
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.
Run the command only for the given user. It's also possible to use '*' and '?' wildcards (e.g. -u *@example.org).
doveadm [GLOBAL OPTIONS] obox user delete [-A | -u user | -F file | --no-userdb-lookup] [-S socket_path]
Delete all data associated with a user from obox storage and metacache.
Additionally, doveadm metacache remove
should be executed after this command is performed.
INFO
Data in fscache, and userdb information is not removed.
WARNING
This command can erase ALL data associated with a user!
WARNING
If Dictmap is used, the same user must not be created back within fs_dictmap_delete_timestamp
. Otherwise new Cassandra writes will have timestamps that are still older than the deleted keys, which causes the writes to be ignored.
doveadm [GLOBAL OPTIONS] obox user wait [-A | -u user | -F file | --no-userdb-lookup] [-S socket_path] [-t secs]
Wait until there are no more sessions (imap, lmtp, etc.) accessing the user. If there are still sessions after secs seconds, fail with exit code 65.
Delete all data for user 'bob'.
doveadm obox user delete -u bob
Report bugs, including doveconf -n output, to the Dovecot Mailing List dovecot@dovecot.org. Information about reporting bugs is available at: https://dovecot.org/bugreport.html