- bookworm 3.6.1-4+deb12u3
- bookworm-backports 3.8.1-1~bpo12+1
- unstable 3.10.0-1
- experimental 3.10.0~rc2-1
CTL_MBOXLIST(8) | Cyrus IMAP | CTL_MBOXLIST(8) |
NAME¶
ctl_mboxlist - Cyrus IMAP documentation
Perform operations on the mailbox list database
SYNOPSIS¶
ctl_mboxlist [ -C config-file ] -d [ -x ] [-y] [ -p partition ] [ -f filename ] ctl_mboxlist [ -C config-file ] -u [ -f filename ] [ -L ] ctl_mboxlist [ -C config-file ] -m [ -a ] [ -w ] [ -i ] [ -f filename ] ctl_mboxlist [ -C config-file ] -v [ -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 in imapd.conf(5) is used to determine the default location of the mailboxes database.
OPTIONS¶
- -C config-file
- Use the specified configuration file config-file rather than the default imapd.conf(5).
- -d
- Dump the contents of the database to standard output in JSON format.
- -x
- When performing a dump, remove the mailboxes dumped from the mailbox list (mostly useful when specified with -p).
- -y
- When performing a dump, also list intermediary mailboxes which would be hidden from IMAP.
- -p partition
- When performing a dump, dump only those mailboxes that live on partition.
- -f filename
- Use the database specified by filename instead of the default (configdirectory/mailboxes.db*).
- -L
- 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
- 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:
- -m
- For backend servers in the Cyrus Murder, synchronize the local mailbox list file with the MUPDATE server.
- -a
- 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:
- -w
- When used with -m, print out what would be done but do not perform the operations.
- -i
- When used with -m, asks for verification before deleting local mailboxes.
- -v
- 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.
EXAMPLES¶
ctl_mboxlist -d
ctl_mboxlist -u < newmboxlist.dump
NOTE:
ctl_mboxlist -m
ctl_mboxlist -m -w
ctl_mboxlist -m -a
NOTE:
ctl_mboxlist -m -i
FILES¶
/etc/imapd.conf, <configdirectory>/mailboxes.db
SEE ALSO¶
AUTHOR¶
The Cyrus Team, Nic Bernstein (Onlight), Jeroen van Meeuwen (Kolab Systems)
COPYRIGHT¶
1993–2023, The Cyrus Team
February 13, 2023 | 3.6.1 |