This documentation is for Dovecot v2.x, see wiki1 for v1.x documentation.
Differences between revisions 1 and 24 (spanning 23 versions)
Revision 1 as of 2010-07-02 15:52:06
Size: 3792
Editor: PageImporter
Comment:
Revision 24 as of 2017-12-20 03:30:05
Size: 5515
Editor: PageImporter
Comment:
Deletions are marked like this. Additions are marked like this.
Line 7: Line 7:
<p><b>doveadm</b> [<b>-Dv</b>] <b>expunge</b> <i>search_query</i><br>
<b>doveadm</b> [<b>-Dv</b>] <b>expunge -A</b> <i>search_query</i><br>
<b>doveadm</b> [<b>-Dv</b>] <b>expunge -u</b> <i>user search_query</i></p>
<p><b>doveadm</b> [<b>-Dv</b>] <b>expunge</b> [<b>-S</b> <i>socket_path</i>] [<b>-d</b>]
<i>search_query</i><br>
<b>doveadm</b> [<b>-Dv</b>] <b>expunge</b> [<b>-S</b> <i>socket_path</i>] [<b>-d</b>] <b>-A</b>
<i>search_query</i><br>
<b>doveadm</b> [<b>-Dv</b>] <b>expunge</b> [<b>-S</b> <i>socket_path</i>] [<b>-d</b>] <b>-F</b>
<i>file
search_query</i><br>
<b>doveadm</b> [<b>-Dv</b>] <b>expunge</b> [<b>-S</b> <i>socket_path</i>] [<b>-d</b>] <b>-u</b>
<i>user search_query</i></p>
Line 15: Line 20:
<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="/Tools/Doveadm">doveadm</a></b>(1) will execute the
Line 18: Line 23:
<p>In the third form, only matching mails of the given <i>user</i>(s) will be expunged.</p> <p>In the third form, <b><a href="/Tools/Doveadm">doveadm</a></b>(1) will expunge messages of the
users listed in the given <i>file</i>.</p>
<p>In the fourth form,
only matching mails of the given <i>user</i>(s) will be expunged.</p>
Line 24: Line 31:
<dt><b>-o&nbsp;</b><i>setting</i><b>=</b><i>value</i></dt>
<dd>Overrides the configuration <i>setting</i> from <i>/etc/dovecot/dovecot.conf</i> and from the
userdb with the given <i>value</i>. In order to override multiple settings, the <b>-o</b> option
may be specified multiple times.</dd>
Line 34: Line 45:
<p>When the sql userdb module is used make sure that the <i>iterate_query</i> setting in the
<i>/etc/dovecot/dovecot-sql.conf.ext</i> matches your database layout. Otherwise <b><a href=
<p>When the SQL userdb module is used make sure that the <i>iterate_query</i> setting in
<i>/etc/dovecot/dovecot-sql.conf.ext</i> matches your database layout. When using the LDAP userdb
module, make sure that the <i>iterate_attrs</i> and <i>iterate_filter</i> settings in
<i>/etc/dovecot/dovecot-ldap.conf.ext</i> match your LDAP schema
. Otherwise <b><a href=
Line 37: Line 50:
</dd>
<dt><b>-F&nbsp;</b><i>file</i></dt>
<dd>Execute the <i>command</i> for all the users in the <i>file</i>. This is similar to the
<b>-A</b> option, but instead of getting the list of users from the userdb, they are read from the
given <i>file</i>. The <i>file</i> contains one username per line.</dd>
<dt style="font-weight: bold">-d</dt>
<dd>Delete the mailbox if it is empty after expunging.</dd>
<dt><b>-S&nbsp;</b><i>socket_path</i></dt>
<dd>The option&#39;s argument is either an absolute path to a local UNIX domain socket, or a
hostname and port (<i>hostname</i>:<i>port</i>), in order to connect a remote host via a TCP
socket.
<p>This allows an administrator to execute <b><a href="/Tools/Doveadm">doveadm</a></b>(1) mail
commands through the given socket.</p>
Line 41: Line 67:
When neither the <b>-A</b> option nor <b>-u&nbsp;</b><i>user</i> was specified, the <i>command</i>
will be executed with the environment of the currently logged in user.</dd>
When neither the <b>-A</b> option, nor the <b>-F&nbsp;</b><i>file</i> option, nor the
<b>-u&nbsp;</b><i>user</i> was specified, the <i>command</i> will be executed with the environment
of the currently logged in user.</dd>
Line 48: Line 75:
"/Tools/Doveadm/Search/Query">doveadm-search-query</a></b>(7) for details.</dd> "/Tools/Doveadm/SearchQuery">doveadm-search-query</a></b>(7) for details.</dd>
Line 54: Line 81:
<b>doveadm expunge -u jane.doe@example.org mailbox Spam savedbefore 2w</b>
</pre>
<b>doveadm expunge -u jane.doe@example.org mailbox Spam savedbefore 2w
</b></pre>
Line 61: Line 88:
"/Tools/Doveadm/Search/Query">doveadm-search-query</a></b>(7) }}} "/Tools/Doveadm/SearchQuery">doveadm-search-query</a></b>(7) }}}

Doveadm-Expunge

Name

doveadm-expunge - Expunge messages matching given search query

Synopsis

doveadm [-Dv] expunge [-S socket_path] [-d] search_query
doveadm [-Dv] expunge [-S socket_path] [-d] -A search_query
doveadm [-Dv] expunge [-S socket_path] [-d] -F file search_query
doveadm [-Dv] expunge [-S socket_path] [-d] -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 execute 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, doveadm(1) will expunge messages of the users listed in the given file.

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

Options

Global doveadm(1) options:

-D
Enables verbosity and debug messages.
-o setting=value
Overrides the configuration setting from /etc/dovecot/dovecot.conf and from the userdb with the given value. In order to override multiple settings, the -o option may be specified multiple times.
-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.

-F file
Execute the command for all the users in the file. This is similar to the -A option, but instead of getting the list of users from the userdb, they are read from the given file. The file contains one username per line.
-d
Delete the mailbox if it is empty after expunging.
-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 the -F file option, nor the -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)