doveadm(1)

1DOVEADM(1)                          Dovecot                         DOVEADM(1)
2
3
4

NAME

6       doveadm - Dovecot's administration utility
7

SYNOPSIS

9       doveadm  [-Dv]  [-f formatter] command [command_options] [command_argu‐
10       ments]
11

DESCRIPTION

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

OPTIONS

18       Global doveadm(1) options:
19
20       -D     Enables verbosity and debug messages.
21
22       -f formatter
23              Specifies  the  formatter  for formatting the output.  Supported
24              formatters are:
25
26              flow   prints each line with key=value pairs.
27
28              pager  prints each key: value pair on its own line and separates
29                     records with form feed character (^L).
30
31              tab    prints  a  table  header  followed by tab separated value
32                     lines.
33
34              table  prints a table header followed by adjusted value lines.
35
36       -v     Enables verbosity, including progress counter.
37

COMMANDS

39       These commands work directly with Dovecot's master process.
40
41   reload
42       doveadm reload
43
44       Force dovecot(1) to reload the configuration.
45
46   stop
47       doveadm stop
48
49       Stop dovecot(1) and all its child processes.
50
51   ADDITIONAL MASTER COMMANDS
52       doveadm director
53              doveadm-director(1), Manage Dovecot directors (if used by  proxy
54              servers).
55
56       doveadm kick
57              doveadm-kick(1),   Disconnect  users  by  user  name  and/or  IP
58              address.
59
60       doveadm log
61              doveadm-log(1), Locate, test or reopen Dovecot's log files.
62
63       doveadm penalty
64              doveadm-penalty(1), Show current penalties.
65
66       doveadm who
67              doveadm-who(1); Show who is logged in to the Dovecot server.
68
69   AUTHENTICATION COMMANDS
70       doveadm auth
71              doveadm-auth(1), Test authentication for a user.
72
73       doveadm pw
74              doveadm-pw(1), Dovecot's password hash generator.
75
76       doveadm user
77              doveadm-user(1), Perform a user lookup in Dovecot's userdbs
78
79   MAILBOX COMMANDS
80       doveadm altmove
81              doveadm-altmove(1), Move matching mails to the alternative stor‐
82              age.
83
84       doveadm dump
85              doveadm-dump(1),  Dump  the  content of Dovecot's binary mailbox
86              index/log.
87
88       doveadm expunge
89              doveadm-expunge(1),  Expunge  messages  matching  given   search
90              query.
91
92       doveadm fetch
93              doveadm-fetch(1), Fetch messages matching given search query.
94
95       doveadm force-resync
96              doveadm-force-resync(1),  Repair broken mailboxes, in case Dove‐
97              cot doesn't automatically do that.
98
99       doveadm import
100              doveadm-import(1), Import messages matching given search query.
101
102       doveadm index
103              doveadm-index(1), Index messages in a given mailbox.
104
105       doveadm mailbox
106              doveadm-mailbox(1), Various commands related to  handling  mail‐
107              boxes.
108
109       doveadm purge
110              doveadm-purge(1)  Remove  messages  with  refcount=0  from mdbox
111              files.
112
113       doveadm quota
114              doveadm-quota(1), Initialize/recalculate or show  current  quota
115              usage.
116
117       doveadm search
118              doveadm-search(1), Show a list of mailbox GUIDs and message UIDs
119              matching given search query.
120

EXIT STATUS

122       doveadm will exit with one of the following values:
123
124       0   Selected command was executed successful.
125
126       >0  Command failed in some way.
127

ENVIRONMENT

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

FILES

133       /etc/dovecot/dovecot.conf
134              Dovecot's main configuration file.
135
136       /etc/dovecot/conf.d/10-mail.conf
137              Mailbox locations and namespaces.
138
139       /etc/dovecot/conf.d/90-plugin.conf
140              Plugin specific settings.
141

REPORTING BUGS

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