logo
Free, unlimited AI code reviews that run on commit
git-lrc git-lrc GitHub Install Now We'd appreciate a star git-lrc - Free, unlimited AI code reviews that run on commit | Product Hunt git-lrc - Free, unlimited AI code reviews that run on commit | Product Hunt

doveadm - Dovecot's administration utility

Commands

       These commands work directly with Dovecot's master process.

   reloaddoveadmreload

       Force dovecot(1) to reload the configuration.

   stopdoveadmstop

       Stop dovecot(1) and all its child processes.

   ADDITIONALMASTERCOMMANDSdoveadmconfigdoveadm-config(1), Dump Dovecot configuration.

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

       doveadmexecdoveadm-exec(1), Easily execute commands from Dovecot's libexec_dir.

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

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

       doveadmlogdoveadm-log(1), Locate, test or reopen Dovecot's log files.

       doveadmpenaltydoveadm-penalty(1), Show current penalties.

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

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

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

       doveadmpwdoveadm-pw(1), Dovecot's password hash generator.

       doveadmuserdoveadm-user(1), Perform a user lookup in Dovecot's userdbs

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

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

       doveadmbackupdoveadm-backup(1), Dovecot's one-way mailbox synchronization utility.

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

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

       doveadmdeduplicatedoveadm-deduplicate(1), Expunge duplicate messages.

       doveadmdumpdoveadm-dump(1), Dump the content of Dovecot's binary mailbox index/log.

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

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

       doveadmflagsdoveadm-flags(1), Add, remove or replace messages' flags.

       doveadmforce-resyncdoveadm-force-resync(1), Repair broken mailboxes, in case Dovecot doesn't automatically do that.

       doveadmfsdoveadm-fs(1), Interact with the abstract mail storage filesystem.

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

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

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

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

       doveadmmailboxcryptokeydoveadm-mailbox-cryptokey(1), Mail crypt plugin management.

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

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

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

       doveadmrebuilddoveadm-rebuild(1), Rebuild index metadata from message data.

       doveadmreplicatordoveadm-replicator(1), Manage users' mail replication.

       doveadmsavedoveadm-save(1), Save email to users' mailboxes.

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

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

       doveadmsyncdoveadm-sync(1), Dovecot's two-way mailbox synchronization utility.

Description

doveadm is the Dovecot administration tool. It can be used to manage various parts of Dovecot, as well as
       access users' mailboxes.
       Execute doveadmhelp, for a command usage listing.

Environment

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

Exit Status

doveadm will exit with one of the following values:

       0   Selected command was executed successful.

       >0  Command failed in some way.

Files

/etc/dovecot/dovecot.conf
              Dovecot's main configuration file.

       /etc/dovecot/conf.d/10-mail.conf
              Mailbox locations and namespaces.

       /etc/dovecot/conf.d/90-plugin.conf
              Plugin specific settings.

Name

       doveadm - Dovecot's administration utility

Options

       Global doveadm(1) options:

       -D     Enables verbosity and debug messages.

       -fformatter
              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.

       -osetting=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.

       -v     Enables verbosity, including progress counter.

Reporting Bugs

       Report   bugs,  including  doveconf-n  output,  to  the  Dovecot  Mailing  List  <dovecot@dovecot.org>.
       Information about reporting bugs is available at: http://dovecot.org/bugreport.html

See Also

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

Dovecot v2.3                                       2014-10-07                                         DOVEADM(1)

Synopsis

doveadm [-Dv] [-fformatter] command [command_options] [command_arguments]

See Also