The IMAP_Tree class provides a tree view of the folders supported with the PHP imap extension (IMAP/POP3/NNTP repositories). It provides access functions to iterate through this tree and query information about individual mailboxes/folders.
$Horde: framework/IMAP/IMAP/Tree.php,v 1.48.2.47 2009/01/06 15:23:11 jan Exp $
Copyright 2000-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/Tree.php (line 77)
The application that generated this tree.
THIS SHOULD BE SET IN EVERY SUBCLASS CONSTRUCTOR.
The name to use when storing the object in the session.
Tree changed flag. Set when something in the tree has been altered.
Does the IMAP server support the children extension?
Location of current element in the tree.
Location of current element in the tree.
Location of current element in the tree.
The server string used for the delimiter.
THIS SHOULD BE SET IN EVERY SUBCLASS CONSTRUCTOR.
Should dotfiles be shown? THIS SHOULD BE SET IN EVERY SUBCLASS CONSTRUCTOR.
Used to determine the list of element changes.
The cached list of expanded folders.
The IMAP_Sort object.
Init mode flag.
Should we use 'mail' mode or 'news' mode? THIS SHOULD BE SET IN EVERY SUBCLASS CONSTRUCTOR.
The location of the first level of folders below the INBOX.
THIS SHOULD BE SET IN EVERY SUBCLASS CONSTRUCTOR.
The list of namespaces to add to the tree.
Insert an element in the tree that doesn't appear on the IMAP server.
If set, IMAP_Tree:: will call _getNonIMAPElt() to obtain the element to add to the tree.
Parent list.
The cached list of mailboxes to poll.
Where we start listing folders.
THIS SHOULD BE SET IN EVERY SUBCLASS CONSTRUCTOR.
The prefix without a trailing delimiter.
The server string for the current server.
THIS SHOULD BE SET IN EVERY SUBCLASS CONSTRUCTOR.
Show unsubscribed mailboxes?
Cached list of subscribed mailboxes.
Associative array containing the mailbox tree.
Cached list of unsubscribed mailboxes.
Have we shown unsubscribed folders previously?
Constructor.
Add element to the poll list.
THIS METHOD SHOULD BE DEFINED IN ALL SUBCLASSES.
Collapse a mail folder.
Should we collapse all elements?
Return the current tree element.
Delete an element from the tree.
Return the list of elements that have changed since nodeDiffStart() was last called.
Set the start point for determining element differences via eltDiff().
Expand a mail folder.
Should we expand all elements?
The existence of this function in IMAP_Tree indicates that extended namespace support is available.
Returns the requested element.
Get information about new/unseen/total messages for the given element.
Initialize/get the list of elements to poll.
THIS METHOD SHOULD BE DEFINED IN ALL SUBCLASSES.
Return the prefix.
Does the element have any active children?
Does the IMAP server support the 'CHILDREN' IMAP extension?
Initalize the list at the top level of the hierarchy.
Insert a folder/mailbox into the tree.
Is this element a container only, not a mailbox (meaning you can not open it)?
Has the tree element been discovered?
Is the element a namespace container?
Is the tree element open?
Does the user want to poll this mailbox for new/unseen messages?
Is the user subscribed to this element?
Sets the internal array pointer to the next element, and returns the next object.
IMAPTREE_NEXT_SHOWCLOSED - Don't ignore closed elements. IMAPTREE_NEXT_SHOWSUB - Only show subscribed elements.
Make sure there is no trailing delimiter on the element name.
Determines if there are more elements in the current tree level.
Remove element from the poll list.
THIS METHOD SHOULD BE DEFINED IN ALL SUBCLASSES.
Set internal pointer to the head of the tree.
This MUST be called before you can traverse the tree with next().
Switch subscribed/unsubscribed viewing.
Attempts to return a reference to a concrete IMAP_Tree instance.
If an IMAP_Tree object is currently stored in the local session, recreate that object. Else, if $create is true, will create a new instance. Ensures that only one IMAP_Tree instance is available at any time.
This method must be invoked as:
$imap_tree = &IMAP_Tree::singleton($app, $classname, [$create[, $unsub]]);
Subscribe an element to the tree.
Unsubscribe an element from the tree.
Adds aliases to a tree element and returns the resulting array.
Does this element's children need sorting?
Documentation generated on Sun, 30 Jan 2011 05:22:56 +0000 by phpDocumentor 1.4.3