php-doc-en/functions/cyrus.xml
Hartmut Holzgraefe 7839d91186 added DO NOT EDIT noctice to old english functions files,
removing the others


git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@78562 c90b9560-bf6c-de11-be94-00142212c4b1
2002-04-17 19:58:46 +00:00

155 lines
4.8 KiB
XML

<!-- D O N O T E D I T T H I S F I L E ! ! !
it is still here for historical reasons only
(as translators may need to check old revision diffs)
if you want to change things documented in this file
you should now edit the files found under en/reference
instead -->
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.8 $ -->
<reference id="ref.cyrus">
<title>Cyrus IMAP administration functions</title>
<titleabbrev>Cyradm functions</titleabbrev>
<partintro>
<para>
&warn.undocumented.func;
</para>
</partintro>
<refentry id="function.cyrus-connect">
<refnamediv>
<refname>cyrus_connect</refname>
<refpurpose>Connect to a Cyrus IMAP server </refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>resource</type><methodname>cyrus_connect</methodname>
<methodparam choice="opt"><type>string</type><parameter>host</parameter></methodparam>
<methodparam choice="opt"><type>string</type><parameter>port</parameter></methodparam>
<methodparam choice="opt"><type>int</type><parameter>flags</parameter></methodparam>
</methodsynopsis>
<para>
&warn.undocumented.func;
</para>
</refsect1>
</refentry>
<refentry id="function.cyrus-authenticate">
<refnamediv>
<refname>cyrus_authenticate</refname>
<refpurpose>Authenticate agaings a Cyrus IMAP server </refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>bool</type><methodname>cyrus_authenticate</methodname>
<methodparam><type>resource</type><parameter>connection</parameter></methodparam>
<methodparam choice="opt"><type>string</type><parameter>mechlist</parameter></methodparam>
<methodparam choice="opt"><type>string</type><parameter>service</parameter></methodparam>
<methodparam choice="opt"><type>string</type><parameter>user</parameter></methodparam>
<methodparam choice="opt"><type>int</type><parameter>minssf</parameter></methodparam>
<methodparam choice="opt"><type>int</type><parameter>maxssf</parameter></methodparam>
</methodsynopsis>
<para>
&warn.undocumented.func;
</para>
</refsect1>
</refentry>
<refentry id="function.cyrus-bind">
<refnamediv>
<refname>cyrus_bind</refname>
<refpurpose>Bind callbacks to a Cyrus IMAP connection </refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>bool</type><methodname>cyrus_bind</methodname>
<methodparam><type>resource</type><parameter>connection</parameter></methodparam>
<methodparam><type>array</type><parameter>callbacks</parameter></methodparam>
</methodsynopsis>
<para>
&warn.undocumented.func;
</para>
</refsect1>
</refentry>
<refentry id="function.cyrus-unbind">
<refnamediv>
<refname>cyrus_unbind</refname>
<refpurpose>Unbind ... </refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>bool</type><methodname>cyrus_unbind</methodname>
<methodparam><type>resource</type><parameter>connection</parameter></methodparam>
<methodparam><type>string</type><parameter>trigger_name</parameter></methodparam>
</methodsynopsis>
<para>
&warn.undocumented.func;
</para>
</refsect1>
</refentry>
<refentry id="function.cyrus-query">
<refnamediv>
<refname>cyrus_query</refname>
<refpurpose>Send a query to a Cyrus IMAP server </refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>bool</type><methodname>cyrus_query</methodname>
<methodparam><type>resource</type><parameter>connection</parameter></methodparam>
<methodparam><type>string</type><parameter>query</parameter></methodparam>
</methodsynopsis>
<para>
&warn.undocumented.func;
</para>
</refsect1>
</refentry>
<refentry id="function.cyrus-close">
<refnamediv>
<refname>cyrus_close</refname>
<refpurpose>Close connection to a cyrus server </refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>bool</type><methodname>cyrus_close</methodname>
<methodparam><type>resource</type><parameter>connection</parameter></methodparam>
</methodsynopsis>
<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:
-->