1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146
|
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.7 $ -->
<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:
-->
|