This documentation is for Dovecot v2.x, see wiki1 for v1.x documentation.
Differences between revisions 8 and 9
Revision 8 as of 2012-02-20 21:26:29
Size: 3698
Editor: PageImporter
Comment:
Revision 9 as of 2013-11-16 15:19:51
Size: 3902
Editor: PageImporter
Comment:
Deletions are marked like this. Additions are marked like this.
Line 16: Line 16:
<p>In the first form, <b><a href="/Tools/Doveadm">doveadm</a></b>(1) will perform the <b>purge</b> <p>In the first form, <b><a href=
"http://localhost/cgi-bin/man/man2html?1+doveadm">doveadm</a></b>(1) will perform the <b>purge</b>
Line 21: Line 22:
<p>Global <b><a href="/Tools/Doveadm">doveadm</a></b>(1) <i>options</i>:</p> <p>Global <b><a href="http://localhost/cgi-bin/man/man2html?1+doveadm">doveadm</a></b>(1)
<i>options</i>:</p>
Line 39: Line 41:
"/Tools/Doveadm">doveadm</a></b>(1) will be unable to iterate over all users.</p> "http://localhost/cgi-bin/man/man2html?1+doveadm">doveadm</a></b>(1) will be unable to iterate over
all users.</p>
Line 45: Line 48:
<p>This allows an administrator to execute <b><a href="/Tools/Doveadm">doveadm</a></b>(1) mail
commands through the given socket.</p>
<p>This allows an administrator to execute <b><a href=
"http://localhost/cgi-bin/man/man2html?1+doveadm">doveadm</a></b>(1) mail commands through the
given socket.</p>
Line 55: Line 59:
<p><b><a href="/Tools/Doveadm">doveadm</a></b>(1), <b><a href=
"/Tools/Doveadm/Expunge">doveadm-expunge</a></b>(1)</p>
<p><b><a href="http://localhost/cgi-bin/man/man2html?1+doveadm">doveadm</a></b>(1), <b><a href=
"http://localhost/cgi-bin/man/man2html?1+doveadm-expunge">doveadm-expunge</a></b>(1)</p>

Doveadm-Purge

Name

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

Synopsis

doveadm [-Dv] purge [-S socket_path]
doveadm [-Dv] purge [-S socket_path] -A
doveadm [-Dv] purge [-S socket_path] -u user

Description

The doveadm purge command is used to remove all messages with refcount=0 from a user's mail storage. The refcount of a message is decreased to 0 when the user (or some administration utility) has expunged all instances of a message from all mailboxes.

In the first form, doveadm(1) will perform the purge action for the currently logged in user.

In the second form, the command will be executed for all users

In the last form, only messages of the given user(s) will be purged.

Options

Global doveadm(1) options:

-D
Enables verbosity and debug messages.
-v
Enables verbosity, including progress counter.

Command specific options:

-A
If the -A option is present, the command will be performed for all users. Using this option in combination with system users from userdb { driver = passwd } is not recommended, because it contains also users with a lower UID than the one configured with the first_valid_uid setting.

When the SQL userdb module is used make sure that the iterate_query setting in /etc/dovecot/dovecot-sql.conf.ext matches your database layout. When using the LDAP userdb module, make sure that the iterate_attrs and iterate_filter settings in /etc/dovecot/dovecot-ldap.conf.ext match your LDAP schema. Otherwise doveadm(1) will be unable to iterate over all users.

-S socket_path
The option's argument is either an absolute path to a local UNIX domain socket, or a hostname and port (hostname:port), in order to connect a remote host via a TCP socket.

This allows an administrator to execute doveadm(1) mail commands through the given socket.

-u user/mask
Run the command only for the given user. It's also possible to use '*' and '?' wildcards (e.g. -u *@example.org).
When neither the -A option nor -u user was specified, the command will be executed with the environment of the currently logged in user.

See Also

doveadm(1), doveadm-expunge(1)

See http://wiki2.dovecot.org/MailboxFormat/dbox#Multi-dbox for some details.


CategoryMan

None: Tools/Doveadm/Purge (last edited 2017-05-30 13:35:41 by PageImporter)