Copyright (c) 2010-2018 Dovecot authors, see the included COPYING file
doveadm - Dovecot\(aqs administration utility ------------------------------------------------------------------------
doveadm " [" -Dv "] [" -f formatter ] command " [" command_options "] [" command_arguments ] ------------------------------------------------------------------------
doveadm is the Dovecot administration tool. It can be used to manage various parts of Dovecot, as well as access users\(aq mailboxes.

Execute doveadm help , for a command usage listing. ------------------------------------------------------------------------
@INCLUDE:global-options-formatter@ ------------------------------------------------------------------------

------------------------------------------------------------------------
These commands work directly with Dovecot\(aqs master process. -------------------------------------
doveadm reload

Force dovecot (1) to reload the configuration. ------------------------------------------------------------------------

doveadm stop

Stop dovecot (1) and all its child processes. ------------------------------------------------------------------------

doveadm director doveadm-director (1), Manage Dovecot directors (if used by proxy servers). -------------------------------------

doveadm exec doveadm-exec (1), Easily execute commands from Dovecot\(aqs libexec_dir. -------------------------------------

doveadm instance doveadm-instance (1), Manage the list of running Dovecot instances. -------------------------------------

doveadm kick doveadm-kick (1), Disconnect users by user name and/or IP address. -------------------------------------

doveadm log doveadm-log (1), Locate, test or reopen Dovecot\(aqs log files. -------------------------------------

doveadm penalty doveadm-penalty (1), Show current penalties. -------------------------------------

doveadm proxy doveadm-proxy (1), Handle Dovecot proxy connections. -------------------------------------

doveadm who doveadm-who (1); Show who is logged in to the Dovecot server. ------------------------------------------------------------------------

-------------------------------------

doveadm auth doveadm-auth (1), Test authentication for a user. -------------------------------------

doveadm pw doveadm-pw (1), Dovecot\(aqs password hash generator. -------------------------------------

doveadm user doveadm-user (1), Perform a user lookup in Dovecot\(aqs userdbs ------------------------------------------------------------------------

doveadm acl doveadm-acl (1), Manage Access Control List (ACL). -------------------------------------

doveadm altmove doveadm-altmove (1), Move matching mails to the alternative storage. -------------------------------------

doveadm backup doveadm-backup (1), Dovecot\(aqs one-way mailbox synchronization utility. -------------------------------------

doveadm batch doveadm-batch (1), Execute multiple commands for multiple users. -------------------------------------

doveadm copy doveadm-copy (1), Copy messages matching the given search query into another mailbox. -------------------------------------

doveadm deduplicate doveadm-deduplicate (1), Expunge duplicate messages. -------------------------------------

doveadm dump doveadm-dump (1), Dump the content of Dovecot\(aqs binary mailbox index/log. -------------------------------------

doveadm expunge doveadm-expunge (1), Expunge messages matching given search query. -------------------------------------

doveadm fetch doveadm-fetch (1), Fetch messages matching given search query. -------------------------------------

doveadm flags doveadm-flags (1), Add, remove or replace messages\(aq flags. -------------------------------------

doveadm fts doveadm-fts (1), Manipulate the Full Text Search (FTS) index. -------------------------------------

doveadm force-resync doveadm-force-resync (1), Repair broken mailboxes, in case Dovecot doesn\(aqt automatically do that. -------------------------------------

doveadm import doveadm-import (1), Import messages matching given search query. -------------------------------------

doveadm index doveadm-index (1), Index messages in a given mailbox. -------------------------------------

doveadm mailbox doveadm-mailbox (1), Various commands related to handling mailboxes. -------------------------------------

doveadm move doveadm-move (1) Move messages matching the given search query into another mailbox. -------------------------------------

doveadm purge doveadm-purge (1) Remove messages with refcount=0 from mdbox files. -------------------------------------

doveadm quota doveadm-quota (1), Initialize/recalculate or show current quota usage. -------------------------------------

doveadm replicator doveadm-replicator (1), Manage users\(aq mail replication. -------------------------------------

doveadm stats doveadm-stats (1), Inspect or reset stats. -------------------------------------

doveadm sync doveadm-sync (1), Dovecot\(aqs two-way mailbox synchronization utility. -------------------------------------

doveadm search doveadm-search (1), Show a list of mailbox GUIDs and message UIDs matching given search query. ------------------------------------------------------------------------

doveadm will exit with one of the following values:

4 0 Selected command was executed successful.

>0 Command failed in some way. ------------------------------------------------------------------------

USER This environment variable is used to determine the user if a command accepts a user but none was specified. ------------------------------------------------------------------------

@pkgsysconfdir@/dovecot.conf Dovecot\(aqs main configuration file.

@pkgsysconfdir@/conf.d/10-mail.conf Mailbox locations and namespaces.

@pkgsysconfdir@/conf.d/90-plugin.conf Plugin specific settings. ------------------------------------------------------------------------
@INCLUDE:reporting-bugs@ ------------------------------------------------------------------------

doveadm-help (1), doveconf (1), dovecot (1), doveadm-search-query (7)