|
2
|
1 |
[Top] [Contents] [Index] [ ? ]
|
|
0
|
2 |
|
|
|
3 |
Vmailmgr Configuration Files
|
|
|
4 |
|
|
2
|
5 |
1. General Information
|
|
|
6 |
2. Configuration Files
|
|
0
|
7 |
_________________________________________________________________
|
|
2
|
8 |
|
|
|
9 |
[ < ] [ > ] [ << ] [ Up ] [ >> ] [Top] [Contents] [Index] [
|
|
|
10 |
? ]
|
|
|
11 |
|
|
|
12 |
1. General Information
|
|
|
13 |
|
|
|
14 |
1.1 Search Order
|
|
|
15 |
1.2 File Types
|
|
|
16 |
1.3 Command Execution
|
|
0
|
17 |
_________________________________________________________________
|
|
2
|
18 |
|
|
|
19 |
[ < ] [ > ] [ << ] [ Up ] [ >> ] [Top] [Contents] [Index] [
|
|
|
20 |
? ]
|
|
|
21 |
|
|
0
|
22 |
1.1 Search Order
|
|
|
23 |
|
|
|
24 |
The system will look for the configuration files listed below in one
|
|
|
25 |
of the following three locations, in the order they are listed:
|
|
|
26 |
1. The domain-local configuration directory
|
|
|
27 |
2. The user-local configuration directory
|
|
|
28 |
3. The global configuration directory
|
|
2
|
29 |
|
|
0
|
30 |
The global configuration directory is set to `/etc/vmailmgr' by
|
|
|
31 |
default. The user-local and domain-local configuration directories
|
|
|
32 |
(for now, one and the same) are a subdirectory, named `.vmailmgr' by
|
|
|
33 |
default, of either the user's home directory or the domain
|
|
|
34 |
subdirectory. If a file matching the configuration name is found in
|
|
|
35 |
one of the local directories, the search stops and it is not searched
|
|
|
36 |
for in any higher up directories.
|
|
2
|
37 |
_________________________________________________________________
|
|
|
38 |
|
|
|
39 |
[ < ] [ > ] [ << ] [ Up ] [ >> ] [Top] [Contents] [Index] [
|
|
|
40 |
? ]
|
|
|
41 |
|
|
0
|
42 |
1.2 File Types
|
|
|
43 |
|
|
|
44 |
Each of the configuration files falls into one of the following types:
|
|
2
|
45 |
|
|
0
|
46 |
String
|
|
|
47 |
A single line is read from this type and used as-is with no
|
|
|
48 |
conversion. All data after the first line is ignored.
|
|
|
49 |
Directory
|
|
|
50 |
A single line is read from this type. If it does not have a
|
|
|
51 |
trailing slash (`/'), one is appended. All data after the first
|
|
|
52 |
line is ignored.
|
|
|
53 |
Number
|
|
|
54 |
A single line is read from this type and converted to an
|
|
|
55 |
unsigned integer. If the conversion succeeds, the value is
|
|
|
56 |
used. All data after the first line is ignored.
|
|
|
57 |
List
|
|
|
58 |
Each line of the file is read, stripped of leading and trailing
|
|
|
59 |
whitespace, and treated as a separate value. Lines that contain
|
|
|
60 |
only whitespace (ie blank lines) or lines beginning with a
|
|
|
61 |
pound symbol (`#') are ignored.
|
|
|
62 |
Executable
|
|
|
63 |
If the execute bits on the file are set, it is treated as an
|
|
|
64 |
executable file and is executed with no interpretation by
|
|
|
65 |
vmailmgr. The the Command Execution section below for details.
|
|
2
|
66 |
|
|
0
|
67 |
All lines are stripped of any leading or trailing white space.
|
|
2
|
68 |
|
|
0
|
69 |
Configuration files marked as `(global only)' are read before any
|
|
|
70 |
user-level processing occurrs, and so are not functional in the
|
|
|
71 |
user-level configuration.
|
|
2
|
72 |
_________________________________________________________________
|
|
|
73 |
|
|
|
74 |
[ < ] [ > ] [ << ] [ Up ] [ >> ] [Top] [Contents] [Index] [
|
|
|
75 |
? ]
|
|
|
76 |
|
|
0
|
77 |
1.3 Command Execution
|
|
|
78 |
|
|
|
79 |
The following rules apply to executing a single command or a list of
|
|
|
80 |
commands.
|
|
2
|
81 |
|
|
0
|
82 |
The executables are searched in reverse order of the configuration
|
|
|
83 |
files. That is, the global setting is used first, and then the local
|
|
|
84 |
settings. If the named file either does not exist in a directory or is
|
|
|
85 |
not executable, that directory is skipped.
|
|
2
|
86 |
|
|
0
|
87 |
A command exit code of `99' indicates that the command completed
|
|
|
88 |
successfully but no further commands should be executed. All other
|
|
|
89 |
non-zero exit codes are treated as an error and will cause the
|
|
|
90 |
invoking program to stop with the same error code. For `vdeliver', an
|
|
|
91 |
error exit of 111 will be passed up to qmail as a temporary error, and
|
|
|
92 |
an error exit of 100 will be passed up as a permanent failure. See the
|
|
|
93 |
`qmail-command' man page for full details on delivery error codes. For
|
|
|
94 |
`checkvpw', any non-zero exit code (except as described above) will
|
|
|
95 |
cause authentication to fail.
|
|
2
|
96 |
|
|
0
|
97 |
The following environment variables will be set (where applicable):
|
|
2
|
98 |
|
|
0
|
99 |
`HOME'
|
|
|
100 |
The home directory of the real user.
|
|
|
101 |
`MAILDIR'
|
|
|
102 |
The mail directory of the real or virtual user.
|
|
|
103 |
`USER'
|
|
|
104 |
The real user's name.
|
|
|
105 |
`VUSER'
|
|
|
106 |
The virtual user's name. For base user logins, this is blank,
|
|
|
107 |
and all the following items prefixed with `VUSER_' are not set.
|
|
|
108 |
`VUSER_CTIME'
|
|
|
109 |
The virtual user's creation time (or "0" if unknown).
|
|
|
110 |
`VUSER_EXPIRY'
|
|
|
111 |
The virtual user's expiry time (or "-" if not applicable).
|
|
|
112 |
`VUSER_HARDQUOTA'
|
|
|
113 |
The virtual user's total size hard quota (in bytes, or "-" if
|
|
|
114 |
not applicable).
|
|
|
115 |
`VUSER_MSGCOUNT'
|
|
|
116 |
The virtual user's message count limit (or "-" if not
|
|
|
117 |
applicable).
|
|
|
118 |
`VUSER_MSGSIZE'
|
|
|
119 |
The virtual user's message size limit (or "-" if not
|
|
|
120 |
applicable).
|
|
|
121 |
`VUSER_PERSONAL'
|
|
|
122 |
The virtual user's personal data.
|
|
|
123 |
`VUSER_SOFTQUOTA'
|
|
|
124 |
The virtual user's total size soft quota (in bytes, or "-" if
|
|
|
125 |
not applicable).
|
|
2
|
126 |
_________________________________________________________________
|
|
|
127 |
|
|
|
128 |
[ < ] [ > ] [ << ] [ Up ] [ >> ] [Top] [Contents] [Index] [
|
|
|
129 |
? ]
|
|
|
130 |
|
|
0
|
131 |
2. Configuration Files
|
|
2
|
132 |
|
|
0
|
133 |
Each of the following sections identifies a single configuration file
|
|
2
|
134 |
|
|
|
135 |
2.1 authvmailmgr-error
|
|
|
136 |
2.2 authvmailmgr-loginfail
|
|
|
137 |
2.3 authvmailmgr-postsetuid
|
|
|
138 |
2.4 authvmailmgr-presetuid
|
|
|
139 |
2.5 autoresponse-dir
|
|
|
140 |
2.6 autoresponse-file
|
|
|
141 |
2.7 bulletin-dir
|
|
|
142 |
2.8 checkvpw-error
|
|
|
143 |
2.9 checkvpw-loginfail
|
|
|
144 |
2.10 checkvpw-postexec
|
|
|
145 |
2.11 checkvpw-postsetuid
|
|
|
146 |
2.12 checkvpw-presetuid
|
|
|
147 |
2.13 default-expiry
|
|
|
148 |
2.14 default-maildir
|
|
|
149 |
2.15 default-msgcount
|
|
|
150 |
2.16 default-msgsize
|
|
|
151 |
2.17 default-hardquota
|
|
|
152 |
2.18 default-softquota
|
|
|
153 |
2.19 default-username
|
|
|
154 |
2.20 error-maildir
|
|
|
155 |
2.21 global-bulletin-dir
|
|
|
156 |
2.22 maildir-arg-str
|
|
|
157 |
2.23 password-file
|
|
|
158 |
2.24 postmaster-aliases
|
|
|
159 |
2.25 postmaster-email
|
|
|
160 |
2.26 qmail-root
|
|
|
161 |
2.27 separators
|
|
|
162 |
2.28 socket-file
|
|
|
163 |
2.29 user-dir
|
|
|
164 |
2.30 user-dir-bits
|
|
|
165 |
2.31 user-dir-slices
|
|
|
166 |
2.32 vdeliver-postdeliver
|
|
|
167 |
2.33 vdeliver-predeliver
|
|
|
168 |
2.34 vsetup-post
|
|
|
169 |
2.35 vsetup-pre
|
|
|
170 |
_________________________________________________________________
|
|
|
171 |
|
|
|
172 |
[ < ] [ > ] [ << ] [ Up ] [ >> ] [Top] [Contents] [Index] [
|
|
|
173 |
? ]
|
|
|
174 |
|
|
0
|
175 |
2.1 authvmailmgr-error
|
|
|
176 |
|
|
|
177 |
Type
|
|
|
178 |
executable
|
|
|
179 |
Default
|
|
|
180 |
Empty
|
|
|
181 |
Used By
|
|
|
182 |
authvmailmgr
|
|
|
183 |
Description
|
|
|
184 |
This is executed by authvmailmgr if any error occurrs other
|
|
|
185 |
than those caught by `authvmailmgr-loginfail' below. The
|
|
|
186 |
environment variable AUTHVMAILMGR_ERROR will contain an error
|
|
|
187 |
message. This can be used to output logging messages about
|
|
|
188 |
errors in authvmailmgr.
|
|
2
|
189 |
_________________________________________________________________
|
|
|
190 |
|
|
|
191 |
[ < ] [ > ] [ << ] [ Up ] [ >> ] [Top] [Contents] [Index] [
|
|
|
192 |
? ]
|
|
|
193 |
|
|
0
|
194 |
2.2 authvmailmgr-loginfail
|
|
|
195 |
|
|
|
196 |
Type
|
|
|
197 |
executable
|
|
|
198 |
Default
|
|
|
199 |
Empty
|
|
|
200 |
Used By
|
|
|
201 |
authvmailmgr
|
|
|
202 |
Description
|
|
|
203 |
This is executed by authvmailmgr if the user's login fails. The
|
|
|
204 |
environment variable AUTHVMAILMGR_ERROR will contain an error
|
|
|
205 |
message. The environment variable VUSER will be set to the
|
|
|
206 |
virtual user name if it has been determined. This can be used
|
|
|
207 |
to output logging messages about login failures or to throttle
|
|
|
208 |
hackers.
|
|
2
|
209 |
_________________________________________________________________
|
|
|
210 |
|
|
|
211 |
[ < ] [ > ] [ << ] [ Up ] [ >> ] [Top] [Contents] [Index] [
|
|
|
212 |
? ]
|
|
|
213 |
|
|
0
|
214 |
2.3 authvmailmgr-postsetuid
|
|
|
215 |
|
|
|
216 |
Type
|
|
|
217 |
executable
|
|
|
218 |
Default
|
|
2
|
219 |
`vpopbull'
|
|
0
|
220 |
Used By
|
|
|
221 |
authvmailmgr
|
|
|
222 |
Description
|
|
|
223 |
This is executed by authvmailmgr after a user is successfully
|
|
|
224 |
authenticated.
|
|
2
|
225 |
_________________________________________________________________
|
|
|
226 |
|
|
|
227 |
[ < ] [ > ] [ << ] [ Up ] [ >> ] [Top] [Contents] [Index] [
|
|
|
228 |
? ]
|
|
|
229 |
|
|
0
|
230 |
2.4 authvmailmgr-presetuid
|
|
|
231 |
|
|
|
232 |
Type
|
|
|
233 |
executable
|
|
|
234 |
Default
|
|
|
235 |
Empty
|
|
|
236 |
Used By
|
|
|
237 |
authvmailmgr
|
|
|
238 |
Description
|
|
|
239 |
This list is executed by authvmailmgr before changing user away
|
|
|
240 |
from root, and before authenticating a virtual user. Note: The
|
|
|
241 |
environment variable `MAILDIR' is not set since the virtual
|
|
|
242 |
user has not yet been authenticated, or even looked up at this
|
|
|
243 |
point. For the same reason, `VUSER' is not authenticated and is
|
|
|
244 |
under complete control of the invoking user.
|
|
2
|
245 |
_________________________________________________________________
|
|
|
246 |
|
|
|
247 |
[ < ] [ > ] [ << ] [ Up ] [ >> ] [Top] [Contents] [Index] [
|
|
|
248 |
? ]
|
|
|
249 |
|
|
0
|
250 |
2.5 autoresponse-dir
|
|
|
251 |
|
|
|
252 |
Type
|
|
|
253 |
directory
|
|
|
254 |
Default
|
|
|
255 |
`autoresponse'
|
|
|
256 |
Used By
|
|
|
257 |
vmailmgrd, autoresponder script
|
|
|
258 |
Description
|
|
|
259 |
Identifies the subdirectory of the virtual user directory in
|
|
|
260 |
which all autoresponse data is stored.
|
|
2
|
261 |
_________________________________________________________________
|
|
|
262 |
|
|
|
263 |
[ < ] [ > ] [ << ] [ Up ] [ >> ] [Top] [Contents] [Index] [
|
|
|
264 |
? ]
|
|
|
265 |
|
|
0
|
266 |
2.6 autoresponse-file
|
|
|
267 |
|
|
|
268 |
Type
|
|
|
269 |
string
|
|
|
270 |
Default
|
|
|
271 |
`message.txt'
|
|
|
272 |
Used By
|
|
|
273 |
vmailmgrd, autoresponder script
|
|
|
274 |
Description
|
|
|
275 |
Identifies the file name within the autoresponse directory that
|
|
|
276 |
contains the autoresponse message.
|
|
2
|
277 |
_________________________________________________________________
|
|
|
278 |
|
|
|
279 |
[ < ] [ > ] [ << ] [ Up ] [ >> ] [Top] [Contents] [Index] [
|
|
|
280 |
? ]
|
|
|
281 |
|
|
0
|
282 |
2.7 bulletin-dir
|
|
|
283 |
|
|
|
284 |
Type
|
|
|
285 |
directory
|
|
|
286 |
Default
|
|
|
287 |
`bulletins'
|
|
|
288 |
Used By
|
|
|
289 |
checkvpw
|
|
|
290 |
Description
|
|
|
291 |
Identifies the subdirectory of the domain directory in which
|
|
|
292 |
bulletins local to a domain are stored.
|
|
2
|
293 |
_________________________________________________________________
|
|
|
294 |
|
|
|
295 |
[ < ] [ > ] [ << ] [ Up ] [ >> ] [Top] [Contents] [Index] [
|
|
|
296 |
? ]
|
|
|
297 |
|
|
0
|
298 |
2.8 checkvpw-error
|
|
|
299 |
|
|
|
300 |
Type
|
|
|
301 |
executable
|
|
|
302 |
Default
|
|
|
303 |
Empty
|
|
|
304 |
Used By
|
|
|
305 |
checkvpw
|
|
|
306 |
Description
|
|
|
307 |
This is executed by checkvpw if any error occurrs other than
|
|
|
308 |
those caught by `checkvpw-loginfail' below. The environment
|
|
|
309 |
variable CHECKVPW_ERROR will contain an error message. This can
|
|
|
310 |
be used to output logging messages about errors in checkvpw.
|
|
2
|
311 |
_________________________________________________________________
|
|
|
312 |
|
|
|
313 |
[ < ] [ > ] [ << ] [ Up ] [ >> ] [Top] [Contents] [Index] [
|
|
|
314 |
? ]
|
|
|
315 |
|
|
0
|
316 |
2.9 checkvpw-loginfail
|
|
|
317 |
|
|
|
318 |
Type
|
|
|
319 |
executable
|
|
|
320 |
Default
|
|
|
321 |
Empty
|
|
|
322 |
Used By
|
|
|
323 |
checkvpw
|
|
|
324 |
Description
|
|
|
325 |
This is executed by checkvpw if the user's login fails. The
|
|
|
326 |
environment variable CHECKVPW_ERROR will contain an error
|
|
|
327 |
message. The environment variable VUSER will be set to the
|
|
|
328 |
virtual user name if it has been determined. This can be used
|
|
|
329 |
to output logging messages about login failures or to throttle
|
|
|
330 |
hackers.
|
|
2
|
331 |
_________________________________________________________________
|
|
|
332 |
|
|
|
333 |
[ < ] [ > ] [ << ] [ Up ] [ >> ] [Top] [Contents] [Index] [
|
|
|
334 |
? ]
|
|
|
335 |
|
|
0
|
336 |
2.10 checkvpw-postexec
|
|
|
337 |
|
|
|
338 |
Type
|
|
|
339 |
executable
|
|
|
340 |
Default
|
|
|
341 |
Empty
|
|
|
342 |
Used By
|
|
|
343 |
checkvpw
|
|
|
344 |
Description
|
|
|
345 |
This is executed by checkvpw after the subcommand successfully
|
|
|
346 |
completes.
|
|
2
|
347 |
_________________________________________________________________
|
|
|
348 |
|
|
|
349 |
[ < ] [ > ] [ << ] [ Up ] [ >> ] [Top] [Contents] [Index] [
|
|
|
350 |
? ]
|
|
|
351 |
|
|
0
|
352 |
2.11 checkvpw-postsetuid
|
|
|
353 |
|
|
|
354 |
Type
|
|
|
355 |
executable
|
|
|
356 |
Default
|
|
2
|
357 |
`vpopbull'
|
|
0
|
358 |
Used By
|
|
|
359 |
checkvpw
|
|
|
360 |
Description
|
|
|
361 |
This is executed by checkvpw after a user is successfully
|
|
|
362 |
authenticated.
|
|
2
|
363 |
_________________________________________________________________
|
|
|
364 |
|
|
|
365 |
[ < ] [ > ] [ << ] [ Up ] [ >> ] [Top] [Contents] [Index] [
|
|
|
366 |
? ]
|
|
|
367 |
|
|
0
|
368 |
2.12 checkvpw-presetuid
|
|
|
369 |
|
|
|
370 |
Type
|
|
|
371 |
executable
|
|
|
372 |
Default
|
|
|
373 |
Empty
|
|
|
374 |
Used By
|
|
|
375 |
checkvpw
|
|
|
376 |
Description
|
|
|
377 |
This list is executed by checkvpw before changing user away
|
|
|
378 |
from root, and before authenticating a virtual user. Note: The
|
|
|
379 |
environment variable `MAILDIR' is not set since the virtual
|
|
|
380 |
user has not yet been authenticated, or even looked up at this
|
|
|
381 |
point. For the same reason, `VUSER' is not authenticated and is
|
|
|
382 |
under complete control of the invoking user.
|
|
2
|
383 |
_________________________________________________________________
|
|
|
384 |
|
|
|
385 |
[ < ] [ > ] [ << ] [ Up ] [ >> ] [Top] [Contents] [Index] [
|
|
|
386 |
? ]
|
|
|
387 |
|
|
0
|
388 |
2.13 default-expiry
|
|
|
389 |
|
|
|
390 |
Type
|
|
|
391 |
number
|
|
|
392 |
Default
|
|
|
393 |
`-1'
|
|
|
394 |
Used By
|
|
|
395 |
vadduser
|
|
|
396 |
Description
|
|
|
397 |
Sets the default expiry value for newly created users. Negative
|
|
|
398 |
values indicate no expiry.
|
|
2
|
399 |
_________________________________________________________________
|
|
|
400 |
|
|
|
401 |
[ < ] [ > ] [ << ] [ Up ] [ >> ] [Top] [Contents] [Index] [
|
|
|
402 |
? ]
|
|
|
403 |
|
|
0
|
404 |
2.14 default-maildir
|
|
|
405 |
|
|
|
406 |
Type
|
|
|
407 |
directory
|
|
|
408 |
Default
|
|
|
409 |
`Maildir'
|
|
|
410 |
Used By
|
|
|
411 |
checkvpw
|
|
|
412 |
Description
|
|
|
413 |
Sets the name of the directory to be used as a non-virtual
|
|
|
414 |
user's maildir.
|
|
2
|
415 |
_________________________________________________________________
|
|
|
416 |
|
|
|
417 |
[ < ] [ > ] [ << ] [ Up ] [ >> ] [Top] [Contents] [Index] [
|
|
|
418 |
? ]
|
|
|
419 |
|
|
0
|
420 |
2.15 default-msgcount
|
|
|
421 |
|
|
|
422 |
Type
|
|
|
423 |
number
|
|
|
424 |
Default
|
|
|
425 |
`-1'
|
|
|
426 |
Used By
|
|
|
427 |
vadduser
|
|
|
428 |
Description
|
|
|
429 |
Sets the default message count limit.
|
|
2
|
430 |
_________________________________________________________________
|
|
|
431 |
|
|
|
432 |
[ < ] [ > ] [ << ] [ Up ] [ >> ] [Top] [Contents] [Index] [
|
|
|
433 |
? ]
|
|
|
434 |
|
|
0
|
435 |
2.16 default-msgsize
|
|
|
436 |
|
|
|
437 |
Type
|
|
|
438 |
number
|
|
|
439 |
Default
|
|
|
440 |
`-1'
|
|
|
441 |
Used By
|
|
|
442 |
vadduser
|
|
|
443 |
Description
|
|
|
444 |
Sets the default message size limit, in bytes.
|
|
2
|
445 |
_________________________________________________________________
|
|
|
446 |
|
|
|
447 |
[ < ] [ > ] [ << ] [ Up ] [ >> ] [Top] [Contents] [Index] [
|
|
|
448 |
? ]
|
|
|
449 |
|
|
0
|
450 |
2.17 default-hardquota
|
|
|
451 |
|
|
|
452 |
Type
|
|
|
453 |
number
|
|
|
454 |
Default
|
|
|
455 |
`-1'
|
|
|
456 |
Used By
|
|
|
457 |
vadduser
|
|
|
458 |
Description
|
|
|
459 |
Sets the default hard quota, in bytes.
|
|
2
|
460 |
_________________________________________________________________
|
|
|
461 |
|
|
|
462 |
[ < ] [ > ] [ << ] [ Up ] [ >> ] [Top] [Contents] [Index] [
|
|
|
463 |
? ]
|
|
|
464 |
|
|
0
|
465 |
2.18 default-softquota
|
|
|
466 |
|
|
|
467 |
Type
|
|
|
468 |
number
|
|
|
469 |
Default
|
|
|
470 |
`-1'
|
|
|
471 |
Used By
|
|
|
472 |
vadduser
|
|
|
473 |
Description
|
|
|
474 |
Sets the default soft quota, in bytes.
|
|
2
|
475 |
_________________________________________________________________
|
|
|
476 |
|
|
|
477 |
[ < ] [ > ] [ << ] [ Up ] [ >> ] [Top] [Contents] [Index] [
|
|
|
478 |
? ]
|
|
|
479 |
|
|
0
|
480 |
2.19 default-username
|
|
|
481 |
|
|
|
482 |
Type
|
|
|
483 |
string
|
|
|
484 |
Default
|
|
|
485 |
`+'
|
|
|
486 |
Used By
|
|
|
487 |
vmailmgrd
|
|
|
488 |
Description
|
|
|
489 |
Identifies the name of the virtual user to be looked up if a
|
|
|
490 |
lookup of another virtual user fails.
|
|
2
|
491 |
_________________________________________________________________
|
|
|
492 |
|
|
|
493 |
[ < ] [ > ] [ << ] [ Up ] [ >> ] [Top] [Contents] [Index] [
|
|
|
494 |
? ]
|
|
|
495 |
|
|
0
|
496 |
2.20 error-maildir
|
|
|
497 |
|
|
|
498 |
Type
|
|
|
499 |
directory
|
|
|
500 |
Default
|
|
|
501 |
`/var/lib/vmailmgr/error-maildir'
|
|
|
502 |
Used By
|
|
|
503 |
checkvpw
|
|
|
504 |
Description
|
|
|
505 |
Specifies the path of a read-only maildir containing a message
|
|
|
506 |
to be sent to the user when the maildir corresponding to that
|
|
|
507 |
user does not exist.
|
|
2
|
508 |
_________________________________________________________________
|
|
|
509 |
|
|
|
510 |
[ < ] [ > ] [ << ] [ Up ] [ >> ] [Top] [Contents] [Index] [
|
|
|
511 |
? ]
|
|
|
512 |
|
|
0
|
513 |
2.21 global-bulletin-dir
|
|
|
514 |
|
|
|
515 |
Type
|
|
|
516 |
directory
|
|
|
517 |
Default
|
|
|
518 |
`/var/spool/bulletins'
|
|
|
519 |
Used By
|
|
|
520 |
checkvpw
|
|
|
521 |
Description
|
|
|
522 |
Identifies a site-wide bulletin directory.
|
|
2
|
523 |
_________________________________________________________________
|
|
|
524 |
|
|
|
525 |
[ < ] [ > ] [ << ] [ Up ] [ >> ] [Top] [Contents] [Index] [
|
|
|
526 |
? ]
|
|
|
527 |
|
|
0
|
528 |
2.22 maildir-arg-str
|
|
|
529 |
|
|
|
530 |
Type
|
|
|
531 |
string
|
|
|
532 |
Default
|
|
|
533 |
`maildir'
|
|
|
534 |
Used By
|
|
|
535 |
checkvpw (global only)
|
|
|
536 |
Description
|
|
|
537 |
Identifies the string to search for when attempting to identify
|
|
|
538 |
the maildir argument on the command line to checkvpw.
|
|
2
|
539 |
_________________________________________________________________
|
|
|
540 |
|
|
|
541 |
[ < ] [ > ] [ << ] [ Up ] [ >> ] [Top] [Contents] [Index] [
|
|
|
542 |
? ]
|
|
|
543 |
|
|
0
|
544 |
2.23 password-file
|
|
|
545 |
|
|
|
546 |
Type
|
|
|
547 |
string
|
|
|
548 |
Default
|
|
|
549 |
`passwd'
|
|
|
550 |
Used By
|
|
|
551 |
vmailmgrd and command-line programs
|
|
|
552 |
Description
|
|
|
553 |
Identifies the file that contains user names, passwords, and
|
|
|
554 |
destinations for a virtual domain. Note that this has nothing
|
|
|
555 |
to do with "real" users, for which the password file is
|
|
|
556 |
determined by the system libraries.
|
|
2
|
557 |
_________________________________________________________________
|
|
|
558 |
|
|
|
559 |
[ < ] [ > ] [ << ] [ Up ] [ >> ] [Top] [Contents] [Index] [
|
|
|
560 |
? ]
|
|
|
561 |
|
|
0
|
562 |
2.24 postmaster-aliases
|
|
|
563 |
|
|
|
564 |
Type
|
|
|
565 |
list
|
|
|
566 |
Default
|
|
|
567 |
`mailer-daemon' `postmaster' `root'
|
|
|
568 |
Used By
|
|
|
569 |
vsetup
|
|
|
570 |
Description
|
|
|
571 |
A list of aliases to the postmaster email address to set up
|
|
|
572 |
when creating a new virtual domain with the vsetup command.
|
|
|
573 |
This should always contain both `postmaster' and
|
|
|
574 |
`mailer-daemon' (required by the RFCs), and should usually
|
|
|
575 |
contain `root'.
|
|
2
|
576 |
_________________________________________________________________
|
|
|
577 |
|
|
|
578 |
[ < ] [ > ] [ << ] [ Up ] [ >> ] [Top] [Contents] [Index] [
|
|
|
579 |
? ]
|
|
|
580 |
|
|
0
|
581 |
2.25 postmaster-email
|
|
|
582 |
|
|
|
583 |
Type
|
|
|
584 |
string
|
|
|
585 |
Default
|
|
|
586 |
`postmaster@'
|
|
|
587 |
Used By
|
|
|
588 |
vsetup
|
|
|
589 |
Description
|
|
|
590 |
Identifies the email address of the entity responsible for the
|
|
|
591 |
administration of the (virtual) host when building the
|
|
|
592 |
postmaster aliases above. If this value ends with a trailing
|
|
|
593 |
`@', the value of `/var/qmail/control/me' is filled in for the
|
|
|
594 |
host name. If no `@' is present, the current virtual host name
|
|
|
595 |
is filled in by vdeliver. If this is set to `postmaster', a
|
|
|
596 |
mail loop will result and all mail to this address will bounce.
|
|
2
|
597 |
_________________________________________________________________
|
|
|
598 |
|
|
|
599 |
[ < ] [ > ] [ << ] [ Up ] [ >> ] [Top] [Contents] [Index] [
|
|
|
600 |
? ]
|
|
|
601 |
|
|
0
|
602 |
2.26 qmail-root
|
|
|
603 |
|
|
|
604 |
Type
|
|
|
605 |
string
|
|
|
606 |
Default
|
|
|
607 |
`/var/qmail'
|
|
|
608 |
Used By
|
|
|
609 |
checkvpw, vdeliver, vmailmgrd
|
|
|
610 |
Description
|
|
|
611 |
Specifies the location of the base directory of your qmail
|
|
|
612 |
install. Set this to whatever you put into `conf-home' when you
|
|
|
613 |
built and installed qmail.
|
|
2
|
614 |
_________________________________________________________________
|
|
|
615 |
|
|
|
616 |
[ < ] [ > ] [ << ] [ Up ] [ >> ] [Top] [Contents] [Index] [
|
|
|
617 |
? ]
|
|
|
618 |
|
|
0
|
619 |
2.27 separators
|
|
|
620 |
|
|
|
621 |
Type
|
|
|
622 |
string
|
|
|
623 |
Default
|
|
|
624 |
`@:'
|
|
|
625 |
Used By
|
|
|
626 |
checkvpw (global only)
|
|
|
627 |
Description
|
|
|
628 |
Identifies the set of valid separators within a user login name
|
|
|
629 |
between the virtual user name and virtual domain name when
|
|
|
630 |
logging in via checkvpw. For example, if separators contains
|
|
|
631 |
`@:' then `user@domain' and `user:domain' are equivalent POP
|
|
|
632 |
mailbox names.
|
|
2
|
633 |
_________________________________________________________________
|
|
|
634 |
|
|
|
635 |
[ < ] [ > ] [ << ] [ Up ] [ >> ] [Top] [Contents] [Index] [
|
|
|
636 |
? ]
|
|
|
637 |
|
|
0
|
638 |
2.28 socket-file
|
|
|
639 |
|
|
|
640 |
Type
|
|
|
641 |
string
|
|
|
642 |
Default
|
|
|
643 |
`/tmp/.vmailmgrd'
|
|
|
644 |
Used By
|
|
|
645 |
vmailmgrd, checkvpw, vdeliver, and the CGI programs
|
|
|
646 |
Description
|
|
|
647 |
Identifies the file name of the local socket used to
|
|
|
648 |
communicate between the vmailmgr daemon and the other programs.
|
|
|
649 |
Warning: Changing this in the local configuration directories
|
|
|
650 |
will cause vdeliver to fail.
|
|
2
|
651 |
_________________________________________________________________
|
|
|
652 |
|
|
|
653 |
[ < ] [ > ] [ << ] [ Up ] [ >> ] [Top] [Contents] [Index] [
|
|
|
654 |
? ]
|
|
|
655 |
|
|
0
|
656 |
2.29 user-dir
|
|
|
657 |
|
|
|
658 |
Type
|
|
|
659 |
directory
|
|
|
660 |
Default
|
|
|
661 |
`users'
|
|
|
662 |
Used By
|
|
|
663 |
vmailmgrd and command-line programs
|
|
|
664 |
Description
|
|
|
665 |
Identifies the subdirectory from the virtual domain directory
|
|
|
666 |
in which a virtual user's maildir will be created. Since this
|
|
|
667 |
maildir is recorded in the password table, it does not have to
|
|
|
668 |
be the same for each user within a domain. This is prefixed
|
|
|
669 |
with `./' before it is used in the password table.
|
|
2
|
670 |
_________________________________________________________________
|
|
|
671 |
|
|
|
672 |
[ < ] [ > ] [ << ] [ Up ] [ >> ] [Top] [Contents] [Index] [
|
|
|
673 |
? ]
|
|
|
674 |
|
|
0
|
675 |
2.30 user-dir-bits
|
|
|
676 |
|
|
|
677 |
Type
|
|
|
678 |
Default
|
|
|
679 |
`0'
|
|
|
680 |
Used By
|
|
|
681 |
vmailmgrd and command-line programs when creating new users.
|
|
|
682 |
Description
|
|
2
|
683 |
See section 2.31 user-dir-slices.
|
|
|
684 |
_________________________________________________________________
|
|
|
685 |
|
|
|
686 |
[ < ] [ > ] [ << ] [ Up ] [ >> ] [Top] [Contents] [Index] [
|
|
|
687 |
? ]
|
|
|
688 |
|
|
0
|
689 |
2.31 user-dir-slices
|
|
|
690 |
|
|
|
691 |
Type
|
|
|
692 |
Default
|
|
|
693 |
`0'
|
|
|
694 |
Used By
|
|
|
695 |
vmailmgrd and command-line programs when creating new users.
|
|
|
696 |
Description
|
|
|
697 |
`user-dir-bits' and `user-dir-slices' work together. When
|
|
|
698 |
creating a new user directory name, a hash code is generated on
|
|
|
699 |
the name of the new user. This hash code is split into
|
|
|
700 |
`user-dir-slices' pieces, each `user-dir-bits' bits long. Each
|
|
|
701 |
of these pieces is translated to an ASCII string by converting
|
|
|
702 |
the binary code to hexadecimal. The resulting user directory
|
|
|
703 |
name is then composed of:
|
|
|
704 |
+ the base users directory, followed by a `/'
|
|
|
705 |
+ each of the string pieces, each followed by a `/'
|
|
|
706 |
+ the user's name
|
|
|
707 |
For example, with `user-dir-bits' set to 6 and
|
|
|
708 |
`user-dir-slices' set to 1, a user named `c' maps to a
|
|
|
709 |
directory name of `users/2f/c/'.
|
|
2
|
710 |
_________________________________________________________________
|
|
|
711 |
|
|
|
712 |
[ < ] [ > ] [ << ] [ Up ] [ >> ] [Top] [Contents] [Index] [
|
|
|
713 |
? ]
|
|
|
714 |
|
|
0
|
715 |
2.32 vdeliver-postdeliver
|
|
|
716 |
|
|
|
717 |
Type
|
|
|
718 |
executable
|
|
|
719 |
Default
|
|
|
720 |
Empty
|
|
|
721 |
Used By
|
|
|
722 |
vdeliver
|
|
|
723 |
Description
|
|
|
724 |
This list is executed after the delivery is successfully
|
|
|
725 |
completed. Since vdeliver expects `USER' and `HOME' to be set,
|
|
|
726 |
it does not set them itself. If the command returns with an
|
|
|
727 |
error code, a warning is printed, but delivery does not fail,
|
|
|
728 |
as failure would lead to duplicates.
|
|
2
|
729 |
_________________________________________________________________
|
|
|
730 |
|
|
|
731 |
[ < ] [ > ] [ << ] [ Up ] [ >> ] [Top] [Contents] [Index] [
|
|
|
732 |
? ]
|
|
|
733 |
|
|
0
|
734 |
2.33 vdeliver-predeliver
|
|
|
735 |
|
|
|
736 |
Type
|
|
|
737 |
executable
|
|
|
738 |
Default
|
|
|
739 |
Empty
|
|
|
740 |
Used By
|
|
|
741 |
vdeliver
|
|
|
742 |
Description
|
|
|
743 |
This list is executed before the delivery is attempted, but
|
|
|
744 |
after the virtual user information is looked up. Since vdeliver
|
|
|
745 |
expects `USER' and `HOME' to be set, it does not set them
|
|
|
746 |
itself.
|
|
2
|
747 |
_________________________________________________________________
|
|
|
748 |
|
|
|
749 |
[ < ] [ > ] [ << ] [ Up ] [ >> ] [Top] [Contents] [Index] [
|
|
|
750 |
? ]
|
|
|
751 |
|
|
|
752 |
2.34 vsetup-post
|
|
0
|
753 |
|
|
|
754 |
Type
|
|
|
755 |
executable
|
|
|
756 |
Default
|
|
|
757 |
Empty
|
|
|
758 |
Used By
|
|
|
759 |
vsetup
|
|
|
760 |
Description
|
|
|
761 |
This list is executed after the vsetup command has sucessfully
|
|
|
762 |
done everything else.
|
|
2
|
763 |
_________________________________________________________________
|
|
|
764 |
|
|
|
765 |
[ < ] [ > ] [ << ] [ Up ] [ >> ] [Top] [Contents] [Index] [
|
|
|
766 |
? ]
|
|
|
767 |
|
|
0
|
768 |
2.35 vsetup-pre
|
|
|
769 |
|
|
|
770 |
Type
|
|
|
771 |
executable
|
|
|
772 |
Default
|
|
|
773 |
Empty
|
|
|
774 |
Used By
|
|
|
775 |
vsetup
|
|
|
776 |
Description
|
|
|
777 |
This list is executed before the vsetup command makes any
|
|
|
778 |
changes.
|
|
|
779 |
_________________________________________________________________
|
|
2
|
780 |
|
|
|
781 |
[Top] [Contents] [Index] [ ? ]
|
|
|
782 |
|
|
|
783 |
Table of Contents
|
|
|
784 |
|
|
|
785 |
1. General Information
|
|
|
786 |
|
|
|
787 |
1.1 Search Order
|
|
|
788 |
1.2 File Types
|
|
|
789 |
1.3 Command Execution
|
|
|
790 |
|
|
|
791 |
2. Configuration Files
|
|
|
792 |
2.1 authvmailmgr-error
|
|
|
793 |
2.2 authvmailmgr-loginfail
|
|
|
794 |
2.3 authvmailmgr-postsetuid
|
|
|
795 |
2.4 authvmailmgr-presetuid
|
|
|
796 |
2.5 autoresponse-dir
|
|
|
797 |
2.6 autoresponse-file
|
|
|
798 |
2.7 bulletin-dir
|
|
|
799 |
2.8 checkvpw-error
|
|
|
800 |
2.9 checkvpw-loginfail
|
|
|
801 |
2.10 checkvpw-postexec
|
|
|
802 |
2.11 checkvpw-postsetuid
|
|
|
803 |
2.12 checkvpw-presetuid
|
|
|
804 |
2.13 default-expiry
|
|
|
805 |
2.14 default-maildir
|
|
|
806 |
2.15 default-msgcount
|
|
|
807 |
2.16 default-msgsize
|
|
|
808 |
2.17 default-hardquota
|
|
|
809 |
2.18 default-softquota
|
|
|
810 |
2.19 default-username
|
|
|
811 |
2.20 error-maildir
|
|
|
812 |
2.21 global-bulletin-dir
|
|
|
813 |
2.22 maildir-arg-str
|
|
|
814 |
2.23 password-file
|
|
|
815 |
2.24 postmaster-aliases
|
|
|
816 |
2.25 postmaster-email
|
|
|
817 |
2.26 qmail-root
|
|
|
818 |
2.27 separators
|
|
|
819 |
2.28 socket-file
|
|
|
820 |
2.29 user-dir
|
|
|
821 |
2.30 user-dir-bits
|
|
|
822 |
2.31 user-dir-slices
|
|
|
823 |
2.32 vdeliver-postdeliver
|
|
|
824 |
2.33 vdeliver-predeliver
|
|
|
825 |
2.34 vsetup-post
|
|
|
826 |
2.35 vsetup-pre
|
|
|
827 |
_________________________________________________________________
|
|
|
828 |
|
|
|
829 |
[Top] [Contents] [Index] [ ? ]
|
|
|
830 |
|
|
|
831 |
Short Table of Contents
|
|
|
832 |
|
|
|
833 |
1. General Information
|
|
|
834 |
2. Configuration Files
|
|
|
835 |
_________________________________________________________________
|
|
|
836 |
|
|
|
837 |
[Top] [Contents] [Index] [ ? ]
|
|
|
838 |
|
|
|
839 |
About this document
|
|
|
840 |
|
|
|
841 |
This document was generated by Bruce.Guenter.dyndns.org on December,
|
|
|
842 |
29 2004 using texi2html
|
|
|
843 |
|
|
|
844 |
The buttons in the navigation panels have the following meaning:
|
|
|
845 |
|
|
|
846 |
Button Name Go to From 1.2.3 go to
|
|
|
847 |
[ < ] Back previous section in reading order 1.2.2
|
|
|
848 |
[ > ] Forward next section in reading order 1.2.4
|
|
|
849 |
[ << ] FastBack previous or up-and-previous section 1.1
|
|
|
850 |
[ Up ] Up up section 1.2
|
|
|
851 |
[ >> ] FastForward next or up-and-next section 1.3
|
|
|
852 |
[Top] Top cover (top) of document
|
|
|
853 |
[Contents] Contents table of contents
|
|
|
854 |
[Index] Index concept index
|
|
|
855 |
[ ? ] About this page
|
|
|
856 |
|
|
|
857 |
where the Example assumes that the current position is at
|
|
|
858 |
Subsubsection One-Two-Three of a document of the following structure:
|
|
|
859 |
* 1. Section One
|
|
|
860 |
|
|
|
861 |
* 1.1 Subsection One-One
|
|
|
862 |
|
|
|
863 |
* ...
|
|
|
864 |
|
|
|
865 |
1.2 Subsection One-Two
|
|
|
866 |
* 1.2.1 Subsubsection One-Two-One
|
|
|
867 |
* 1.2.2 Subsubsection One-Two-Two
|
|
|
868 |
* 1.2.3 Subsubsection One-Two-Three <== Current Position
|
|
|
869 |
* 1.2.4 Subsubsection One-Two-Four
|
|
|
870 |
|
|
|
871 |
1.3 Subsection One-Three
|
|
|
872 |
* ...
|
|
|
873 |
|
|
|
874 |
1.4 Subsection One-Four
|
|
|
875 |
_________________________________________________________________
|
|
|
876 |
|
|
|
877 |
This document was generated by Bruce.Guenter.dyndns.org on December,
|
|
|
878 |
29 2004 using texi2html
|