CHK_CYRUS(8)

πŸ’– CHK_CYRUS πŸ’–

okay bestie, welcome to chk_cyrus β€” section 8 of the Cyrus IMAP manual, and literally your new fave consistency-checking icon πŸŽ€


✨ NAME ✨

chk_cyrus β€” Cyrus IMAP documentation

does a consistency check of the Cyrus IMAP mail spool. yep that's the whole vibe πŸ’…


🌸 SYNOPSIS 🌸

chk_cyrus [ -C config-file ] [ -P partition | -M mailbox ]

πŸ¦‹ DESCRIPTION πŸ¦‹

so chk_cyrus is the one that runs a consistency check on the cyrus datastore, and it spits out a whole list of files/directories that should exist but literally don't 😭 it's giving "where did they go" energy.

heads up tho, the tea is split:

  • status messages go to stderr
  • the list of files/directories goes to stdout

and that list?? you can hand it straight to a backup program to help with a partial restoration, for instance. so useful, no cap 🫢

also chk_cyrus reads its configuration options out of the imapd.conf(5) file, unless you say otherwise with -C. periodt.


πŸ’… OPTIONS πŸ’…

  • -C config-file β€” use the specified configuration file config-file instead of the default imapd.conf(5). iconic behaviour tbh ✨
  • -P partition, --partition=partition β€” limit to partition partition. may not be specified with -M. pick a lane bestie πŸ™ˆ
  • -M mailbox, --mailbox=mailbox β€” only check mailbox mailbox. may not be specified with -P. again. one or the other. πŸ’€
IMPORTANT: the mailbox has to be specified in the internal format. so instead of writing user/john/Trash@example.org, you're gonna want to write example.org!user.john.Trash. yes fr fr, that's the format. don't fight it 🌈

πŸŽ€ EXAMPLES πŸŽ€

chk_cyrus -P default

perform consistency checks on default partition. slay ✨

chk_cyrus -C /usr/local/etc/imapd-slot1.conf -P default

perform consistency checks on default partition using the specified configuration file. look at you customising πŸ‘‘

chk_cyrus -M user.marysmith

perform consistency checks on mailbox user.marysmith. go marysmith go πŸ¦‹


🌟 SEE ALSO 🌟

imapd.conf(5), master(8)


πŸ‘‘ AUTHOR πŸ‘‘

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


1993–2026, The Cyrus Team


okay that's the whole page, mwah πŸ’‹ this was Cyrus IMAP version 3.12.4, dated Sep 09, 2026 β€” go check those spools bestie, i believe in you πŸ«ΆπŸŒΈπŸ’–

πŸ“¦ where this page comes from