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

NAME

6       ctl_mboxlist - perform operations on the mailbox list database
7

SYNOPSIS

9       ctl_mboxlist [ -C config-file ] -d [ -x ] [ -p partition ]
10                    [ -f filename ]
11       ctl_mboxlist [ -C config-file ] -u [ -f filename ]
12       ctl_mboxlist [ -C config-file ] -m [ -a ] [ -w ]
13                    [ -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 is
22       used to determine the default location of the mailbox list database.
23

OPTIONS

25       -C config-file
26              Read configuration options from config-file.
27
28       -d     Dump the contents of the database to standard output in a porta‐
29              ble  flat-text  format.  NOTE: In Cyrus versions 2.2.13 and ear‐
30              lier, the dump format did not include the  mailbox  type  flags,
31              breaking  remote  mailboxes  (frontends, mupdate master, unified
32              backends) when undumped.
33
34       -x     When performing a dump, remove the  mailboxes  dumped  from  the
35              mailbox list (mostly useful when specified with -p)
36
37       -p partition
38              When  performing  a dump, dump only thise mailboxes that live on
39              partition
40
41       -u     Load the contents of the  database  from  standard  input.   The
42              input  MUST  be in the format output using the -d option.  NOTE:
43              Both the old and new formats can be loaded, but the  old  format
44              will break remote mailboxes.
45
46       -m     For  backend  servers in the Cyrus Murder, synchronize the local
47              mailbox list file with the MUPDATE server.
48
49       -a     When used with -m, assume the local mailboxes file  is  authori‐
50              tiative,  that is, only change the mupdate server, do not delete
51              any local mailboxes.  USE THIS OPTION WITH CARE,  as  it  allows
52              namespace collisions into the murder.
53
54       -w     When  used with -m, print out what would be done but do not per‐
55              form the operations.
56
57       -v     Verify the consistency of the  mailbox  list  database  and  the
58              spool  partition(s).  Mailboxes  present in the database and not
59              located on a spool partition, and those located on a spool  par‐
60              tition  (directory containing a valid cyrus.header file) and not
61              present in the database will be reported.  Note that this  func‐
62              tion is very I/O intensive.
63
64       -f filename
65              Use  the  database  specified by filename instead of the default
66              (configdirectory/mailboxes.db).
67

FILES

69       /etc/imapd.conf
70

SEE ALSO

72       imapd.conf(5), cyrus-master(8)
73
74
75
76CMU                              Project Cyrus                 CTL_MBOXLIST(8)
Impressum