From 2f4b0127cf5c5a489136de35a7f0413be24c1df5 Mon Sep 17 00:00:00 2001
From: Hartmut Holzgraefe <hholzgra@php.net>
Date: Tue, 14 Dec 1999 17:21:27 +0000
Subject: [PATCH] integrated some of the user notes into the docs (especially
 my own and the smaller ones)

git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@17196 c90b9560-bf6c-de11-be94-00142212c4b1
---
 functions/imap.xml | 62 ++++++++++++++++++++++++++++++++++++++++------
 1 file changed, 55 insertions(+), 7 deletions(-)

diff --git a/functions/imap.xml b/functions/imap.xml
index efc68fedd1..9b20788ee5 100644
--- a/functions/imap.xml
+++ b/functions/imap.xml
@@ -162,9 +162,13 @@
     </funcsynopsis>
     <para>  
      <function>imap_createmailbox</function> creates a new mailbox
-     specified by <parameter>mbox</parameter>.</para>
+     specified by <parameter>mbox</parameter> 
+     (see <function>imap_open</function> for the format 
+     of <parameter>mbox</parameter> names). </para> 
     <para>
      Returns true on success and false on error.</para>
+    <para>
+    See also <function>imap_renamemailbox</function> and <function>imap_deletemailbox</function>.</para>
    </refsect1>
   </refentry>
 
@@ -206,9 +210,12 @@
     </funcsynopsis>
     <para> 
      <function>imap_deletemailbox</function> deletes the specified
-     mailbox.</para>
+     mailbox (see <function>imap_open</function> for the format 
+     of <parameter>mbox</parameter> names).</para>  
     <para>
      Returns true on success and false on error.</para>
+    <para>
+     See also <function>imap_createmailbox</function> and <function>imap_reanmemailbox</function>.</para>
    </refsect1>
   </refentry>
 
@@ -263,7 +270,7 @@
       <listitem><simpara>
 	FT_PEEK - Do not set the \Seen flag if not already set</simpara></listitem>
       <listitem><simpara>
-	FT_UID - The return string is in "internal" format, without
+	FT_INTERNAL - The return string is in "internal" format, without
 	any attempt to canonicalize CRLF</simpara></listitem>
      </itemizedlist></para>
    </refsect1>
@@ -396,6 +403,41 @@
       </tgroup>
      </table>
     </para>
+
+    <para>
+     <table>
+       <title>Primary body type</title>
+       <tgroup cols="2">
+        <tbody>
+        <row><entry>0</entry><entry>text</entry></row>
+        <row><entry>1</entry><entry>multipart</entry></row>
+        <row><entry>2</entry><entry>message</entry></row>
+        <row><entry>3</entry><entry>application</entry></row>
+        <row><entry>4</entry><entry>audio</entry></row>
+        <row><entry>5</entry><entry>image</entry></row>
+        <row><entry>6</entry><entry>video</entry></row>
+        <row><entry>7</entry><entry>other</entry></row>
+        </tbody>
+       </tgroup>
+     </table>
+    </para>
+
+    <para>
+     <table>
+       <title>Transfer encodings</title>
+       <tgroup cols="2">
+        <tbody>
+        <row><entry>0</entry><entry>7BIT</entry></row>
+        <row><entry>1</entry><entry>8BIT</entry></row>
+        <row><entry>2</entry><entry>BINARY</entry></row>
+        <row><entry>3</entry><entry>BASE64</entry></row>
+        <row><entry>4</entry><entry>QUOTED-PRINTABLE</entry></row>
+        <row><entry>5</entry><entry>OTHER</entry></row>
+        </tbody>
+       </tgroup>
+     </table>
+    </para>
+
    </refsect1>
   </refentry>
 
@@ -697,7 +739,7 @@ fetchsubject (subject line formatted to fit <parameter>subjectlength</parameter>
     <title>Description</title>
     <funcsynopsis>
      <funcdef>int <function>imap_num_msg</function></funcdef>
-     <paramdef>int <parameter>stream_id</parameter></paramdef>
+     <paramdef>int <parameter>imap_stream</parameter></paramdef>
     </funcsynopsis>
     <para>
      Return the number of messages in the current mailbox.</para>
@@ -820,9 +862,12 @@ $nntp = imap_open("{localhost/nntp:119}comp.test","","");
      <paramdef>string <parameter>new_mbox</parameter></paramdef>
     </funcsynopsis>
     <para>  
-     This function renames on old mailbox to new mailbox.</para>
+     This function renames on old mailbox to new mailbox (see <function>imap_open</function> for the format 
+     of <parameter>mbox</parameter> names).</para>
     <para>
      Returns true on success and false on error.</para>
+    <para>
+     See also <function>imap_createmailbox</function> and <function>imap_deletemailbox</function>.</para>
    </refsect1>
   </refentry>
 
@@ -1004,7 +1049,7 @@ $nntp = imap_open("{localhost/nntp:119}comp.test","","");
    <refsect1>
     <title>Description</title>
     <funcsynopsis>
-     <funcdef>array <function>imap_mailboxmsginfo</function></funcdef>
+     <funcdef>object <function>imap_mailboxmsginfo</function></funcdef>
      <paramdef>int <parameter>imap_stream</parameter></paramdef>
     </funcsynopsis>
     <para>
@@ -1062,7 +1107,7 @@ $nntp = imap_open("{localhost/nntp:119}comp.test","","");
      <paramdef>string <parameter>default_host</parameter></paramdef>
     </funcsynopsis>
     <para>
-     This function parses the address tring and for each address,
+     This function parses the address string and for each address,
      returns an array of objects.  The 4 objects are:</para>
     <para>
      <informalexample>
@@ -1093,6 +1138,7 @@ $nntp = imap_open("{localhost/nntp:119}comp.test","","");
     <para>
      This function causes a store to add the specified flag to the
      flags set for the messages in the specified sequence.</para>
+    <para>The flags which you can set are "\\Seen", "\\Answered", "\\Flagged", "\\Deleted", "\\Draft", and "\\Recent" ( as defined by RFC2060)</para>
     <para>
      The options are a bit mask with one or more of the following:
      <informalexample>
@@ -1349,6 +1395,7 @@ $nntp = imap_open("{localhost/nntp:119}comp.test","","");
      untouched; calling <function>imap_last_error</function>
      subsequently, with no intervening errors, will return the same
      error.</para>
+    <para>CAUTION: this function is not yet available in PHP4</para>
    </refsect1>
   </refentry>
 
@@ -1370,6 +1417,7 @@ $nntp = imap_open("{localhost/nntp:119}comp.test","","");
      or the beginning of the page. When
      <function>imap_errors</function> is called, the error stack is
      subsequently cleared.</para>
+    <para>CAUTION: this function is not yet available in PHP4</para>
    </refsect1>
   </refentry>