1CTL_MBOXLIST(8)             System Manager's Manual            CTL_MBOXLIST(8)
2
3
4
5 *
6

NAME

8       ctl_mboxlist - perform operations on the mailbox list database
9

SYNOPSIS

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

DESCRIPTION

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

OPTIONS

27       -C config-file
28              Read configuration options from config-file.
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       -u     Load the contents of the  database  from  standard  input.   The
44              input  MUST  be in the format output using the -d option.  NOTE:
45              Both the old and new formats can be loaded, but the  old  format
46              will break remote mailboxes.
47
48       -m     For  backend  servers in the Cyrus Murder, synchronize the local
49              mailbox list file with the MUPDATE server.
50
51       -a     When used with -m, assume the local mailboxes file  is  authori‐
52              tiative,  that is, only change the mupdate server, do not delete
53              any local mailboxes.  USE THIS OPTION WITH CARE,  as  it  allows
54              namespace collisions into the murder.
55
56       -w     When  used with -m, print out what would be done but do not per‐
57              form the operations.
58
59       -i     When used with -m, asks for verification before  deleting  local
60              mailboxes.
61
62       -v     Verify  the  consistency  of  the  mailbox list database and the
63              spool partition(s). Mailboxes present in the  database  and  not
64              located  on a spool partition, and those located on a spool par‐
65              tition (directory containing a valid cyrus.header file) and  not
66              present  in the database will be reported.  Note that this func‐
67              tion is very I/O intensive.
68
69       -f filename
70              Use the database specified by filename instead  of  the  default
71              (configdirectory/mailboxes.db).
72

FILES

74       /etc/imapd.conf
75

SEE ALSO

77       imapd.conf(5), cyrus-master(8)
78
79
80
81CMU                              Project Cyrus                 CTL_MBOXLIST(8)
Impressum