Section 1: user commands and tools
NAME doveadm-mount – Manage the list of mountpoints where mails are stored SYNOPSIS doveadm [-Dv] [-f formatter] mount command [arguments] DESCRIPTION The doveadm mount commands can be used to manage the list of mountpoints where mails are stored. This is used mainly for better error handling when a mountpoint isn’t mounted for some reason: *…
NAME doveadm-mailbox – Commands related to handling mailboxes SYNOPSIS doveadm [-Dv] [-f formatter] mailbox_cmd [options] [arguments] DESCRIPTION doveadm mailbox can be used to query and modify mailboxes. OPTIONS Global doveadm(1) options: -D Enables verbosity and debug messages. -f formatter Specifies the formatter for formatting the output. Supported formatters are: flow prints each line with key=value pairs….
NAME doveadm-log – Locate, test or reopen Dovecot’s log files SYNOPSIS doveadm [-Dv] log errors [-s min_timestamp] doveadm [-Dv] log find [directory] doveadm [-Dv] log reopen doveadm [-Dv] log test DESCRIPTION The doveadm log commands are used to locate and reopen the log files of dovecot(1). It’s also possible to test the configured targets of…
NAME doveadm-kick – Disconnect users by user name and/or IP address SYNOPSIS doveadm [-Dv] kick [ -a anvil_socket_path] [-f] user doveadm [-Dv] kick [ -a anvil_socket_path] [-f] ip[/mask] doveadm [-Dv] kick [ -a anvil_socket_path] [-f] user ip[/mask] DESCRIPTION doveadm‘s kick command is used to disconnect users by user name and/or the ip address, from which they…
NAME doveadm-instance – Manage the list of running Dovecot instances SYNOPSIS doveadm [-Dv] [-f formatter] instance list doveadm [-Dv] instance remove name | base_dir DESCRIPTION The doveadm instance commands are used to manage the list of Dovecot instances running on the server. In most installations there is only one Dovecot instance, but in some cases…
NAME doveadm-index – Index mailboxes SYNOPSIS doveadm [-Dv] index [-S socket_path] [-q] [-n max_recent] mailbox doveadm [-Dv] index [-S socket_path] -A [-q] [-n max_recent] mailbox doveadm [-Dv] index [-S socket_path] -u user [-q] [-n max_recent] mailbox DESCRIPTION Add unindexed messages in a mailbox into index/cache file. If full text search is enabled, also add unindexed messages…
NAME doveadm-import – Import messages matching given search query SYNOPSIS doveadm [-Dv] import [-S socket_path] [-s] source_location dest_parent search_query doveadm [-Dv] import [-S socket_path] [-s] -A source_location dest_parent search_query doveadm [-Dv] import [-S socket_path] [-s] -u user source_location dest_parent search_query DESCRIPTION This command can be used to import mails from another mail storage specified by…
NAME doveadm-help – Show information about doveadm commands SYNOPSIS doveadm [-Dv] help [command] DESCRIPTION With no command argument given, doveadm help will print: * the synopsis for the most of the doveadm(1) commands. * groups of commands, e.g. log or mailbox. When the name of a command (or a group) was given, it will show…
NAME doveadm-force-resync – Repair broken mailboxes SYNOPSIS doveadm [-Dv] force-resync [-S socket_path] mailbox doveadm [-Dv] force-resync [-S socket_path] -A mailbox doveadm [-Dv] force-resync [-S socket_path] -u user mailbox DESCRIPTION Under certain circumstances it may happen, that dovecot(1) is unable to automatically solve problems with mailboxes. In such situations the force-resync command may be helpful. It tries…
NAME doveadm-flags – add, remove or replace messages’ flags SYNOPSIS doveadm [-Dv] flags [-S socket_path] command flags search_query doveadm [-Dv] flags [-S socket_path] command flags search_query -A doveadm [-Dv] flags [-S socket_path] command flags search_query -u user DESCRIPTION This command is used to manipulate flags of messages. OPTIONS Global doveadm(1) options: -D Enables verbosity and…
NAME doveadm-fetch – Fetch partial/full messages or message information SYNOPSIS doveadm [-Dv] [-f formatter] fetch [-S socket_path] fields search_query doveadm [-Dv] [-f formatter] fetch [-S socket_path] -A fields search_query doveadm [-Dv] [-f formatter] fetch [-S socket_path] -u user fields search_query DESCRIPTION doveadm fetch can be used to fetch messages’ contents and metadata. This can be…
NAME doveadm-expunge – Expunge messages matching given search query SYNOPSIS doveadm [-Dv] expunge [-S socket_path] [-d] search_query doveadm [-Dv] expunge [-S socket_path] [-d] -A search_query doveadm [-Dv] expunge [-S socket_path] [-d] -u user search_query DESCRIPTION This command can be used to expunge mails matching the given search query. It is typically used to expunge old…
NAME doveadm-exec – easily execute commands from Dovecot’s libexec_dir SYNOPSIS doveadm [-Dv] exec binary [binary arguments] DESCRIPTION This command allows administrators and local users to simply execute commands from within libexec_dir. So for example a logged in system user could start a pre-authenticated imap session, using the command: doveadm exec imap. An administrator would use…
NAME doveadm-dump – Dump the content of Dovecot’s binary mailbox index/log SYNOPSIS doveadm [-Dv] dump [-t type] path DESCRIPTION Dovecot uses several binary index and log files in order to improve performance for accessing mails. For some mailbox formats, such as sdbox and mdbox, the index files are part of the format itself. For details…
NAME doveadm-director – Manage Dovecot directors SYNOPSIS doveadm [-Dv] director add [-a director_socket_path] host [vhost_count] doveadm [-Dv] director flush [-a director_socket_path] host|all doveadm [-Dv] director map [-a director_socket_path] [-f users_file] [host] doveadm [-Dv] director remove [-a director_socket_path] host doveadm [-Dv] director dump [-a director_socket_path] doveadm [-Dv] director status [-a director_socket_path] [user] DESCRIPTION doveadm director can…
NAME doveadm-deduplicate – expunge duplicate messages SYNOPSIS doveadm [-Dv] deduplicate [-u user|-A] [-S socket_path] [-m] search_query DESCRIPTION This command is used to expunge duplicated messages in mailboxes. doveadm deduplicate is mainly useful to revert some (more or less) accidental duplication of messages, e.g. after doveadm copy or doveadm import. doveadm(1) will delete the newest duplicated…
NAME doveadm-move – Move messages matching the given search query into another mailbox doveadm-copy – Copy messages matching the given search query into another mailbox SYNOPSIS doveadm [-Dv] move [-S socket_path] destination [user source_user] search_query doveadm [-Dv] move [-S socket_path] -A destination [user source_user] search_query doveadm [-Dv] move [-S socket_path] -u user destination [user source_user]…
NAME doveconf – Dovecot’s configuration dumping utility SYNOPSIS doveconf [-adnNSx] [-c config-file] [-f filter] [-m module] doveconf [-n] [-c config-file] section_name … doveconf [-h] [-c config-file] [-f filter] setting_name … DESCRIPTION doveconf reads and parses Dovecot’s configuration files and converts them into a simpler format used by the rest of Dovecot. All standalone programs, such as dovecot(1)…
NAME doveadm-batch – Execute multiple commands for multiple users SYNOPSIS doveadm [-Dv] batch [-S socket_path] -A sep command sep command […] doveadm [-Dv] batch [-S socket_path] -u usermask sep command sep command […] DESCRIPTION The command doveadm batch is used to execute multiple doveadm(1) commands sequentially for multiple users. This is primarily an optimization where…
NAME doveadm-auth – Test authentication for a user SYNOPSIS doveadm [-Dv] auth [-a auth_socket_path] [-x auth_info] user [password] DESCRIPTION The auth command can be used to test the authentication for the given user. OPTIONS Global doveadm(1) options: -D Enables verbosity and debug messages. -v Enables verbosity, including progress counter. Command specific options: -a auth_socket_path This option…