1CTL_MBOXLIST(8)                   Cyrus IMAP                   CTL_MBOXLIST(8)
2
3
4

NAME

6       ctl_mboxlist - Cyrus IMAP documentation
7
8       Perform operations on the mailbox list database
9

SYNOPSIS

11       ctl_mboxlist [ -C config-file ] -d [ -x ] [-y] [ -p partition ] [ -f filename ]
12       ctl_mboxlist [ -C config-file ] -u [ -f filename ] [ -L ]
13       ctl_mboxlist [ -C config-file ] -m [ -a ] [ -w ] [ -i ] [ -f filename ]
14       ctl_mboxlist [ -C config-file ] -v [ -f filename ]
15

DESCRIPTION

17       ctl_mboxlist  is  used  to perform various administrative operations on
18       the mailbox list database.
19
20       ctl_mboxlist reads its configuration options out of  the  imapd.conf(5)
21       file  unless  specified otherwise by -C.  The configdirectory option in
22       imapd.conf(5) is used to determine the default location  of  the  mail‐
23       boxes database.
24

OPTIONS

26       -C config-file
27              Use the specified configuration file config-file rather than the
28              default imapd.conf(5).
29
30       -d     Dump the contents of the database to  standard  output  in  JSON
31              format.
32
33       -x     When  performing  a  dump,  remove the mailboxes dumped from the
34              mailbox list (mostly useful when specified with -p).
35
36       -y     When performing a dump, also list intermediary  mailboxes  which
37              would be hidden from IMAP.
38
39       -p partition
40              When  performing  a dump, dump only those mailboxes that live on
41              partition.
42
43       -f filename
44              Use the database specified by filename instead  of  the  default
45              (configdirectory/mailboxes.db*).
46
47       -L     When performing an undump, use the legacy dump parser instead of
48              the JSON parser.  This might be useful for importing a dump pro‐
49              duced by an older version of Cyrus.
50
51       -u     Load  (“undump”)  the contents of the database from standard in‐
52              put.  The input MUST be a valid JSON file, unless the -L  option
53              is also supplied.
54
55              IMPORTANT:
56                 USE  THIS  OPTION  WITH  CARE.  If you have modified the dump
57                 file since it was dumped, or if the file was not produced  by
58                 -d in the first place, or was produced on a different server,
59                 you can easily break your mailboxes.db.  Undump  will  refuse
60                 to process a syntactically-invalid dump file, but it can’t do
61                 much to protect you from a valid file containing bad data.
62
63       -m     For backend servers in the Cyrus Murder, synchronize  the  local
64              mailbox list file with the MUPDATE server.
65
66       -a     When used with -m, assume the local mailboxes file is authorita‐
67              tive, that is, only change the mupdate server, do not delete any
68              local mailboxes.
69
70              IMPORTANT:
71                 USE  THIS OPTION WITH CARE, as it allows namespace collisions
72                 into the murder.
73
74       -w     When used with -m, print out what would be done but do not  per‐
75              form the operations.
76
77       -i     When  used  with -m, asks for verification before deleting local
78              mailboxes.
79
80       -v     Verify the consistency of the  mailbox  list  database  and  the
81              spool  partition(s).  Mailboxes  present in the database and not
82              located on a spool partition, and those located on a spool  par‐
83              tition  (directory containing a valid cyrus.header file) and not
84              present in the database will be reported.  Note that this  func‐
85              tion is very I/O intensive.
86

EXAMPLES

88       ctl_mboxlist -d
89          Dump the mailboxes list to standard output in JSON format
90
91       ctl_mboxlist -u < newmboxlist.dump
92          Undump (restore) the mailboxes database from newmboxlist.dump, where
93          newmboxlist.dump is a JSON file produced by ctl_mboxlist -d
94
95          NOTE:
96              Be very careful with this option.
97
98       ctl_mboxlist -m
99          Synchronize our mailboxes database with the  MUPDATE  server.   (One
100          may  commonly  put  a  command  like  this into the START section of
101          cyrus.conf(5) on backend nodes of a  Murder  cluster  to  cause  the
102          backend to synchronize its mailbox list with the mupdate master upon
103          startup).
104
105       ctl_mboxlist -m -w
106          The same as above, but only show us what would be done, don’t  actu‐
107          ally do it.
108
109       ctl_mboxlist -m -a
110          Populate the Mupdate server from our copy of the mailboxes database.
111
112          NOTE:
113              Be  very careful with this option, as it can create conflicts in
114              the Murder.
115
116       ctl_mboxlist -m -i
117          Synchronize our mailboxes database with the MUPDATE server  interac‐
118          tively, asking for verification before deleting any local mailboxes.
119

FILES

121       /etc/imapd.conf, <configdirectory>/mailboxes.db
122

SEE ALSO

124       imapd.conf(5), master(8)
125

AUTHOR

127       The Cyrus Team, Nic Bernstein (Onlight), Jeroen van Meeuwen (Kolab Sys‐
128       tems)
129

131       1993–2022, The Cyrus Team
132
133
134
135
1363.6.0                          December 12, 2022               CTL_MBOXLIST(8)
Impressum