php-doc-en/functions/cyrus.xml

<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.5 $ -->
 <reference id="ref.cyrus">
  <title>Cyrus IMAP administration functions</title>
  <titleabbrev>Cyradm functions</titleabbrev>

  <partintro>
   <para>
		undocumented 
   </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>
    <funcsynopsis>
     <funcprototype>
      <funcdef>resource <function>cyrus_connect</function></funcdef>
     <paramdef>string
      <parameter><optional>host</optional></parameter>
     </paramdef>
     <paramdef>string
      <parameter><optional>port</optional></parameter>
     </paramdef>
     <paramdef>int
      <parameter><optional>flags</optional></parameter>
     </paramdef>
     </funcprototype>
    </funcsynopsis>
    <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>
    <funcsynopsis>
     <funcprototype>
      <funcdef>bool <function>cyrus_authenticate</function></funcdef>
     <paramdef>resource <parameter>connection</parameter></paramdef>
     <paramdef>string
      <parameter><optional>mechlist</optional></parameter>
     </paramdef>
     <paramdef>string
      <parameter><optional>service</optional></parameter>
     </paramdef>
     <paramdef>string
      <parameter><optional>user</optional></parameter>
     </paramdef>
     <paramdef>int
      <parameter><optional>minssf</optional></parameter>
     </paramdef>
     <paramdef>int
      <parameter><optional>maxssf</optional></parameter>
     </paramdef>
     </funcprototype>
    </funcsynopsis>
    <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>
    <funcsynopsis>
     <funcprototype>
      <funcdef>bool <function>cyrus_bind</function></funcdef>
			<paramdef>resource <parameter>connection</parameter></paramdef>
			<paramdef>array <parameter>callbacks</parameter></paramdef>
     </funcprototype>
    </funcsynopsis>
    <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>
    <funcsynopsis>
     <funcprototype>
      <funcdef>bool <function>cyrus_unbind</function></funcdef>
			<paramdef>resource <parameter>connection</parameter></paramdef>
			<paramdef>string <parameter>trigger_name</parameter></paramdef>
     </funcprototype>
    </funcsynopsis>
    <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>
    <funcsynopsis>
     <funcprototype>
      <funcdef>bool <function>cyrus_query</function></funcdef>
			<paramdef>resource <parameter>connection</parameter></paramdef>
			<paramdef>string <parameter>query</parameter></paramdef>
     </funcprototype>
    </funcsynopsis>
    <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>
    <funcsynopsis>
     <funcprototype>
      <funcdef>bool <function>cyrus_close</function></funcdef>
			<paramdef>resource <parameter>connection</parameter></paramdef>
     </funcprototype>
    </funcsynopsis>
    <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:
-->