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       -o setting=value
37              Overrides  the  configuration  setting  from  /etc/dovecot/dove‐
38              cot.conf  and from the userdb with the given value.  In order to
39              override multiple settings, the -o option may be specified  mul‐
40              tiple times.
41
42       -v     Enables verbosity, including progress counter.
43

COMMANDS

45       These commands work directly with Dovecot's master process.
46
47   reload
48       doveadm reload
49
50       Force dovecot(1) to reload the configuration.
51
52   stop
53       doveadm stop
54
55       Stop dovecot(1) and all its child processes.
56
57   ADDITIONAL MASTER COMMANDS
58       doveadm config
59              doveadm-config(1), Dump Dovecot configuration.
60
61       doveadm director
62              doveadm-director(1),  Manage Dovecot directors (if used by proxy
63              servers).
64
65       doveadm exec
66              doveadm-exec(1),  Easily   execute   commands   from   Dovecot's
67              libexec_dir.
68
69       doveadm instance
70              doveadm-instance(1),   Manage   the   list  of  running  Dovecot
71              instances.
72
73       doveadm kick
74              doveadm-kick(1),  Disconnect  users  by  user  name  and/or   IP
75              address.
76
77       doveadm log
78              doveadm-log(1), Locate, test or reopen Dovecot's log files.
79
80       doveadm penalty
81              doveadm-penalty(1), Show current penalties.
82
83       doveadm proxy
84              doveadm-proxy(1), Handle Dovecot proxy connections.
85
86       doveadm who
87              doveadm-who(1); Show who is logged in to the Dovecot server.
88
89   AUTHENTICATION COMMANDS
90       doveadm auth
91              doveadm-auth(1), Test authentication for a user.
92
93       doveadm pw
94              doveadm-pw(1), Dovecot's password hash generator.
95
96       doveadm user
97              doveadm-user(1), Perform a user lookup in Dovecot's userdbs
98
99   MAILBOX COMMANDS
100       doveadm acl
101              doveadm-acl(1), Manage Access Control List (ACL).
102
103       doveadm altmove
104              doveadm-altmove(1), Move matching mails to the alternative stor‐
105              age.
106
107       doveadm backup
108              doveadm-backup(1),  Dovecot's  one-way  mailbox  synchronization
109              utility.
110
111       doveadm batch
112              doveadm-batch(1), Execute multiple commands for multiple users.
113
114       doveadm copy
115              doveadm-copy(1),  Copy  messages matching the given search query
116              into another mailbox.
117
118       doveadm deduplicate
119              doveadm-deduplicate(1), Expunge duplicate messages.
120
121       doveadm dump
122              doveadm-dump(1), Dump the content of  Dovecot's  binary  mailbox
123              index/log.
124
125       doveadm expunge
126              doveadm-expunge(1),   Expunge  messages  matching  given  search
127              query.
128
129       doveadm fetch
130              doveadm-fetch(1), Fetch messages matching given search query.
131
132       doveadm flags
133              doveadm-flags(1), Add, remove or replace messages' flags.
134
135       doveadm force-resync
136              doveadm-force-resync(1), Repair broken mailboxes, in case  Dove‐
137              cot doesn't automatically do that.
138
139       doveadm fs
140              doveadm-fs(1),  Interact with the abstract mail storage filesys‐
141              tem.
142
143       doveadm fts
144              doveadm-fts(1), Manipulate the Full Text Search (FTS) index.
145
146       doveadm import
147              doveadm-import(1), Import messages matching given search query.
148
149       doveadm index
150              doveadm-index(1), Index messages in a given mailbox.
151
152       doveadm mailbox
153              doveadm-mailbox(1), Various commands related to  handling  mail‐
154              boxes.
155
156       doveadm mailbox cryptokey
157              doveadm-mailbox-cryptokey(1), Mail crypt plugin management.
158
159       doveadm move
160              doveadm-move(1)  Move  messages  matching the given search query
161              into another mailbox.
162
163       doveadm purge
164              doveadm-purge(1) Remove  messages  with  refcount=0  from  mdbox
165              files.
166
167       doveadm quota
168              doveadm-quota(1),  Initialize/recalculate  or show current quota
169              usage.
170
171       doveadm rebuild
172              doveadm-rebuild(1), Rebuild index metadata from message data.
173
174       doveadm replicator
175              doveadm-replicator(1), Manage users' mail replication.
176
177       doveadm save
178              doveadm-save(1), Save email to users' mailboxes.
179
180       doveadm search
181              doveadm-search(1), Show a list of mailbox GUIDs and message UIDs
182              matching given search query.
183
184       doveadm stats
185              doveadm-stats(1), Inspect or reset stats.
186
187       doveadm sync
188              doveadm-sync(1), Dovecot's two-way mailbox synchronization util‐
189              ity.
190

EXIT STATUS

192       doveadm will exit with one of the following values:
193
194       0   Selected command was executed successful.
195
196       >0  Command failed in some way.
197

ENVIRONMENT

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

FILES

203       /etc/dovecot/dovecot.conf
204              Dovecot's main configuration file.
205
206       /etc/dovecot/conf.d/10-mail.conf
207              Mailbox locations and namespaces.
208
209       /etc/dovecot/conf.d/90-plugin.conf
210              Plugin specific settings.
211

REPORTING BUGS

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

SEE ALSO

218       doveadm-help(1), doveconf(1), dovecot(1), doveadm-search-query(7)
219
220
221
222Dovecot v2.3                      2014-10-07                        DOVEADM(1)
Impressum