|
0
|
1 |
<HTML>
|
|
|
2 |
<HEAD>
|
|
|
3 |
<!-- Created by texi2html 1.56k from vmailmgr-cgi.texi on 14 September 2000 -->
|
|
|
4 |
|
|
|
5 |
<TITLE>vmailmgr CGI Documentation</TITLE>
|
|
|
6 |
</HEAD>
|
|
|
7 |
<BODY>
|
|
|
8 |
<H1>vmailmgr CGI Documentation</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="vmailmgr-cgi.html#SEC1">1. Introduction</A>
|
|
|
16 |
<UL>
|
|
|
17 |
<LI><A NAME="TOC2" HREF="vmailmgr-cgi.html#SEC2">1.1 Common Form Configuration</A>
|
|
|
18 |
<UL>
|
|
|
19 |
<LI><A NAME="TOC3" HREF="vmailmgr-cgi.html#SEC3">1.1.1 Required Form Fields</A>
|
|
|
20 |
<LI><A NAME="TOC4" HREF="vmailmgr-cgi.html#SEC4">1.1.2 Optional Form Fields</A>
|
|
|
21 |
</UL>
|
|
|
22 |
</UL>
|
|
|
23 |
<LI><A NAME="TOC5" HREF="vmailmgr-cgi.html#SEC5">2. listvdomain</A>
|
|
|
24 |
<UL>
|
|
|
25 |
<LI><A NAME="TOC6" HREF="vmailmgr-cgi.html#SEC6">2.1 Overview</A>
|
|
|
26 |
<LI><A NAME="TOC7" HREF="vmailmgr-cgi.html#SEC7">2.2 Form Configuration</A>
|
|
|
27 |
<UL>
|
|
|
28 |
<LI><A NAME="TOC8" HREF="vmailmgr-cgi.html#SEC8">2.2.1 Required Form Fields</A>
|
|
|
29 |
<LI><A NAME="TOC9" HREF="vmailmgr-cgi.html#SEC9">2.2.2 Optional Form Fields</A>
|
|
|
30 |
</UL>
|
|
|
31 |
</UL>
|
|
|
32 |
<LI><A NAME="TOC10" HREF="vmailmgr-cgi.html#SEC10">3. vaddalias</A>
|
|
|
33 |
<UL>
|
|
|
34 |
<LI><A NAME="TOC11" HREF="vmailmgr-cgi.html#SEC11">3.1 Overview</A>
|
|
|
35 |
<LI><A NAME="TOC12" HREF="vmailmgr-cgi.html#SEC12">3.2 Form Configuration</A>
|
|
|
36 |
<UL>
|
|
|
37 |
<LI><A NAME="TOC13" HREF="vmailmgr-cgi.html#SEC13">3.2.1 Required Form Fields</A>
|
|
|
38 |
<LI><A NAME="TOC14" HREF="vmailmgr-cgi.html#SEC14">3.2.2 Optional Form Fields</A>
|
|
|
39 |
</UL>
|
|
|
40 |
</UL>
|
|
|
41 |
<LI><A NAME="TOC15" HREF="vmailmgr-cgi.html#SEC15">4. vadduser</A>
|
|
|
42 |
<UL>
|
|
|
43 |
<LI><A NAME="TOC16" HREF="vmailmgr-cgi.html#SEC16">4.1 Overview</A>
|
|
|
44 |
<LI><A NAME="TOC17" HREF="vmailmgr-cgi.html#SEC17">4.2 Form Configuration</A>
|
|
|
45 |
<UL>
|
|
|
46 |
<LI><A NAME="TOC18" HREF="vmailmgr-cgi.html#SEC18">4.2.1 Required Form Fields</A>
|
|
|
47 |
<LI><A NAME="TOC19" HREF="vmailmgr-cgi.html#SEC19">4.2.2 Optional Form Fields</A>
|
|
|
48 |
</UL>
|
|
|
49 |
</UL>
|
|
|
50 |
<LI><A NAME="TOC20" HREF="vmailmgr-cgi.html#SEC20">5. vchattr</A>
|
|
|
51 |
<UL>
|
|
|
52 |
<LI><A NAME="TOC21" HREF="vmailmgr-cgi.html#SEC21">5.1 Overview</A>
|
|
|
53 |
<LI><A NAME="TOC22" HREF="vmailmgr-cgi.html#SEC22">5.2 Form Configuration</A>
|
|
|
54 |
<UL>
|
|
|
55 |
<LI><A NAME="TOC23" HREF="vmailmgr-cgi.html#SEC23">5.2.1 Required Form Fields</A>
|
|
|
56 |
</UL>
|
|
|
57 |
</UL>
|
|
|
58 |
<LI><A NAME="TOC24" HREF="vmailmgr-cgi.html#SEC24">6. vchforwards</A>
|
|
|
59 |
<UL>
|
|
|
60 |
<LI><A NAME="TOC25" HREF="vmailmgr-cgi.html#SEC25">6.1 Overview</A>
|
|
|
61 |
<LI><A NAME="TOC26" HREF="vmailmgr-cgi.html#SEC26">6.2 Form Configuration</A>
|
|
|
62 |
<UL>
|
|
|
63 |
<LI><A NAME="TOC27" HREF="vmailmgr-cgi.html#SEC27">6.2.1 Required Form Fields</A>
|
|
|
64 |
<LI><A NAME="TOC28" HREF="vmailmgr-cgi.html#SEC28">6.2.2 Optional Form Fields</A>
|
|
|
65 |
</UL>
|
|
|
66 |
</UL>
|
|
|
67 |
<LI><A NAME="TOC29" HREF="vmailmgr-cgi.html#SEC29">7. vdeluser</A>
|
|
|
68 |
<UL>
|
|
|
69 |
<LI><A NAME="TOC30" HREF="vmailmgr-cgi.html#SEC30">7.1 Overview</A>
|
|
|
70 |
<LI><A NAME="TOC31" HREF="vmailmgr-cgi.html#SEC31">7.2 Form Configuration</A>
|
|
|
71 |
<UL>
|
|
|
72 |
<LI><A NAME="TOC32" HREF="vmailmgr-cgi.html#SEC32">7.2.1 Required Form Fields</A>
|
|
|
73 |
</UL>
|
|
|
74 |
</UL>
|
|
|
75 |
<LI><A NAME="TOC33" HREF="vmailmgr-cgi.html#SEC33">8. vpasswd</A>
|
|
|
76 |
<UL>
|
|
|
77 |
<LI><A NAME="TOC34" HREF="vmailmgr-cgi.html#SEC34">8.1 Overview</A>
|
|
|
78 |
<LI><A NAME="TOC35" HREF="vmailmgr-cgi.html#SEC35">8.2 Form Configuration</A>
|
|
|
79 |
<UL>
|
|
|
80 |
<LI><A NAME="TOC36" HREF="vmailmgr-cgi.html#SEC36">8.2.1 Required Form Fields</A>
|
|
|
81 |
</UL>
|
|
|
82 |
</UL>
|
|
|
83 |
</UL>
|
|
|
84 |
<P><HR><P>
|
|
|
85 |
|
|
|
86 |
|
|
|
87 |
<H1><A NAME="SEC1" HREF="vmailmgr-cgi.html#TOC1">1. Introduction</A></H1>
|
|
|
88 |
|
|
|
89 |
<P>
|
|
|
90 |
This is the documentation for the CGI programs for vmailmgr.
|
|
|
91 |
|
|
|
92 |
|
|
|
93 |
|
|
|
94 |
|
|
|
95 |
<H2><A NAME="SEC2" HREF="vmailmgr-cgi.html#TOC2">1.1 Common Form Configuration</A></H2>
|
|
|
96 |
|
|
|
97 |
<P>
|
|
|
98 |
The following form fields are common to all of the vmailmgr CGI
|
|
|
99 |
programs.
|
|
|
100 |
|
|
|
101 |
|
|
|
102 |
|
|
|
103 |
|
|
|
104 |
<H3><A NAME="SEC3" HREF="vmailmgr-cgi.html#TOC3">1.1.1 Required Form Fields</A></H3>
|
|
|
105 |
|
|
|
106 |
<DL COMPACT>
|
|
|
107 |
|
|
|
108 |
<DT><STRONG>Field:</STRONG>
|
|
|
109 |
<DD>
|
|
|
110 |
vdomain
|
|
|
111 |
<DT><STRONG>Description:</STRONG>
|
|
|
112 |
<DD>
|
|
|
113 |
This field specifies the name of the virtual domain under which to
|
|
|
114 |
perform this operation.
|
|
|
115 |
<DT><STRONG>Syntax:</STRONG>
|
|
|
116 |
<DD>
|
|
|
117 |
<SAMP>`<input type=hidden name=vdomain value="<VAR>domain-name</VAR>">'</SAMP>
|
|
|
118 |
or
|
|
|
119 |
<SAMP>`<input type=text name=vdomain>'</SAMP>
|
|
|
120 |
</DL>
|
|
|
121 |
|
|
|
122 |
<DL COMPACT>
|
|
|
123 |
|
|
|
124 |
<DT><STRONG>Field:</STRONG>
|
|
|
125 |
<DD>
|
|
|
126 |
password
|
|
|
127 |
<DT><STRONG>Description:</STRONG>
|
|
|
128 |
<DD>
|
|
|
129 |
Unless noted below, this field specifies the password of the
|
|
|
130 |
administrator for the given virtual domain.
|
|
|
131 |
<DT><STRONG>Syntax:</STRONG>
|
|
|
132 |
<DD>
|
|
|
133 |
<SAMP>`<input type=password name=password>'</SAMP>
|
|
|
134 |
</DL>
|
|
|
135 |
|
|
|
136 |
|
|
|
137 |
|
|
|
138 |
<H3><A NAME="SEC4" HREF="vmailmgr-cgi.html#TOC4">1.1.2 Optional Form Fields</A></H3>
|
|
|
139 |
|
|
|
140 |
<DL COMPACT>
|
|
|
141 |
|
|
|
142 |
<DT><STRONG>Field:</STRONG>
|
|
|
143 |
<DD>
|
|
|
144 |
error_redirect
|
|
|
145 |
<DT><STRONG>Description:</STRONG>
|
|
|
146 |
<DD>
|
|
|
147 |
If this field is set, any operation that results in an error will be
|
|
|
148 |
redirected to the given URL.
|
|
|
149 |
If not set, a pre-programmed document (which includes the error message)
|
|
|
150 |
will be output.
|
|
|
151 |
<DT><STRONG>Syntax:</STRONG>
|
|
|
152 |
<DD>
|
|
|
153 |
<SAMP>`<input type=hidden name=error_redirect value="<VAR>URL</VAR>">'</SAMP>
|
|
|
154 |
</DL>
|
|
|
155 |
|
|
|
156 |
<DL COMPACT>
|
|
|
157 |
|
|
|
158 |
<DT><STRONG>Field:</STRONG>
|
|
|
159 |
<DD>
|
|
|
160 |
redirect
|
|
|
161 |
<DT><STRONG>Description:</STRONG>
|
|
|
162 |
<DD>
|
|
|
163 |
If this field is set, any operation that completes successfully with be
|
|
|
164 |
redirected to the given URL.
|
|
|
165 |
If not set, a pre-programmed document (which includes the completion
|
|
|
166 |
message) will be output.
|
|
|
167 |
<DT><STRONG>Syntax:</STRONG>
|
|
|
168 |
<DD>
|
|
|
169 |
<SAMP>`<input type=hidden name=redirect value="<VAR>URL</VAR>">'</SAMP>
|
|
|
170 |
</DL>
|
|
|
171 |
|
|
|
172 |
|
|
|
173 |
|
|
|
174 |
<H1><A NAME="SEC5" HREF="vmailmgr-cgi.html#TOC5">2. listvdomain</A></H1>
|
|
|
175 |
|
|
|
176 |
|
|
|
177 |
|
|
|
178 |
<H2><A NAME="SEC6" HREF="vmailmgr-cgi.html#TOC6">2.1 Overview</A></H2>
|
|
|
179 |
|
|
|
180 |
<P>
|
|
|
181 |
This CGI program will list the mailboxes and aliases in a virtual domain
|
|
|
182 |
in a three-column table.
|
|
|
183 |
The first column lists the mailbox or alias name,
|
|
|
184 |
the second column is either <SAMP>`Alias'</SAMP> or <SAMP>`Mailbox'</SAMP>,
|
|
|
185 |
and the third column lists the destination.
|
|
|
186 |
|
|
|
187 |
|
|
|
188 |
|
|
|
189 |
|
|
|
190 |
<H2><A NAME="SEC7" HREF="vmailmgr-cgi.html#TOC7">2.2 Form Configuration</A></H2>
|
|
|
191 |
|
|
|
192 |
|
|
|
193 |
|
|
|
194 |
<H3><A NAME="SEC8" HREF="vmailmgr-cgi.html#TOC8">2.2.1 Required Form Fields</A></H3>
|
|
|
195 |
|
|
|
196 |
<P>
|
|
|
197 |
No additional form fields are Required.
|
|
|
198 |
|
|
|
199 |
|
|
|
200 |
|
|
|
201 |
|
|
|
202 |
<H3><A NAME="SEC9" HREF="vmailmgr-cgi.html#TOC9">2.2.2 Optional Form Fields</A></H3>
|
|
|
203 |
|
|
|
204 |
<DL COMPACT>
|
|
|
205 |
|
|
|
206 |
<DT><STRONG>Field:</STRONG>
|
|
|
207 |
<DD>
|
|
|
208 |
body-flags
|
|
|
209 |
<DT><STRONG>Description:</STRONG>
|
|
|
210 |
<DD>
|
|
|
211 |
If present, the contents of this field is inserted into the
|
|
|
212 |
<SAMP>`<body>'</SAMP> tag at the start of the document.
|
|
|
213 |
<DT><STRONG>Syntax:</STRONG>
|
|
|
214 |
<DD>
|
|
|
215 |
<SAMP>`<input type=hidden name=body-flags value="bgcolor=ffffff">'</SAMP>
|
|
|
216 |
</DL>
|
|
|
217 |
|
|
|
218 |
<DL COMPACT>
|
|
|
219 |
|
|
|
220 |
<DT><STRONG>Field:</STRONG>
|
|
|
221 |
<DD>
|
|
|
222 |
cell-align
|
|
|
223 |
<DT><STRONG>Description:</STRONG>
|
|
|
224 |
<DD>
|
|
|
225 |
Sets the cell alignment.
|
|
|
226 |
Defaults to <SAMP>`left'</SAMP>.
|
|
|
227 |
<DT><STRONG>Syntax:</STRONG>
|
|
|
228 |
<DD>
|
|
|
229 |
<SAMP>`<input type=hidden name=cell-align value=center>'</SAMP>
|
|
|
230 |
</DL>
|
|
|
231 |
|
|
|
232 |
<DL COMPACT>
|
|
|
233 |
|
|
|
234 |
<DT><STRONG>Field:</STRONG>
|
|
|
235 |
<DD>
|
|
|
236 |
cell-post
|
|
|
237 |
<DT><STRONG>Description:</STRONG>
|
|
|
238 |
<DD>
|
|
|
239 |
If present, the contents of this field will be output prior to every
|
|
|
240 |
<SAMP>`</td>'</SAMP> tag.
|
|
|
241 |
<DT><STRONG>Syntax:</STRONG>
|
|
|
242 |
<DD>
|
|
|
243 |
<SAMP>`<input type=hidden name=cell-post value="</font>">'</SAMP>
|
|
|
244 |
</DL>
|
|
|
245 |
|
|
|
246 |
<DL COMPACT>
|
|
|
247 |
|
|
|
248 |
<DT><STRONG>Field:</STRONG>
|
|
|
249 |
<DD>
|
|
|
250 |
cell-pre
|
|
|
251 |
<DT><STRONG>Description:</STRONG>
|
|
|
252 |
<DD>
|
|
|
253 |
If present, the contents of this field will be output after every
|
|
|
254 |
<SAMP>`<td>'</SAMP> tag.
|
|
|
255 |
<DT><STRONG>Syntax:</STRONG>
|
|
|
256 |
<DD>
|
|
|
257 |
<SAMP>`<input type=hidden name=cell-pre value="<font size=1 name=ariel>">'</SAMP>
|
|
|
258 |
</DL>
|
|
|
259 |
|
|
|
260 |
<DL COMPACT>
|
|
|
261 |
|
|
|
262 |
<DT><STRONG>Field:</STRONG>
|
|
|
263 |
<DD>
|
|
|
264 |
p-align
|
|
|
265 |
<DT><STRONG>Description:</STRONG>
|
|
|
266 |
<DD>
|
|
|
267 |
Sets the default paragraph alignment.
|
|
|
268 |
Defaults to <SAMP>`left'</SAMP>.
|
|
|
269 |
<DT><STRONG>Syntax:</STRONG>
|
|
|
270 |
<DD>
|
|
|
271 |
<SAMP>`<input type=hidden name=p-align value=center>'</SAMP>
|
|
|
272 |
</DL>
|
|
|
273 |
|
|
|
274 |
<DL COMPACT>
|
|
|
275 |
|
|
|
276 |
<DT><STRONG>Field:</STRONG>
|
|
|
277 |
<DD>
|
|
|
278 |
title-post
|
|
|
279 |
<DT><STRONG>Description:</STRONG>
|
|
|
280 |
<DD>
|
|
|
281 |
If present, the contents of this field are output after the title text.
|
|
|
282 |
Defaults to <SAMP>`</h1>'</SAMP>.
|
|
|
283 |
<DT><STRONG>Syntax:</STRONG>
|
|
|
284 |
<DD>
|
|
|
285 |
<SAMP>`<input type=hidden name=title-post value="</font>">'</SAMP>
|
|
|
286 |
</DL>
|
|
|
287 |
|
|
|
288 |
<DL COMPACT>
|
|
|
289 |
|
|
|
290 |
<DT><STRONG>Field:</STRONG>
|
|
|
291 |
<DD>
|
|
|
292 |
table-align
|
|
|
293 |
<DT><STRONG>Description:</STRONG>
|
|
|
294 |
<DD>
|
|
|
295 |
Sets the allignment of the table listing the users.
|
|
|
296 |
Defaults to <SAMP>`left'</SAMP>.
|
|
|
297 |
<DT><STRONG>Syntax:</STRONG>
|
|
|
298 |
<DD>
|
|
|
299 |
<SAMP>`<input type=hidden name=table-align value=center>'</SAMP>
|
|
|
300 |
</DL>
|
|
|
301 |
|
|
|
302 |
<DL COMPACT>
|
|
|
303 |
|
|
|
304 |
<DT><STRONG>Field:</STRONG>
|
|
|
305 |
<DD>
|
|
|
306 |
title-pre
|
|
|
307 |
<DT><STRONG>Description:</STRONG>
|
|
|
308 |
<DD>
|
|
|
309 |
If present, the contents of this field are output before the title text.
|
|
|
310 |
Defaults to <SAMP>`<h1>'</SAMP>.
|
|
|
311 |
<DT><STRONG>Syntax:</STRONG>
|
|
|
312 |
<DD>
|
|
|
313 |
<SAMP>`<input type=hidden name=title-pre value="<font size=3 face=verdana>">'</SAMP>
|
|
|
314 |
</DL>
|
|
|
315 |
|
|
|
316 |
<DL COMPACT>
|
|
|
317 |
|
|
|
318 |
<DT><STRONG>Field:</STRONG>
|
|
|
319 |
<DD>
|
|
|
320 |
userlink
|
|
|
321 |
<DT><STRONG>Description:</STRONG>
|
|
|
322 |
<DD>
|
|
|
323 |
If this field is present, all user names will be enclosed in a link to the
|
|
|
324 |
contents of this field. If the field contains a '%', it will be
|
|
|
325 |
replaced by the user name.
|
|
|
326 |
<DT><STRONG>Syntax:</STRONG>
|
|
|
327 |
<DD>
|
|
|
328 |
<SAMP>`<input type=hidden name=userlink value="/cgi-bin/admin-user?name=%">'</SAMP>
|
|
|
329 |
</DL>
|
|
|
330 |
|
|
|
331 |
|
|
|
332 |
|
|
|
333 |
<H1><A NAME="SEC10" HREF="vmailmgr-cgi.html#TOC10">3. vaddalias</A></H1>
|
|
|
334 |
|
|
|
335 |
|
|
|
336 |
|
|
|
337 |
<H2><A NAME="SEC11" HREF="vmailmgr-cgi.html#TOC11">3.1 Overview</A></H2>
|
|
|
338 |
|
|
|
339 |
<P>
|
|
|
340 |
This CGI program can be used to add an alias to a virtual domain.
|
|
|
341 |
|
|
|
342 |
|
|
|
343 |
|
|
|
344 |
|
|
|
345 |
<H2><A NAME="SEC12" HREF="vmailmgr-cgi.html#TOC12">3.2 Form Configuration</A></H2>
|
|
|
346 |
|
|
|
347 |
|
|
|
348 |
|
|
|
349 |
<H3><A NAME="SEC13" HREF="vmailmgr-cgi.html#TOC13">3.2.1 Required Form Fields</A></H3>
|
|
|
350 |
|
|
|
351 |
<DL COMPACT>
|
|
|
352 |
|
|
|
353 |
<DT><STRONG>Field:</STRONG>
|
|
|
354 |
<DD>
|
|
|
355 |
username
|
|
|
356 |
<DT><STRONG>Description:</STRONG>
|
|
|
357 |
<DD>
|
|
|
358 |
The virtual user name of the alias to create.
|
|
|
359 |
<DT><STRONG>Syntax:</STRONG>
|
|
|
360 |
<DD>
|
|
|
361 |
<SAMP>`<input type=text name=username>'</SAMP>
|
|
|
362 |
</DL>
|
|
|
363 |
|
|
|
364 |
<DL COMPACT>
|
|
|
365 |
|
|
|
366 |
<DT><STRONG>Field:</STRONG>
|
|
|
367 |
<DD>
|
|
|
368 |
destination
|
|
|
369 |
<DT><STRONG>Description:</STRONG>
|
|
|
370 |
<DD>
|
|
|
371 |
The destination address or addresses of the alias, separated by commas.
|
|
|
372 |
If an address does not contain a host name (separated from the user name
|
|
|
373 |
with an <SAMP>`@'</SAMP>), it is treated as local to the virtual domain and
|
|
|
374 |
must already exist.
|
|
|
375 |
<DT><STRONG>Syntax:</STRONG>
|
|
|
376 |
<DD>
|
|
|
377 |
<SAMP>`<input type=text name=destination>'</SAMP>
|
|
|
378 |
</DL>
|
|
|
379 |
|
|
|
380 |
|
|
|
381 |
|
|
|
382 |
<H3><A NAME="SEC14" HREF="vmailmgr-cgi.html#TOC14">3.2.2 Optional Form Fields</A></H3>
|
|
|
383 |
|
|
|
384 |
<DL COMPACT>
|
|
|
385 |
|
|
|
386 |
<DT><STRONG>Field:</STRONG>
|
|
|
387 |
<DD>
|
|
|
388 |
newpass1, newpass2
|
|
|
389 |
<DT><STRONG>Description:</STRONG>
|
|
|
390 |
<DD>
|
|
|
391 |
These two fields specify the new password of the user. They must match
|
|
|
392 |
for the password to be changed. The first eight characters are relevant,
|
|
|
393 |
and may be any combination of letters, digits, or punctuation symbols.
|
|
|
394 |
If these fields are not present or are empty, a null passcode is used.
|
|
|
395 |
<DT><STRONG>Syntax:</STRONG>
|
|
|
396 |
<DD>
|
|
|
397 |
<SAMP>`<input type=password name=newpass1><input type=password name=newpass1>'</SAMP>
|
|
|
398 |
</DL>
|
|
|
399 |
|
|
|
400 |
|
|
|
401 |
|
|
|
402 |
<H1><A NAME="SEC15" HREF="vmailmgr-cgi.html#TOC15">4. vadduser</A></H1>
|
|
|
403 |
|
|
|
404 |
|
|
|
405 |
|
|
|
406 |
<H2><A NAME="SEC16" HREF="vmailmgr-cgi.html#TOC16">4.1 Overview</A></H2>
|
|
|
407 |
|
|
|
408 |
<P>
|
|
|
409 |
This CGI program can be used to add a user mailbox to a virtual domain.
|
|
|
410 |
|
|
|
411 |
|
|
|
412 |
|
|
|
413 |
|
|
|
414 |
<H2><A NAME="SEC17" HREF="vmailmgr-cgi.html#TOC17">4.2 Form Configuration</A></H2>
|
|
|
415 |
|
|
|
416 |
|
|
|
417 |
|
|
|
418 |
<H3><A NAME="SEC18" HREF="vmailmgr-cgi.html#TOC18">4.2.1 Required Form Fields</A></H3>
|
|
|
419 |
|
|
|
420 |
<DL COMPACT>
|
|
|
421 |
|
|
|
422 |
<DT><STRONG>Field:</STRONG>
|
|
|
423 |
<DD>
|
|
|
424 |
username
|
|
|
425 |
<DT><STRONG>Description:</STRONG>
|
|
|
426 |
<DD>
|
|
|
427 |
The virtual user name of the alias to create.
|
|
|
428 |
<DT><STRONG>Syntax:</STRONG>
|
|
|
429 |
<DD>
|
|
|
430 |
<SAMP>`<input type=text name=username>'</SAMP>
|
|
|
431 |
</DL>
|
|
|
432 |
|
|
|
433 |
<DL COMPACT>
|
|
|
434 |
|
|
|
435 |
<DT><STRONG>Field:</STRONG>
|
|
|
436 |
<DD>
|
|
|
437 |
newpass1, newpass2
|
|
|
438 |
<DT><STRONG>Description:</STRONG>
|
|
|
439 |
<DD>
|
|
|
440 |
These two fields specify the new password of the user. They must match
|
|
|
441 |
for the password to be changed. The first eight characters are relevant,
|
|
|
442 |
and may be any combination of letters, digits, or punctuation symbols.
|
|
|
443 |
<DT><STRONG>Syntax:</STRONG>
|
|
|
444 |
<DD>
|
|
|
445 |
<SAMP>`<input type=password name=newpass1><input type=password name=newpass1>'</SAMP>
|
|
|
446 |
</DL>
|
|
|
447 |
|
|
|
448 |
|
|
|
449 |
|
|
|
450 |
<H3><A NAME="SEC19" HREF="vmailmgr-cgi.html#TOC19">4.2.2 Optional Form Fields</A></H3>
|
|
|
451 |
|
|
|
452 |
<DL COMPACT>
|
|
|
453 |
|
|
|
454 |
<DT><STRONG>Field:</STRONG>
|
|
|
455 |
<DD>
|
|
|
456 |
destination
|
|
|
457 |
<DT><STRONG>Description:</STRONG>
|
|
|
458 |
<DD>
|
|
|
459 |
The destination address or addresses to direct a copy of incoming mail,
|
|
|
460 |
separated by commas.
|
|
|
461 |
If an address does not contain a host name (separated from the user name
|
|
|
462 |
with an <SAMP>`@'</SAMP>), it is treated as local to the virtual domain and
|
|
|
463 |
must already exist.
|
|
|
464 |
If this field is not present or blank, no forwarding will be done.
|
|
|
465 |
<DT><STRONG>Syntax:</STRONG>
|
|
|
466 |
<DD>
|
|
|
467 |
<SAMP>`<input type=text name=destination>'</SAMP>
|
|
|
468 |
</DL>
|
|
|
469 |
|
|
|
470 |
<DL COMPACT>
|
|
|
471 |
|
|
|
472 |
<DT><STRONG>Field:</STRONG>
|
|
|
473 |
<DD>
|
|
|
474 |
userdir
|
|
|
475 |
<DT><STRONG>Description:</STRONG>
|
|
|
476 |
<DD>
|
|
|
477 |
This field can be used to specify the user mail directory name relative
|
|
|
478 |
to the virtual domain's users directory.
|
|
|
479 |
If this field is not present, the directory name will be the same as the
|
|
|
480 |
user name.
|
|
|
481 |
<DT><STRONG>Syntax:</STRONG>
|
|
|
482 |
<DD>
|
|
|
483 |
<SAMP>`<input type=text name=userdir>'</SAMP>
|
|
|
484 |
</DL>
|
|
|
485 |
|
|
|
486 |
|
|
|
487 |
|
|
|
488 |
<H1><A NAME="SEC20" HREF="vmailmgr-cgi.html#TOC20">5. vchattr</A></H1>
|
|
|
489 |
|
|
|
490 |
|
|
|
491 |
|
|
|
492 |
<H2><A NAME="SEC21" HREF="vmailmgr-cgi.html#TOC21">5.1 Overview</A></H2>
|
|
|
493 |
|
|
|
494 |
<P>
|
|
|
495 |
This CGI program can be used to change the attributes of an existing
|
|
|
496 |
user in a virtual domain.
|
|
|
497 |
|
|
|
498 |
|
|
|
499 |
|
|
|
500 |
|
|
|
501 |
<H2><A NAME="SEC22" HREF="vmailmgr-cgi.html#TOC22">5.2 Form Configuration</A></H2>
|
|
|
502 |
|
|
|
503 |
|
|
|
504 |
|
|
|
505 |
<H3><A NAME="SEC23" HREF="vmailmgr-cgi.html#TOC23">5.2.1 Required Form Fields</A></H3>
|
|
|
506 |
|
|
|
507 |
<DL COMPACT>
|
|
|
508 |
|
|
|
509 |
<DT><STRONG>Field:</STRONG>
|
|
|
510 |
<DD>
|
|
|
511 |
username
|
|
|
512 |
<DT><STRONG>Description:</STRONG>
|
|
|
513 |
<DD>
|
|
|
514 |
The virtual user name to modify.
|
|
|
515 |
<DT><STRONG>Syntax:</STRONG>
|
|
|
516 |
<DD>
|
|
|
517 |
<SAMP>`<input type=text name=username>'</SAMP>
|
|
|
518 |
</DL>
|
|
|
519 |
|
|
|
520 |
<DL COMPACT>
|
|
|
521 |
|
|
|
522 |
<DT><STRONG>Field:</STRONG>
|
|
|
523 |
<DD>
|
|
|
524 |
attribute
|
|
|
525 |
<DT><STRONG>Description:</STRONG>
|
|
|
526 |
<DD>
|
|
|
527 |
The number of the attribute to modify.
|
|
|
528 |
The possible values are:
|
|
|
529 |
<DL COMPACT>
|
|
|
530 |
|
|
|
531 |
<DT><SAMP>`1'</SAMP>
|
|
|
532 |
<DD>
|
|
|
533 |
The password.
|
|
|
534 |
Use the <TT>`vpasswd'</TT> CGI to do this.
|
|
|
535 |
<DT><SAMP>`2'</SAMP>
|
|
|
536 |
<DD>
|
|
|
537 |
The forwarding destination.
|
|
|
538 |
Use the <TT>`vchforwards'</TT> to do this.
|
|
|
539 |
<DT><SAMP>`3'</SAMP>
|
|
|
540 |
<DD>
|
|
|
541 |
The hard quota.
|
|
|
542 |
<DT><SAMP>`4'</SAMP>
|
|
|
543 |
<DD>
|
|
|
544 |
The soft quota.
|
|
|
545 |
<DT><SAMP>`5'</SAMP>
|
|
|
546 |
<DD>
|
|
|
547 |
The message size limit.
|
|
|
548 |
<DT><SAMP>`6'</SAMP>
|
|
|
549 |
<DD>
|
|
|
550 |
The message count limit.
|
|
|
551 |
<DT><SAMP>`7'</SAMP>
|
|
|
552 |
<DD>
|
|
|
553 |
The account's expiry time.
|
|
|
554 |
<DT><SAMP>`8'</SAMP>
|
|
|
555 |
<DD>
|
|
|
556 |
Set to zero to disable delivery to the account's mailbox (without
|
|
|
557 |
deleting the account).
|
|
|
558 |
Set to non-zero to enable delivery.
|
|
|
559 |
<DT><SAMP>`9'</SAMP>
|
|
|
560 |
<DD>
|
|
|
561 |
The personal information string.
|
|
|
562 |
</DL>
|
|
|
563 |
<DT><STRONG>Syntax:</STRONG>
|
|
|
564 |
<DD>
|
|
|
565 |
<SAMP>`<input type=hidden name=attribute value=2>'</SAMP>
|
|
|
566 |
</DL>
|
|
|
567 |
|
|
|
568 |
<DL COMPACT>
|
|
|
569 |
|
|
|
570 |
<DT><STRONG>Field:</STRONG>
|
|
|
571 |
<DD>
|
|
|
572 |
newvalue
|
|
|
573 |
<DT><STRONG>Description:</STRONG>
|
|
|
574 |
<DD>
|
|
|
575 |
The new value for the given attribute.
|
|
|
576 |
The format of this new value is dependant on the type of the attribute.
|
|
|
577 |
<DT><STRONG>Syntax:</STRONG>
|
|
|
578 |
<DD>
|
|
|
579 |
<SAMP>`<input type=text name=newvalue>'</SAMP>
|
|
|
580 |
</DL>
|
|
|
581 |
|
|
|
582 |
|
|
|
583 |
|
|
|
584 |
<H1><A NAME="SEC24" HREF="vmailmgr-cgi.html#TOC24">6. vchforwards</A></H1>
|
|
|
585 |
|
|
|
586 |
|
|
|
587 |
|
|
|
588 |
<H2><A NAME="SEC25" HREF="vmailmgr-cgi.html#TOC25">6.1 Overview</A></H2>
|
|
|
589 |
|
|
|
590 |
<P>
|
|
|
591 |
This CGI program can be used to change the forwarding destination of an
|
|
|
592 |
existing user.
|
|
|
593 |
|
|
|
594 |
|
|
|
595 |
|
|
|
596 |
|
|
|
597 |
<H2><A NAME="SEC26" HREF="vmailmgr-cgi.html#TOC26">6.2 Form Configuration</A></H2>
|
|
|
598 |
|
|
|
599 |
|
|
|
600 |
|
|
|
601 |
<H3><A NAME="SEC27" HREF="vmailmgr-cgi.html#TOC27">6.2.1 Required Form Fields</A></H3>
|
|
|
602 |
|
|
|
603 |
<DL COMPACT>
|
|
|
604 |
|
|
|
605 |
<DT><STRONG>Field:</STRONG>
|
|
|
606 |
<DD>
|
|
|
607 |
username
|
|
|
608 |
<DT><STRONG>Description:</STRONG>
|
|
|
609 |
<DD>
|
|
|
610 |
The virtual user name to modify.
|
|
|
611 |
<DT><STRONG>Syntax:</STRONG>
|
|
|
612 |
<DD>
|
|
|
613 |
<SAMP>`<input type=text name=username>'</SAMP>
|
|
|
614 |
</DL>
|
|
|
615 |
|
|
|
616 |
<DL COMPACT>
|
|
|
617 |
|
|
|
618 |
<DT><STRONG>Field:</STRONG>
|
|
|
619 |
<DD>
|
|
|
620 |
destination
|
|
|
621 |
<DT><STRONG>Description:</STRONG>
|
|
|
622 |
<DD>
|
|
|
623 |
The destination address or addresses of the alias, separated by commas.
|
|
|
624 |
If an address does not contain a host name (separated from the user name
|
|
|
625 |
with an <SAMP>`@'</SAMP>), it is treated as local to the virtual domain and
|
|
|
626 |
must already exist.
|
|
|
627 |
<DT><STRONG>Syntax:</STRONG>
|
|
|
628 |
<DD>
|
|
|
629 |
<SAMP>`<input type=text name=destination>'</SAMP>
|
|
|
630 |
</DL>
|
|
|
631 |
|
|
|
632 |
|
|
|
633 |
|
|
|
634 |
<H3><A NAME="SEC28" HREF="vmailmgr-cgi.html#TOC28">6.2.2 Optional Form Fields</A></H3>
|
|
|
635 |
|
|
|
636 |
<DL COMPACT>
|
|
|
637 |
|
|
|
638 |
<DT><STRONG>Field:</STRONG>
|
|
|
639 |
<DD>
|
|
|
640 |
enable
|
|
|
641 |
<DT><STRONG>Description:</STRONG>
|
|
|
642 |
<DD>
|
|
|
643 |
Set this field to <SAMP>`0'</SAMP> to cause mailbox delivery to this account to
|
|
|
644 |
be disabled after changing the alias.
|
|
|
645 |
Set it to any number except <SAMP>`0'</SAMP> to cause mailbox delivery to be
|
|
|
646 |
enabled before changing the alias.
|
|
|
647 |
If it is not set, the mailbox is neither enabled nor disabled.
|
|
|
648 |
<DT><STRONG>Syntax:</STRONG>
|
|
|
649 |
<DD>
|
|
|
650 |
<SAMP>`<select name=enable>
|
|
|
651 |
<option value=0>Disable
|
|
|
652 |
<option value=1>Enable
|
|
|
653 |
</select>'</SAMP>
|
|
|
654 |
</DL>
|
|
|
655 |
|
|
|
656 |
|
|
|
657 |
|
|
|
658 |
<H1><A NAME="SEC29" HREF="vmailmgr-cgi.html#TOC29">7. vdeluser</A></H1>
|
|
|
659 |
|
|
|
660 |
|
|
|
661 |
|
|
|
662 |
<H2><A NAME="SEC30" HREF="vmailmgr-cgi.html#TOC30">7.1 Overview</A></H2>
|
|
|
663 |
|
|
|
664 |
<P>
|
|
|
665 |
This CGI program deletes a user from a virtual domain.
|
|
|
666 |
|
|
|
667 |
|
|
|
668 |
|
|
|
669 |
|
|
|
670 |
<H2><A NAME="SEC31" HREF="vmailmgr-cgi.html#TOC31">7.2 Form Configuration</A></H2>
|
|
|
671 |
|
|
|
672 |
|
|
|
673 |
|
|
|
674 |
<H3><A NAME="SEC32" HREF="vmailmgr-cgi.html#TOC32">7.2.1 Required Form Fields</A></H3>
|
|
|
675 |
|
|
|
676 |
<DL COMPACT>
|
|
|
677 |
|
|
|
678 |
<DT><STRONG>Field:</STRONG>
|
|
|
679 |
<DD>
|
|
|
680 |
username
|
|
|
681 |
<DT><STRONG>Description:</STRONG>
|
|
|
682 |
<DD>
|
|
|
683 |
The virtual user name of the user to delete.
|
|
|
684 |
<DT><STRONG>Syntax:</STRONG>
|
|
|
685 |
<DD>
|
|
|
686 |
<SAMP>`<input type=text name=username>'</SAMP>
|
|
|
687 |
</DL>
|
|
|
688 |
|
|
|
689 |
|
|
|
690 |
|
|
|
691 |
<H1><A NAME="SEC33" HREF="vmailmgr-cgi.html#TOC33">8. vpasswd</A></H1>
|
|
|
692 |
|
|
|
693 |
|
|
|
694 |
|
|
|
695 |
<H2><A NAME="SEC34" HREF="vmailmgr-cgi.html#TOC34">8.1 Overview</A></H2>
|
|
|
696 |
|
|
|
697 |
<P>
|
|
|
698 |
This CGI program can be used to change the password of a user either by
|
|
|
699 |
the user themself or by the domain administrator.
|
|
|
700 |
|
|
|
701 |
|
|
|
702 |
|
|
|
703 |
|
|
|
704 |
<H2><A NAME="SEC35" HREF="vmailmgr-cgi.html#TOC35">8.2 Form Configuration</A></H2>
|
|
|
705 |
|
|
|
706 |
<P>
|
|
|
707 |
The password field used by this CGI may match either the password of the
|
|
|
708 |
virtual domain administrator or that of the user being modified.
|
|
|
709 |
|
|
|
710 |
|
|
|
711 |
|
|
|
712 |
|
|
|
713 |
<H3><A NAME="SEC36" HREF="vmailmgr-cgi.html#TOC36">8.2.1 Required Form Fields</A></H3>
|
|
|
714 |
|
|
|
715 |
<DL COMPACT>
|
|
|
716 |
|
|
|
717 |
<DT><STRONG>Field:</STRONG>
|
|
|
718 |
<DD>
|
|
|
719 |
username
|
|
|
720 |
<DT><STRONG>Description:</STRONG>
|
|
|
721 |
<DD>
|
|
|
722 |
This field specifies the name of the user that is to be modified.
|
|
|
723 |
<DT><STRONG>Syntax:</STRONG>
|
|
|
724 |
<DD>
|
|
|
725 |
<SAMP>`<input type=text name=username>'</SAMP>
|
|
|
726 |
</DL>
|
|
|
727 |
|
|
|
728 |
<DL COMPACT>
|
|
|
729 |
|
|
|
730 |
<DT><STRONG>Field:</STRONG>
|
|
|
731 |
<DD>
|
|
|
732 |
newpass1, newpass2
|
|
|
733 |
<DT><STRONG>Description:</STRONG>
|
|
|
734 |
<DD>
|
|
|
735 |
These two fields specify the new password of the user.
|
|
|
736 |
They must match for the password to be changed.
|
|
|
737 |
The password may contain any combination of
|
|
|
738 |
letters, digits, or punctuation symbols.
|
|
|
739 |
<DT><STRONG>Syntax:</STRONG>
|
|
|
740 |
<DD>
|
|
|
741 |
<SAMP>`<input type=password name=newpass1> <input type=password name=newpass2>'</SAMP>
|
|
|
742 |
</DL>
|
|
|
743 |
|
|
|
744 |
<P><HR><P>
|
|
|
745 |
This document was generated on 14 September 2000 using
|
|
|
746 |
<A HREF="http://wwwinfo.cern.ch/dis/texi2html/">texi2html</A> 1.56k.
|
|
|
747 |
</BODY>
|
|
|
748 |
</HTML>
|