integrated some user annotations

git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@33020 c90b9560-bf6c-de11-be94-00142212c4b1
This commit is contained in:
Hartmut Holzgraefe 2000-09-27 22:10:10 +00:00
parent 08516232aa
commit e93f595d61

View file

@ -23,62 +23,63 @@
<acronym>POP3</acronym> and local mailbox access methods.
</simpara>
<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:
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;rfc821.html">RFC821</ulink>:
Simple Mail Transfer Protocol (SMTP).
<ulink url="&url.rfc;rfc821.html">RFC821</ulink>: Simple Mail
Transfer Protocol (SMTP).
</simpara>
</listitem>
<listitem>
<simpara>
<ulink url="&url.rfc;rfc822.html">RFC822</ulink>:
Standard for ARPA internet text messages.
<ulink url="&url.rfc;rfc822.html">RFC822</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.
<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).
<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).
<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.
<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).
<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 book
<ulink url="&url.email.book;">Programming Internet Email</ulink>
by David Wood.
</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>
</partintro>
@ -206,6 +207,13 @@ imap_close($stream);
</simpara>
</listitem>
</itemizedlist>
</para>
<para>
<function>imap_body</function> will only return a verbatim copy of the
message body. To extract single parts of a multipart MIME-encoded
message you have to use <function>imap_fetch_structure</function> to
analyze its structure and <function>imap_fetch_body</function> to
extract a copy of a single body component.
</para>
</refsect1>
</refentry>
@ -702,28 +710,26 @@ imap_close ($mbox);
</refsect1>
</refentry>
<refentry id="function.imap-header">
<refentry id="function.imap-headerinfo">
<refnamediv>
<refname>imap_header</refname>
<refname>imap_headerinfo</refname>
<refpurpose>Read the header of the message</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<funcsynopsis>
<funcprototype>
<funcdef>object <function>imap_header</function></funcdef>
<paramdef>int <parameter>imap_stream</parameter></paramdef>
<paramdef>int <parameter>msg_number</parameter></paramdef>
<paramdef>int
<parameter><optional>fromlength</optional></parameter>
</paramdef>
<paramdef>int
<parameter><optional>subjectlength</optional></parameter>
</paramdef>
<paramdef>string
<parameter><optional>defaulthost</optional></parameter>
</paramdef>
</funcprototype>
<funcdef>object <function>imap_headerinfo</function></funcdef>
<paramdef>int <parameter>imap_stream</parameter></paramdef>
<paramdef>int <parameter>msg_number</parameter></paramdef>
<paramdef>int
<parameter><optional>fromlength</optional></parameter>
</paramdef>
<paramdef>int
<parameter><optional>subjectlength</optional></parameter>
</paramdef>
<paramdef>string
<parameter><optional>defaulthost</optional></parameter>
</paramdef>
</funcsynopsis>
<para>
This function returns an object of various header elements.
@ -819,6 +825,34 @@ fetchsubject (subject line formatted to fit <parameter>subjectlength</parameter>
</refsect1>
</refentry>
<refentry id="function.imap-header">
<refnamediv>
<refname>imap_header</refname>
<refpurpose>Read the header of the message</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<funcsynopsis>
<funcdef>object <function>imap_header</function></funcdef>
<paramdef>int <parameter>imap_stream</parameter></paramdef>
<paramdef>int <parameter>msg_number</parameter></paramdef>
<paramdef>int
<parameter><optional>fromlength</optional></parameter>
</paramdef>
<paramdef>int
<parameter><optional>subjectlength</optional></parameter>
</paramdef>
<paramdef>string
<parameter><optional>defaulthost</optional></parameter>
</paramdef>
</funcsynopsis>
<para>
This is an alias to <function>imap_headerinfo</function>
and is identical to this in any way.
</para>
</refsect1>
</refentry>
<refentry id="function.imap-rfc822-parse-headers">
<refnamediv>
<refname>imap_rfc822_parse_headers</refname>
@ -1006,6 +1040,9 @@ imap_close($mbox);
</programlisting>
</example>
</para>
<para>
See also <function>imap_getsubscribed</function>.
</para>
</refsect1>
</refentry>