doveadm-altmove(1)

1DOVEADM-ALTMOVE(1)                  Dovecot                 DOVEADM-ALTMOVE(1)
2
3
4

NAME

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

SYNOPSIS

10       doveadm [-Dv] altmove [-r] [-S socket_path] search_query
11       doveadm [-Dv] altmove [-r] [-S socket_path] -A search_query
12       doveadm [-Dv] altmove [-r] [-S socket_path] -u user search_query
13

DESCRIPTION

15       This command can be used with sdbox or mdbox storage to move  mails  to
16       alternative  storage  path  when  :ALT=<path> is specified for the mail
17       location.
18
19       In the first form, doveadm(1) will executed the altmove action with the
20       environment of the logged in system user.
21
22       In the second form, the command will be performed for all users.
23
24       In  the  third  form,  only matching mails of the given user(s) will be
25       moved to the alternative storage.
26

OPTIONS

28       Global doveadm(1) options:
29
30       -D     Enables verbosity and debug messages.
31
32       -v     Enables verbosity, including progress counter.
33
34       Command specific options:
35
36       -A     If the -A option is present, the command will be  performed  for
37              all  users.   Using this option in combination with system users
38              from userdb { driver = passwd } is not recommended,  because  it
39              contains  also  users  with  a lower UID than the one configured
40              with the first_valid_uid setting.
41
42              When the SQL userdb module is used  make  sure  that  the  iter‐
43              ate_query  setting  in /etc/dovecot/dovecot-sql.conf.ext matches
44              your database layout.  When using the LDAP userdb  module,  make
45              sure  that  the  iterate_attrs  and  iterate_filter  settings in
46              /etc/dovecot/dovecot-ldap.conf.ext match your LDAP schema.  Oth‐
47              erwise doveadm(1) will be unable to iterate over all users.
48
49       -r     When  the  -r  option  is given this command works the other way
50              round.  Mails will be moved from the alternative storage back to
51              the default mail location.
52
53       -S socket_path
54              The option's argument is either an absolute path to a local UNIX
55              domain socket, or a hostname and port (hostname:port), in  order
56              to connect a remote host via a TCP socket.
57
58              This allows an administrator to execute doveadm(1) mail commands
59              through the given socket.
60
61       -u user/mask
62              Run the command only for the given user.  It's also possible  to
63              use '*' and '?' wildcards (e.g. -u *@example.org).
64              When  neither  the -A option nor -u user was specified, the com‐
65              mand will be executed with  the  environment  of  the  currently
66              logged in user.
67

ARGUMENTS

69       search_query
70              Messages  matching  this search query will be moved to alt stor‐
71              age.  See doveadm-search-query(7) for details.
72

FILES

74       /etc/dovecot/conf.d/10-mail.conf
75              Mailbox locations and namespaces.
76
77       /etc/dovecot/conf.d/auth-*.conf.ext
78              Authentication processes, including userdb settings.
79

EXAMPLE

81       This example moves seen mails older than one week to alternative  stor‐
82       age under /nfsmount:
83       mail_location = mdbox:~/mdbox:ALT=/nfsmount/%h/mdbox
84
85       doveadm altmove -u johnd@example.com seen savedbefore 1w
86

REPORTING BUGS

88       Report  bugs, including doveconf -n output, to the Dovecot Mailing List
89       <dovecot@dovecot.org>.  Information about reporting bugs  is  available
90       at: http://dovecot.org/bugreport.html
91