<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>
<head>
<meta http-equiv="content-type" content="text/html; charset=UTF-8">
<title>Returns a tree of threaded message</title>
</head>
<body><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="function.imap-subscribe.html">imap_subscribe</a></div>
<div class="next" style="text-align: right; float: right;"><a href="function.imap-timeout.html">imap_timeout</a></div>
<div class="up"><a href="ref.imap.html">IMAP Functions</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div><hr /><div id="function.imap-thread" class="refentry">
<div class="refnamediv">
<h1 class="refname">imap_thread</h1>
<p class="verinfo">(PHP 4 >= 4.0.7, PHP 5)</p><p class="refpurpose"><span class="refname">imap_thread</span> — <span class="dc-title">Returns a tree of threaded message</span></p>
</div>
<div class="refsect1 description" id="refsect1-function.imap-thread-description">
<h3 class="title">Description</h3>
<div class="methodsynopsis dc-description">
<span class="type">array</span> <span class="methodname"><strong>imap_thread</strong></span>
( <span class="methodparam"><span class="type">resource</span> <code class="parameter">$imap_stream</code></span>
[, <span class="methodparam"><span class="type">int</span> <code class="parameter">$options</code><span class="initializer"> = SE_FREE</span></span>
] )</div>
<p class="para rdfs-comment">
Gets a tree of a threaded message.
</p>
</div>
<div class="refsect1 parameters" id="refsect1-function.imap-thread-parameters">
<h3 class="title">Parameters</h3>
<p class="para">
<dl>
<dt>
<span class="term"><em><code class="parameter">
imap_stream</code></em></span><dd>
<p class="para">An IMAP stream returned by
<span class="function"><a href="function.imap-open.html" class="function">imap_open()</a></span>.</p></dd>
</dt>
<dt>
<span class="term"><em><code class="parameter">options</code></em></span>
<dd>
<p class="para">
</p>
</dd>
</dt>
</dl>
</p>
</div>
<div class="refsect1 returnvalues" id="refsect1-function.imap-thread-returnvalues">
<h3 class="title">Return Values</h3>
<p class="para">
<span class="function"><strong>imap_thread()</strong></span> returns an associative array containing
a tree of messages threaded by <em>REFERENCES</em>, or <strong><code>FALSE</code></strong>
on error.
</p>
<p class="para">
Every message in the current mailbox will be represented by three entries
in the resulting array:
<ul class="itemizedlist">
<li class="listitem"><p class="para">
<var class="varname"><var class="varname">$thread["XX.num"]</var></var> - current message number
</p></li>
<li class="listitem"><p class="para">
<var class="varname"><var class="varname">$thread["XX.next"]</var></var>
</p></li>
<li class="listitem"><p class="para">
<var class="varname"><var class="varname">$thread["XX.branch"]</var></var>
</p></li>
</ul>
</p>
</div>
<div class="refsect1 examples" id="refsect1-function.imap-thread-examples">
<h3 class="title">Examples</h3>
<p class="para">
<div class="example" id="example-3377">
<p><strong>Example #1 <span class="function"><strong>imap_thread()</strong></span> Example</strong></p>
<div class="example-contents">
<div class="phpcode"><code><span style="color: #000000">
<span style="color: #0000BB"><?php<br /><br /></span><span style="color: #FF8000">// Here we're outputting the threads of a newsgroup, in HTML<br /><br /></span><span style="color: #0000BB">$nntp </span><span style="color: #007700">= </span><span style="color: #0000BB">imap_open</span><span style="color: #007700">(</span><span style="color: #DD0000">'{news.example.com:119/nntp}some.newsgroup'</span><span style="color: #007700">, </span><span style="color: #DD0000">''</span><span style="color: #007700">, </span><span style="color: #DD0000">''</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">$threads </span><span style="color: #007700">= </span><span style="color: #0000BB">imap_thread</span><span style="color: #007700">(</span><span style="color: #0000BB">$nntp</span><span style="color: #007700">);<br /><br />foreach (</span><span style="color: #0000BB">$threads </span><span style="color: #007700">as </span><span style="color: #0000BB">$key </span><span style="color: #007700">=> </span><span style="color: #0000BB">$val</span><span style="color: #007700">) {<br /> </span><span style="color: #0000BB">$tree </span><span style="color: #007700">= </span><span style="color: #0000BB">explode</span><span style="color: #007700">(</span><span style="color: #DD0000">'.'</span><span style="color: #007700">, </span><span style="color: #0000BB">$key</span><span style="color: #007700">);<br /> if (</span><span style="color: #0000BB">$tree</span><span style="color: #007700">[</span><span style="color: #0000BB">1</span><span style="color: #007700">] == </span><span style="color: #DD0000">'num'</span><span style="color: #007700">) {<br /> </span><span style="color: #0000BB">$header </span><span style="color: #007700">= </span><span style="color: #0000BB">imap_headerinfo</span><span style="color: #007700">(</span><span style="color: #0000BB">$nntp</span><span style="color: #007700">, </span><span style="color: #0000BB">$val</span><span style="color: #007700">);<br /> echo </span><span style="color: #DD0000">"<ul>\n\t<li>" </span><span style="color: #007700">. </span><span style="color: #0000BB">$header</span><span style="color: #007700">-></span><span style="color: #0000BB">fromaddress </span><span style="color: #007700">. </span><span style="color: #DD0000">"\n"</span><span style="color: #007700">;<br /> } elseif (</span><span style="color: #0000BB">$tree</span><span style="color: #007700">[</span><span style="color: #0000BB">1</span><span style="color: #007700">] == </span><span style="color: #DD0000">'branch'</span><span style="color: #007700">) {<br /> echo </span><span style="color: #DD0000">"\t</li>\n</ul>\n"</span><span style="color: #007700">;<br /> }<br />}<br /><br /></span><span style="color: #0000BB">imap_close</span><span style="color: #007700">(</span><span style="color: #0000BB">$nntp</span><span style="color: #007700">);<br /><br /></span><span style="color: #0000BB">?></span>
</span>
</code></div>
</div>
</div>
</p>
</div>
</div><hr /><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="function.imap-subscribe.html">imap_subscribe</a></div>
<div class="next" style="text-align: right; float: right;"><a href="function.imap-timeout.html">imap_timeout</a></div>
<div class="up"><a href="ref.imap.html">IMAP Functions</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div></body></html>
