Debian Codegraph @

doc/html/_sources/imap/reference/manpages/systemcommands/mbpath.rst.txt

raw
1 .. cyrusman:: mbpath(8)
2
3 .. author: Nic Bernstein (Onlight)
4
5 .. _imap-reference-manpages-systemcommands-mbpath:
6
7 ==========
8 **mbpath**
9 ==========
10
11 Translate mailbox names to filesystem paths
12
13 Synopsis
14 ========
15
16 .. parsed-literal::
17
18 **mbpath** [ **-C** *config-file* ] [ **-l** ] [ **-m** ] [ **-q** ] [ **-s** ] [ **-u** | **-p** ] [ **-a** | **-A** | **-M** | **-S** | **-U** ] [ *mailbox-names*... ]
19
20 Description
21 ===========
22
23 Given a mailbox name or a space separated list of mailbox names,
24 **mbpath** outputs the filesystem path(s) of the mailbox. By default,
25 the mailboxes' data partition paths are shown (same as **-D**).
26 See `Selectors`_ for selecting which filesystem path(s) to output.
27
28 **mbpath** |default-conf-text| It uses <configdirectory>/mailboxes.db
29 to locate the mailboxes on disk.
30
31 Options
32 =======
33
34 .. program:: mbpath
35
36 .. option:: -C config-file
37
38 |cli-dash-c-text|
39
40 .. option:: -l, --local-only
41
42 Local mailboxes only (exits with error for remote or nonexistent mailboxes)
43
44 .. option:: -m
45
46 Output the path to the metadata files (if different from the
47 message files). Legacy, use **-M**.
48
49 .. option:: -q, --quiet
50
51 Suppress any error output.
52
53 .. option:: -s, --stop
54
55 If any error occurs, stop processing the list of mailboxes and exit.
56
57 .. option:: -u, --userids
58
59 The specified *mailbox-names* are userids, not mailboxes.
60
61 .. option:: -p, --paths
62
63 The specified *mailbox-names* are UNIX mailbox paths, not mailboxes.
64
65 Selectors
66 =========
67
68 .. option:: -A, --archive
69
70 Show the mailbox archive path
71
72 .. option:: -D, --data
73
74 Show the mailbox data path (*default*)
75
76 .. option:: -M, --metadata
77
78 Show the mailbox metadata path (same as **-m**)
79
80 .. option:: -S, --sieve
81
82 Show the user sieve scripts path
83
84 .. option:: -U, --user-files
85
86 Show the user files path (seen, sub, etc)
87
88 .. option:: -a, --all
89
90 Show all paths, as if all selectors were specified
91
92 Examples
93 ========
94
95 .. parsed-literal::
96
97 **mbpath** *user.jsmith*
98
99 ..
100
101 Display the data path for mailbox *user.jsmith*.
102
103 .. only:: html
104
105 ::
106
107 /var/spool/cyrus/user/jsmith
108
109 .. parsed-literal::
110
111 **mbpath -M** *user.jsmith*
112
113 ..
114
115 Display the metadata path for mailbox *user.jsmith*.
116
117 .. only:: html
118
119 ::
120
121 /var/spool/meta/imap/user/jsmith
122
123 .. parsed-literal::
124
125 **mbpath -u -S** *jsmith*
126
127 ..
128
129 Display the sieve scripts path for user *jsmith*.
130
131 .. only:: html
132
133 ::
134
135 /var/spool/sieve/j/jsmith
136
137 Files
138 =====
139
140 /etc/imapd.conf,
141 <configdirectory>/mailboxes.db
142
143 See Also
144 ========
145
146 :cyrusman:`imapd.conf(5)`