TEXT   23

vmailmgr cgi

Guest on 19th July 2022 02:26:21 AM

  1.    [Top] [Contents] [Index] [ ? ]
  2.  
  3.                           vmailmgr CGI Documentation
  4.      _________________________________________________________________
  5.  
  6.    [ < ] [ > ]   [ << ] [ Up ] [ >> ]         [Top] [Contents] [Index] [
  7.    ? ]
  8.  
  9.                                 1. Introduction
  10.  
  11.    This is the documentation for the CGI programs for vmailmgr.
  12.      _________________________________________________________________
  13.  
  14.    [ < ] [ > ]   [ << ] [ Up ] [ >> ]         [Top] [Contents] [Index] [
  15.    ? ]
  16.  
  17. 1.1 Common Form Configuration
  18.  
  19.    The following form fields are common to all of the vmailmgr CGI
  20.    programs.
  21.      _________________________________________________________________
  22.  
  23.    [ < ] [ > ]   [ << ] [ Up ] [ >> ]         [Top] [Contents] [Index] [
  24.    ? ]
  25.  
  26.   1.1.1 Required Form Fields
  27.  
  28.    Field:
  29.           vdomain
  30.    Description:
  31.           This field specifies the name of the virtual domain under which
  32.           to perform this operation.
  33.    Syntax:
  34.           `<input type=hidden name=vdomain value="domain-name">' or
  35.           `<input type=text name=vdomain>'
  36.  
  37.    Field:
  38.           password
  39.    Description:
  40.           Unless noted below, this field specifies the password of the
  41.           administrator for the given virtual domain.
  42.    Syntax:
  43.           `<input type=password name=password>'
  44.      _________________________________________________________________
  45.  
  46.    [ < ] [ > ]   [ << ] [ Up ] [ >> ]         [Top] [Contents] [Index] [
  47.    ? ]
  48.  
  49.   1.1.2 Optional Form Fields
  50.  
  51.    Field:
  52.           error_redirect
  53.    Description:
  54.           If this field is set, any operation that results in an error
  55.           will be redirected to the given URL. If not set, a
  56.           pre-programmed document (which includes the error message) will
  57.           be output.
  58.    Syntax:
  59.           `<input type=hidden name=error_redirect value="URL">'
  60.  
  61.    Field:
  62.           redirect
  63.    Description:
  64.           If this field is set, any operation that completes successfully
  65.           with be redirected to the given URL. If not set, a
  66.           pre-programmed document (which includes the completion message)
  67.           will be output.
  68.    Syntax:
  69.           `<input type=hidden name=redirect value="URL">'
  70.      _________________________________________________________________
  71.  
  72.    [ < ] [ > ]   [ << ] [ Up ] [ >> ]         [Top] [Contents] [Index] [
  73.    ? ]
  74.  
  75.                                 2. listvdomain
  76.      _________________________________________________________________
  77.  
  78.    [ < ] [ > ]   [ << ] [ Up ] [ >> ]         [Top] [Contents] [Index] [
  79.    ? ]
  80.  
  81. 2.1 Overview
  82.  
  83.    This CGI program will list the mailboxes and aliases in a virtual
  84.    domain in a three-column table. The first column lists the mailbox or
  85.    alias name, the second column is either `Alias' or `Mailbox', and the
  86.    third column lists the destination.
  87.      _________________________________________________________________
  88.  
  89.    [ < ] [ > ]   [ << ] [ Up ] [ >> ]         [Top] [Contents] [Index] [
  90.    ? ]
  91.  
  92. 2.2 Form Configuration
  93.      _________________________________________________________________
  94.  
  95.    [ < ] [ > ]   [ << ] [ Up ] [ >> ]         [Top] [Contents] [Index] [
  96.    ? ]
  97.  
  98.   2.2.1 Required Form Fields
  99.  
  100.    No additional form fields are Required.
  101.      _________________________________________________________________
  102.  
  103.    [ < ] [ > ]   [ << ] [ Up ] [ >> ]         [Top] [Contents] [Index] [
  104.    ? ]
  105.  
  106.   2.2.2 Optional Form Fields
  107.  
  108.    Field:
  109.           body-flags
  110.    Description:
  111.           If present, the contents of this field is inserted into the
  112.           `<body>' tag at the start of the document.
  113.    Syntax:
  114.           `<input type=hidden name=body-flags value="bgcolor=ffffff">'
  115.  
  116.    Field:
  117.           cell-align
  118.    Description:
  119.           Sets the cell alignment. Defaults to `left'.
  120.    Syntax:
  121.           `<input type=hidden name=cell-align value=center>'
  122.  
  123.    Field:
  124.           cell-post
  125.    Description:
  126.           If present, the contents of this field will be output prior to
  127.           every `</td>' tag.
  128.    Syntax:
  129.           `<input type=hidden name=cell-post value="</font>">'
  130.  
  131.    Field:
  132.           cell-pre
  133.    Description:
  134.           If present, the contents of this field will be output after
  135.           every `<td>' tag.
  136.    Syntax:
  137.           `<input type=hidden name=cell-pre value="<font size=1
  138.           name=ariel>">'
  139.  
  140.    Field:
  141.           p-align
  142.    Description:
  143.           Sets the default paragraph alignment. Defaults to `left'.
  144.    Syntax:
  145.           `<input type=hidden name=p-align value=center>'
  146.  
  147.    Field:
  148.           title-post
  149.    Description:
  150.           If present, the contents of this field are output after the
  151.           title text. Defaults to `</h1>'.
  152.    Syntax:
  153.           `<input type=hidden name=title-post value="</font>">'
  154.  
  155.    Field:
  156.           table-align
  157.    Description:
  158.           Sets the allignment of the table listing the users. Defaults to
  159.           `left'.
  160.    Syntax:
  161.           `<input type=hidden name=table-align value=center>'
  162.  
  163.    Field:
  164.           title-pre
  165.    Description:
  166.           If present, the contents of this field are output before the
  167.           title text. Defaults to `<h1>'.
  168.    Syntax:
  169.           `<input type=hidden name=title-pre value="<font size=3
  170.           face=verdana>">'
  171.  
  172.    Field:
  173.           userlink
  174.    Description:
  175.           If this field is present, all user names will be enclosed in a
  176.           link to the contents of this field. If the field contains a
  177.           '%', it will be replaced by the user name.
  178.    Syntax:
  179.           `<input type=hidden name=userlink
  180.           value="/cgi-bin/admin-user?name=%">'
  181.      _________________________________________________________________
  182.  
  183.    [ < ] [ > ]   [ << ] [ Up ] [ >> ]         [Top] [Contents] [Index] [
  184.    ? ]
  185.  
  186.                                  3. vaddalias
  187.      _________________________________________________________________
  188.  
  189.    [ < ] [ > ]   [ << ] [ Up ] [ >> ]         [Top] [Contents] [Index] [
  190.    ? ]
  191.  
  192. 3.1 Overview
  193.  
  194.    This CGI program can be used to add an alias to a virtual domain.
  195.      _________________________________________________________________
  196.  
  197.    [ < ] [ > ]   [ << ] [ Up ] [ >> ]         [Top] [Contents] [Index] [
  198.    ? ]
  199.  
  200. 3.2 Form Configuration
  201.      _________________________________________________________________
  202.  
  203.    [ < ] [ > ]   [ << ] [ Up ] [ >> ]         [Top] [Contents] [Index] [
  204.    ? ]
  205.  
  206.   3.2.1 Required Form Fields
  207.  
  208.    Field:
  209.           username
  210.    Description:
  211.           The virtual user name of the alias to create.
  212.    Syntax:
  213.           `<input type=text name=username>'
  214.  
  215.    Field:
  216.           destination
  217.    Description:
  218.           The destination address or addresses of the alias, separated by
  219.           commas. If an address does not contain a host name (separated
  220.           from the user name with an `@'), it is treated as local to the
  221.           virtual domain and must already exist.
  222.    Syntax:
  223.           `<input type=text name=destination>'
  224.      _________________________________________________________________
  225.  
  226.    [ < ] [ > ]   [ << ] [ Up ] [ >> ]         [Top] [Contents] [Index] [
  227.    ? ]
  228.  
  229.   3.2.2 Optional Form Fields
  230.  
  231.    Field:
  232.           newpass1, newpass2
  233.    Description:
  234.           These two fields specify the new password of the user. They
  235.           must match for the password to be changed. The first eight
  236.           characters are relevant, and may be any combination of letters,
  237.           digits, or punctuation symbols. If these fields are not present
  238.           or are empty, a null passcode is used.
  239.    Syntax:
  240.           `<input type=password name=newpass1><input type=password
  241.           name=newpass1>'
  242.      _________________________________________________________________
  243.  
  244.    [ < ] [ > ]   [ << ] [ Up ] [ >> ]         [Top] [Contents] [Index] [
  245.    ? ]
  246.  
  247.                                   4. vadduser
  248.      _________________________________________________________________
  249.  
  250.    [ < ] [ > ]   [ << ] [ Up ] [ >> ]         [Top] [Contents] [Index] [
  251.    ? ]
  252.  
  253. 4.1 Overview
  254.  
  255.    This CGI program can be used to add a user mailbox to a virtual
  256.    domain.
  257.      _________________________________________________________________
  258.  
  259.    [ < ] [ > ]   [ << ] [ Up ] [ >> ]         [Top] [Contents] [Index] [
  260.    ? ]
  261.  
  262. 4.2 Form Configuration
  263.      _________________________________________________________________
  264.  
  265.    [ < ] [ > ]   [ << ] [ Up ] [ >> ]         [Top] [Contents] [Index] [
  266.    ? ]
  267.  
  268.   4.2.1 Required Form Fields
  269.  
  270.    Field:
  271.           username
  272.    Description:
  273.           The virtual user name of the alias to create.
  274.    Syntax:
  275.           `<input type=text name=username>'
  276.  
  277.    Field:
  278.           newpass1, newpass2
  279.    Description:
  280.           These two fields specify the new password of the user. They
  281.           must match for the password to be changed. The first eight
  282.           characters are relevant, and may be any combination of letters,
  283.           digits, or punctuation symbols.
  284.    Syntax:
  285.           `<input type=password name=newpass1><input type=password
  286.           name=newpass1>'
  287.      _________________________________________________________________
  288.  
  289.    [ < ] [ > ]   [ << ] [ Up ] [ >> ]         [Top] [Contents] [Index] [
  290.    ? ]
  291.  
  292.   4.2.2 Optional Form Fields
  293.  
  294.    Field:
  295.           destination
  296.    Description:
  297.           The destination address or addresses to direct a copy of
  298.           incoming mail, separated by commas. If an address does not
  299.           contain a host name (separated from the user name with an `@'),
  300.           it is treated as local to the virtual domain and must already
  301.           exist. If this field is not present or blank, no forwarding
  302.           will be done.
  303.    Syntax:
  304.           `<input type=text name=destination>'
  305.  
  306.    Field:
  307.           userdir
  308.    Description:
  309.           This field can be used to specify the user mail directory name
  310.           relative to the virtual domain's users directory. If this field
  311.           is not present, the directory name will be the same as the user
  312.           name.
  313.    Syntax:
  314.           `<input type=text name=userdir>'
  315.      _________________________________________________________________
  316.  
  317.    [ < ] [ > ]   [ << ] [ Up ] [ >> ]         [Top] [Contents] [Index] [
  318.    ? ]
  319.  
  320.                                   5. vchattr
  321.      _________________________________________________________________
  322.  
  323.    [ < ] [ > ]   [ << ] [ Up ] [ >> ]         [Top] [Contents] [Index] [
  324.    ? ]
  325.  
  326. 5.1 Overview
  327.  
  328.    This CGI program can be used to change the attributes of an existing
  329.    user in a virtual domain.
  330.      _________________________________________________________________
  331.  
  332.    [ < ] [ > ]   [ << ] [ Up ] [ >> ]         [Top] [Contents] [Index] [
  333.    ? ]
  334.  
  335. 5.2 Form Configuration
  336.      _________________________________________________________________
  337.  
  338.    [ < ] [ > ]   [ << ] [ Up ] [ >> ]         [Top] [Contents] [Index] [
  339.    ? ]
  340.  
  341.   5.2.1 Required Form Fields
  342.  
  343.    Field:
  344.           username
  345.    Description:
  346.           The virtual user name to modify.
  347.    Syntax:
  348.           `<input type=text name=username>'
  349.  
  350.    Field:
  351.           attribute
  352.    Description:
  353.           The number of the attribute to modify. The possible values are:
  354.         `1'
  355.                The password. Use the `vpasswd' CGI to do this.
  356.         `2'
  357.                The forwarding destination. Use the `vchforwards' to do
  358.                this.
  359.         `3'
  360.                The hard quota.
  361.         `4'
  362.                The soft quota.
  363.         `5'
  364.                The message size limit.
  365.         `6'
  366.                The message count limit.
  367.         `7'
  368.                The account's expiry time.
  369.         `8'
  370.                Set to zero to disable delivery to the account's mailbox
  371.                (without deleting the account). Set to non-zero to enable
  372.                delivery.
  373.         `9'
  374.                The personal information string.
  375.    Syntax:
  376.           `<input type=hidden name=attribute value=2>'
  377.  
  378.    Field:
  379.           newvalue
  380.    Description:
  381.           The new value for the given attribute. The format of this new
  382.           value is dependant on the type of the attribute.
  383.    Syntax:
  384.           `<input type=text name=newvalue>'
  385.      _________________________________________________________________
  386.  
  387.    [ < ] [ > ]   [ << ] [ Up ] [ >> ]         [Top] [Contents] [Index] [
  388.    ? ]
  389.  
  390.                                 6. vchforwards
  391.      _________________________________________________________________
  392.  
  393.    [ < ] [ > ]   [ << ] [ Up ] [ >> ]         [Top] [Contents] [Index] [
  394.    ? ]
  395.  
  396. 6.1 Overview
  397.  
  398.    This CGI program can be used to change the forwarding destination of
  399.    an existing user.
  400.      _________________________________________________________________
  401.  
  402.    [ < ] [ > ]   [ << ] [ Up ] [ >> ]         [Top] [Contents] [Index] [
  403.    ? ]
  404.  
  405. 6.2 Form Configuration
  406.      _________________________________________________________________
  407.  
  408.    [ < ] [ > ]   [ << ] [ Up ] [ >> ]         [Top] [Contents] [Index] [
  409.    ? ]
  410.  
  411.   6.2.1 Required Form Fields
  412.  
  413.    Field:
  414.           username
  415.    Description:
  416.           The virtual user name to modify.
  417.    Syntax:
  418.           `<input type=text name=username>'
  419.  
  420.    Field:
  421.           destination
  422.    Description:
  423.           The destination address or addresses of the alias, separated by
  424.           commas. If an address does not contain a host name (separated
  425.           from the user name with an `@'), it is treated as local to the
  426.           virtual domain and must already exist.
  427.    Syntax:
  428.           `<input type=text name=destination>'
  429.      _________________________________________________________________
  430.  
  431.    [ < ] [ > ]   [ << ] [ Up ] [ >> ]         [Top] [Contents] [Index] [
  432.    ? ]
  433.  
  434.   6.2.2 Optional Form Fields
  435.  
  436.    Field:
  437.           enable
  438.    Description:
  439.           Set this field to `0' to cause mailbox delivery to this account
  440.           to be disabled after changing the alias. Set it to any number
  441.           except `0' to cause mailbox delivery to be enabled before
  442.           changing the alias. If it is not set, the mailbox is neither
  443.           enabled nor disabled.
  444.    Syntax:
  445.           `<select name=enable> <option value=0>Disable <option
  446.           value=1>Enable </select>'
  447.      _________________________________________________________________
  448.  
  449.    [ < ] [ > ]   [ << ] [ Up ] [ >> ]         [Top] [Contents] [Index] [
  450.    ? ]
  451.  
  452.                                   7. vdeluser
  453.      _________________________________________________________________
  454.  
  455.    [ < ] [ > ]   [ << ] [ Up ] [ >> ]         [Top] [Contents] [Index] [
  456.    ? ]
  457.  
  458. 7.1 Overview
  459.  
  460.    This CGI program deletes a user from a virtual domain.
  461.      _________________________________________________________________
  462.  
  463.    [ < ] [ > ]   [ << ] [ Up ] [ >> ]         [Top] [Contents] [Index] [
  464.    ? ]
  465.  
  466. 7.2 Form Configuration
  467.      _________________________________________________________________
  468.  
  469.    [ < ] [ > ]   [ << ] [ Up ] [ >> ]         [Top] [Contents] [Index] [
  470.    ? ]
  471.  
  472.   7.2.1 Required Form Fields
  473.  
  474.    Field:
  475.           username
  476.    Description:
  477.           The virtual user name of the user to delete.
  478.    Syntax:
  479.           `<input type=text name=username>'
  480.      _________________________________________________________________
  481.  
  482.    [ < ] [ > ]   [ << ] [ Up ] [ >> ]         [Top] [Contents] [Index] [
  483.    ? ]
  484.  
  485.                                   8. vpasswd
  486.      _________________________________________________________________
  487.  
  488.    [ < ] [ > ]   [ << ] [ Up ] [ >> ]         [Top] [Contents] [Index] [
  489.    ? ]
  490.  
  491. 8.1 Overview
  492.  
  493.    This CGI program can be used to change the password of a user either
  494.    by the user themself or by the domain administrator.
  495.      _________________________________________________________________
  496.  
  497.    [ < ] [ > ]   [ << ] [ Up ] [ >> ]         [Top] [Contents] [Index] [
  498.    ? ]
  499.  
  500. 8.2 Form Configuration
  501.  
  502.    The password field used by this CGI may match either the password of
  503.    the virtual domain administrator or that of the user being modified.
  504.      _________________________________________________________________
  505.  
  506.    [ < ] [ > ]   [ << ] [ Up ] [ >> ]         [Top] [Contents] [Index] [
  507.    ? ]
  508.  
  509.   8.2.1 Required Form Fields
  510.  
  511.    Field:
  512.           username
  513.    Description:
  514.           This field specifies the name of the user that is to be
  515.           modified.
  516.    Syntax:
  517.           `<input type=text name=username>'
  518.  
  519.    Field:
  520.           newpass1, newpass2
  521.    Description:
  522.           These two fields specify the new password of the user. They
  523.           must match for the password to be changed. The password may
  524.           contain any combination of letters, digits, or punctuation
  525.           symbols.
  526.    Syntax:
  527.           `<input type=password name=newpass1> <input type=password
  528.           name=newpass2>'
  529.      _________________________________________________________________
  530.  
  531.    [Top] [Contents] [Index] [ ? ]
  532.  
  533.                                Table of Contents
  534.  
  535.    1. Introduction
  536.  
  537.    1.1 Common Form Configuration
  538.  
  539.    1.1.1 Required Form Fields
  540.        1.1.2 Optional Form Fields
  541.  
  542.    2. listvdomain
  543.    2.1 Overview
  544.        2.2 Form Configuration
  545.  
  546.    2.2.1 Required Form Fields
  547.        2.2.2 Optional Form Fields
  548.  
  549.    3. vaddalias
  550.    3.1 Overview
  551.        3.2 Form Configuration
  552.  
  553.    3.2.1 Required Form Fields
  554.        3.2.2 Optional Form Fields
  555.  
  556.    4. vadduser
  557.    4.1 Overview
  558.        4.2 Form Configuration
  559.  
  560.    4.2.1 Required Form Fields
  561.        4.2.2 Optional Form Fields
  562.  
  563.    5. vchattr
  564.    5.1 Overview
  565.        5.2 Form Configuration
  566.  
  567.    5.2.1 Required Form Fields
  568.  
  569.    6. vchforwards
  570.    6.1 Overview
  571.        6.2 Form Configuration
  572.  
  573.    6.2.1 Required Form Fields
  574.        6.2.2 Optional Form Fields
  575.  
  576.    7. vdeluser
  577.    7.1 Overview
  578.        7.2 Form Configuration
  579.  
  580.    7.2.1 Required Form Fields
  581.  
  582.    8. vpasswd
  583.    8.1 Overview
  584.        8.2 Form Configuration
  585.  
  586.    8.2.1 Required Form Fields
  587.      _________________________________________________________________
  588.  
  589.    [Top] [Contents] [Index] [ ? ]
  590.  
  591.                             Short Table of Contents
  592.  
  593.      1. Introduction
  594.      2. listvdomain
  595.      3. vaddalias
  596.      4. vadduser
  597.      5. vchattr
  598.      6. vchforwards
  599.      7. vdeluser
  600.      8. vpasswd
  601.      _________________________________________________________________
  602.  
  603.    [Top] [Contents] [Index] [ ? ]
  604.  
  605.                               About this document
  606.  
  607.    This document was generated by Bruce.Guenter.dyndns.org on December,
  608.    29 2004 using texi2html
  609.  
  610.    The buttons in the navigation panels have the following meaning:
  611.  
  612.      Button      Name                    Go to                From 1.2.3 go to
  613.      [ < ]       Back     previous section in reading order   1.2.2
  614.      [ > ]      Forward   next section in reading order       1.2.4
  615.      [ << ]    FastBack   previous or up-and-previous section 1.1
  616.      [ Up ]       Up      up section                          1.2
  617.      [ >> ]   FastForward next or up-and-next section         1.3
  618.      [Top]        Top     cover (top) of document            
  619.    [Contents]  Contents   table of contents                  
  620.     [Index]      Index    concept index                      
  621.      [ ? ]       About    this page                          
  622.  
  623.    where the Example assumes that the current position is at
  624.    Subsubsection One-Two-Three of a document of the following structure:
  625.      * 1. Section One
  626.  
  627.      * 1.1 Subsection One-One
  628.  
  629.      * ...
  630.  
  631.      1.2 Subsection One-Two
  632.      * 1.2.1 Subsubsection One-Two-One
  633.      * 1.2.2 Subsubsection One-Two-Two
  634.      * 1.2.3 Subsubsection One-Two-Three     <== Current Position
  635.      * 1.2.4 Subsubsection One-Two-Four
  636.  
  637.      1.3 Subsection One-Three
  638.      * ...
  639.  
  640.      1.4 Subsection One-Four
  641.      _________________________________________________________________
  642.  
  643.    This document was generated by Bruce.Guenter on December,
  644.     using texi2html

Raw Paste


Login or Register to edit or fork this paste. It's free.