Doveadm-Move
Name ☜
doveadm-move - Move messages matching the given search query into another mailbox
Synopsis ☜
doveadm [-Dv] move [-S socket_path] destination
search_query
doveadm [-Dv] move [-S socket_path] -A destination
search_query
doveadm [-Dv] move [-S socket_path] -u user
destination search_query
Description ☜
doveadm move can be used for moving mails between mailboxes for one or more users. The search_query is used to restrict which messages are moved into the destination mailbox.
In the first form, doveadm(1) will executed the move action with the environment of the logged in system user.
In the second form, doveadm(1) will iterate over all users, found in the configured user_db(s), and move each user's messages, matching the given search_query, into the user's destination mailbox.
In the third form, matching mails will be moved only for given user(s).
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 ☜
- destination
- The name of the destination mailbox, into which the mails should be moved. The destination mailbox must exist, otherwise this command will fail.
- search_query
- Move messages matching the given search query. See doveadm-search-query(7) for details.
Example ☜
Move jane's messages - received in September 2011 - from her INBOX into her archive.
doveadm move -u jane Archive/2011/09 mailbox INBOX BEFORE \ 2011-10-01 SINCE 01-Sep-2011
See Also ☜
doveadm(1), doveadm-search-query(7)
