1CTL_MBOXLIST(8) Cyrus IMAP CTL_MBOXLIST(8)
2
6 ctl_mboxlist - Cyrus IMAP documentation
7 Perform operations on the mailbox list database
9
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
17 ctl_mboxlist is used to perform various administrative operations on
18 the mailbox list database.
19 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
26 -C config-file
27 Use the specified configuration file config-file rather than the
28 default imapd.conf(5).
29 -d, --dump
31 Dump the contents of the database to standard output in JSON
32 format.
33 -x, --remove-dumped
35 When performing a dump, remove the mailboxes dumped from the
36 mailbox list (mostly useful when specified with -p).
37 -y, --include-intermediaries
39 When performing a dump, also list intermediary mailboxes which
40 would be hidden from IMAP.
41 -p partition, --partition=partition
43 When performing a dump, dump only those mailboxes that live on
44 partition.
45 -f filename, --filename=filename
47 Use the database specified by filename instead of the default
48 (configdirectory/mailboxes.db*).
49 -L, --legacy
51 When performing an undump, use the legacy dump parser instead of
52 the JSON parser. This might be useful for importing a dump pro‐
53 duced by an older version of Cyrus.
54 -u, --undump
56 Load ("undump") the contents of the database from standard in‐
57 put. The input MUST be a valid JSON file, unless the -L option
58 is also supplied.
59 IMPORTANT:
61 USE THIS OPTION WITH CARE. If you have modified the dump
62 file since it was dumped, or if the file was not produced by
63 -d in the first place, or was produced on a different server,
64 you can easily break your mailboxes.db. Undump will refuse
65 to process a syntactically-invalid dump file, but it can't do
66 much to protect you from a valid file containing bad data.
67 -m, --sync-mupdate
69 For backend servers in the Cyrus Murder, synchronize the local
70 mailbox list file with the MUPDATE server.
71 -a, --authoritative
73 When used with -m, assume the local mailboxes file is authorita‐
74 tive, that is, only change the mupdate server, do not delete any
75 local mailboxes.
76 IMPORTANT:
78 USE THIS OPTION WITH CARE, as it allows namespace collisions
79 into the murder.
80 -w, --warn-only
82 When used with -m, print out what would be done but do not per‐
83 form the operations.
84 -i, --interactive
86 When used with -m, asks for verification before deleting local
87 mailboxes.
88 -v, --verify
90 Verify the consistency of the mailbox list database and the
91 spool partition(s). Mailboxes present in the database and not
92 located on a spool partition, and those located on a spool par‐
93 tition (directory containing a valid cyrus.header file) and not
94 present in the database will be reported. Note that this func‐
95 tion is very I/O intensive.
96
98 ctl_mboxlist -d
99 Dump the mailboxes list to standard output in JSON format
100 ctl_mboxlist -u < newmboxlist.dump
102 Undump (restore) the mailboxes database from newmboxlist.dump, where
103 newmboxlist.dump is a JSON file produced by ctl_mboxlist -d
104 NOTE:
106 Be very careful with this option.
107 ctl_mboxlist -m
109 Synchronize our mailboxes database with the MUPDATE server. (One
110 may commonly put a command like this into the START section of
111 cyrus.conf(5) on backend nodes of a Murder cluster to cause the
112 backend to synchronize its mailbox list with the mupdate master upon
113 startup).
114 ctl_mboxlist -m -w
116 The same as above, but only show us what would be done, don't actu‐
117 ally do it.
118 ctl_mboxlist -m -a
120 Populate the Mupdate server from our copy of the mailboxes database.
121 NOTE:
123 Be very careful with this option, as it can create conflicts in
124 the Murder.
125 ctl_mboxlist -m -i
127 Synchronize our mailboxes database with the MUPDATE server interac‐
128 tively, asking for verification before deleting any local mailboxes.
129
131 /etc/imapd.conf, <configdirectory>/mailboxes.db
132
134 imapd.conf(5), master(8)
135
137 The Cyrus Team, Nic Bernstein (Onlight), Jeroen van Meeuwen (Kolab Sys‐
138 tems)
139
141 1993–2023, The Cyrus Team
1423.8.1 Sep 11, 2023 CTL_MBOXLIST(8)