php-doc-en/functions/vmailmgr.sgml

 <reference id="ref.vmailmgr">
  <title>Vmailmgr functions</title>
  <titleabbrev>Vmailmgr</titleabbrev>

  <partintro>
   <simpara>
    These functions require <ulink url="&url.qmail;">qmail</ulink> and the
    <ulink url="&url.vmailmgr;">vmailmgr package</ulink> by Bruce Guenter.
   <simpara>
    For all functions, the following two variables are defined as:
    string vdomain the domain name of your virtual domain
    (vdomain.com) string basepwd the password of the 'real' user that
    holds the virtual users
   <simpara>
    Only up to 8 characters are recognized in passwords for virtual
    users
   <simpara>
    Return status for all functions matches response in response.h
   <para>

    <simplelist>
     <member>O ok</member>
     <member>1 bad</member>
     <member>2 error</member>
     <member>3 error connecting</member>
    </simplelist>

   <para>
    Known problems: <function>vm_deluser</function> does not delete
    the user directory as it should.  <function>vm_addalias</function>
    currently does not work correctly.
   <para>
    <informalexample>
     <programlisting>
&lt;?php
dl("php3_vmailmgr.so"); //load the shared library
$vdomain="vdomain.com";
$basepwd="password";
?>
      </programlisting>
     </informalexample>

  </partintro>

  <refentry id="function.vm-adduser">
   <refnamediv>
    <refname>vm_adduser</refname>
    <refpurpose>Add a new virtual user with a password</refpurpose>
   </refnamediv>
   <refsect1>
    <title>Description</title>
    <funcsynopsis>
     <funcdef>int <function>vm_adduser</function></funcdef>
     <paramdef>string <parameter>vdomain</parameter></paramdef>
     <paramdef>string <parameter>basepwd</parameter></paramdef>
     <paramdef>string <parameter>newusername</parameter></paramdef>
     <paramdef>string <parameter>newuserpassword</parameter></paramdef>
    </funcsynopsis>
    <simpara>
     Add a new virtual user with a
     password. <parameter>newusername</parameter> is the email login
     name and <parameter>newuserpassword</parameter> the password for
     this user.
   </refsect1>
  </refentry>

  <refentry id="function.vm-addalias">
   <refnamediv>
    <refname>vm_addalias</refname>
    <refpurpose>Add an alias to a virtual user</refpurpose>
   </refnamediv>
   <refsect1>
    <title>Description</title>
    <funcsynopsis>
     <funcdef>int <function>vm_addalias</function></funcdef>
     <paramdef>string <parameter>vdomain</parameter></paramdef>
     <paramdef>string <parameter>basepwd</parameter></paramdef>
     <paramdef>string <parameter>username</parameter></paramdef>
     <paramdef>string <parameter>alias</parameter></paramdef>
    </funcsynopsis>
    <simpara>
     Add an alias to a virtual user. <parameter>username</parameter>
     is the email login name and <parameter>alias</parameter>
     is an alias for this vuser.
   </refsect1>
  </refentry>

  <refentry id="function.vm-passwd">
   <refnamediv>
    <refname>vm_passwd</refname>
    <refpurpose>Changes a virtual users password</refpurpose>
   </refnamediv>
   <refsect1>
    <title>Description</title>
    <funcsynopsis>
     <funcdef>int <function>vm_passwd</function></funcdef>
     <paramdef>string <parameter>vdomain</parameter></paramdef>
     <paramdef>string <parameter>username</parameter></paramdef>
     <paramdef>string <parameter>password</parameter></paramdef>
     <paramdef>string <parameter>newpassword</parameter></paramdef>
    </funcsynopsis>
    <simpara>
     Changes a virtual users password. <parameter>username</parameter>
     is the email login name, <parameter>password</parameter> the old
     password for the vuser, and <parameter>newpassword</parameter>
     the new password.
   </refsect1>
  </refentry>

  <refentry id="function.vm-delalias">
   <refnamediv>
    <refname>vm_delalias</refname>
    <refpurpose>Removes an alias</refpurpose>
   </refnamediv>
   <refsect1>
    <title>Description</title>
    <funcsynopsis>
     <funcdef>int <function>vm_delalias</function></funcdef>
     <paramdef>string <parameter>vdomain</parameter></paramdef>
     <paramdef>string <parameter>basepwd</parameter></paramdef>
     <paramdef>string <parameter>alias</parameter></paramdef>
    </funcsynopsis>
    <simpara>
     Removes an alias.
   </refsect1>
  </refentry>

  <refentry id="function.vm-deluser">
   <refnamediv>
    <refname>vm_deluser</refname>
    <refpurpose>Removes a virtual user</refpurpose>
   </refnamediv>
   <refsect1>
    <title>Description</title>
    <funcsynopsis>
     <funcdef>int <function>vm_deluser</function></funcdef>
     <paramdef>string <parameter>vdomain</parameter></paramdef>
     <paramdef>string <parameter>username</parameter></paramdef>
    </funcsynopsis>
    <simpara>
     Removes a virtual user..
   </refsect1>
  </refentry>

 </reference>


<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-omittag:t
sgml-shorttag:t
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:1
sgml-indent-data:t
sgml-parent-document:nil
sgml-default-dtd-file:"../manual.ced"
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
End:
-->