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

<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.10 $ -->
 <reference id='ref.imap'>
  <title>IMAP, POP3 and NNTP functions</title>
  <titleabbrev>IMAP</titleabbrev>

  <partintro>
   <section id="imap.intro">
   &reftitle.intro;
   <para>
     These functions are not limited to the <acronym>IMAP</acronym> protocol,
     despite their name. The underlying c-client library also supports
     <acronym>NNTP</acronym>, <acronym>POP3</acronym> and local mailbox access
     methods.
    </para>
   </section>

   <section id="imap.requirements">
    &reftitle.required;
    <para>
     This extension requires the c-client library to be installed.
     Grab the latest version from <ulink url="&url.imap;">&url.imap;</ulink>
     and compile it.
    </para>
    <para>
     You have to copy some files to make sure they are in your link path
     (e.g.: <filename>/usr/local/lib/</filename>) and include directory
     (e.g.: <filename>/usr/local/include</filename>).
     The files to copy can be found in the source tree
     under <filename>imap-200x/c-lient</filename> after a succesfull run of
     <command>make</command>. Copy <filename>c-client.a</filename>
     to <filename>/usr/local/lib/libc-client.a</filename> or some other
     directory on your <emphasis>link path</emphasis>.
    </para>
    <note>
     <para>
      Make sure <filename>c-client.a</filename> ends up in your link path
      under the name <filename>libc-client.a</filename>.
     </para>
    </note>
    <para>
     Copy the following files to <filename>/usr/local/include</filename> or some
     other directory in your <emphasis>include path</emphasis>.
     <simplelist>
      <member><filename>c-client.h</filename></member>
      <member><filename>imap4r1.h</filename></member>
      <member><filename>rfc822.h</filename></member>
      <member><filename>mail.h</filename></member>
      <member><filename>linkage.h</filename></member>
      <member><filename>env.h</filename></member>
      <member><filename>env_unix.h</filename></member>
      <member><filename>fs.h</filename></member>
      <member><filename>ftl.h</filename></member>
      <member><filename>misc.h</filename></member>
      <member><filename>nntp.h</filename></member>
      <member><filename>nl.h</filename></member>
      <member><filename>osdep.h</filename></member>
      <member><filename>smtp.h</filename></member>
      <member><filename>tcp.h</filename></member>
     </simplelist>
    </para>
    <note>
     <para>
      The name of <filename>env_unix.h</filename> depends on your OS.
      Make sure to copy this files with following symlinks option.
      To build the c-client library with SSL or/and Kerberos support read
      the docs supplied with the package.
     </para>
    </note>
   </section>

   &reference.imap.configure;

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

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

   &reference.imap.constants;

   <section 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>
        <ulink url="&url.rfc;rfc2821.html">RFC2821</ulink>: Simple Mail
        Transfer Protocol (SMTP).
       </simpara>
      </listitem>
      <listitem>
       <simpara>
        <ulink url="&url.rfc;rfc2822.html">RFC2822</ulink>: Standard for
        ARPA internet text messages.
       </simpara>
      </listitem>
      <listitem>
       <simpara>
        <ulink url="&url.rfc;rfc2060.html">RFC2060</ulink>: Internet
        Message Access Protocol (IMAP) Version 4rev1. 
       </simpara>
      </listitem>
      <listitem>
       <simpara>
        <ulink url="&url.rfc;rfc1939.html">RFC1939</ulink>:  Post
        Office Protocol Version 3 (POP3).
       </simpara>
      </listitem>
      <listitem>
       <simpara>
        <ulink url="&url.rfc;rfc977.html">RFC977</ulink>: Network News
        Transfer Protocol (NNTP).
       </simpara>
      </listitem>
      <listitem>
       <simpara>
        <ulink url="&url.rfc;rfc2076.html">RFC2076</ulink>: Common
        Internet Message Headers.
       </simpara>
      </listitem>
      <listitem>
       <simpara>
        <ulink url="&url.rfc;rfc2045.html">RFC2045</ulink> , <ulink
        url="&url.rfc;rfc2046.html">RFC2046</ulink> , <ulink
        url="&url.rfc;rfc2047.html">RFC2047</ulink> , <ulink
        url="&url.rfc;rfc2048.html">RFC2048</ulink> &amp; <ulink
        url="&url.rfc;rfc2049.html">RFC2049</ulink>: Multipurpose
        Internet Mail Extensions (MIME).
       </simpara>
      </listitem>
     </itemizedlist> 
     A detailed overview is also available in the books
     <ulink url="&url.email.book;">Programming Internet Email</ulink>
     by David Wood and  <ulink url="&url.imap.book;">Managing
     IMAP</ulink> by Dianna Mullet &amp; Kevin Mullet.
    </para>
    <warning>
     <para>
      Crashes and startup problems of <literal>PHP</literal> may be encountered
      when loading this extension in conjunction with the recode extension.
      See the <link linkend="ref.recode">recode</link> extension for more
      information.
     </para>
    </warning>
   </section>
  </partintro>

&reference.imap.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
-->