1 

     2                           vmailmgr CGI Documentation

     3                                        

     4 14 September 2000

     5 

     6    

     7     Bruce Guenter

     8      _________________________________________________________________

     9    

    10                                Table of Contents

    11                                        

    12      * 1. Introduction

    13           + 1.1 Common Form Configuration

    14                o 1.1.1 Required Form Fields

    15                o 1.1.2 Optional Form Fields

    16      * 2. listvdomain

    17           + 2.1 Overview

    18           + 2.2 Form Configuration

    19                o 2.2.1 Required Form Fields

    20                o 2.2.2 Optional Form Fields

    21      * 3. vaddalias

    22           + 3.1 Overview

    23           + 3.2 Form Configuration

    24                o 3.2.1 Required Form Fields

    25                o 3.2.2 Optional Form Fields

    26      * 4. vadduser

    27           + 4.1 Overview

    28           + 4.2 Form Configuration

    29                o 4.2.1 Required Form Fields

    30                o 4.2.2 Optional Form Fields

    31      * 5. vchattr

    32           + 5.1 Overview

    33           + 5.2 Form Configuration

    34                o 5.2.1 Required Form Fields

    35      * 6. vchforwards

    36           + 6.1 Overview

    37           + 6.2 Form Configuration

    38                o 6.2.1 Required Form Fields

    39                o 6.2.2 Optional Form Fields

    40      * 7. vdeluser

    41           + 7.1 Overview

    42           + 7.2 Form Configuration

    43                o 7.2.1 Required Form Fields

    44      * 8. vpasswd

    45           + 8.1 Overview

    46           + 8.2 Form Configuration

    47                o 8.2.1 Required Form Fields

    48      _________________________________________________________________

    49    

    50                                 1. Introduction

    51                                        

    52    This is the documentation for the CGI programs for vmailmgr.

    53    

    54 1.1 Common Form Configuration

    55 

    56    The following form fields are common to all of the vmailmgr CGI

    57    programs.

    58    

    59   1.1.1 Required Form Fields

    60   

    61    Field:

    62           vdomain

    63    Description:

    64           This field specifies the name of the virtual domain under which

    65           to perform this operation.

    66    Syntax:

    67           `<input type=hidden name=vdomain value="domain-name">' or

    68           `<input type=text name=vdomain>'

    69           

    70    Field:

    71           password

    72    Description:

    73           Unless noted below, this field specifies the password of the

    74           administrator for the given virtual domain.

    75    Syntax:

    76           `<input type=password name=password>'

    77           

    78   1.1.2 Optional Form Fields

    79   

    80    Field:

    81           error_redirect

    82    Description:

    83           If this field is set, any operation that results in an error

    84           will be redirected to the given URL. If not set, a

    85           pre-programmed document (which includes the error message) will

    86           be output.

    87    Syntax:

    88           `<input type=hidden name=error_redirect value="URL">'

    89           

    90    Field:

    91           redirect

    92    Description:

    93           If this field is set, any operation that completes successfully

    94           with be redirected to the given URL. If not set, a

    95           pre-programmed document (which includes the completion message)

    96           will be output.

    97    Syntax:

    98           `<input type=hidden name=redirect value="URL">'

    99           

   100                                 2. listvdomain

   101                                        

   102 2.1 Overview

   103 

   104    This CGI program will list the mailboxes and aliases in a virtual

   105    domain in a three-column table. The first column lists the mailbox or

   106    alias name, the second column is either `Alias' or `Mailbox', and the

   107    third column lists the destination.

   108    

   109 2.2 Form Configuration

   110 

   111   2.2.1 Required Form Fields

   112   

   113    No additional form fields are Required.

   114    

   115   2.2.2 Optional Form Fields

   116   

   117    Field:

   118           body-flags

   119    Description:

   120           If present, the contents of this field is inserted into the

   121           `<body>' tag at the start of the document.

   122    Syntax:

   123           `<input type=hidden name=body-flags value="bgcolor=ffffff">'

   124           

   125    Field:

   126           cell-align

   127    Description:

   128           Sets the cell alignment. Defaults to `left'.

   129    Syntax:

   130           `<input type=hidden name=cell-align value=center>'

   131           

   132    Field:

   133           cell-post

   134    Description:

   135           If present, the contents of this field will be output prior to

   136           every `</td>' tag.

   137    Syntax:

   138           `<input type=hidden name=cell-post value="</font>">'

   139           

   140    Field:

   141           cell-pre

   142    Description:

   143           If present, the contents of this field will be output after

   144           every `<td>' tag.

   145    Syntax:

   146           `<input type=hidden name=cell-pre value="<font size=1

   147           name=ariel>">'

   148           

   149    Field:

   150           p-align

   151    Description:

   152           Sets the default paragraph alignment. Defaults to `left'.

   153    Syntax:

   154           `<input type=hidden name=p-align value=center>'

   155           

   156    Field:

   157           title-post

   158    Description:

   159           If present, the contents of this field are output after the

   160           title text. Defaults to `</h1>'.

   161    Syntax:

   162           `<input type=hidden name=title-post value="</font>">'

   163           

   164    Field:

   165           table-align

   166    Description:

   167           Sets the allignment of the table listing the users. Defaults to

   168           `left'.

   169    Syntax:

   170           `<input type=hidden name=table-align value=center>'

   171           

   172    Field:

   173           title-pre

   174    Description:

   175           If present, the contents of this field are output before the

   176           title text. Defaults to `<h1>'.

   177    Syntax:

   178           `<input type=hidden name=title-pre value="<font size=3

   179           face=verdana>">'

   180           

   181    Field:

   182           userlink

   183    Description:

   184           If this field is present, all user names will be enclosed in a

   185           link to the contents of this field. If the field contains a

   186           '%', it will be replaced by the user name.

   187    Syntax:

   188           `<input type=hidden name=userlink

   189           value="/cgi-bin/admin-user?name=%">'

   190           

   191                                  3. vaddalias

   192                                        

   193 3.1 Overview

   194 

   195    This CGI program can be used to add an alias to a virtual domain.

   196    

   197 3.2 Form Configuration

   198 

   199   3.2.1 Required Form Fields

   200   

   201    Field:

   202           username

   203    Description:

   204           The virtual user name of the alias to create.

   205    Syntax:

   206           `<input type=text name=username>'

   207           

   208    Field:

   209           destination

   210    Description:

   211           The destination address or addresses of the alias, separated by

   212           commas. If an address does not contain a host name (separated

   213           from the user name with an `@'), it is treated as local to the

   214           virtual domain and must already exist.

   215    Syntax:

   216           `<input type=text name=destination>'

   217           

   218   3.2.2 Optional Form Fields

   219   

   220    Field:

   221           newpass1, newpass2

   222    Description:

   223           These two fields specify the new password of the user. They

   224           must match for the password to be changed. The first eight

   225           characters are relevant, and may be any combination of letters,

   226           digits, or punctuation symbols. If these fields are not present

   227           or are empty, a null passcode is used.

   228    Syntax:

   229           `<input type=password name=newpass1><input type=password

   230           name=newpass1>'

   231           

   232                                   4. vadduser

   233                                        

   234 4.1 Overview

   235 

   236    This CGI program can be used to add a user mailbox to a virtual

   237    domain.

   238    

   239 4.2 Form Configuration

   240 

   241   4.2.1 Required Form Fields

   242   

   243    Field:

   244           username

   245    Description:

   246           The virtual user name of the alias to create.

   247    Syntax:

   248           `<input type=text name=username>'

   249           

   250    Field:

   251           newpass1, newpass2

   252    Description:

   253           These two fields specify the new password of the user. They

   254           must match for the password to be changed. The first eight

   255           characters are relevant, and may be any combination of letters,

   256           digits, or punctuation symbols.

   257    Syntax:

   258           `<input type=password name=newpass1><input type=password

   259           name=newpass1>'

   260           

   261   4.2.2 Optional Form Fields

   262   

   263    Field:

   264           destination

   265    Description:

   266           The destination address or addresses to direct a copy of

   267           incoming mail, separated by commas. If an address does not

   268           contain a host name (separated from the user name with an `@'),

   269           it is treated as local to the virtual domain and must already

   270           exist. If this field is not present or blank, no forwarding

   271           will be done.

   272    Syntax:

   273           `<input type=text name=destination>'

   274           

   275    Field:

   276           userdir

   277    Description:

   278           This field can be used to specify the user mail directory name

   279           relative to the virtual domain's users directory. If this field

   280           is not present, the directory name will be the same as the user

   281           name.

   282    Syntax:

   283           `<input type=text name=userdir>'

   284           

   285                                   5. vchattr

   286                                        

   287 5.1 Overview

   288 

   289    This CGI program can be used to change the attributes of an existing

   290    user in a virtual domain.

   291    

   292 5.2 Form Configuration

   293 

   294   5.2.1 Required Form Fields

   295   

   296    Field:

   297           username

   298    Description:

   299           The virtual user name to modify.

   300    Syntax:

   301           `<input type=text name=username>'

   302           

   303    Field:

   304           attribute

   305    Description:

   306           The number of the attribute to modify. The possible values are:

   307         `1'

   308                The password. Use the `vpasswd' CGI to do this.

   309         `2'

   310                The forwarding destination. Use the `vchforwards' to do

   311                this.

   312         `3'

   313                The hard quota.

   314         `4'

   315                The soft quota.

   316         `5'

   317                The message size limit.

   318         `6'

   319                The message count limit.

   320         `7'

   321                The account's expiry time.

   322         `8'

   323                Set to zero to disable delivery to the account's mailbox

   324                (without deleting the account). Set to non-zero to enable

   325                delivery.

   326         `9'

   327                The personal information string.

   328    Syntax:

   329           `<input type=hidden name=attribute value=2>'

   330           

   331    Field:

   332           newvalue

   333    Description:

   334           The new value for the given attribute. The format of this new

   335           value is dependant on the type of the attribute.

   336    Syntax:

   337           `<input type=text name=newvalue>'

   338           

   339                                 6. vchforwards

   340                                        

   341 6.1 Overview

   342 

   343    This CGI program can be used to change the forwarding destination of

   344    an existing user.

   345    

   346 6.2 Form Configuration

   347 

   348   6.2.1 Required Form Fields

   349   

   350    Field:

   351           username

   352    Description:

   353           The virtual user name to modify.

   354    Syntax:

   355           `<input type=text name=username>'

   356           

   357    Field:

   358           destination

   359    Description:

   360           The destination address or addresses of the alias, separated by

   361           commas. If an address does not contain a host name (separated

   362           from the user name with an `@'), it is treated as local to the

   363           virtual domain and must already exist.

   364    Syntax:

   365           `<input type=text name=destination>'

   366           

   367   6.2.2 Optional Form Fields

   368   

   369    Field:

   370           enable

   371    Description:

   372           Set this field to `0' to cause mailbox delivery to this account

   373           to be disabled after changing the alias. Set it to any number

   374           except `0' to cause mailbox delivery to be enabled before

   375           changing the alias. If it is not set, the mailbox is neither

   376           enabled nor disabled.

   377    Syntax:

   378           `<select name=enable> <option value=0>Disable <option

   379           value=1>Enable </select>'

   380           

   381                                   7. vdeluser

   382                                        

   383 7.1 Overview

   384 

   385    This CGI program deletes a user from a virtual domain.

   386    

   387 7.2 Form Configuration

   388 

   389   7.2.1 Required Form Fields

   390   

   391    Field:

   392           username

   393    Description:

   394           The virtual user name of the user to delete.

   395    Syntax:

   396           `<input type=text name=username>'

   397           

   398                                   8. vpasswd

   399                                        

   400 8.1 Overview

   401 

   402    This CGI program can be used to change the password of a user either

   403    by the user themself or by the domain administrator.

   404    

   405 8.2 Form Configuration

   406 

   407    The password field used by this CGI may match either the password of

   408    the virtual domain administrator or that of the user being modified.

   409    

   410   8.2.1 Required Form Fields

   411   

   412    Field:

   413           username

   414    Description:

   415           This field specifies the name of the user that is to be

   416           modified.

   417    Syntax:

   418           `<input type=text name=username>'

   419           

   420    Field:

   421           newpass1, newpass2

   422    Description:

   423           These two fields specify the new password of the user. They

   424           must match for the password to be changed. The password may

   425           contain any combination of letters, digits, or punctuation

   426           symbols.

   427    Syntax:

   428           `<input type=password name=newpass1> <input type=password

   429           name=newpass2>'

   430      _________________________________________________________________

   431    

   432    This document was generated on 14 September 2000 using

   433    texi2html 1.56k.