1MBPATH(8)                         Cyrus IMAP                         MBPATH(8)
2
3
4

NAME

6       mbpath - Cyrus IMAP documentation
7
8       Translate mailbox names to filesystem paths
9

SYNOPSIS

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

DESCRIPTION

14       Given a mailbox name or a space separated list of mailbox names, mbpath
15       outputs the filesystem path(s) of the mailbox.  By default,  the  mail‐
16       boxes'  data partition paths are shown (same as -D).  See Selectors for
17       selecting which filesystem path(s) to output.
18
19       mbpath reads its configuration options out of  the  imapd.conf(5)  file
20       unless  specified  otherwise  by  -C.  It  uses <configdirectory>/mail‐
21       boxes.db to locate the mailboxes on disk.
22

OPTIONS

24       -C config-file
25              Use the specified configuration file config-file rather than the
26              default imapd.conf(5).
27
28       -l, --local-only
29              Local mailboxes only (exits with error for remote or nonexistent
30              mailboxes)
31
32       -m     Output the path to the metadata files  (if  different  from  the
33              message files).  Legacy, use -M.
34
35       -q, --quiet
36              Suppress any error output.
37
38       -s, --stop
39              If  any  error occurs, stop processing the list of mailboxes and
40              exit.
41
42       -u, --userids
43              The specified mailbox-names are userids, not mailboxes.
44
45       -p, --paths
46              The specified mailbox-names are UNIX mailbox  paths,  not  mail‐
47              boxes.
48

SELECTORS

50       -A, --archive
51              Show the mailbox archive path
52
53       -D, --data
54              Show the mailbox data path (default)
55
56       -M, --metadata
57              Show the mailbox metadata path (same as -m)
58
59       -S, --sieve
60              Show the user sieve scripts path
61
62       -U, --user-files
63              Show the user files path (seen, sub, etc)
64
65       -a, --all
66              Show all paths, as if all selectors were specified
67

EXAMPLES

69          mbpath user.jsmith
70          Display the data path for mailbox user.jsmith.
71
72          mbpath -M user.jsmith
73          Display the metadata path for mailbox user.jsmith.
74
75          mbpath -u -S jsmith
76          Display the sieve scripts path for user jsmith.
77

FILES

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

SEE ALSO

82       imapd.conf(5)
83

AUTHOR

85       The Cyrus Team, Nic Bernstein (Onlight)
86

88       1993–2023, The Cyrus Team
89
90
91
92
933.8.1                            Sep 11, 2023                        MBPATH(8)
Impressum