1 

     2 

     2                           vmailmgr CGI Documentation

     3                           vmailmgr CGI Documentation

    50                                 1. Introduction

     9                                 1. Introduction

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

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

    54 1.1 Common Form Configuration

    17 1.1 Common Form Configuration

    55 

    18 

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

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

    57    programs.

    20    programs.

    59   1.1.1 Required Form Fields

    26   1.1.1 Required Form Fields

    61    Field:

    28    Field:

    62           vdomain

    29           vdomain

    63    Description:

    30    Description:

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

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

    65           to perform this operation.

    32           to perform this operation.

    66    Syntax:

    33    Syntax:

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

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

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

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

    70    Field:

    37    Field:

    71           password

    38           password

    72    Description:

    39    Description:

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

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

    74           administrator for the given virtual domain.

    41           administrator for the given virtual domain.

    75    Syntax:

    42    Syntax:

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

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

    78   1.1.2 Optional Form Fields

    49   1.1.2 Optional Form Fields

    80    Field:

    51    Field:

    81           error_redirect

    52           error_redirect

    82    Description:

    53    Description:

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

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

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

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

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

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

    86           be output.

    57           be output.

    87    Syntax:

    58    Syntax:

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

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

    90    Field:

    61    Field:

    91           redirect

    62           redirect

    92    Description:

    63    Description:

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

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

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

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

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

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

    96           will be output.

    67           will be output.

    97    Syntax:

    68    Syntax:

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

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

   100                                 2. listvdomain

    75                                 2. listvdomain

   102 2.1 Overview

    81 2.1 Overview

   103 

    82 

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

    83    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

    84    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

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

   107    third column lists the destination.

    86    third column lists the destination.

   109 2.2 Form Configuration

    92 2.2 Form Configuration

   110 

    97 

   111   2.2.1 Required Form Fields

    98   2.2.1 Required Form Fields

   113    No additional form fields are Required.

   100    No additional form fields are Required.

   115   2.2.2 Optional Form Fields

   106   2.2.2 Optional Form Fields

   117    Field:

   108    Field:

   118           body-flags

   109           body-flags

   119    Description:

   110    Description:

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

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

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

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

   122    Syntax:

   113    Syntax:

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

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

   125    Field:

   116    Field:

   126           cell-align

   117           cell-align

   127    Description:

   118    Description:

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

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

   129    Syntax:

   120    Syntax:

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

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

   132    Field:

   123    Field:

   133           cell-post

   124           cell-post

   134    Description:

   125    Description:

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

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

   136           every `</td>' tag.

   127           every `</td>' tag.

   137    Syntax:

   128    Syntax:

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

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

   140    Field:

   131    Field:

   141           cell-pre

   132           cell-pre

   142    Description:

   133    Description:

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

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

   144           every `<td>' tag.

   135           every `<td>' tag.

   145    Syntax:

   136    Syntax:

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

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

   147           name=ariel>">'

   138           name=ariel>">'

   149    Field:

   140    Field:

   150           p-align

   141           p-align

   151    Description:

   142    Description:

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

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

   153    Syntax:

   144    Syntax:

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

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

   156    Field:

   147    Field:

   157           title-post

   148           title-post

   158    Description:

   149    Description:

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

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

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

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

   161    Syntax:

   152    Syntax:

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

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

   164    Field:

   155    Field:

   165           table-align

   156           table-align

   166    Description:

   157    Description:

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

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

   168           `left'.

   159           `left'.

   169    Syntax:

   160    Syntax:

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

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

   172    Field:

   163    Field:

   173           title-pre

   164           title-pre

   174    Description:

   165    Description:

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

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

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

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

   177    Syntax:

   168    Syntax:

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

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

   179           face=verdana>">'

   170           face=verdana>">'

   181    Field:

   172    Field:

   182           userlink

   173           userlink

   183    Description:

   174    Description:

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

   175           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

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

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

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

   187    Syntax:

   178    Syntax:

   188           `<input type=hidden name=userlink

   179           `<input type=hidden name=userlink

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

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

   191                                  3. vaddalias

   186                                  3. vaddalias

   193 3.1 Overview

   192 3.1 Overview

   194 

   193 

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

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

   197 3.2 Form Configuration

   200 3.2 Form Configuration

   198 

   205 

   199   3.2.1 Required Form Fields

   206   3.2.1 Required Form Fields

   201    Field:

   208    Field:

   202           username

   209           username

   203    Description:

   210    Description:

   204           The virtual user name of the alias to create.

   211           The virtual user name of the alias to create.

   205    Syntax:

   212    Syntax:

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

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

   208    Field:

   215    Field:

   209           destination

   216           destination

   210    Description:

   217    Description:

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

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

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

   219           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

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

   214           virtual domain and must already exist.

   221           virtual domain and must already exist.

   215    Syntax:

   222    Syntax:

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

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

   218   3.2.2 Optional Form Fields

   229   3.2.2 Optional Form Fields

   220    Field:

   231    Field:

   221           newpass1, newpass2

   232           newpass1, newpass2

   222    Description:

   233    Description:

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

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

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

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

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

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

   227           or are empty, a null passcode is used.

   238           or are empty, a null passcode is used.

   228    Syntax:

   239    Syntax:

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

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

   230           name=newpass1>'

   241           name=newpass1>'

   232                                   4. vadduser

   247                                   4. vadduser

   234 4.1 Overview

   253 4.1 Overview

   235 

   254 

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

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

   237    domain.

   256    domain.

   239 4.2 Form Configuration

   262 4.2 Form Configuration

   240 

   267 

   241   4.2.1 Required Form Fields

   268   4.2.1 Required Form Fields

   243    Field:

   270    Field:

   244           username

   271           username

   245    Description:

   272    Description:

   246           The virtual user name of the alias to create.

   273           The virtual user name of the alias to create.

   247    Syntax:

   274    Syntax:

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

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

   250    Field:

   277    Field:

   251           newpass1, newpass2

   278           newpass1, newpass2

   252    Description:

   279    Description:

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

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

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

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

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

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

   256           digits, or punctuation symbols.

   283           digits, or punctuation symbols.

   257    Syntax:

   284    Syntax:

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

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

   259           name=newpass1>'

   286           name=newpass1>'

   261   4.2.2 Optional Form Fields

   292   4.2.2 Optional Form Fields

   263    Field:

   294    Field:

   264           destination

   295           destination

   265    Description:

   296    Description:

   266           The destination address or addresses to direct a copy of

   297           The destination address or addresses to direct a copy of

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

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

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

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

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

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

   271           will be done.

   302           will be done.

   272    Syntax:

   303    Syntax:

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

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

   275    Field:

   306    Field:

   276           userdir

   307           userdir

   277    Description:

   308    Description:

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

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

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

   310           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

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

   281           name.

   312           name.

   282    Syntax:

   313    Syntax:

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

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

   285                                   5. vchattr

   320                                   5. vchattr

   287 5.1 Overview

   326 5.1 Overview

   288 

   327 

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

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

   290    user in a virtual domain.

   329    user in a virtual domain.

   292 5.2 Form Configuration

   335 5.2 Form Configuration

   293 

   340 

   294   5.2.1 Required Form Fields

   341   5.2.1 Required Form Fields

   296    Field:

   343    Field:

   297           username

   344           username

   298    Description:

   345    Description:

   299           The virtual user name to modify.

   346           The virtual user name to modify.

   300    Syntax:

   347    Syntax:

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

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

   303    Field:

   350    Field:

   304           attribute

   351           attribute

   305    Description:

   352    Description:

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

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

   307         `1'

   354         `1'

   325                delivery.

   372                delivery.

   326         `9'

   373         `9'

   327                The personal information string.

   374                The personal information string.

   328    Syntax:

   375    Syntax:

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

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

   331    Field:

   378    Field:

   332           newvalue

   379           newvalue

   333    Description:

   380    Description:

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

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

   335           value is dependant on the type of the attribute.

   382           value is dependant on the type of the attribute.

   336    Syntax:

   383    Syntax:

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

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

   339                                 6. vchforwards

   390                                 6. vchforwards

   341 6.1 Overview

   396 6.1 Overview

   342 

   397 

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

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

   344    an existing user.

   399    an existing user.

   346 6.2 Form Configuration

   405 6.2 Form Configuration

   347 

   410 

   348   6.2.1 Required Form Fields

   411   6.2.1 Required Form Fields

   350    Field:

   413    Field:

   351           username

   414           username

   352    Description:

   415    Description:

   353           The virtual user name to modify.

   416           The virtual user name to modify.

   354    Syntax:

   417    Syntax:

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

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

   357    Field:

   420    Field:

   358           destination

   421           destination

   359    Description:

   422    Description:

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

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

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

   424           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

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

   363           virtual domain and must already exist.

   426           virtual domain and must already exist.

   364    Syntax:

   427    Syntax:

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

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

   367   6.2.2 Optional Form Fields

   434   6.2.2 Optional Form Fields

   369    Field:

   436    Field:

   370           enable

   437           enable

   371    Description:

   438    Description:

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

   439           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

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

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

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

   376           enabled nor disabled.

   443           enabled nor disabled.

   377    Syntax:

   444    Syntax:

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

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

   379           value=1>Enable </select>'

   446           value=1>Enable </select>'

   381                                   7. vdeluser

   452                                   7. vdeluser

   383 7.1 Overview

   458 7.1 Overview

   384 

   459 

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

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

   387 7.2 Form Configuration

   466 7.2 Form Configuration

   388 

   471 

   389   7.2.1 Required Form Fields

   472   7.2.1 Required Form Fields

   391    Field:

   474    Field:

   392           username

   475           username

   393    Description:

   476    Description:

   394           The virtual user name of the user to delete.

   477           The virtual user name of the user to delete.

   395    Syntax:

   478    Syntax:

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

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

   398                                   8. vpasswd

   485                                   8. vpasswd

   400 8.1 Overview

   491 8.1 Overview

   401 

   492 

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

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

   403    by the user themself or by the domain administrator.

   494    by the user themself or by the domain administrator.

   405 8.2 Form Configuration

   500 8.2 Form Configuration

   406 

   501 

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

   502    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.

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

   410   8.2.1 Required Form Fields

   509   8.2.1 Required Form Fields

   412    Field:

   511    Field:

   413           username

   512           username

   414    Description:

   513    Description:

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

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

   416           modified.

   515           modified.

   417    Syntax:

   516    Syntax:

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

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

   420    Field:

   519    Field:

   421           newpass1, newpass2

   520           newpass1, newpass2

   422    Description:

   521    Description:

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

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

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

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

   426           symbols.

   525           symbols.

   427    Syntax:

   526    Syntax:

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

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

   429           name=newpass2>'

   528           name=newpass2>'

   430      _________________________________________________________________

   529      _________________________________________________________________