mirror of
https://github.com/sigmasternchen/php-doc-en
synced 2025-03-28 14:58:55 +00:00
82815f96a3
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@65178 c90b9560-bf6c-de11-be94-00142212c4b1
412 lines
12 KiB
XML
412 lines
12 KiB
XML
<?xml version="1.0" encoding="iso-8859-1"?>
|
|
<!-- $Revision: 1.1 $ -->
|
|
<reference id="ref.vpopmail">
|
|
<title>vpopmail functions</title>
|
|
<titleabbrev>vpopmail functions</titleabbrev>
|
|
|
|
<partintro>
|
|
<para>
|
|
</para>
|
|
</partintro>
|
|
|
|
|
|
<refentry id="function.vpopmail-add-domain">
|
|
<refnamediv>
|
|
<refname>vpopmail_add_domain</refname>
|
|
<refpurpose>Add a new virtual domain </refpurpose>
|
|
</refnamediv>
|
|
<refsect1>
|
|
<title>Description</title>
|
|
<funcsynopsis>
|
|
<funcprototype>
|
|
<funcdef>bool <function>vpopmail_add_domain</function></funcdef>
|
|
<paramdef>string <parameter>domain</parameter></paramdef>
|
|
<paramdef>string <parameter>dir</parameter></paramdef>
|
|
<paramdef>int <parameter>uid</parameter></paramdef>
|
|
<paramdef>int <parameter>gid</parameter></paramdef>
|
|
</funcprototype>
|
|
</funcsynopsis>
|
|
&warn.experimental.func;
|
|
<para>
|
|
&warn.undocumented.func;
|
|
</para>
|
|
</refsect1>
|
|
</refentry>
|
|
|
|
<refentry id="function.vpopmail-del-domain">
|
|
<refnamediv>
|
|
<refname>vpopmail_del_domain</refname>
|
|
<refpurpose>Delete a virtual domain </refpurpose>
|
|
</refnamediv>
|
|
<refsect1>
|
|
<title>Description</title>
|
|
<funcsynopsis>
|
|
<funcprototype>
|
|
<funcdef>bool <function>vpopmail_del_domain</function></funcdef>
|
|
<paramdef>string <parameter>domain</parameter></paramdef>
|
|
</funcprototype>
|
|
</funcsynopsis>
|
|
&warn.experimental.func;
|
|
<para>
|
|
&warn.undocumented.func;
|
|
</para>
|
|
</refsect1>
|
|
</refentry>
|
|
|
|
<refentry id="function.vpopmail-add-alias-domain">
|
|
<refnamediv>
|
|
<refname>vpopmail_add_alias_domain</refname>
|
|
<refpurpose>Add an alias for a virtual domain </refpurpose>
|
|
</refnamediv>
|
|
<refsect1>
|
|
<title>Description</title>
|
|
<funcsynopsis>
|
|
<funcprototype>
|
|
<funcdef>bool <function>vpopmail_add_alias_domain</function></funcdef>
|
|
<paramdef>string <parameter>domain</parameter></paramdef>
|
|
<paramdef>string <parameter>aliasdomain</parameter></paramdef>
|
|
</funcprototype>
|
|
</funcsynopsis>
|
|
&warn.experimental.func;
|
|
<para>
|
|
&warn.undocumented.func;
|
|
</para>
|
|
</refsect1>
|
|
</refentry>
|
|
|
|
<refentry id="function.vpopmail-add-domain-ex">
|
|
<refnamediv>
|
|
<refname>vpopmail_add_domain_ex</refname>
|
|
<refpurpose>Add a new virtual domain </refpurpose>
|
|
</refnamediv>
|
|
<refsect1>
|
|
<title>Description</title>
|
|
<funcsynopsis>
|
|
<funcprototype>
|
|
<funcdef>bool <function>vpopmail_add_domain_ex</function></funcdef>
|
|
<paramdef>string <parameter>domain</parameter></paramdef>
|
|
<paramdef>string <parameter>passwd</parameter></paramdef>
|
|
<paramdef>string
|
|
<parameter><optional>quota</optional></parameter>
|
|
</paramdef>
|
|
<paramdef>string
|
|
<parameter><optional>bounce</optional></parameter>
|
|
</paramdef>
|
|
<paramdef>bool
|
|
<parameter><optional>apop</optional></parameter>
|
|
</paramdef>
|
|
</funcprototype>
|
|
</funcsynopsis>
|
|
&warn.experimental.func;
|
|
<para>
|
|
&warn.undocumented.func;
|
|
</para>
|
|
</refsect1>
|
|
</refentry>
|
|
|
|
<refentry id="function.vpopmail-del-domain-ex">
|
|
<refnamediv>
|
|
<refname>vpopmail_del_domain_ex</refname>
|
|
<refpurpose>Delete a virtual domain </refpurpose>
|
|
</refnamediv>
|
|
<refsect1>
|
|
<title>Description</title>
|
|
<funcsynopsis>
|
|
<funcprototype>
|
|
<funcdef>bool <function>vpopmail_del_domain_ex</function></funcdef>
|
|
<paramdef>string <parameter>domain</parameter></paramdef>
|
|
</funcprototype>
|
|
</funcsynopsis>
|
|
&warn.experimental.func;
|
|
<para>
|
|
&warn.undocumented.func;
|
|
</para>
|
|
</refsect1>
|
|
</refentry>
|
|
|
|
<refentry id="function.vpopmail-add-alias-domain-ex">
|
|
<refnamediv>
|
|
<refname>vpopmail_add_alias_domain_ex</refname>
|
|
<refpurpose>Add alias to an existing virtual domain </refpurpose>
|
|
</refnamediv>
|
|
<refsect1>
|
|
<title>Description</title>
|
|
<funcsynopsis>
|
|
<funcprototype>
|
|
<funcdef>bool <function>vpopmail_add_alias_domain_ex</function></funcdef>
|
|
<paramdef>string <parameter>olddomain</parameter></paramdef>
|
|
<paramdef>string <parameter>newdomain</parameter></paramdef>
|
|
</funcprototype>
|
|
</funcsynopsis>
|
|
&warn.experimental.func;
|
|
<para>
|
|
&warn.undocumented.func;
|
|
</para>
|
|
</refsect1>
|
|
</refentry>
|
|
|
|
<refentry id="function.vpopmail-add-user">
|
|
<refnamediv>
|
|
<refname>vpopmail_add_user</refname>
|
|
<refpurpose>Add a new user to the specified virtual domain </refpurpose>
|
|
</refnamediv>
|
|
<refsect1>
|
|
<title>Description</title>
|
|
<funcsynopsis>
|
|
<funcprototype>
|
|
<funcdef>bool <function>vpopmail_add_user</function></funcdef>
|
|
<paramdef>string <parameter>user</parameter></paramdef>
|
|
<paramdef>string <parameter>domain</parameter></paramdef>
|
|
<paramdef>string <parameter>password</parameter></paramdef>
|
|
<paramdef>string
|
|
<parameter><optional>gecos</optional></parameter>
|
|
</paramdef>
|
|
<paramdef>bool
|
|
<parameter><optional>apop</optional></parameter>
|
|
</paramdef>
|
|
</funcprototype>
|
|
</funcsynopsis>
|
|
&warn.experimental.func;
|
|
<para>
|
|
&warn.undocumented.func;
|
|
</para>
|
|
</refsect1>
|
|
</refentry>
|
|
|
|
<refentry id="function.vpopmail-del-user">
|
|
<refnamediv>
|
|
<refname>vpopmail_del_user</refname>
|
|
<refpurpose>Delete a user from a virtual domain </refpurpose>
|
|
</refnamediv>
|
|
<refsect1>
|
|
<title>Description</title>
|
|
<funcsynopsis>
|
|
<funcprototype>
|
|
<funcdef>bool <function>vpopmail_del_user</function></funcdef>
|
|
<paramdef>string <parameter>user</parameter></paramdef>
|
|
<paramdef>string <parameter>domain</parameter></paramdef>
|
|
</funcprototype>
|
|
</funcsynopsis>
|
|
&warn.experimental.func;
|
|
<para>
|
|
&warn.undocumented.func;
|
|
</para>
|
|
</refsect1>
|
|
</refentry>
|
|
|
|
<refentry id="function.vpopmail-passwd">
|
|
<refnamediv>
|
|
<refname>vpopmail_passwd</refname>
|
|
<refpurpose>Change a virtual user's password </refpurpose>
|
|
</refnamediv>
|
|
<refsect1>
|
|
<title>Description</title>
|
|
<funcsynopsis>
|
|
<funcprototype>
|
|
<funcdef>bool <function>vpopmail_passwd</function></funcdef>
|
|
<paramdef>string <parameter>user</parameter></paramdef>
|
|
<paramdef>string <parameter>domain</parameter></paramdef>
|
|
<paramdef>string <parameter>password</parameter></paramdef>
|
|
</funcprototype>
|
|
</funcsynopsis>
|
|
&warn.experimental.func;
|
|
<para>
|
|
&warn.undocumented.func;
|
|
</para>
|
|
</refsect1>
|
|
</refentry>
|
|
|
|
<refentry id="function.vpopmail-set-user-quota">
|
|
<refnamediv>
|
|
<refname>vpopmail_set_user_quota</refname>
|
|
<refpurpose>Sets a virtual user's quota </refpurpose>
|
|
</refnamediv>
|
|
<refsect1>
|
|
<title>Description</title>
|
|
<funcsynopsis>
|
|
<funcprototype>
|
|
<funcdef>bool <function>vpopmail_set_user_quota</function></funcdef>
|
|
<paramdef>string <parameter>user</parameter></paramdef>
|
|
<paramdef>string <parameter>domain</parameter></paramdef>
|
|
<paramdef>string <parameter>quota</parameter></paramdef>
|
|
</funcprototype>
|
|
</funcsynopsis>
|
|
&warn.experimental.func;
|
|
<para>
|
|
&warn.undocumented.func;
|
|
</para>
|
|
</refsect1>
|
|
</refentry>
|
|
|
|
<refentry id="function.vpopmail-auth-user">
|
|
<refnamediv>
|
|
<refname>vpopmail_auth_user</refname>
|
|
<refpurpose>Attempt to validate a username/domain/password. Returns true/false </refpurpose>
|
|
</refnamediv>
|
|
<refsect1>
|
|
<title>Description</title>
|
|
<funcsynopsis>
|
|
<funcprototype>
|
|
<funcdef>bool <function>vpopmail_auth_user</function></funcdef>
|
|
<paramdef>string <parameter>user</parameter></paramdef>
|
|
<paramdef>string <parameter>domain</parameter></paramdef>
|
|
<paramdef>string <parameter>password</parameter></paramdef>
|
|
<paramdef>string
|
|
<parameter><optional>apop</optional></parameter>
|
|
</paramdef>
|
|
</funcprototype>
|
|
</funcsynopsis>
|
|
&warn.experimental.func;
|
|
<para>
|
|
&warn.undocumented.func;
|
|
</para>
|
|
</refsect1>
|
|
</refentry>
|
|
|
|
<refentry id="function.vpopmail-alias-add">
|
|
<refnamediv>
|
|
<refname>vpopmail_alias_add</refname>
|
|
<refpurpose>insert a virtual alias </refpurpose>
|
|
</refnamediv>
|
|
<refsect1>
|
|
<title>Description</title>
|
|
<funcsynopsis>
|
|
<funcprototype>
|
|
<funcdef>bool <function>vpopmail_alias_add</function></funcdef>
|
|
<paramdef>string <parameter>user</parameter></paramdef>
|
|
<paramdef>string <parameter>domain</parameter></paramdef>
|
|
<paramdef>string <parameter>alias</parameter></paramdef>
|
|
</funcprototype>
|
|
</funcsynopsis>
|
|
&warn.experimental.func;
|
|
<para>
|
|
&warn.undocumented.func;
|
|
</para>
|
|
</refsect1>
|
|
</refentry>
|
|
|
|
<refentry id="function.vpopmail-alias-del">
|
|
<refnamediv>
|
|
<refname>vpopmail_alias_del</refname>
|
|
<refpurpose>deletes all virtual aliases of a user </refpurpose>
|
|
</refnamediv>
|
|
<refsect1>
|
|
<title>Description</title>
|
|
<funcsynopsis>
|
|
<funcprototype>
|
|
<funcdef>bool <function>vpopmail_alias_del</function></funcdef>
|
|
<paramdef>string <parameter>user</parameter></paramdef>
|
|
<paramdef>string <parameter>domain</parameter></paramdef>
|
|
</funcprototype>
|
|
</funcsynopsis>
|
|
&warn.experimental.func;
|
|
<para>
|
|
&warn.undocumented.func;
|
|
</para>
|
|
</refsect1>
|
|
</refentry>
|
|
|
|
<refentry id="function.vpopmail-alias-del-domain">
|
|
<refnamediv>
|
|
<refname>vpopmail_alias_del_domain</refname>
|
|
<refpurpose>deletes all virtual aliases of a domain </refpurpose>
|
|
</refnamediv>
|
|
<refsect1>
|
|
<title>Description</title>
|
|
<funcsynopsis>
|
|
<funcprototype>
|
|
<funcdef>bool <function>vpopmail_alias_del_domain</function></funcdef>
|
|
<paramdef>string <parameter>domain</parameter></paramdef>
|
|
</funcprototype>
|
|
</funcsynopsis>
|
|
&warn.experimental.func;
|
|
<para>
|
|
&warn.undocumented.func;
|
|
</para>
|
|
</refsect1>
|
|
</refentry>
|
|
|
|
<refentry id="function.vpopmail-alias-get">
|
|
<refnamediv>
|
|
<refname>vpopmail_alias_get</refname>
|
|
<refpurpose>get all lines of an alias for a domain </refpurpose>
|
|
</refnamediv>
|
|
<refsect1>
|
|
<title>Description</title>
|
|
<funcsynopsis>
|
|
<funcprototype>
|
|
<funcdef>array <function>vpopmail_alias_get</function></funcdef>
|
|
<paramdef>string <parameter>alias</parameter></paramdef>
|
|
<paramdef>string <parameter>domain</parameter></paramdef>
|
|
</funcprototype>
|
|
</funcsynopsis>
|
|
&warn.experimental.func;
|
|
<para>
|
|
&warn.undocumented.func;
|
|
</para>
|
|
</refsect1>
|
|
</refentry>
|
|
|
|
<refentry id="function.vpopmail-alias-get-all">
|
|
<refnamediv>
|
|
<refname>vpopmail_alias_get_all</refname>
|
|
<refpurpose>get all lines of an alias for a domain </refpurpose>
|
|
</refnamediv>
|
|
<refsect1>
|
|
<title>Description</title>
|
|
<funcsynopsis>
|
|
<funcprototype>
|
|
<funcdef>array <function>vpopmail_alias_get_all</function></funcdef>
|
|
<paramdef>string <parameter>domain</parameter></paramdef>
|
|
</funcprototype>
|
|
</funcsynopsis>
|
|
&warn.experimental.func;
|
|
<para>
|
|
&warn.undocumented.func;
|
|
</para>
|
|
</refsect1>
|
|
</refentry>
|
|
|
|
<refentry id="function.vpopmail-error">
|
|
<refnamediv>
|
|
<refname>vpopmail_error</refname>
|
|
<refpurpose>Get text message for last vpopmail error. Returns string </refpurpose>
|
|
</refnamediv>
|
|
<refsect1>
|
|
<title>Description</title>
|
|
<funcsynopsis>
|
|
<funcprototype>
|
|
<funcdef>string <function>vpopmail_error</function></funcdef>
|
|
<void/>
|
|
</funcprototype>
|
|
</funcsynopsis>
|
|
&warn.experimental.func;
|
|
<para>
|
|
&warn.undocumented.func;
|
|
</para>
|
|
</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
|
|
indent-tabs-mode:nil
|
|
sgml-parent-document:nil
|
|
sgml-default-dtd-file:"../../manual.ced"
|
|
sgml-exposed-tags:nil
|
|
sgml-local-catalogs:nil
|
|
sgml-local-ecat-files:nil
|
|
End:
|
|
vim600: syn=xml fen fdm=syntax fdl=2 si
|
|
vim: et tw=78 syn=sgml
|
|
vi: ts=1 sw=1
|
|
-->
|
|
|