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