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 ]
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 the contents of the database to standard output in a porta‐
31 ble flat-text format. NOTE: In Cyrus versions 2.2.13 and ear‐
32 lier, the dump format did not include the mailbox type flags,
33 breaking remote mailboxes (frontends, mupdate master, unified
34 backends) when undumped.
35 -x When performing a dump, remove the mailboxes dumped from the
37 mailbox list (mostly useful when specified with -p).
38 -y When performing a dump, also list intermediary mailboxes which
40 would be hidden from IMAP.
41 -p partition
43 When performing a dump, dump only those mailboxes that live on
44 partition.
45 -f filename
47 Use the database specified by filename instead of the default
48 (configdirectory/mailboxes.db*).
49 -u Load the contents of the database from standard input. The in‐
51 put MUST be in the format output by the -d option.
52 NOTE:
54 Both the old and new formats can be loaded, but the old format will
55 break remote mailboxes.
56 -m For backend servers in the Cyrus Murder, synchronize the local
58 mailbox list file with the MUPDATE server.
59 -a When used with -m, assume the local mailboxes file is authorita‐
61 tive, that is, only change the mupdate server, do not delete any
62 local mailboxes.
63 IMPORTANT:
65 USE THIS OPTION WITH CARE, as it allows namespace collisions into
66 the murder.
67 -w When used with -m, print out what would be done but do not per‐
69 form the operations.
70 -i When used with -m, asks for verification before deleting local
72 mailboxes.
73 -v Verify the consistency of the mailbox list database and the
75 spool partition(s). Mailboxes present in the database and not
76 located on a spool partition, and those located on a spool par‐
77 tition (directory containing a valid cyrus.header file) and not
78 present in the database will be reported. Note that this func‐
79 tion is very I/O intensive.
80
82 ctl_mboxlist -d
83 Dump the mailboxes list in portable text format.
84 ctl_mboxlist -u < newmboxlist.dump
86 Undump (restore) the mailboxes database from newmboxlist.dump, a
87 portable text formatted file.
88 ctl_mboxlist -m
90 Synchronize our mailboxes database with the MUPDATE server. (One
91 may commonly put a command like this into the START section of
92 cyrus.conf(5) on backend nodes of a Murder cluster to cause the
93 backend to synchronize its mailbox list with the mupdate master upon
94 startup).
95 ctl_mboxlist -m -w
97 The same as above, but only show us what would be done, don't actu‐
98 ally do it.
99 ctl_mboxlist -m -a
101 Populate the Mupdate server from our copy of the mailboxes database.
102 NOTE:
104 Be very careful with this option, as it can create conflicts in
105 the Murder.
106 ctl_mboxlist -m -i
108 Synchronize our mailboxes database with the MUPDATE server interac‐
109 tively, asking for verification before deleting any local mailboxes.
110
112 /etc/imapd.conf, <configdirectory>/mailboxes.db
113
115 imapd.conf(5), master(8)
116
118 The Cyrus Team, Nic Bernstein (Onlight), Jeroen van Meeuwen (Kolab Sys‐
119 tems)
120
122 1993-2018, The Cyrus Team
1233.2.6 March 09, 2021 CTL_MBOXLIST(8)