doveadm-obox¶
NAME¶
doveadm-obox - Utility actions for Dovecot’s obox mailbox format
SYNOPSIS¶
doveadm [GLOBAL OPTIONS] obox command [arguments]
DESCRIPTION¶
doveadm obox can be used to run actions that interact with and modify Dovecot’s obox mailbox format.
GLOBAL OPTIONS¶
Global doveadm(1) options:
- -D
Enables verbosity and debug messages.
- -O
Do not read any config file, just use defaults.
- -k
Preserve entire environment for doveadm, not just
import_environment
.- -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_name
setting 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 -o option may be specified multiple times.
- -f formatter
Specifies the formatter for formatting the output. Supported formatters are:
- flow
prints each line with key=value pairs.
- pager
prints each key: value pair on its own line and separates records with form feed character (^L).
- tab
prints a table header followed by tab separated value lines.
- table
prints a table header followed by adjusted value lines.
OPTIONS¶
- -A
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 iterate_query setting in /etc/dovecot/dovecot-sql.conf.ext matches your database layout. When using the LDAP userdb module, make sure that the iterate_attrs and iterate_filter settings in /etc/dovecot/dovecot-ldap.conf.ext 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 -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.
- -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).
COMMANDS¶
obox user delete¶
doveadm obox user delete [-A|-u user|-F file] [-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.
NOTE: Data in fscache, and userdb information, is not removed.
WARNING! This command can erase ALL data associated with a user!
obox user wait¶
doveadm obox user wait [-A|-u user|-F file] [-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.
EXAMPLE¶
Delete all data for user ‘bob’.
doveadm obox user delete -u bob
REPORTING BUGS¶
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