This documentation is for Dovecot v2.x, see wiki1 for v1.x documentation.
Differences between revisions 12 and 13
Revision 12 as of 2013-11-16 15:18:38
Size: 5085
Editor: PageImporter
Revision 13 as of 2013-11-16 15:34:36
Size: 4843
Editor: PageImporter
Deletions are marked like this. Additions are marked like this.
Line 17: Line 17:
<p>In the first form, <b><a href=
"http://localhost/cgi-bin/man/man2html?1+doveadm">doveadm</a></b>(1) will executed the
<p>In the first form, <b><a href="/Tools/Doveadm">doveadm</a></b>(1) will executed the
Line 24: Line 23:
<p>Global <b><a href="http://localhost/cgi-bin/man/man2html?1+doveadm">doveadm</a></b>(1)
<p>Global <b><a href="/Tools/Doveadm">doveadm</a></b>(1) <i>options</i>:</p>
Line 43: Line 41:
"http://localhost/cgi-bin/man/man2html?1+doveadm">doveadm</a></b>(1) will be unable to iterate over
all users.</p>
"/Tools/Doveadm">doveadm</a></b>(1) will be unable to iterate over all users.</p>
Line 53: Line 50:
<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>
<p>This allows an administrator to execute <b><a href="/Tools/Doveadm">doveadm</a></b>(1) mail
commands through the given socket.</p>
Line 67: Line 63:
"http://localhost/cgi-bin/man/man2html?7+doveadm-search-query">doveadm-search-query</a></b>(7) for
"/Tools/Doveadm/SearchQuery">doveadm-search-query</a></b>(7) for details.</dd>
Line 87: Line 82:
<p><b><a href="http://localhost/cgi-bin/man/man2html?1+doveadm">doveadm</a></b>(1), <b><a href=
<p><b><a href="/Tools/Doveadm">doveadm</a></b>(1), <b><a href=
"/Tools/Doveadm/SearchQuery">doveadm-search-query</a></b>(7) }}}



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


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] -u user search_query


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, only matching mails of the given user(s) will be moved to the alternative storage.


Global doveadm(1) options:

Enables verbosity and debug messages.
Enables verbosity, including progress counter.

Command specific options:

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.

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 *
When neither the -A option nor -u user was specified, the command will be executed with the environment of the currently logged in user.


Messages matching this search query will be moved to alt storage. See doveadm-search-query(7) for details.


Mailbox locations and namespaces.
Authentication processes, including userdb settings.


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 seen savedbefore 1w

See Also

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


None: Tools/Doveadm/Altmove (last edited 2017-12-20 03:30:04 by PageImporter)