--- a/doc/vmailmgr-cgi.txt Sun Jan 20 00:12:17 2008 +0100
+++ b/doc/vmailmgr-cgi.txt Sun Jan 20 00:22:09 2008 +0100
@@ -1,63 +1,30 @@
+ [Top] [Contents] [Index] [ ? ]
vmailmgr CGI Documentation
-
-14 September 2000
-
-
- Bruce Guenter
_________________________________________________________________
-
- Table of Contents
-
- * 1. Introduction
- + 1.1 Common Form Configuration
- o 1.1.1 Required Form Fields
- o 1.1.2 Optional Form Fields
- * 2. listvdomain
- + 2.1 Overview
- + 2.2 Form Configuration
- o 2.2.1 Required Form Fields
- o 2.2.2 Optional Form Fields
- * 3. vaddalias
- + 3.1 Overview
- + 3.2 Form Configuration
- o 3.2.1 Required Form Fields
- o 3.2.2 Optional Form Fields
- * 4. vadduser
- + 4.1 Overview
- + 4.2 Form Configuration
- o 4.2.1 Required Form Fields
- o 4.2.2 Optional Form Fields
- * 5. vchattr
- + 5.1 Overview
- + 5.2 Form Configuration
- o 5.2.1 Required Form Fields
- * 6. vchforwards
- + 6.1 Overview
- + 6.2 Form Configuration
- o 6.2.1 Required Form Fields
- o 6.2.2 Optional Form Fields
- * 7. vdeluser
- + 7.1 Overview
- + 7.2 Form Configuration
- o 7.2.1 Required Form Fields
- * 8. vpasswd
- + 8.1 Overview
- + 8.2 Form Configuration
- o 8.2.1 Required Form Fields
+
+ [ < ] [ > ] [ << ] [ Up ] [ >> ] [Top] [Contents] [Index] [
+ ? ]
+
+ 1. Introduction
+
+ This is the documentation for the CGI programs for vmailmgr.
_________________________________________________________________
-
- 1. Introduction
-
- This is the documentation for the CGI programs for vmailmgr.
-
+
+ [ < ] [ > ] [ << ] [ Up ] [ >> ] [Top] [Contents] [Index] [
+ ? ]
+
1.1 Common Form Configuration
The following form fields are common to all of the vmailmgr CGI
programs.
-
+ _________________________________________________________________
+
+ [ < ] [ > ] [ << ] [ Up ] [ >> ] [Top] [Contents] [Index] [
+ ? ]
+
1.1.1 Required Form Fields
-
+
Field:
vdomain
Description:
@@ -66,7 +33,7 @@
Syntax:
`<input type=hidden name=vdomain value="domain-name">' or
`<input type=text name=vdomain>'
-
+
Field:
password
Description:
@@ -74,9 +41,13 @@
administrator for the given virtual domain.
Syntax:
`<input type=password name=password>'
-
+ _________________________________________________________________
+
+ [ < ] [ > ] [ << ] [ Up ] [ >> ] [Top] [Contents] [Index] [
+ ? ]
+
1.1.2 Optional Form Fields
-
+
Field:
error_redirect
Description:
@@ -86,7 +57,7 @@
be output.
Syntax:
`<input type=hidden name=error_redirect value="URL">'
-
+
Field:
redirect
Description:
@@ -96,24 +67,44 @@
will be output.
Syntax:
`<input type=hidden name=redirect value="URL">'
-
+ _________________________________________________________________
+
+ [ < ] [ > ] [ << ] [ Up ] [ >> ] [Top] [Contents] [Index] [
+ ? ]
+
2. listvdomain
-
+ _________________________________________________________________
+
+ [ < ] [ > ] [ << ] [ Up ] [ >> ] [Top] [Contents] [Index] [
+ ? ]
+
2.1 Overview
This CGI program will list the mailboxes and aliases in a virtual
domain in a three-column table. The first column lists the mailbox or
alias name, the second column is either `Alias' or `Mailbox', and the
third column lists the destination.
-
+ _________________________________________________________________
+
+ [ < ] [ > ] [ << ] [ Up ] [ >> ] [Top] [Contents] [Index] [
+ ? ]
+
2.2 Form Configuration
+ _________________________________________________________________
+
+ [ < ] [ > ] [ << ] [ Up ] [ >> ] [Top] [Contents] [Index] [
+ ? ]
2.2.1 Required Form Fields
-
+
No additional form fields are Required.
-
+ _________________________________________________________________
+
+ [ < ] [ > ] [ << ] [ Up ] [ >> ] [Top] [Contents] [Index] [
+ ? ]
+
2.2.2 Optional Form Fields
-
+
Field:
body-flags
Description:
@@ -121,14 +112,14 @@
`<body>' tag at the start of the document.
Syntax:
`<input type=hidden name=body-flags value="bgcolor=ffffff">'
-
+
Field:
cell-align
Description:
Sets the cell alignment. Defaults to `left'.
Syntax:
`<input type=hidden name=cell-align value=center>'
-
+
Field:
cell-post
Description:
@@ -136,7 +127,7 @@
every `</td>' tag.
Syntax:
`<input type=hidden name=cell-post value="</font>">'
-
+
Field:
cell-pre
Description:
@@ -145,14 +136,14 @@
Syntax:
`<input type=hidden name=cell-pre value="<font size=1
name=ariel>">'
-
+
Field:
p-align
Description:
Sets the default paragraph alignment. Defaults to `left'.
Syntax:
`<input type=hidden name=p-align value=center>'
-
+
Field:
title-post
Description:
@@ -160,7 +151,7 @@
title text. Defaults to `</h1>'.
Syntax:
`<input type=hidden name=title-post value="</font>">'
-
+
Field:
table-align
Description:
@@ -168,7 +159,7 @@
`left'.
Syntax:
`<input type=hidden name=table-align value=center>'
-
+
Field:
title-pre
Description:
@@ -177,7 +168,7 @@
Syntax:
`<input type=hidden name=title-pre value="<font size=3
face=verdana>">'
-
+
Field:
userlink
Description:
@@ -187,24 +178,40 @@
Syntax:
`<input type=hidden name=userlink
value="/cgi-bin/admin-user?name=%">'
-
+ _________________________________________________________________
+
+ [ < ] [ > ] [ << ] [ Up ] [ >> ] [Top] [Contents] [Index] [
+ ? ]
+
3. vaddalias
-
+ _________________________________________________________________
+
+ [ < ] [ > ] [ << ] [ Up ] [ >> ] [Top] [Contents] [Index] [
+ ? ]
+
3.1 Overview
This CGI program can be used to add an alias to a virtual domain.
-
+ _________________________________________________________________
+
+ [ < ] [ > ] [ << ] [ Up ] [ >> ] [Top] [Contents] [Index] [
+ ? ]
+
3.2 Form Configuration
+ _________________________________________________________________
+
+ [ < ] [ > ] [ << ] [ Up ] [ >> ] [Top] [Contents] [Index] [
+ ? ]
3.2.1 Required Form Fields
-
+
Field:
username
Description:
The virtual user name of the alias to create.
Syntax:
`<input type=text name=username>'
-
+
Field:
destination
Description:
@@ -214,9 +221,13 @@
virtual domain and must already exist.
Syntax:
`<input type=text name=destination>'
-
+ _________________________________________________________________
+
+ [ < ] [ > ] [ << ] [ Up ] [ >> ] [Top] [Contents] [Index] [
+ ? ]
+
3.2.2 Optional Form Fields
-
+
Field:
newpass1, newpass2
Description:
@@ -228,25 +239,41 @@
Syntax:
`<input type=password name=newpass1><input type=password
name=newpass1>'
-
+ _________________________________________________________________
+
+ [ < ] [ > ] [ << ] [ Up ] [ >> ] [Top] [Contents] [Index] [
+ ? ]
+
4. vadduser
-
+ _________________________________________________________________
+
+ [ < ] [ > ] [ << ] [ Up ] [ >> ] [Top] [Contents] [Index] [
+ ? ]
+
4.1 Overview
This CGI program can be used to add a user mailbox to a virtual
domain.
-
+ _________________________________________________________________
+
+ [ < ] [ > ] [ << ] [ Up ] [ >> ] [Top] [Contents] [Index] [
+ ? ]
+
4.2 Form Configuration
+ _________________________________________________________________
+
+ [ < ] [ > ] [ << ] [ Up ] [ >> ] [Top] [Contents] [Index] [
+ ? ]
4.2.1 Required Form Fields
-
+
Field:
username
Description:
The virtual user name of the alias to create.
Syntax:
`<input type=text name=username>'
-
+
Field:
newpass1, newpass2
Description:
@@ -257,9 +284,13 @@
Syntax:
`<input type=password name=newpass1><input type=password
name=newpass1>'
-
+ _________________________________________________________________
+
+ [ < ] [ > ] [ << ] [ Up ] [ >> ] [Top] [Contents] [Index] [
+ ? ]
+
4.2.2 Optional Form Fields
-
+
Field:
destination
Description:
@@ -271,7 +302,7 @@
will be done.
Syntax:
`<input type=text name=destination>'
-
+
Field:
userdir
Description:
@@ -281,25 +312,41 @@
name.
Syntax:
`<input type=text name=userdir>'
-
+ _________________________________________________________________
+
+ [ < ] [ > ] [ << ] [ Up ] [ >> ] [Top] [Contents] [Index] [
+ ? ]
+
5. vchattr
-
+ _________________________________________________________________
+
+ [ < ] [ > ] [ << ] [ Up ] [ >> ] [Top] [Contents] [Index] [
+ ? ]
+
5.1 Overview
This CGI program can be used to change the attributes of an existing
user in a virtual domain.
-
+ _________________________________________________________________
+
+ [ < ] [ > ] [ << ] [ Up ] [ >> ] [Top] [Contents] [Index] [
+ ? ]
+
5.2 Form Configuration
+ _________________________________________________________________
+
+ [ < ] [ > ] [ << ] [ Up ] [ >> ] [Top] [Contents] [Index] [
+ ? ]
5.2.1 Required Form Fields
-
+
Field:
username
Description:
The virtual user name to modify.
Syntax:
`<input type=text name=username>'
-
+
Field:
attribute
Description:
@@ -327,7 +374,7 @@
The personal information string.
Syntax:
`<input type=hidden name=attribute value=2>'
-
+
Field:
newvalue
Description:
@@ -335,25 +382,41 @@
value is dependant on the type of the attribute.
Syntax:
`<input type=text name=newvalue>'
-
+ _________________________________________________________________
+
+ [ < ] [ > ] [ << ] [ Up ] [ >> ] [Top] [Contents] [Index] [
+ ? ]
+
6. vchforwards
-
+ _________________________________________________________________
+
+ [ < ] [ > ] [ << ] [ Up ] [ >> ] [Top] [Contents] [Index] [
+ ? ]
+
6.1 Overview
This CGI program can be used to change the forwarding destination of
an existing user.
-
+ _________________________________________________________________
+
+ [ < ] [ > ] [ << ] [ Up ] [ >> ] [Top] [Contents] [Index] [
+ ? ]
+
6.2 Form Configuration
+ _________________________________________________________________
+
+ [ < ] [ > ] [ << ] [ Up ] [ >> ] [Top] [Contents] [Index] [
+ ? ]
6.2.1 Required Form Fields
-
+
Field:
username
Description:
The virtual user name to modify.
Syntax:
`<input type=text name=username>'
-
+
Field:
destination
Description:
@@ -363,9 +426,13 @@
virtual domain and must already exist.
Syntax:
`<input type=text name=destination>'
-
+ _________________________________________________________________
+
+ [ < ] [ > ] [ << ] [ Up ] [ >> ] [Top] [Contents] [Index] [
+ ? ]
+
6.2.2 Optional Form Fields
-
+
Field:
enable
Description:
@@ -377,38 +444,70 @@
Syntax:
`<select name=enable> <option value=0>Disable <option
value=1>Enable </select>'
-
+ _________________________________________________________________
+
+ [ < ] [ > ] [ << ] [ Up ] [ >> ] [Top] [Contents] [Index] [
+ ? ]
+
7. vdeluser
-
+ _________________________________________________________________
+
+ [ < ] [ > ] [ << ] [ Up ] [ >> ] [Top] [Contents] [Index] [
+ ? ]
+
7.1 Overview
This CGI program deletes a user from a virtual domain.
-
+ _________________________________________________________________
+
+ [ < ] [ > ] [ << ] [ Up ] [ >> ] [Top] [Contents] [Index] [
+ ? ]
+
7.2 Form Configuration
+ _________________________________________________________________
+
+ [ < ] [ > ] [ << ] [ Up ] [ >> ] [Top] [Contents] [Index] [
+ ? ]
7.2.1 Required Form Fields
-
+
Field:
username
Description:
The virtual user name of the user to delete.
Syntax:
`<input type=text name=username>'
-
+ _________________________________________________________________
+
+ [ < ] [ > ] [ << ] [ Up ] [ >> ] [Top] [Contents] [Index] [
+ ? ]
+
8. vpasswd
-
+ _________________________________________________________________
+
+ [ < ] [ > ] [ << ] [ Up ] [ >> ] [Top] [Contents] [Index] [
+ ? ]
+
8.1 Overview
This CGI program can be used to change the password of a user either
by the user themself or by the domain administrator.
-
+ _________________________________________________________________
+
+ [ < ] [ > ] [ << ] [ Up ] [ >> ] [Top] [Contents] [Index] [
+ ? ]
+
8.2 Form Configuration
The password field used by this CGI may match either the password of
the virtual domain administrator or that of the user being modified.
-
+ _________________________________________________________________
+
+ [ < ] [ > ] [ << ] [ Up ] [ >> ] [Top] [Contents] [Index] [
+ ? ]
+
8.2.1 Required Form Fields
-
+
Field:
username
Description:
@@ -416,7 +515,7 @@
modified.
Syntax:
`<input type=text name=username>'
-
+
Field:
newpass1, newpass2
Description:
@@ -428,6 +527,118 @@
`<input type=password name=newpass1> <input type=password
name=newpass2>'
_________________________________________________________________
-
- This document was generated on 14 September 2000 using
- texi2html 1.56k.
+
+ [Top] [Contents] [Index] [ ? ]
+
+ Table of Contents
+
+ 1. Introduction
+
+ 1.1 Common Form Configuration
+
+ 1.1.1 Required Form Fields
+ 1.1.2 Optional Form Fields
+
+ 2. listvdomain
+ 2.1 Overview
+ 2.2 Form Configuration
+
+ 2.2.1 Required Form Fields
+ 2.2.2 Optional Form Fields
+
+ 3. vaddalias
+ 3.1 Overview
+ 3.2 Form Configuration
+
+ 3.2.1 Required Form Fields
+ 3.2.2 Optional Form Fields
+
+ 4. vadduser
+ 4.1 Overview
+ 4.2 Form Configuration
+
+ 4.2.1 Required Form Fields
+ 4.2.2 Optional Form Fields
+
+ 5. vchattr
+ 5.1 Overview
+ 5.2 Form Configuration
+
+ 5.2.1 Required Form Fields
+
+ 6. vchforwards
+ 6.1 Overview
+ 6.2 Form Configuration
+
+ 6.2.1 Required Form Fields
+ 6.2.2 Optional Form Fields
+
+ 7. vdeluser
+ 7.1 Overview
+ 7.2 Form Configuration
+
+ 7.2.1 Required Form Fields
+
+ 8. vpasswd
+ 8.1 Overview
+ 8.2 Form Configuration
+
+ 8.2.1 Required Form Fields
+ _________________________________________________________________
+
+ [Top] [Contents] [Index] [ ? ]
+
+ Short Table of Contents
+
+ 1. Introduction
+ 2. listvdomain
+ 3. vaddalias
+ 4. vadduser
+ 5. vchattr
+ 6. vchforwards
+ 7. vdeluser
+ 8. vpasswd
+ _________________________________________________________________
+
+ [Top] [Contents] [Index] [ ? ]
+
+ About this document
+
+ This document was generated by Bruce.Guenter.dyndns.org on December,
+ 29 2004 using texi2html
+
+ The buttons in the navigation panels have the following meaning:
+
+ Button Name Go to From 1.2.3 go to
+ [ < ] Back previous section in reading order 1.2.2
+ [ > ] Forward next section in reading order 1.2.4
+ [ << ] FastBack previous or up-and-previous section 1.1
+ [ Up ] Up up section 1.2
+ [ >> ] FastForward next or up-and-next section 1.3
+ [Top] Top cover (top) of document
+ [Contents] Contents table of contents
+ [Index] Index concept index
+ [ ? ] About this page
+
+ where the Example assumes that the current position is at
+ Subsubsection One-Two-Three of a document of the following structure:
+ * 1. Section One
+
+ * 1.1 Subsection One-One
+
+ * ...
+
+ 1.2 Subsection One-Two
+ * 1.2.1 Subsubsection One-Two-One
+ * 1.2.2 Subsubsection One-Two-Two
+ * 1.2.3 Subsubsection One-Two-Three <== Current Position
+ * 1.2.4 Subsubsection One-Two-Four
+
+ 1.3 Subsection One-Three
+ * ...
+
+ 1.4 Subsection One-Four
+ _________________________________________________________________
+
+ This document was generated by Bruce.Guenter.dyndns.org on December,
+ 29 2004 using texi2html