betz Wed May 29 14:46:11 2002 EDT
Added files:
/phpdoc/en/reference/imap constants.xml
Modified files:
/phpdoc/en/reference/imap reference.xml
Log:
new structure and constants added
Index: phpdoc/en/reference/imap/reference.xml
diff -u phpdoc/en/reference/imap/reference.xml:1.4
phpdoc/en/reference/imap/reference.xml:1.5
--- phpdoc/en/reference/imap/reference.xml:1.4 Mon Apr 22 05:17:32 2002
+++ phpdoc/en/reference/imap/reference.xml Wed May 29 14:46:11 2002
@@ -1,96 +1,127 @@
<?xml version="1.0" encoding="iso-8859-1"?>
-<!-- $Revision: 1.4 $ -->
+<!-- $Revision: 1.5 $ -->
<reference id='ref.imap'>
<title>IMAP, POP3 and NNTP functions</title>
<titleabbrev>IMAP</titleabbrev>
<partintro>
- <simpara>
- To get these functions to work, you have to compile PHP with
- <option role="configure">--with-imap</option>. That requires the
- c-client library to be installed. Grab the latest version from
- <ulink url="&url.imap;">&url.imap;</ulink> and compile it.
- </simpara>
- <simpara>
- Then copy <filename>c-client/c-client.a</filename> to
- <filename>/usr/local/lib/libc-client.a</filename> or some other
- directory on your link path and copy <filename>c-client/*.h</filename>
- to <filename>/usr/local/include</filename> or some other directory in
- your include path.
- </simpara>
- <note>
- <simpara>
- Depending how the c-client was configured, you might also need to add
- <option role="configure">--with-imap-ssl=/path/to/openssl/</option>
- and/or <option role="configure">--with-kerberos</option> into the PHP
- configure line.
- </simpara>
- </note>
- <simpara>
- Note that 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.
- </simpara>
+ <section id="imap.intro">
+ &reftitle.intro;
<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
+ 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.requirenments">
+ &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>
+ </section>
+
+ <section id="imap.installation">
+ &reftitle.install;
+ <para>
+ To get these functions to work, you have to compile PHP with
+ <option role="configure">--with-imap</option>.
+ </para>
+ <para>
+ Then copy <filename>c-client/c-client.a</filename> to
+ <filename>/usr/local/lib/libc-client.a</filename> or some other
+ directory on your link path and copy <filename>c-client/*.h</filename>
+ to <filename>/usr/local/include</filename> or some other directory in
+ your include path.
+ </para>
+ <note>
+ <simpara>
+ Depending how the c-client was configured, you might also need to add
+ <option role="configure">--with-imap-ssl=/path/to/openssl/</option>
+ and/or <option role="configure">--with-kerberos</option> into the PHP
+ configure line.
+ </simpara>
+ </note>
+ </section>
+
+ <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> & <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
+ 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 & Kevin Mullet.
- </para>
+ </para>
+ </section>
</partintro>
&reference.imap.functions;
Index: phpdoc/en/reference/imap/constants.xml
+++ phpdoc/en/reference/imap/constants.xml
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.1 $ -->
<section id="imap.constants">
&reftitle.constants;
&extension.constants;
<variablelist>
<varlistentry>
<term>
<constant>NIL</constant>
(<link linkend="language.types.integer">integer</link>)
</term>
<listitem>
<simpara>
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term>
<constant>OP_DEBUG</constant>
(<link linkend="language.types.integer">integer</link>)
</term>
<listitem>
<simpara>
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term>
<constant>OP_READONLY</constant>
(<link linkend="language.types.integer">integer</link>)
</term>
<listitem>
<simpara>
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term>
<constant>OP_ANONYMOUS</constant>
(<link linkend="language.types.integer">integer</link>)
</term>
<listitem>
<simpara>
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term>
<constant>OP_SHORTCACHE</constant>
(<link linkend="language.types.integer">integer</link>)
</term>
<listitem>
<simpara>
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term>
<constant>OP_SILENT</constant>
(<link linkend="language.types.integer">integer</link>)
</term>
<listitem>
<simpara>
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term>
<constant>OP_PROTOTYPE</constant>
(<link linkend="language.types.integer">integer</link>)
</term>
<listitem>
<simpara>
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term>
<constant>OP_HALFOPEN</constant>
(<link linkend="language.types.integer">integer</link>)
</term>
<listitem>
<simpara>
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term>
<constant>OP_EXPUNGE</constant>
(<link linkend="language.types.integer">integer</link>)
</term>
<listitem>
<simpara>
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term>
<constant>OP_SECURE</constant>
(<link linkend="language.types.integer">integer</link>)
</term>
<listitem>
<simpara>
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term>
<constant>CL_EXPUNGE</constant>
(<link linkend="language.types.integer">integer</link>)
</term>
<listitem>
<simpara>
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term>
<constant>FT_UID</constant>
(<link linkend="language.types.integer">integer</link>)
</term>
<listitem>
<simpara>
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term>
<constant>FT_PEEK</constant>
(<link linkend="language.types.integer">integer</link>)
</term>
<listitem>
<simpara>
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term>
<constant>FT_NOT</constant>
(<link linkend="language.types.integer">integer</link>)
</term>
<listitem>
<simpara>
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term>
<constant>FT_INTERNAL</constant>
(<link linkend="language.types.integer">integer</link>)
</term>
<listitem>
<simpara>
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term>
<constant>FT_PREFETCHTEXT</constant>
(<link linkend="language.types.integer">integer</link>)
</term>
<listitem>
<simpara>
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term>
<constant>ST_UID</constant>
(<link linkend="language.types.integer">integer</link>)
</term>
<listitem>
<simpara>
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term>
<constant>ST_SILENT</constant>
(<link linkend="language.types.integer">integer</link>)
</term>
<listitem>
<simpara>
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term>
<constant>ST_SET</constant>
(<link linkend="language.types.integer">integer</link>)
</term>
<listitem>
<simpara>
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term>
<constant>CP_UID</constant>
(<link linkend="language.types.integer">integer</link>)
</term>
<listitem>
<simpara>
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term>
<constant>CP_MOVE</constant>
(<link linkend="language.types.integer">integer</link>)
</term>
<listitem>
<simpara>
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term>
<constant>SE_UID</constant>
(<link linkend="language.types.integer">integer</link>)
</term>
<listitem>
<simpara>
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term>
<constant>SE_FREE</constant>
(<link linkend="language.types.integer">integer</link>)
</term>
<listitem>
<simpara>
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term>
<constant>SE_NOPREFETCH</constant>
(<link linkend="language.types.integer">integer</link>)
</term>
<listitem>
<simpara>
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term>
<constant>SO_FREE</constant>
(<link linkend="language.types.integer">integer</link>)
</term>
<listitem>
<simpara>
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term>
<constant>SO_NOSERVER</constant>
(<link linkend="language.types.integer">integer</link>)
</term>
<listitem>
<simpara>
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term>
<constant>SA_MESSAGES</constant>
(<link linkend="language.types.integer">integer</link>)
</term>
<listitem>
<simpara>
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term>
<constant>SA_RECENT</constant>
(<link linkend="language.types.integer">integer</link>)
</term>
<listitem>
<simpara>
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term>
<constant>SA_UNSEEN</constant>
(<link linkend="language.types.integer">integer</link>)
</term>
<listitem>
<simpara>
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term>
<constant>SA_UIDNEXT</constant>
(<link linkend="language.types.integer">integer</link>)
</term>
<listitem>
<simpara>
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term>
<constant>SA_UIDVALIDITY</constant>
(<link linkend="language.types.integer">integer</link>)
</term>
<listitem>
<simpara>
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term>
<constant>SA_ALL</constant>
(<link linkend="language.types.integer">integer</link>)
</term>
<listitem>
<simpara>
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term>
<constant>LATT_NOINFERIORS</constant>
(<link linkend="language.types.integer">integer</link>)
</term>
<listitem>
<simpara>
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term>
<constant>LATT_NOSELECT</constant>
(<link linkend="language.types.integer">integer</link>)
</term>
<listitem>
<simpara>
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term>
<constant>LATT_MARKED</constant>
(<link linkend="language.types.integer">integer</link>)
</term>
<listitem>
<simpara>
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term>
<constant>LATT_UNMARKED</constant>
(<link linkend="language.types.integer">integer</link>)
</term>
<listitem>
<simpara>
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term>
<constant>SORTDATE</constant>
(<link linkend="language.types.integer">integer</link>)
</term>
<listitem>
<simpara>
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term>
<constant>SORTARRIVAL</constant>
(<link linkend="language.types.integer">integer</link>)
</term>
<listitem>
<simpara>
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term>
<constant>SORTFROM</constant>
(<link linkend="language.types.integer">integer</link>)
</term>
<listitem>
<simpara>
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term>
<constant>SORTSUBJECT</constant>
(<link linkend="language.types.integer">integer</link>)
</term>
<listitem>
<simpara>
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term>
<constant>SORTTO</constant>
(<link linkend="language.types.integer">integer</link>)
</term>
<listitem>
<simpara>
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term>
<constant>SORTCC</constant>
(<link linkend="language.types.integer">integer</link>)
</term>
<listitem>
<simpara>
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term>
<constant>SORTSIZE</constant>
(<link linkend="language.types.integer">integer</link>)
</term>
<listitem>
<simpara>
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term>
<constant>TYPETEXT</constant>
(<link linkend="language.types.integer">integer</link>)
</term>
<listitem>
<simpara>
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term>
<constant>TYPEMULTIPART</constant>
(<link linkend="language.types.integer">integer</link>)
</term>
<listitem>
<simpara>
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term>
<constant>TYPEMESSAGE</constant>
(<link linkend="language.types.integer">integer</link>)
</term>
<listitem>
<simpara>
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term>
<constant>TYPEAPPLICATION</constant>
(<link linkend="language.types.integer">integer</link>)
</term>
<listitem>
<simpara>
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term>
<constant>TYPEAUDIO</constant>
(<link linkend="language.types.integer">integer</link>)
</term>
<listitem>
<simpara>
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term>
<constant>TYPEIMAGE</constant>
(<link linkend="language.types.integer">integer</link>)
</term>
<listitem>
<simpara>
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term>
<constant>TYPEVIDEO</constant>
(<link linkend="language.types.integer">integer</link>)
</term>
<listitem>
<simpara>
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term>
<constant>TYPEOTHER</constant>
(<link linkend="language.types.integer">integer</link>)
</term>
<listitem>
<simpara>
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term>
<constant>ENC7BIT</constant>
(<link linkend="language.types.integer">integer</link>)
</term>
<listitem>
<simpara>
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term>
<constant>ENC8BIT</constant>
(<link linkend="language.types.integer">integer</link>)
</term>
<listitem>
<simpara>
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term>
<constant>ENCBINARY</constant>
(<link linkend="language.types.integer">integer</link>)
</term>
<listitem>
<simpara>
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term>
<constant>ENCBASE64</constant>
(<link linkend="language.types.integer">integer</link>)
</term>
<listitem>
<simpara>
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term>
<constant>ENCQUOTEDPRINTABLE</constant>
(<link linkend="language.types.integer">integer</link>)
</term>
<listitem>
<simpara>
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term>
<constant>ENCOTHER</constant>
(<link linkend="language.types.integer">integer</link>)
</term>
<listitem>
<simpara>
</simpara>
</listitem>
</varlistentry>
</variablelist>
</section>
<!-- 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
-->
