This documentation is for Dovecot v2.x, see wiki1 for v1.x documentation.
Differences between revisions 1 and 29 (spanning 28 versions)
Revision 1 as of 2010-07-02 15:52:00
Size: 3942
Editor: PageImporter
Comment:
Revision 29 as of 2021-09-22 07:08:13
Size: 5581
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>altmove</b> <i>search_query</i><br>
<b>doveadm</b> [<b>-Dv</b>] <b>altmove -A</b> <i>search_query</i><br>
<b>doveadm</b> [<b>-Dv</b>] <b>altmove -u</b> <i>user search_query</i></p>
<p><b>doveadm</b> [<b>-Dv</b>] <b>altmove</b> [<b>-r</b>] [-S <i>socket_path</i>]
<i>search_query</i><br>
<b>doveadm</b> [<b>-Dv</b>] <b>altmove</b> [<b>-r</b>] [-S <i>socket_path</i>] <b>-A</b>
<i>search_query</i><br>
<b>doveadm</b> [<b>-Dv</b>] <b>altmove</b> [<b>-r</b>] [-S <i>socket_path</i>] <b>-F</b> <i>file
search_query</i><br>
<b>doveadm</b> [<b>-Dv</b>] <b>altmove</b> [<b>-r</b>] [-S <i>socket_path</i>] <b>-u</b> <i>user
search_query</i></p>
Line 12: Line 17:
<p>This command can be used with dbox or mdbox storage to move mails to alternative storage path <p>This command can be used with sdbox or mdbox storage to move mails to alternative storage path
Line 17: Line 22:
<p>In the third form, only matching mails of the given <i>user</i>(s) will be moved to the <p>In the third form, the command will be performed for all 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 moved to the
Line 22: Line 29:
<dt style="font-weight: bold">-D</dt> <dt><b>-D</b></dt>
Line 24: Line 31:
<dt style="font-weight: bold">-v</dt> <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>
<dt><b>-v</b></dt>
Line 29: Line 40:
<dt style="font-weight: bold">-A</dt> <dt><b>-A</b></dt>
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><b>-r</b></dt>
<dd>When the <b>-r</b> option is given this <i>command</i> works the other way round. Mails will be
moved from the alternative storage back to the default mail location.</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 68:
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 46: Line 74:
<dt style="font-style: italic">search_query</dt> <dt><i>search_query</i></dt>
Line 48: Line 76:
"/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 52: Line 80:
<dt style="font-style: italic">/etc/dovecot/conf.d/10-mail.conf</dt> <dt><i>/etc/dovecot/conf.d/10-mail.conf</i></dt>
Line 54: Line 82:
<dt style="font-style: italic">/etc/dovecot/conf.d/auth-*.conf.ext</dt> <dt><i>/etc/dovecot/conf.d/auth-*.conf.ext</i></dt>
Line 64: Line 92:
<b>doveadm altmove -u johnd@example.com seen savedbefore 1w</b>
</pre>
<b>doveadm altmove -u johnd@example.com seen savedbefore 1w
</b></pre>
Line 68: Line 96:
"/Tools/Doveadm/Search/Query">doveadm-search-query</a></b>(7) }}} "/Tools/Doveadm/SearchQuery">doveadm-search-query</a></b>(7) }}}

Doveadm-Altmove

Name

doveadm-altmove - Move matching mails to the alternative storage (dbox-only)

Synopsis

doveadm [-Dv] altmove [-r] [-S socket_path] search_query
doveadm [-Dv] altmove [-r] [-S socket_path] -A search_query
doveadm [-Dv] altmove [-r] [-S socket_path] -F file search_query
doveadm [-Dv] altmove [-r] [-S socket_path] -u user search_query

Description

This command can be used with sdbox or mdbox storage to move mails to alternative storage path when :ALT=<path> is specified for the mail location.

In the first form, doveadm(1) will executed the altmove 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, the command will be performed for all users listed in the given file.

In the fourth form, only matching mails of the given user(s) will be moved to the alternative storage.

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.
-r
When the -r option is given this command works the other way round. Mails will be moved from the alternative storage back to the default mail location.
-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
Messages matching this search query will be moved to alt storage. See doveadm-search-query(7) for details.

Files

/etc/dovecot/conf.d/10-mail.conf
Mailbox locations and namespaces.
/etc/dovecot/conf.d/auth-*.conf.ext
Authentication processes, including userdb settings.

Example

This example moves seen mails older than one week to alternative storage under /nfsmount:

mail_location = mdbox:~/mdbox:ALT=/nfsmount/%h/mdbox
doveadm altmove -u johnd@example.com seen savedbefore 1w

See Also

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


CategoryMan

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