1DOVEADM-PURGE(1) Dovecot DOVEADM-PURGE(1)
2
3
4
6 doveadm-purge - Remove messages with refcount=0 from mdbox files
7
9 doveadm [-Dv] purge [-S socket_path]
10 doveadm [-Dv] purge [-S socket_path] -A
11 doveadm [-Dv] purge [-S socket_path] -u user
12
14 The doveadm purge command is used to remove all messages with ref‐
15 count=0 from a user's mail storage. The refcount of a message is
16 decreased to 0 when the user (or some administration utility) has
17 expunged all instances of a message from all mailboxes.
18
19 In the first form, doveadm(1) will perform the purge action for the
20 currently logged in user.
21
22 In the second form, the command will be executed for all users
23
24 In the last form, only messages of the given user(s) will be purged.
25
27 Global doveadm(1) options:
28
29 -D Enables verbosity and debug messages.
30
31 -v Enables verbosity, including progress counter.
32
33 Command specific options:
34
35 -A If the -A option is present, the command will be performed for
36 all users. Using this option in combination with system users
37 from userdb { driver = passwd } is not recommended, because it
38 contains also users with a lower UID than the one configured
39 with the first_valid_uid setting.
40
41 When the SQL userdb module is used make sure that the iter‐
42 ate_query setting in /etc/dovecot/dovecot-sql.conf.ext matches
43 your database layout. When using the LDAP userdb module, make
44 sure that the iterate_attrs and iterate_filter settings in
45 /etc/dovecot/dovecot-ldap.conf.ext match your LDAP schema. Oth‐
46 erwise doveadm(1) will be unable to iterate over all users.
47
48 -S socket_path
49 The option's argument is either an absolute path to a local UNIX
50 domain socket, or a hostname and port (hostname:port), in order
51 to connect a remote host via a TCP socket.
52
53 This allows an administrator to execute doveadm(1) mail commands
54 through the given socket.
55
56 -u user/mask
57 Run the command only for the given user. It's also possible to
58 use '*' and '?' wildcards (e.g. -u *@example.org).
59 When neither the -A option nor -u user was specified, the com‐
60 mand will be executed with the environment of the currently
61 logged in user.
62
64 Report bugs, including doveconf -n output, to the Dovecot Mailing List
65 <dovecot@dovecot.org>. Information about reporting bugs is available
66 at: http://dovecot.org/bugreport.html
67
69 doveadm(1), doveadm-expunge(1)
70
71 See http://wiki2.dovecot.org/MailboxFormat/dbox#Multi-dbox for some
72 details.
73
74
75
76Dovecot v2.0 2010-11-25 DOVEADM-PURGE(1)