ctl_mboxlist - Cyrus IMAP documentation

       The Cyrus Team, Nic Bernstein (Onlight), Jeroen van Meeuwen (Kolab Systems)

       1993–2025, The Cyrus Team

3.10.2                                            Jun 27, 2025                                   CTL_MBOXLIST(8)

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 in imapd.conf(5) is  used  to  determine  the  default  location  of  the
       mailboxes database.

ctl_mboxlist-dDumpthemailboxeslisttostandardoutputinJSONformatctl_mboxlist-u<newmboxlist.dumpUndump(restore)themailboxesdatabasefromnewmboxlist.dump,wherenewmboxlist.dumpisaJSONfileproducedbyctl_mboxlist-dNOTE:Beverycarefulwiththisoption.ctl_mboxlist-mSynchronizeourmailboxesdatabasewiththeMUPDATEserver.(OnemaycommonlyputacommandlikethisintotheSTARTsectionofcyrus.conf(5)onbackendnodesofaMurderclustertocausethebackendtosynchronizeitsmailboxlistwiththemupdatemasteruponstartup).ctl_mboxlist-m-wThesameasabove,butonlyshowuswhatwouldbedone,don'tactuallydoit.ctl_mboxlist-m-aPopulatetheMupdateserverfromourcopyofthemailboxesdatabase.NOTE:Beverycarefulwiththisoption,asitcancreateconflictsintheMurder.ctl_mboxlist-m-iSynchronizeourmailboxesdatabasewiththeMUPDATEserverinteractively,askingforverificationbeforedeletinganylocalmailboxes.

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

       ctl_mboxlist - Cyrus IMAP documentation

       Perform operations on the mailbox list database

-Cconfig-file
              Use the specified configuration file config-file rather than the default imapd.conf(5).

       -d,--dump
              Dump the contents of the database to standard output in JSON format.

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

       -y,--include-intermediaries
              When performing a dump, also list intermediary mailboxes which would be hidden from IMAP.

       -ppartition,--partition=partition
              When performing a dump, dump only those mailboxes that live on partition.

       -ffilename,--filename=filename
              Use the database specified by filename instead of the default (configdirectory/mailboxes.db*).

       -L,--legacy
              When performing an undump, use the legacy dump parser instead of the JSON parser.  This  might  be
              useful for importing a dump produced by an older version of Cyrus.

       -u,--undump
              Load  ("undump") the contents of the database from standard input.  The input MUST be a valid JSON
              file, unless the -L option is also supplied.

              IMPORTANT:
                 USE THIS OPTION WITH CARE.  If you have modified the dump file since it was dumped, or  if  the
                 file  was not produced by -d in the first place, or was produced on a different server, you can
                 easily break your mailboxes.db.  Undump will refuse to  process  a  syntactically-invalid  dump
                 file, but it can't do much to protect you from a valid file containing bad data.

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

       -a,--authoritative
              When used with -m, assume the local mailboxes file is authoritative,  that  is,  only  change  the
              mupdate server, do not delete any local mailboxes.

              IMPORTANT:
                 USE THIS OPTION WITH CARE, as it allows namespace collisions into the murder.

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

       -i,--interactive
              When used with -m, asks for verification before deleting local mailboxes.

       -v,--verify
              Verify  the consistency of the mailbox list database and the spool partition(s). Mailboxes present
              in the database and not located on a spool partition, and  those  located  on  a  spool  partition
              (directory containing a valid cyrus.header file) and not present in the database will be reported.
              Note that this function is very I/O intensive.

imapd.conf(5), master(8)

ctl_mboxlist [ -Cconfig-file ] -d [ -x ] [-y] [ -ppartition ] [ -ffilename ]
          ctl_mboxlist [ -Cconfig-file ] -u [ -ffilename ] [ -L ]
          ctl_mboxlist [ -Cconfig-file ] -m [ -a ] [ -w ] [ -i ] [ -ffilename ]
          ctl_mboxlist [ -Cconfig-file ] -v [ -ffilename ]