This manual page is for Mac OS X Server version 10.6

If you are running Mac OS X (client), this command is not available.

If you are running a different version of Mac OS X Server, view the documentation locally:

  • In Xcode

  • In Terminal, using the man(1) command

Reading manual pages

Manual pages are intended as a quick reference for people who already understand a technology.

  • For more information about the manual page format, see the manual page for manpages(5).

  • For more information about this technology, look for other documentation in the Apple Reference Library.

  • For general information about writing shell scripts, read Shell Scripting Primer.



CTL_MBOXLIST(8)                                                                              CTL_MBOXLIST(8)



NAME
       ctl_mboxlist - perform operations on the mailbox list database

SYNOPSIS
       ctl_mboxlist [ -C config-file ] -d [ -x ] [ -p partition ] [ -f filename ]
       ctl_mboxlist [ -C config-file ] -u [ -f filename ]
       ctl_mboxlist [ -C config-file ] -m [ -a ] [ -w ]
                    [ -f filename ]

DESCRIPTION
       Ctl_mboxlist is used to perform various administrative operations on the mailbox list database.

       Ctl_mboxlist reads its configuration options out of the imapd.conf(5) file unless specified otherwise
       by -C.  The configdirectory option is used to determine the default  location  of  the  mailbox  list
       database.

OPTIONS
       -C config-file
              Read configuration options from config-file.

       -d     Dump the contents of the database to standard output in a portable flat-text format.  NOTE: In
              Cyrus versions 2.2.13 and earlier, the dump format did not include  the  mailbox  type  flags,
              breaking remote mailboxes (frontends, mupdate master, unified backends) when undumped.

       -x     When  performing a dump, remove the mailboxes dumped from the mailbox list (mostly useful when
              specified with -p)

       -p partition
              When performing a dump, dump only thise mailboxes that live on partition

       -u     Load the contents of the database from standard input.  The input MUST be in the format output
              using  the  -d  option.   NOTE: Both the old and new formats can be loaded, but the old format
              will break remote mailboxes.

       -m     For backend servers in the Cyrus Murder, synchronize the local mailbox list file with the MUP-DATE MUPDATE
              DATE server.

       -a     When used with -m, assume the local mailboxes file is authoritiative, that is, only change the
              mupdate server, do not delete any local mailboxes.  USE THIS OPTION WITH CARE,  as  it  allows
              namespace collisions into the murder.

       -w     When used with -m, print out what would be done but do not perform the operations.

       -f filename
              Use  the database specified by filename instead of the default (configdirectory/mailboxes.db).

FILES
       /etc/imapd.conf

SEE ALSO
       imapd.conf(5), master(8)



CMU                                             Project Cyrus                                CTL_MBOXLIST(8)

Reporting Problems

The way to report a problem with this manual page depends on the type of problem:

Content errors
Report errors in the content of this documentation with the feedback links below.
Bug reports
Report bugs in the functionality of the described tool or API through Bug Reporter.
Formatting problems
Report formatting mistakes in the online version of these pages with the feedback links below.