didou Mon Aug 30 21:21:00 2004 EDT
Modified files:
/phpdoc/en/reference/imap/functions imap-bodystruct.xml
imap-getacl.xml imap-setacl.xml
imap-thread.xml
Log:
imap_(g|s)et_acl is only available with c-client2000 or greater
fix imap_bodystruct proto
start documenting imap_thread
# the second parameter, thread[XX.next] and thread['XX.branch'] needs to be
documented
http://cvs.php.net/diff.php/phpdoc/en/reference/imap/functions/imap-bodystruct.xml?r1=1.3&r2=1.4&ty=u
Index: phpdoc/en/reference/imap/functions/imap-bodystruct.xml
diff -u phpdoc/en/reference/imap/functions/imap-bodystruct.xml:1.3
phpdoc/en/reference/imap/functions/imap-bodystruct.xml:1.4
--- phpdoc/en/reference/imap/functions/imap-bodystruct.xml:1.3 Wed Oct 9 10:55:05
2002
+++ phpdoc/en/reference/imap/functions/imap-bodystruct.xml Mon Aug 30 21:20:59
2004
@@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
-<!-- $Revision: 1.3 $ -->
+<!-- $Revision: 1.4 $ -->
<!-- splitted from ./en/functions/imap.xml, last change in rev 1.58 -->
<refentry id='function.imap-bodystruct'>
<refnamediv>
@@ -14,7 +14,7 @@
<type>object</type><methodname>imap_bodystruct</methodname>
<methodparam><type>resource</type><parameter>stream_id</parameter></methodparam>
<methodparam><type>int</type><parameter>msg_no</parameter></methodparam>
- <methodparam><type>int</type><parameter>section</parameter></methodparam>
+ <methodparam><type>string</type><parameter>section</parameter></methodparam>
</methodsynopsis>
<para>
&warn.undocumented.func;
http://cvs.php.net/diff.php/phpdoc/en/reference/imap/functions/imap-getacl.xml?r1=1.2&r2=1.3&ty=u
Index: phpdoc/en/reference/imap/functions/imap-getacl.xml
diff -u phpdoc/en/reference/imap/functions/imap-getacl.xml:1.2
phpdoc/en/reference/imap/functions/imap-getacl.xml:1.3
--- phpdoc/en/reference/imap/functions/imap-getacl.xml:1.2 Mon Mar 8 04:18:41
2004
+++ phpdoc/en/reference/imap/functions/imap-getacl.xml Mon Aug 30 21:20:59 2004
@@ -1,5 +1,5 @@
<?xml version='1.0' encoding='iso-8859-1'?>
-<!-- $Revision: 1.2 $ -->
+<!-- $Revision: 1.3 $ -->
<refentry id="function.imap-getacl">
<refnamediv>
<refname>imap_getacl</refname>
@@ -16,9 +16,12 @@
</methodsynopsis>
&warn.undocumented.func;
-
<para>
- See also: <function>imap_setacl</function>.
+ This function is currently only available to users of the c-client2000
+ or greater library.
+ </para>
+ <para>
+ See also <function>imap_setacl</function>.
</para>
</refsect1>
</refentry>
http://cvs.php.net/diff.php/phpdoc/en/reference/imap/functions/imap-setacl.xml?r1=1.4&r2=1.5&ty=u
Index: phpdoc/en/reference/imap/functions/imap-setacl.xml
diff -u phpdoc/en/reference/imap/functions/imap-setacl.xml:1.4
phpdoc/en/reference/imap/functions/imap-setacl.xml:1.5
--- phpdoc/en/reference/imap/functions/imap-setacl.xml:1.4 Mon Mar 8 04:18:43
2004
+++ phpdoc/en/reference/imap/functions/imap-setacl.xml Mon Aug 30 21:20:59 2004
@@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
-<!-- $Revision: 1.4 $ -->
+<!-- $Revision: 1.5 $ -->
<!-- splitted from ./en/functions/imap.xml, last change in rev 1.58 -->
<refentry id='function.imap-setacl'>
<refnamediv>
@@ -21,7 +21,11 @@
&warn.undocumented.func;
</para>
<para>
- See also: <function>imap_getacl</function>.
+ This function is currently only available to users of the c-client2000
+ or greater library.
+ </para>
+ <para>
+ See also <function>imap_getacl</function>.
</para>
</refsect1>
</refentry>
http://cvs.php.net/diff.php/phpdoc/en/reference/imap/functions/imap-thread.xml?r1=1.3&r2=1.4&ty=u
Index: phpdoc/en/reference/imap/functions/imap-thread.xml
diff -u phpdoc/en/reference/imap/functions/imap-thread.xml:1.3
phpdoc/en/reference/imap/functions/imap-thread.xml:1.4
--- phpdoc/en/reference/imap/functions/imap-thread.xml:1.3 Wed Oct 9 10:55:05
2002
+++ phpdoc/en/reference/imap/functions/imap-thread.xml Mon Aug 30 21:20:59 2004
@@ -1,11 +1,11 @@
<?xml version="1.0" encoding="iso-8859-1"?>
-<!-- $Revision: 1.3 $ -->
+<!-- $Revision: 1.4 $ -->
<!-- splitted from ./en/functions/imap.xml, last change in rev 1.58 -->
<refentry id='function.imap-thread'>
<refnamediv>
<refname>imap_thread</refname>
<refpurpose>
- Return threaded by REFERENCES tree
+ Returns a tree of threaded message
</refpurpose>
</refnamediv>
<refsect1>
@@ -16,7 +16,53 @@
<methodparam
choice="opt"><type>int</type><parameter>options</parameter></methodparam>
</methodsynopsis>
<para>
- &warn.undocumented.func;
+ <function>imap_thread</function> returns an associative array containing
+ a tree of messages threaded by <literal>REFERENCES</literal>, or &false;
+ on error.
+ </para>
+ <para>
+ Every message in the current mailbox will be represented by three entries
+ in the resulting array:
+ <itemizedlist>
+ <listitem>
+ <varname>$thread["XX.num"]</varname> - current message number
+ </listitem>
+ <listitem>
+ <varname>$thread["XX.next"]</varname>
+ </listitem>
+ <listitem>
+ <varname>$thread["XX.branch"]</varname>
+ </listitem>
+ </itemizedlist>
+ </para>
+ <para>
+ <example>
+ <title><function>imap_thread</function> Example</title>
+ <programlisting role="php">
+<![CDATA[
+<?php
+
+// Here we're outputting the threads of a newsgroup, in HTML
+
+$nntp = imap_open('{news.example.com:119/nntp}some.newsgroup', '', '');
+$threads = imap_thread($nntp);
+
+foreach ($thread as $key => $val) {
+ $tree = explode('.', $key);
+ if ($tree[1] == 'num') {
+ $header = imap_headerinfo($nntp, $val);
+ echo "<ul>\n\t<li>" . $header->fromaddress . "\n";
+ } elseif ($tree[1] == 'branch') {
+ echo "\t</li>\n</ul>\n";
+ }
+}
+
+imap_close($nntp);
+
+?>
+]]>
+ </programlisting>
+ </example>
</para>
</refsect1>
</refentry>
