nützliche Kommandos rund um Dovecot
doveconf
Dovecot stellt ähnlich wie auch Postfix, bietet Dovecot ein Adnministrationswerkzeug zur Abfrage der Konfigurationsoptionen.
Die wohl am häufigsten benutzten Optionen sind:
doveconfbzw.doveconf -a: Die aktuelle aktive Konfiguration wird auf dem Bildschirm ausgegeben. Dies ist eine nützliche und oft gewünschte Abfrage, unter anderem bei Hilferufen in den einschlägigen Mailinglisten.doveconf -c <filename>: Die Konfiguration wird aus dem genannten Konfigurationsfile neu gelesen; per default ist das /etc/dovecot/dovecot.conf.doveconf -d: Statt der aktuellen Konfiguration, wird die Default-Konfiguration von Dovecot ausgegeben.doveconf -n: Zeigt alle Optionen der aktuellen Konfiguration, die nicht den Defaultwerten entsprechen.doveconf -N: Zeigt alle Optionen der aktuellen Konfiguration, die nicht den Defaultwerten entsprechen und zusätzlich alle explizit gesetzten Standardkonfigurationswerte.doveconf -m <module>: Zeigt nur die Konfiguration des genannten Moduls, also z.B. imap, imap-login, lmtp, pop3 und pop3-login.
Eine Übersicht aller Optionen ist in der Manpage des Befehls doveconf zu finden.
DOVECONF(1) Dovecot DOVECONF(1)
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) and dovecot-lda(1), will first get their settings by executing doveconf.
For system administrators, doveconf is mainly useful for dumping the configuration in easy human readable output.
OPTIONS
-a Show all settings with their currently configured values.
-c config-file
read configuration from the given config-file. By default /etc/dovecot/dovecot.conf will be used.
-d Show the setting's default value instead of the one currently configured.
-f filter
Show the matching configuration for the specified filter condition. The filter option string has to be given as name=value
pair. For multiple filter conditions the -f option can be supplied multiple times.
Possible names for the filter are:
lname The local hostname, e.g. mail.example.com. This will only match hostnames which were configured like:
local_name mail.example.com { # special settings }
local The server's hostname or IP address. This will also match hostnames which were configured like:
local imap.example.net { # special settings }
protocol, service
The protocol, e.g. imap or pop3
remote The client's hostname or IP address.
-h Hide the setting's name, show only the setting's value.
-m module
Show only settings for the given module.
e.g. imap, imap-login, lmtp, pop3 or pop3-login
-n Show only settings with non-default values.
-N Show settings with non-default values and explicitly set default values.
-S Dump settings in simplified machine parsable/readable format.
-x Expand configuration variables (e.g. $mail_plugins ⇒ quota) and show file contents (from e.g. ssl_cert =
</etc/ssl/certs/dovecot.pem).
section_name
Show only the current configuration of one or more specified sections.
setting_name
Show only the setting of one or more setting_name(s) with the currently configured value. You can show a setting inside a
section using '/' as the section separator, e.g. service/imap/executable.
EXAMPLE
When Dovecot was configured to use different settings for some networks/subnets it is possible to show which settings will be
applied for a specific connection.
doveconf -f local=10.0.0.110 -f remote=10.11.1.2 -f service=pop3 -n
doveconf can be also used to convert v1.x configuration files into v2.x format.
doveconf -n -c /oldpath/dovecot.conf > /etc/dovecot/dovecot.conf.new
This example shows how to ask doveconf for a global setting and a protocol specific setting. The second command uses also the -h
option, in order to hide the setting's name.
doveconf mail_plugins
mail_plugins = quota
doveconf -h -f protocol=imap mail_plugins
quota imap_quota
This example demonstrates how to dump a whole configuration section.
doveconf dict
dict {
quota = pgsql:/etc/dovecot/dovecot-dict-sql.conf.ext
}
Or how to dump only the quota dict:
doveconf dict/quota
dict/quota = pgsql:/etc/dovecot/dovecot-dict-sql.conf.ext
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(1), dovecot(1), dovecot-lda(1), dsync(1)
Dovecot v2.2 2012-01-29 DOVECONF(1)
doveadm
DOVEADM(1) Dovecot DOVEADM(1)
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 exec
doveadm-exec(1), Easily execute commands from Dovecot's 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's log files.
doveadm mount
doveadm-mount(1), Manage the list of mountpoints where mails are stored.
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 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'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 flags
doveadm-flags(1), Add, remove or replace messages' flags.
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 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 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
SEE ALSO
doveadm-help(1), doveconf(1), dovecot(1), dsync(1), doveadm-search-query(7)
Dovecot v2.2 2013-11-16 DOVEADM(1)
django