Login or Register to Ask a Question and Join Our Community

Linux and UNIX Man Pages

Linux & Unix Commands - Search Man Pages

cyrus-ctl_mboxlist(8) [debian man page]

CTL_MBOXLIST(8) 					      System Manager's Manual						   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 ] [ -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 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 MUPDATE 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.

       -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.

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

FILES

       /etc/imapd.conf

SEE ALSO

       imapd.conf(5), cyrmaster(8)

CMU
								   Project Cyrus						   CTL_MBOXLIST(8)

Check Out this Related Man Page

SQUATTER(8)						      System Manager's Manual						       SQUATTER(8)

 *

NAME

       squatter - create SQUAT indexes for mailboxes

SYNOPSIS

       squatter [ -C config-file ] [ -r ] [ -s ] [ -i ] [ -a ] [ -v ] mailbox...

DESCRIPTION

       Squatter  creates  a new SQUAT index for one or more IMAP mailboxes.  The SQUAT index is a unified index of all of the header and body text
       of each message a given mailbox.  This index is used to significantly reduce IMAP SEARCH times on a mailbox.

       Squatter creates an index of ALL messages in the mailbox, not just those since the last time that it was run (i.e., it does NOT	do  incre-
       mental  updates).   Any messages appended to the mailbox after squatter is run, will NOT be included in the index.  To include new messages
       in the index, squatter must be run again.  For large and active mailboxes, it is recommended to run squatter periodically as  an  EVENT	in
       cyrus.conf(5)

       NOTE: Messages and mailboxes that have not been indexed CAN still be SEARCHed, just not as quickly as those with a SQUAT index.

       Squatter reads its configuration options out of the imapd.conf(5) file unless specified otherwise by -C.

OPTIONS

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

       -r     Recursively create indexes for all sub-mailboxes of the mailboxes or mailbox prefixes given as arguments.

       -s     Skip mailboxes whose index file is older than their current squat file (within a small time delta).

       -i     Incremental updates where squat indexes already exist.

       -a     Only create indexes for mailboxes which have the shared /vendor/cmu/cyrus-imapd/squat annotation set to "true".

	      The  value  of  the /vendor/cmu/cyrus-imapd/squat annotation is inherited by all children of the given mailbox, so an entire mailbox
	      tree can be indexed (or not indexed) by setting a single annotation on the root of that tree with a value of  "true"  (or  "false").
	      If  a  mailbox does not have a /vendor/cmu/cyrus-imapd/squat annotation set on it (or does not inherit one), then the mailbox is not
	      indexed.	In other words, the implicit value of /vendor/cmu/cyrus-imapd/squat is "false".

       -v     Increase the verbosity of progress/status messages.

FILES

       /etc/imapd.conf /etc/cyrus.conf

CMU
								   Project Cyrus						       SQUATTER(8)
Man Page