Class IMAP_Thread

Description

IMAP_Thread provides functions for working with imap_thread() output.

$Horde: framework/IMAP/IMAP/Thread.php,v 1.4.10.19 2009/01/06 15:23:11 jan Exp $

Copyright 2004-2009 The Horde Project (http://www.horde.org/)

See the enclosed file COPYING for license information (GPL). If you did not receive this file, see http://www.fsf.org/copyleft/gpl.html.

Located in /IMAP/IMAP/Thread.php (line 16)


	
			
Variable Summary
 array $_lookup
 array $_thread
Method Summary
 IMAP_Thread IMAP_Thread (array $ob)
 array getThread (integer $index)
 mixed getThreadBase (integer $index)
 mixed getThreadIndent (integer $index)
 boolean lastInLevel (integer $index)
 array messageList (boolean $new)
Variables
array $_lookup = array() (line 30)

Array index to Message index lookup array.

array $_thread = array() (line 23)

Internal thread data structure.

Methods
Constructor IMAP_Thread (line 37)

Constructor.

IMAP_Thread IMAP_Thread (array $ob)
  • array $ob: Output from imap_thread().
getThread (line 125)

Returns the list of messages in the current thread.

  • return: A list of IMAP message indices.
array getThread (integer $index)
  • integer $index: The IMAP index of the current message.
getThreadBase (line 67)

Gets the base thread index for an IMAP message index.

  • return: Returns the base IMAP index if $index is part of a thread. Returns false on failure.
mixed getThreadBase (integer $index)
  • integer $index: The IMAP message index.
getThreadIndent (line 50)

Gets the indention level for an IMAP message index.

  • return: Returns the thread indent level if $index found. Returns false on failure.
mixed getThreadIndent (integer $index)
  • integer $index: The IMAP message index.
lastInLevel (line 84)

Is this index the last in the current level?

  • return: Returns true if $index is the last element in the current thread level. Returns false if not, or on failure.
boolean lastInLevel (integer $index)
  • integer $index: The IMAP message index.
messageList (line 113)

Return the sorted list of messages indices.

  • return: The sorted list of messages.
array messageList (boolean $new)
  • boolean $new: True for newest first, false for oldest first.

Documentation generated on Sun, 30 Jan 2011 05:22:53 +0000 by phpDocumentor 1.4.3