php-doc-en/reference/imap/reference.xml

<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.20 $ -->
<!-- Purpose: remote.mail -->
<!-- Membership: bundled, external -->

 <reference xml:id='ref.imap' xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
  <title>IMAP, POP3 and NNTP Functions</title>
  <titleabbrev>IMAP</titleabbrev>

  <partintro>
   <section xml:id="imap.intro">
    &reftitle.intro;
    <para>
     These functions enable you to operate with the <acronym>IMAP</acronym>
     protocol, as well as the <acronym>NNTP</acronym>, <acronym>POP3</acronym>
     and local mailbox access methods.
    </para>
    <para>
     Be warned however, that some of IMAP functions will not work correctly
     with the POP protocol.
    </para>
   </section>

   <section xml:id="imap.requirements">
    &reftitle.required;
    <para>
     This extension requires the c-client library to be installed.
     Grab the latest version from <link xlink:href="&url.imap;">&url.imap;</link>
     and compile it.
    </para>
    <para>
     It's important that you do not copy the IMAP source files directly into
     the system include directory as there may be conflicts.  Instead, create
     a new directory inside the system include directory, such as 
     <filename>/usr/local/imap-2000b/</filename> (location and name
     depend on your setup and IMAP version), and inside this new 
     directory create additional directories named <filename>lib/</filename> 
     and <filename>include/</filename>.  From the <filename>c-client</filename> 
     directory from your IMAP source tree, copy all the <filename>*.h</filename> 
     files into <filename>include/</filename> and all the 
     <filename>*.c</filename> files into <filename>lib/</filename>.  
     Additionally when you compiled IMAP, a file named
     <filename>c-client.a</filename> was created.  Also put this in the 
     <filename>lib/</filename> directory but rename it as
     <filename>libc-client.a</filename>.
    </para>
    <note>
     <para>
      To build the c-client library with SSL or/and Kerberos support read
      the docs supplied with the package.
     </para>
    </note>
    <note>
     <simpara>
      In Mandrake Linux, the IMAP library (<filename>libc-client.a</filename>)
      is compiled without Kerberos support. A separate version with SSL
      (<filename>client-PHP4.a</filename>) is installed. The library must
      be recompiled in order to add Kerberos support.
     </simpara>
    </note>
   </section>

   &reference.imap.configure;

   <section xml:id="imap.configuration">
    &reftitle.runtime;
    &no.config;
   </section>

   <section xml:id="imap.resources">
    &reftitle.resources;
    <para>
    </para>
   </section>

   &reference.imap.constants;

   <section xml:id="imap.seealso">
   &reftitle.seealso;
    <para>
     This document can't go into detail on all the topics touched by
     the provided functions. Further information is provided by the
     documentation of the c-client library source
     (<filename>docs/internal.txt</filename>). and the following RFC
     documents:
     <itemizedlist>
      <listitem>
       <simpara>
        <link xlink:href="&url.rfc;2821">RFC2821</link>: Simple Mail
        Transfer Protocol (SMTP).
       </simpara>
      </listitem>
      <listitem>
       <simpara>
        <link xlink:href="&url.rfc;2822">RFC2822</link>: Standard for
        ARPA internet text messages.
       </simpara>
      </listitem>
      <listitem>
       <simpara>
        <link xlink:href="&url.rfc;2060">RFC2060</link>: Internet
        Message Access Protocol (IMAP) Version 4rev1. 
       </simpara>
      </listitem>
      <listitem>
       <simpara>
        <link xlink:href="&url.rfc;1939">RFC1939</link>:  Post
        Office Protocol Version 3 (POP3).
       </simpara>
      </listitem>
      <listitem>
       <simpara>
        <link xlink:href="&url.rfc;977">RFC977</link>: Network News
        Transfer Protocol (NNTP).
       </simpara>
      </listitem>
      <listitem>
       <simpara>
        <link xlink:href="&url.rfc;2076">RFC2076</link>: Common
        Internet Message Headers.
       </simpara>
      </listitem>
      <listitem>
       <simpara>
        <link xlink:href="&url.rfc;2045">RFC2045</link> , <link
        xlink:href="&url.rfc;2046">RFC2046</link> , <link
        xlink:href="&url.rfc;2047">RFC2047</link> , <link
        xlink:href="&url.rfc;2048">RFC2048</link> &amp; <link
        xlink:href="&url.rfc;2049">RFC2049</link>: Multipurpose
        Internet Mail Extensions (MIME).
       </simpara>
      </listitem>
     </itemizedlist> 
     A detailed overview is also available in the books
     <link xlink:href="&url.email.book;">Programming Internet Email</link>
     by David Wood and  <link xlink:href="&url.imap.book;">Managing
     IMAP</link> by Dianna Mullet &amp; Kevin Mullet.
    </para>
   </section>
  </partintro>

&reference.imap.entities.functions;

 </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
-->