This documentation is for Dovecot v2.x, see wiki1 for v1.x documentation.
Differences between revisions 7 and 8
Revision 7 as of 2010-11-26 03:30:12
Size: 4461
Editor: PageImporter
Comment:
Revision 8 as of 2012-02-20 21:21:07
Size: 4802
Editor: PageImporter
Comment:
Deletions are marked like this. Additions are marked like this.
Line 18: Line 18:
<p>In the first form, <b><a href="/Tools/Doveadm">doveadm</a></b>(1) will executed the <p>In the first form, <b><a href=
"http://localhost/cgi-bin/man/man2html?1+doveadm">doveadm</a></b>(1) will executed the
Line 23: Line 24:
<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 41: Line 43:
"/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 47: Line 50:
<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 60: Line 64:
"/Tools/Doveadm/SearchQuery">doveadm-search-query</a></b>(7) for details.</dd> "http://localhost/cgi-bin/man/man2html?7+doveadm-search-query">doveadm-search-query</a></b>(7) for
details.</dd>
Line 69: Line 74:
<p><b><a href="/Tools/Doveadm">doveadm</a></b>(1), <b><a href=
"/Tools/Doveadm/Fetch">doveadm-fetch</a></b>(1), <b><a href=
"/Tools/Doveadm/Purge">doveadm-purge</a></b>(1), <b><a href=
"/Tools/Doveadm/Search">doveadm-search</a></b>(1), <b><a href=
"/Tools/Doveadm/SearchQuery">doveadm-search-query</a></b>(7) }}}
<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-fetch">doveadm-fetch</a></b>(1), <b><a href=
"http://localhost/cgi-bin/man/man2html?1+doveadm-purge">doveadm-purge</a></b>(1), <b><a href=
"http://localhost/cgi-bin/man/man2html?1+doveadm-search">doveadm-search</a></b>(1), <b><a href=
"http://localhost/cgi-bin/man/man2html?7+doveadm-search-query">doveadm-search-query</a></b>(7)
}}}

Doveadm-Expunge

Name

doveadm-expunge - Expunge messages matching given search query

Synopsis

doveadm [-Dv] expunge [-S socket_path] search_query
doveadm [-Dv] expunge [-S socket_path] -A search_query
doveadm [-Dv] expunge [-S socket_path] -u user search_query

Description

This command can be used to expunge mails matching the given search query. It is typically used to expunge old mails from users' Trash and/or Spam mailboxes. To test which messages a given search query would match, you can use doveadm fetch or doveadm search commands.

In the first form, doveadm(1) will executed the expunge action with the environment of the logged in system user.

In the second form, the command will be performed for all users.

In the third form, only matching mails of the given user(s) will be expunged.

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.

Arguments

search_query
Expunge messages matching this search query. See doveadm-search-query(7) for details.

Example

This example expunges messages from Spam mailbox that were saved/copied there more than two weeks ago:

doveadm expunge -u jane.doe@example.org mailbox Spam savedbefore 2w

See Also

doveadm(1), doveadm-fetch(1), doveadm-purge(1), doveadm-search(1), doveadm-search-query(7)


CategoryMan

None: Tools/Doveadm/Expunge (last edited 2021-09-22 07:08:14 by PageImporter)