MBPATH(8)

πŸ’– MBPATH(8) β€” Cyrus IMAP πŸ’–

okay bestie, welcome to mbpath, part of the Cyrus IMAP family. this one's whole job? take mailbox names and hand you back the actual filesystem paths they live at. translation: human words in, disk locations out ✨


✨ NAME ✨

mbpath β€” translate mailbox names to filesystem paths πŸ’«


✨ SYNOPSIS ✨

mbpath [ -C config-file ] [ -l ] [ -m ] [ -q ] [ -s ] [ -u | -p ] [ -a | -A | -M | -S | -U ] [ mailbox-names... ]

✨ DESCRIPTION ✨

so basically, you give it one mailbox name, or a space separated list of them, and mbpath prints out the filesystem path(s) for each one. that's it. that's the gig. πŸ’…

by default it shows you the mailboxes' data partition paths β€” which, yeah, is exactly the same as passing -D. wanna pick a different path instead? that's what the Selectors section below is for, bestie πŸŽ€

mbpath pulls its configuration options out of the imapd.conf(5) file, unless you tell it otherwise with -C. and to actually find the mailboxes on disk, it goes digging in <configdirectory>/mailboxes.db πŸ—‚οΈ


✨ OPTIONS ✨

  • -C config-file β€” use this specific config file instead of the default imapd.conf(5). your rules, your file 🫢
  • -l, --local-only β€” local mailboxes only!! if the mailbox is remote or just straight up doesn't exist, it exits with an error. no pretending, no cap πŸ’€
  • -m β€” output the path to the metadata files (only if they're different from the message files, tho). this one's legacy, so use -M instead πŸ‘‘
  • -q, --quiet β€” suppress any error output. shhh 🀫
  • -s, --stop β€” if literally any error happens, stop processing the rest of the mailbox list and exit. dramatic but fair πŸ›‘
  • -u, --userids β€” the mailbox-names you passed are actually userids, not mailboxes. plot twist 🌸
  • -p, --paths β€” the mailbox-names you passed are actually UNIX mailbox paths, not mailboxes πŸ¦‹

πŸŽ€ SELECTORS πŸŽ€

  • -A, --archive β€” show the mailbox archive path πŸ“¦
  • -D, --data β€” show the mailbox data path (this is the default, iykyk) πŸ’–
  • -M, --metadata β€” show the mailbox metadata path (same thing as -m) ✨
  • -S, --sieve β€” show the user sieve scripts path 🧚
  • -U, --user-files β€” show the user files path (seen, sub, etc.) πŸ“
  • -a, --all β€” show all the paths, like you specified every single selector at once. main character energy, honestly πŸ‘‘

✨ EXAMPLES ✨

lowkey the best part. here's how it looks in the wild:

mbpath user.jsmith

display the data path for mailbox user.jsmith. classic πŸ’…

mbpath -M user.jsmith

display the metadata path for mailbox user.jsmith ✨

mbpath -u -S jsmith

display the sieve scripts path for user jsmith 🧚 note the -u, since jsmith here is a userid, not a mailbox.


✨ FILES ✨

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

✨ SEE ALSO ✨


✨ AUTHOR ✨

The Cyrus Team, Nic Bernstein (Onlight) 🌈


1993–2026, The Cyrus Team 🫢


ngl bestie, that's the whole page. go forth and find your paths πŸ’–

okay and one last thing before you go β€” this lil guide is from Cyrus IMAP version 3.12.3, dated Jul 15, 2026. slay, enjoy, and don't forget: -M not -m, periodt βœ¨πŸ’…

πŸ“¦ where this page comes from