|
1 \input texinfo @c -*-texinfo-*- |
|
2 @c %**start of header |
|
3 @setfilename vmailmgr-cgi.info |
|
4 @settitle vmailmgr CGI Documentation |
|
5 @setchapternewpage off |
|
6 @paragraphindent 5 |
|
7 @c %**end of header |
|
8 @footnotestyle end |
|
9 |
|
10 @ifinfo |
|
11 Copyright @copyright{} 1998 Bruce Guenter |
|
12 @end ifinfo |
|
13 |
|
14 @titlepage |
|
15 @title vmailmgr CGI Documentation |
|
16 @author Bruce Guenter |
|
17 @subtitle @today{} |
|
18 @end titlepage |
|
19 |
|
20 @node Top, , (dir), (dir) |
|
21 |
|
22 @c **************************************************************************** |
|
23 @chapter Introduction |
|
24 |
|
25 This is the documentation for the CGI programs for vmailmgr. |
|
26 |
|
27 @c ============================================================================ |
|
28 @section Common Form Configuration |
|
29 |
|
30 The following form fields are common to all of the vmailmgr CGI |
|
31 programs. |
|
32 |
|
33 @c ---------------------------------------------------------------------------- |
|
34 @subsection Required Form Fields |
|
35 |
|
36 @table @strong |
|
37 @item Field: |
|
38 vdomain |
|
39 @item Description: |
|
40 This field specifies the name of the virtual domain under which to |
|
41 perform this operation. |
|
42 @item Syntax: |
|
43 @samp{<input type=hidden name=vdomain value="@var{domain-name}">} |
|
44 or |
|
45 @samp{<input type=text name=vdomain>} |
|
46 @end table |
|
47 |
|
48 @table @strong |
|
49 @item Field: |
|
50 password |
|
51 @item Description: |
|
52 Unless noted below, this field specifies the password of the |
|
53 administrator for the given virtual domain. |
|
54 @item Syntax: |
|
55 @samp{<input type=password name=password>} |
|
56 @end table |
|
57 |
|
58 @c ---------------------------------------------------------------------------- |
|
59 @subsection Optional Form Fields |
|
60 |
|
61 @table @strong |
|
62 @item Field: |
|
63 error_redirect |
|
64 @item Description: |
|
65 If this field is set, any operation that results in an error will be |
|
66 redirected to the given URL. |
|
67 If not set, a pre-programmed document (which includes the error message) |
|
68 will be output. |
|
69 @item Syntax: |
|
70 @samp{<input type=hidden name=error_redirect value="@var{URL}">} |
|
71 @end table |
|
72 |
|
73 @table @strong |
|
74 @item Field: |
|
75 redirect |
|
76 @item Description: |
|
77 If this field is set, any operation that completes successfully with be |
|
78 redirected to the given URL. |
|
79 If not set, a pre-programmed document (which includes the completion |
|
80 message) will be output. |
|
81 @item Syntax: |
|
82 @samp{<input type=hidden name=redirect value="@var{URL}">} |
|
83 @end table |
|
84 |
|
85 @c **************************************************************************** |
|
86 @chapter listvdomain |
|
87 |
|
88 @c ============================================================================ |
|
89 @section Overview |
|
90 |
|
91 This CGI program will list the mailboxes and aliases in a virtual domain |
|
92 in a three-column table. |
|
93 The first column lists the mailbox or alias name, |
|
94 the second column is either @samp{Alias} or @samp{Mailbox}, |
|
95 and the third column lists the destination. |
|
96 |
|
97 @c ============================================================================ |
|
98 @section Form Configuration |
|
99 |
|
100 @c ---------------------------------------------------------------------------- |
|
101 @subsection Required Form Fields |
|
102 |
|
103 No additional form fields are Required. |
|
104 |
|
105 @c ---------------------------------------------------------------------------- |
|
106 @subsection Optional Form Fields |
|
107 |
|
108 @table @strong |
|
109 @item Field: |
|
110 body-flags |
|
111 @item Description: |
|
112 If present, the contents of this field is inserted into the |
|
113 @samp{<body>} tag at the start of the document. |
|
114 @item Syntax: |
|
115 @samp{<input type=hidden name=body-flags value="bgcolor=ffffff">} |
|
116 @end table |
|
117 |
|
118 @table @strong |
|
119 @item Field: |
|
120 cell-align |
|
121 @item Description: |
|
122 Sets the cell alignment. |
|
123 Defaults to @samp{left}. |
|
124 @item Syntax: |
|
125 @samp{<input type=hidden name=cell-align value=center>} |
|
126 @end table |
|
127 |
|
128 @table @strong |
|
129 @item Field: |
|
130 cell-post |
|
131 @item Description: |
|
132 If present, the contents of this field will be output prior to every |
|
133 @samp{</td>} tag. |
|
134 @item Syntax: |
|
135 @samp{<input type=hidden name=cell-post value="</font>">} |
|
136 @end table |
|
137 |
|
138 @table @strong |
|
139 @item Field: |
|
140 cell-pre |
|
141 @item Description: |
|
142 If present, the contents of this field will be output after every |
|
143 @samp{<td>} tag. |
|
144 @item Syntax: |
|
145 @samp{<input type=hidden name=cell-pre value="<font size=1 name=ariel>">} |
|
146 @end table |
|
147 |
|
148 @table @strong |
|
149 @item Field: |
|
150 p-align |
|
151 @item Description: |
|
152 Sets the default paragraph alignment. |
|
153 Defaults to @samp{left}. |
|
154 @item Syntax: |
|
155 @samp{<input type=hidden name=p-align value=center>} |
|
156 @end table |
|
157 |
|
158 @table @strong |
|
159 @item Field: |
|
160 title-post |
|
161 @item Description: |
|
162 If present, the contents of this field are output after the title text. |
|
163 Defaults to @samp{</h1>}. |
|
164 @item Syntax: |
|
165 @samp{<input type=hidden name=title-post value="</font>">} |
|
166 @end table |
|
167 |
|
168 @table @strong |
|
169 @item Field: |
|
170 table-align |
|
171 @item Description: |
|
172 Sets the allignment of the table listing the users. |
|
173 Defaults to @samp{left}. |
|
174 @item Syntax: |
|
175 @samp{<input type=hidden name=table-align value=center>} |
|
176 @end table |
|
177 |
|
178 @table @strong |
|
179 @item Field: |
|
180 title-pre |
|
181 @item Description: |
|
182 If present, the contents of this field are output before the title text. |
|
183 Defaults to @samp{<h1>}. |
|
184 @item Syntax: |
|
185 @samp{<input type=hidden name=title-pre value="<font size=3 face=verdana>">} |
|
186 @end table |
|
187 |
|
188 @table @strong |
|
189 @item Field: |
|
190 userlink |
|
191 @item Description: |
|
192 If this field is present, all user names will be enclosed in a link to the |
|
193 contents of this field. If the field contains a '%', it will be |
|
194 replaced by the user name. |
|
195 @item Syntax: |
|
196 @samp{<input type=hidden name=userlink value="/cgi-bin/admin-user?name=%">} |
|
197 @end table |
|
198 |
|
199 @c **************************************************************************** |
|
200 @chapter vaddalias |
|
201 |
|
202 @c ============================================================================ |
|
203 @section Overview |
|
204 |
|
205 This CGI program can be used to add an alias to a virtual domain. |
|
206 |
|
207 @c ============================================================================ |
|
208 @section Form Configuration |
|
209 |
|
210 @c ---------------------------------------------------------------------------- |
|
211 @subsection Required Form Fields |
|
212 |
|
213 @table @strong |
|
214 @item Field: |
|
215 username |
|
216 @item Description: |
|
217 The virtual user name of the alias to create. |
|
218 @item Syntax: |
|
219 @samp{<input type=text name=username>} |
|
220 @end table |
|
221 |
|
222 @table @strong |
|
223 @item Field: |
|
224 destination |
|
225 @item Description: |
|
226 The destination address or addresses of the alias, separated by commas. |
|
227 If an address does not contain a host name (separated from the user name |
|
228 with an @samp{@@}), it is treated as local to the virtual domain and |
|
229 must already exist. |
|
230 @item Syntax: |
|
231 @samp{<input type=text name=destination>} |
|
232 @end table |
|
233 |
|
234 @c ---------------------------------------------------------------------------- |
|
235 @subsection Optional Form Fields |
|
236 |
|
237 @table @strong |
|
238 @item Field: |
|
239 newpass1, newpass2 |
|
240 @item Description: |
|
241 These two fields specify the new password of the user. They must match |
|
242 for the password to be changed. The first eight characters are relevant, |
|
243 and may be any combination of letters, digits, or punctuation symbols. |
|
244 If these fields are not present or are empty, a null passcode is used. |
|
245 @item Syntax: |
|
246 @samp{<input type=password name=newpass1><input type=password name=newpass1>} |
|
247 @end table |
|
248 |
|
249 @c **************************************************************************** |
|
250 @chapter vadduser |
|
251 |
|
252 @c ============================================================================ |
|
253 @section Overview |
|
254 |
|
255 This CGI program can be used to add a user mailbox to a virtual domain. |
|
256 |
|
257 @c ============================================================================ |
|
258 @section Form Configuration |
|
259 |
|
260 @c ---------------------------------------------------------------------------- |
|
261 @subsection Required Form Fields |
|
262 |
|
263 @table @strong |
|
264 @item Field: |
|
265 username |
|
266 @item Description: |
|
267 The virtual user name of the alias to create. |
|
268 @item Syntax: |
|
269 @samp{<input type=text name=username>} |
|
270 @end table |
|
271 |
|
272 @table @strong |
|
273 @item Field: |
|
274 newpass1, newpass2 |
|
275 @item Description: |
|
276 These two fields specify the new password of the user. They must match |
|
277 for the password to be changed. The first eight characters are relevant, |
|
278 and may be any combination of letters, digits, or punctuation symbols. |
|
279 @item Syntax: |
|
280 @samp{<input type=password name=newpass1><input type=password name=newpass1>} |
|
281 @end table |
|
282 |
|
283 @c ---------------------------------------------------------------------------- |
|
284 @subsection Optional Form Fields |
|
285 |
|
286 @table @strong |
|
287 @item Field: |
|
288 destination |
|
289 @item Description: |
|
290 The destination address or addresses to direct a copy of incoming mail, |
|
291 separated by commas. |
|
292 If an address does not contain a host name (separated from the user name |
|
293 with an @samp{@@}), it is treated as local to the virtual domain and |
|
294 must already exist. |
|
295 If this field is not present or blank, no forwarding will be done. |
|
296 @item Syntax: |
|
297 @samp{<input type=text name=destination>} |
|
298 @end table |
|
299 |
|
300 @table @strong |
|
301 @item Field: |
|
302 userdir |
|
303 @item Description: |
|
304 This field can be used to specify the user mail directory name relative |
|
305 to the virtual domain's users directory. |
|
306 If this field is not present, the directory name will be the same as the |
|
307 user name. |
|
308 @item Syntax: |
|
309 @samp{<input type=text name=userdir>} |
|
310 @end table |
|
311 |
|
312 @c **************************************************************************** |
|
313 @chapter vchattr |
|
314 |
|
315 @c ============================================================================ |
|
316 @section Overview |
|
317 |
|
318 This CGI program can be used to change the attributes of an existing |
|
319 user in a virtual domain. |
|
320 |
|
321 @c ============================================================================ |
|
322 @section Form Configuration |
|
323 |
|
324 @c ---------------------------------------------------------------------------- |
|
325 @subsection Required Form Fields |
|
326 |
|
327 @table @strong |
|
328 @item Field: |
|
329 username |
|
330 @item Description: |
|
331 The virtual user name to modify. |
|
332 @item Syntax: |
|
333 @samp{<input type=text name=username>} |
|
334 @end table |
|
335 |
|
336 @table @strong |
|
337 @item Field: |
|
338 attribute |
|
339 @item Description: |
|
340 The number of the attribute to modify. |
|
341 The possible values are: |
|
342 @table @samp |
|
343 @item 1 |
|
344 The password. |
|
345 Use the @file{vpasswd} CGI to do this. |
|
346 @item 2 |
|
347 The forwarding destination. |
|
348 Use the @file{vchforwards} to do this. |
|
349 @item 3 |
|
350 The hard quota. |
|
351 @item 4 |
|
352 The soft quota. |
|
353 @item 5 |
|
354 The message size limit. |
|
355 @item 6 |
|
356 The message count limit. |
|
357 @item 7 |
|
358 The account's expiry time. |
|
359 @item 8 |
|
360 Set to zero to disable delivery to the account's mailbox (without |
|
361 deleting the account). |
|
362 Set to non-zero to enable delivery. |
|
363 @item 9 |
|
364 The personal information string. |
|
365 @end table |
|
366 @item Syntax: |
|
367 @samp{<input type=hidden name=attribute value=2>} |
|
368 @end table |
|
369 |
|
370 @table @strong |
|
371 @item Field: |
|
372 newvalue |
|
373 @item Description: |
|
374 The new value for the given attribute. |
|
375 The format of this new value is dependant on the type of the attribute. |
|
376 @item Syntax: |
|
377 @samp{<input type=text name=newvalue>} |
|
378 @end table |
|
379 |
|
380 @c **************************************************************************** |
|
381 @chapter vchforwards |
|
382 |
|
383 @c ============================================================================ |
|
384 @section Overview |
|
385 |
|
386 This CGI program can be used to change the forwarding destination of an |
|
387 existing user. |
|
388 |
|
389 @c ============================================================================ |
|
390 @section Form Configuration |
|
391 |
|
392 @c ---------------------------------------------------------------------------- |
|
393 @subsection Required Form Fields |
|
394 |
|
395 @table @strong |
|
396 @item Field: |
|
397 username |
|
398 @item Description: |
|
399 The virtual user name to modify. |
|
400 @item Syntax: |
|
401 @samp{<input type=text name=username>} |
|
402 @end table |
|
403 |
|
404 @table @strong |
|
405 @item Field: |
|
406 destination |
|
407 @item Description: |
|
408 The destination address or addresses of the alias, separated by commas. |
|
409 If an address does not contain a host name (separated from the user name |
|
410 with an @samp{@@}), it is treated as local to the virtual domain and |
|
411 must already exist. |
|
412 @item Syntax: |
|
413 @samp{<input type=text name=destination>} |
|
414 @end table |
|
415 |
|
416 @c ---------------------------------------------------------------------------- |
|
417 @subsection Optional Form Fields |
|
418 |
|
419 @table @strong |
|
420 @item Field: |
|
421 enable |
|
422 @item Description: |
|
423 Set this field to @samp{0} to cause mailbox delivery to this account to |
|
424 be disabled after changing the alias. |
|
425 Set it to any number except @samp{0} to cause mailbox delivery to be |
|
426 enabled before changing the alias. |
|
427 If it is not set, the mailbox is neither enabled nor disabled. |
|
428 @item Syntax: |
|
429 @samp{<select name=enable> |
|
430 <option value=0>Disable |
|
431 <option value=1>Enable |
|
432 </select>} |
|
433 @end table |
|
434 |
|
435 @c **************************************************************************** |
|
436 @chapter vdeluser |
|
437 |
|
438 @c ============================================================================ |
|
439 @section Overview |
|
440 |
|
441 This CGI program deletes a user from a virtual domain. |
|
442 |
|
443 @c ============================================================================ |
|
444 @section Form Configuration |
|
445 |
|
446 @c ---------------------------------------------------------------------------- |
|
447 @subsection Required Form Fields |
|
448 |
|
449 @table @strong |
|
450 @item Field: |
|
451 username |
|
452 @item Description: |
|
453 The virtual user name of the user to delete. |
|
454 @item Syntax: |
|
455 @samp{<input type=text name=username>} |
|
456 @end table |
|
457 |
|
458 @c **************************************************************************** |
|
459 @chapter vpasswd |
|
460 |
|
461 @c ============================================================================ |
|
462 @section Overview |
|
463 |
|
464 This CGI program can be used to change the password of a user either by |
|
465 the user themself or by the domain administrator. |
|
466 |
|
467 @c ============================================================================ |
|
468 @section Form Configuration |
|
469 |
|
470 The password field used by this CGI may match either the password of the |
|
471 virtual domain administrator or that of the user being modified. |
|
472 |
|
473 @c ---------------------------------------------------------------------------- |
|
474 @subsection Required Form Fields |
|
475 |
|
476 @table @strong |
|
477 @item Field: |
|
478 username |
|
479 @item Description: |
|
480 This field specifies the name of the user that is to be modified. |
|
481 @item Syntax: |
|
482 @samp{<input type=text name=username>} |
|
483 @end table |
|
484 |
|
485 @table @strong |
|
486 @item Field: |
|
487 newpass1, newpass2 |
|
488 @item Description: |
|
489 These two fields specify the new password of the user. |
|
490 They must match for the password to be changed. |
|
491 The password may contain any combination of |
|
492 letters, digits, or punctuation symbols. |
|
493 @item Syntax: |
|
494 @samp{<input type=password name=newpass1> <input type=password name=newpass2>} |
|
495 @end table |
|
496 |
|
497 @c **************************************************************************** |
|
498 @contents |
|
499 |
|
500 @bye |
|
501 |
|
502 @c **************************************************************************** |
|
503 @chapter template |
|
504 |
|
505 @c ============================================================================ |
|
506 @section Overview |
|
507 |
|
508 This CGI program ... |
|
509 |
|
510 @c ============================================================================ |
|
511 @section Form Configuration |
|
512 |
|
513 @c ---------------------------------------------------------------------------- |
|
514 @subsection Required Form Fields |
|
515 |
|
516 @table @strong |
|
517 @item Field: |
|
518 fieldname |
|
519 @item Description: |
|
520 @item Syntax: |
|
521 @end table |
|
522 |
|
523 @c ---------------------------------------------------------------------------- |
|
524 @subsection Optional Form Fields |
|
525 |
|
526 @table @strong |
|
527 @item Field: |
|
528 fieldname |
|
529 @item Description: |
|
530 @item Syntax: |
|
531 @end table |
|
532 |