1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
|
.\" Copyright (c) 2010-2018 Dovecot authors, see the included COPYING file
.TH DOVEADM 1 "2014-10-07" "Dovecot v2.3" "Dovecot"
.SH NAME
doveadm \- Dovecot\(aqs administration utility
.\"------------------------------------------------------------------------
.SH SYNOPSIS
.BR doveadm " [" \-Dv "] [" \-f
.IR formatter ]
.IR command " [" command_options "] [" command_arguments ]
.\"------------------------------------------------------------------------
.SH DESCRIPTION
.B doveadm
is the Dovecot administration tool. It can be used to manage various parts
of Dovecot, as well as access users\(aq mailboxes.
.br
Execute
.BR doveadm\ help ,
for a command usage listing.
.\"------------------------------------------------------------------------
@INCLUDE:global-options-formatter@
.\"------------------------------------------------------------------------
.SH COMMANDS
.\"------------------------------------------------------------------------
These commands work directly with Dovecot\(aqs master process.
.\"-------------------------------------
.SS reload
.B doveadm reload
.PP
Force
.BR dovecot (1)
to reload the configuration.
.\"------------------------------------------------------------------------
.SS stop
.B doveadm stop
.PP
Stop
.BR dovecot (1)
and all its child processes.
.\"------------------------------------------------------------------------
.SS ADDITIONAL MASTER COMMANDS
.TP
.B doveadm config
.BR doveadm\-config (1),
Dump Dovecot configuration.
.\"-------------------------------------
.TP
.B doveadm director
.BR doveadm\-director (1),
Manage Dovecot directors (if used by proxy servers).
.\"-------------------------------------
.TP
.B doveadm exec
.BR doveadm\-exec (1),
Easily execute commands from Dovecot\(aqs libexec_dir.
.\"-------------------------------------
.TP
.B doveadm instance
.BR doveadm\-instance (1),
Manage the list of running Dovecot instances.
.\"-------------------------------------
.TP
.B doveadm kick
.BR doveadm\-kick (1),
Disconnect users by user name and/or IP address.
.\"-------------------------------------
.TP
.B doveadm log
.BR doveadm\-log (1),
Locate, test or reopen Dovecot\(aqs log files.
.\"-------------------------------------
.TP
.B doveadm penalty
.BR doveadm\-penalty (1),
Show current penalties.
.\"-------------------------------------
.TP
.B doveadm proxy
.BR doveadm\-proxy (1),
Handle Dovecot proxy connections.
.\"-------------------------------------
.TP
.B doveadm who
.BR doveadm\-who (1);
Show who is logged in to the Dovecot server.
.\"------------------------------------------------------------------------
.SS AUTHENTICATION COMMANDS
.\"-------------------------------------
.TP
.B doveadm auth
.BR doveadm\-auth (1),
Test authentication for a user.
.\"-------------------------------------
.TP
.B doveadm pw
.BR doveadm\-pw (1),
Dovecot\(aqs password hash generator.
.\"-------------------------------------
.TP
.B doveadm user
.BR doveadm\-user (1),
Perform a user lookup in Dovecot\(aqs userdbs
.\"------------------------------------------------------------------------
.SS MAILBOX COMMANDS
.TP
.B doveadm acl
.BR doveadm\-acl (1),
Manage Access Control List (ACL).
.\"-------------------------------------
.TP
.B doveadm altmove
.BR doveadm\-altmove (1),
Move matching mails to the alternative storage.
.\"-------------------------------------
.TP
.B doveadm backup
.BR doveadm\-backup (1),
Dovecot\(aqs one\-way mailbox synchronization utility.
.\"-------------------------------------
.TP
.B doveadm batch
.BR doveadm\-batch (1),
Execute multiple commands for multiple users.
.\"-------------------------------------
.TP
.B doveadm copy
.BR doveadm\-copy (1),
Copy messages matching the given search query into another mailbox.
.\"-------------------------------------
.TP
.B doveadm deduplicate
.BR doveadm\-deduplicate (1),
Expunge duplicate messages.
.\"-------------------------------------
.TP
.B doveadm dump
.BR doveadm\-dump (1),
Dump the content of Dovecot\(aqs binary mailbox index/log.
.\"-------------------------------------
.TP
.B doveadm expunge
.BR doveadm\-expunge (1),
Expunge messages matching given search query.
.\"-------------------------------------
.TP
.B doveadm fetch
.BR doveadm\-fetch (1),
Fetch messages matching given search query.
.\"-------------------------------------
.TP
.B doveadm flags
.BR doveadm\-flags (1),
Add, remove or replace messages\(aq flags.
.\"-------------------------------------
.TP
.B doveadm force\-resync
.BR doveadm\-force\-resync (1),
Repair broken mailboxes, in case Dovecot doesn\(aqt automatically do that.
.\"-------------------------------------
.TP
.B doveadm fs
.BR doveadm\-fs (1),
Interact with the abstract mail storage filesystem.
.\"-------------------------------------
.TP
.B doveadm fts
.BR doveadm\-fts (1),
Manipulate the Full Text Search (FTS) index.
.\"-------------------------------------
.TP
.B doveadm import
.BR doveadm\-import (1),
Import messages matching given search query.
.\"-------------------------------------
.TP
.B doveadm index
.BR doveadm\-index (1),
Index messages in a given mailbox.
.\"-------------------------------------
.TP
.B doveadm mailbox
.BR doveadm\-mailbox (1),
Various commands related to handling mailboxes.
.\"-------------------------------------
.TP
.B doveadm mailbox cryptokey
.BR doveadm\-mailbox\-cryptokey (1),
Mail crypt plugin management.
.\"-------------------------------------
.TP
.B doveadm move
.BR doveadm\-move (1)
Move messages matching the given search query into another mailbox.
.\"-------------------------------------
.TP
.B doveadm purge
.BR doveadm\-purge (1)
Remove messages with refcount=0 from mdbox files.
.\"-------------------------------------
.TP
.B doveadm quota
.BR doveadm\-quota (1),
Initialize/recalculate or show current quota usage.
.\"-------------------------------------
.TP
.B doveadm rebuild
.BR doveadm\-rebuild (1),
Rebuild index metadata from message data.
.\"-------------------------------------
.TP
.B doveadm replicator
.BR doveadm\-replicator (1),
Manage users\(aq mail replication.
.\"-------------------------------------
.TP
.B doveadm save
.BR doveadm\-save (1),
Save email to users\(aq mailboxes.
.\"-------------------------------------
.TP
.B doveadm search
.BR doveadm\-search (1),
Show a list of mailbox GUIDs and message UIDs matching given search query.
.\"-------------------------------------
.TP
.B doveadm stats
.BR doveadm\-stats (1),
Inspect or reset stats.
.\"-------------------------------------
.TP
.B doveadm sync
.BR doveadm\-sync (1),
Dovecot\(aqs two\-way mailbox synchronization utility.
.\"------------------------------------------------------------------------
.SH "EXIT STATUS"
.B doveadm
will exit with one of the following values:
.TP 4
.B 0
Selected command was executed successful.
.TP
.B >0
Command failed in some way.
.\"------------------------------------------------------------------------
.SH ENVIRONMENT
.TP
.B USER
This environment variable is used to determine the
.I user
if a command accepts a
.I user
but none was specified.
.\"------------------------------------------------------------------------
.SH FILES
.TP
.I @pkgsysconfdir@/dovecot.conf
Dovecot\(aqs main configuration file.
.TP
.I @pkgsysconfdir@/conf.d/10\-mail.conf
Mailbox locations and namespaces.
.TP
.I @pkgsysconfdir@/conf.d/90\-plugin.conf
Plugin specific settings.
.\"------------------------------------------------------------------------
@INCLUDE:reporting-bugs@
.\"------------------------------------------------------------------------
.SH SEE ALSO
.BR doveadm\-help (1),
.BR doveconf (1),
.BR dovecot (1),
.BR doveadm\-search\-query (7)
|
