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] -F file search_query
13       doveadm [-Dv] altmove [-r] [-S socket_path] -u user search_query
14

DESCRIPTION

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

OPTIONS

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

ARGUMENTS

85       search_query
86              Messages matching this search query will be moved to  alt  stor‐
87              age.  See doveadm-search-query(7) for details.
88

FILES

90       /etc/dovecot/conf.d/10-mail.conf
91              Mailbox locations and namespaces.
92
93       /etc/dovecot/conf.d/auth-*.conf.ext
94              Authentication processes, including userdb settings.
95

EXAMPLE

97       This  example moves seen mails older than one week to alternative stor‐
98       age under /nfsmount:
99       mail_location = mdbox:~/mdbox:ALT=/nfsmount/%h/mdbox
100
101       doveadm altmove -u johnd@example.com seen savedbefore 1w
102

REPORTING BUGS

104       Report bugs, including doveconf -n output, to the Dovecot Mailing  List
105       <dovecot@dovecot.org>.   Information  about reporting bugs is available
106       at: http://dovecot.org/bugreport.html
107

SEE ALSO

109       doveadm(1), doveadm-search-query(7)
110
111
112
113Dovecot v2.3                      2015-05-09                DOVEADM-ALTMOVE(1)
Impressum