php man page for imap_thread

IMAP_THREAD(3)								 1							    IMAP_THREAD(3)

imap_thread - Returns a tree of threaded message

SYNOPSIS
       array imap_thread (resource  $imap_stream, [int	$options = SE_FREE])

DESCRIPTION
	Gets a tree of a threaded message.

PARAMETERS
	      o $
		imap_stream -An IMAP stream returned by imap_open(3).

	      o $options
		-

RETURN VALUES
       imap_thread(3) returns an associative array containing a tree of messages threaded by REFERENCES, or FALSE on error.

	Every message in the current mailbox will be represented by three entries in the resulting array:

	      o$thread["XX.num"] - current message number

	      o$thread["XX.next"]

	      o$thread["XX.branch"]

EXAMPLES
       Example #1

	      imap_thread(3) Example

	      <?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 ($threads as $key => $val) {
		$tree = explode('.', $key);
		if ($tree[1] == 'num') {
		  $header = imap_headerinfo($nntp, $val);
		  echo "<ul>
	<li>" . $header->fromaddress . "
";
		} elseif ($tree[1] == 'branch') {
		  echo "	</li>
</ul>
";
		}
	      }

	      imap_close($nntp);

	      ?>

PHP Documentation Group 													    IMAP_THREAD(3)