|
Size: 3024
Comment:
|
Size: 4610
Comment:
|
| Deletions are marked like this. | Additions are marked like this. |
| Line 7: | Line 7: |
| <p><b>doveadm</b> [<b>-Dv</b>] <b>purge</b><br> <b>doveadm</b> [<b>-Dv</b>] <b>purge -A</b><br> <b>doveadm</b> [<b>-Dv</b>] <b>purge -u</b> <i>user</i></p> |
<p><b>doveadm</b> [<b>-Dv</b>] <b>purge</b> [<b>-S</b> <i>socket_path</i>]<br> <b>doveadm</b> [<b>-Dv</b>] <b>purge</b> [<b>-S</b> <i>socket_path</i>] <b>-A</b><br> <b>doveadm</b> [<b>-Dv</b>] <b>purge</b> [<b>-S</b> <i>socket_path</i>] <b>-F </b><i>file</i><br> <b>doveadm</b> [<b>-Dv</b>] <b>purge</b> [<b>-S</b> <i>socket_path</i>] <b>-u</b><i> user</i></p> |
| Line 15: | Line 18: |
| <p>In the first form, <b><a href="/Tools/Doveadm">doveadm</a></b>(1) will perform the <b>purge</b> action for the currently logged in user.</p> <p>In the second form, the command will be executed for all users</p> |
<p>In the first form, <b><a href="/man/man2html?1+doveadm">doveadm</a></b>(1) will perform the <b>purge</b> action for the currently logged in user.</p> <p>In the second form, the command will be executed for all users.</p> <p>In the third form, the command will be executed for all users listed in the given <i>file</i>.</p> |
| Line 20: | Line 25: |
| <p>Global <b><a href="/Tools/Doveadm">doveadm</a></b>(1) <i>options</i>:</p> | <p>Global <b><a href="/man/man2html?1+doveadm">doveadm</a></b>(1) <i>options</i>:</p> |
| Line 24: | Line 29: |
| <dt><b>-o </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 43: |
| <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= "/Tools/Doveadm">doveadm</a></b>(1) will be unable to iterate over all users.</p> |
<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= "/man/man2html?1+doveadm">doveadm</a></b>(1) will be unable to iterate over all users.</p> </dd> <dt><b>-F </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><b>-S </b><i>socket_path</i></dt> <dd>The option'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="/man/man2html?1+doveadm">doveadm</a></b>(1) mail commands through the given socket.</p> |
| Line 41: | Line 63: |
| When neither the <b>-A</b> option nor <b>-u </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 </b><i>file</i> option, nor the <b>-u </b><i>user</i> was specified, the <i>command</i> will be executed with the environment of the currently logged in user.</dd> |
| Line 45: | Line 68: |
| <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="/man/man2html?1+doveadm">doveadm</a></b>(1), <b><a href= "/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]
-F file
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 third form, the command will be executed for all users listed in the given file.
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.
- -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.
- -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.
See Also ☜
doveadm(1), doveadm-expunge(1)
See http://wiki2.dovecot.org/MailboxFormat/dbox#Multi-dbox for some details.