carta
cyrus-mbpath(8)

cyrus-mbpath8

Cyrus imap documentation translate mailbox names to filesystem paths

Overview

Given a mailbox name or a space separated list of mailbox names, mbpath outputs the filesystem path(s) of the mailbox. By default, the mailboxes' data partition paths are shown (same as -D). See Selectors for selecting which filesystem path(s) to output.

mbpath reads its configuration options out of the imapd.conf(5) file unless specified otherwise by -C. It uses <configdirectory>/mailboxes.db to locate the mailboxes on disk.

Options

-C config-file

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

-l, --local-only

Local mailboxes only (exits with error for remote or nonexistent mailboxes)

-m

Output the path to the metadata files (if different from the message files). Legacy, use -M.

-q, --quiet

Suppress any error output.

-s, --stop

If any error occurs, stop processing the list of mailboxes and exit.

-u, --userids

The specified mailbox-names are userids, not mailboxes.

-p, --paths

The specified mailbox-names are UNIX mailbox paths, not mailboxes.

Selectors

-A, --archive

Show the mailbox archive path

-D, --data

Show the mailbox data path (default)

-M, --metadata

Show the mailbox metadata path (same 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 paths, as if all selectors were specified

Examples

mbpath user.jsmith

Display the data path for mailbox user.jsmith.

mbpath -M user.jsmith

Display the metadata path for mailbox user.jsmith.

mbpath -u -S jsmith

Display the sieve scripts path for user jsmith.

Files

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

History

  • Debian 13 (Trixie): the text shown here
  • Debian 12 (Bookworm)
  • Debian 11 (Bullseye)
  • Debian 10 (Buster)
  • Debian 9 (Stretch)
  • Debian 8 (Jessie) to Debian 7 (Wheezy)

--local-only since Debian 13 (Trixie); --paths since Debian 13 (Trixie); --quiet since Debian 13 (Trixie); --stop since Debian 13 (Trixie); --userids since Debian 13 (Trixie); -C since Debian 10 (Buster); -l since Debian 11 (Bullseye); -m since Debian 10 (Buster); -p since Debian 12 (Bookworm); -q since Debian 10 (Buster); -s since Debian 10 (Buster); -u since Debian 11 (Bullseye).

Author

The Cyrus Team, Nic Bernstein (Onlight)

From cyrus-common 3.10.2-1+deb13u2 in Debian 13 (Trixie). Parsed by carta from the page's man source.