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 ] [ -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

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 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
36       -x     When performing a dump, remove the  mailboxes  dumped  from  the
37              mailbox list (mostly useful when specified with -p).
38
39       -p partition
40              When  performing  a dump, dump only thise 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       -u     Load  the  contents  of  the  database from standard input.  The
48              input MUST be in the format output by the -d option.
49
50       NOTE:
51          Both the old and new formats can be loaded, but the old format  will
52          break remote mailboxes.
53
54       -m     For  backend  servers in the Cyrus Murder, synchronize the local
55              mailbox list file with the MUPDATE server.
56
57       -a     When used with -m, assume the local mailboxes file  is  authori‐
58              tiative,  that is, only change the mupdate server, do not delete
59              any local mailboxes.
60
61       IMPORTANT:
62          USE THIS OPTION WITH CARE, as it allows  namespace  collisions  into
63          the murder.
64
65       -w     When  used with -m, print out what would be done but do not per‐
66              form the operations.
67
68       -i     When used with -m, asks for verification before  deleting  local
69              mailboxes.
70
71       -v     Verify  the  consistency  of  the  mailbox list database and the
72              spool partition(s). Mailboxes present in the  database  and  not
73              located  on a spool partition, and those located on a spool par‐
74              tition (directory containing a valid cyrus.header file) and  not
75              present  in the database will be reported.  Note that this func‐
76              tion is very I/O intensive.
77

EXAMPLES

79       ctl_mboxlist -d
80          Dump the mailboxes list in portable text format.
81
82       ctl_mboxlist -u < newmboxlist.dump
83          Undump (restore) the mailboxes  database  from  newmboxlist.dump,  a
84          portable text formatted file.
85
86       ctl_mboxlist -m
87          Synchronize  our  mailboxes  database with the MUPDATE server.  (One
88          may commonly put a command like  this  into  the  START  section  of
89          cyrus.conf(5)  on  backend  nodes  of  a Murder cluster to cause the
90          backend to synchronize its mailbox list with the mupdate master upon
91          startup).
92
93       ctl_mboxlist -m -w
94          The  same as above, but only show us what would be done, don't actu‐
95          ally do it.
96
97       ctl_mboxlist -m -a
98          Populate the Mupdate server from our copy of the mailboxes database.
99
100          NOTE:
101              Be very careful with this option, as it can create conflicts  in
102              the Murder.
103
104       ctl_mboxlist -m -i
105          Synchronize  our mailboxes database with the MUPDATE server interac‐
106          tively, asking for verification before deleting any local mailboxes.
107

FILES

109       /etc/imapd.conf, <configdirectory>/mailboxes.db
110

SEE ALSO

112       imapd.conf(5), master(8)
113

AUTHOR

115       The Cyrus Team, Nic Bernstein (Onlight), Jeroen van Meeuwen (Kolab Sys‐
116       tems)
117
119       1993-2017, The Cyrus Team
120
121
122
123
1243.0.13                         December 16, 2019               CTL_MBOXLIST(8)
Impressum