doveadm-stop(1) - Linux man page

Name

doveadm - Dovecot's administration utility

Synopsis

doveadm [-Dv] [-f formatter] command [command_options] [command_arguments]

Description

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

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.
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.
-v
Enables verbosity, including progress counter.

Commands

These commands work directly with Dovecot's master process.

reload

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

stop

doveadm stop
Stop dovecot(1) and all its child processes.

ADDITIONAL MASTER COMMANDS

doveadm director: doveadm-director(1), Manage Dovecot directors (if used by proxy servers).
doveadm kick: doveadm-kick(1), Disconnect users by user name and/or IP address.
doveadm log: doveadm-log(1), Locate, test or reopen Dovecot's log files.
doveadm penalty: doveadm-penalty(1), Show current penalties.
doveadm who: doveadm-who(1); Show who is logged in to the Dovecot server.

AUTHENTICATION COMMANDS

doveadm auth: doveadm-auth(1), Test authentication for a user.
doveadm pw: doveadm-pw(1), Dovecot's password hash generator.
doveadm user: doveadm-user(1), Perform a user lookup in Dovecot's userdbs

MAILBOX COMMANDS

doveadm altmove: doveadm-altmove(1), Move matching mails to the alternative storage.
doveadm dump: doveadm-dump(1), Dump the content of Dovecot's 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 force-resync: doveadm-force-resync(1), Repair broken mailboxes, in case Dovecot doesn't automatically do that.
doveadm import: doveadm-import(1), Import messages matching given search query.
doveadm mailbox: doveadm-mailbox(1), Various commands related to handling mailboxes.
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 search: doveadm-search(1), Show a list of mailbox GUIDs and message UIDs matching given search query.

Exit Status

doveadm will exit with one of the following values:

0 Selected command was executed successful. >0 Command failed in some way.

Environment

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

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.

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