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 ] [ -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 mailboxes only (exits with error for remote or nonexistent
29              mailboxes)
30
31       -m     Output the path to the metadata files  (if  different  from  the
32              message files).  Legacy, use -M.
33
34       -q     Suppress any error output.
35
36       -s     If  any  error occurs, stop processing the list of mailboxes and
37              exit.
38
39       -u     The specified mailbox-names are users, not mailboxes.
40

SELECTORS

42       -A     Show the mailbox archive path
43
44       -D     Show the mailbox data path (default)
45
46       -M     Show the mailbox metadata path (same as -m)
47
48       -S     Show the user sieve scripts path
49
50       -U     Show the user files path (seen, sub, etc)
51
52       -a     Show all paths, as if all selectors were specified
53

EXAMPLES

55       mbpath user.jsmith
56          Display the data path for mailbox user.jsmith.
57
58       mbpath -M user.jsmith
59          Display the metadata path for mailbox user.jsmith.
60
61       mbpath -u -S jsmith
62          Display the sieve scripts path for user jsmith.
63

FILES

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

SEE ALSO

68       imapd.conf(5)
69

AUTHOR

71       The Cyrus Team, Nic Bernstein (Onlight)
72

74       1993-2018, The Cyrus Team
75
76
77
78
793.2.4                          October 05, 2020                      MBPATH(8)
Impressum