doveadm-purge(1)

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

NAME

6       doveadm-purge - Remove messages with refcount=0 from mdbox files
7

SYNOPSIS

9       doveadm [-Dv] purge [-S socket_path]
10       doveadm [-Dv] purge [-S socket_path] -A
11       doveadm [-Dv] purge [-S socket_path] -F file
12       doveadm [-Dv] purge [-S socket_path] -u user
13

DESCRIPTION

15       The  doveadm  purge  command  is  used to remove all messages with ref‐
16       count=0 from a user's mail storage.   The  refcount  of  a  message  is
17       decreased  to  0  when  the  user  (or some administration utility) has
18       expunged all instances of a message from all mailboxes.
19
20       In the first form, doveadm(1) will perform the  purge  action  for  the
21       currently logged in user.
22
23       In the second form, the command will be executed for all users.
24
25       In the third form, the command will be executed for all users listed in
26       the given file.
27
28       In the last form, only messages of the given user(s) will be purged.
29

OPTIONS

31       Global doveadm(1) options:
32
33       -D     Enables verbosity and debug messages.
34
35       -o setting=value
36              Overrides  the  configuration  setting  from  /etc/dovecot/dove‐
37              cot.conf  and from the userdb with the given value.  In order to
38              override multiple settings, the -o option may be specified  mul‐
39              tiple times.
40
41       -v     Enables verbosity, including progress counter.
42
43       Command specific options:
44
45       -A     If  the  -A option is present, the command will be performed for
46              all users.  Using this option in combination with  system  users
47              from  userdb  { driver = passwd } is not recommended, because it
48              contains also users with a lower UID  than  the  one  configured
49              with the first_valid_uid setting.
50
51              When  the  SQL  userdb  module  is used make sure that the iter‐
52              ate_query setting in  /etc/dovecot/dovecot-sql.conf.ext  matches
53              your  database  layout.  When using the LDAP userdb module, make
54              sure that  the  iterate_attrs  and  iterate_filter  settings  in
55              /etc/dovecot/dovecot-ldap.conf.ext match your LDAP schema.  Oth‐
56              erwise doveadm(1) will be unable to iterate over all users.
57
58       -F file
59              Execute the command for all the users in the file.  This is sim‐
60              ilar  to the -A option, but instead of getting the list of users
61              from the userdb, they are read from the given  file.   The  file
62              contains one username per line.
63
64       -S socket_path
65              The option's argument is either an absolute path to a local UNIX
66              domain socket, or a hostname and port (hostname:port), in  order
67              to connect a remote host via a TCP socket.
68
69              This allows an administrator to execute doveadm(1) mail commands
70              through the given socket.
71
72       -u user/mask
73              Run the command only for the given user.  It's also possible  to
74              use '*' and '?' wildcards (e.g. -u *@example.org).
75              When  neither  the  -A  option,  nor the -F file option, nor the
76              -u user was specified, the command will  be  executed  with  the
77              environment of the currently logged in user.
78

REPORTING BUGS

80       Report  bugs, including doveconf -n output, to the Dovecot Mailing List
81       <dovecot@dovecot.org>.  Information about reporting bugs  is  available
82       at: http://dovecot.org/bugreport.html
83

NAME

SYNOPSIS

DESCRIPTION

OPTIONS

REPORTING BUGS

SEE ALSO