integer $_currkey = null (line 96)

Location of current element in the tree.

array $_currstack = array() (line 103)

Location of current element in the tree.

array $_eltdiff = null (line 194)

Used to determine the list of element changes.

boolean $_forceopen = false (line 208)

See $open parameter in build().

IMAP_Sort $_imap_sort = null (line 166)

The IMAP_Sort object.

array $_parent = array() (line 117)

Parent list.

string $_server = '' (line 173)

The server string for the current server.

array $_subscribed = null (line 138)

Cached list of subscribed mailboxes.

array $_tree (line 82)

Array containing the mailbox tree.

Constructor IMP_Tree (line 244)

Constructor.

build (line 1683)

Builds a list of folders, suitable to render a folder tree.

• return: An array with three elements: the folder list, the total number of new messages, and a list with folder names suitable for user interaction. The folder list array contains the following added entries on top of the entries provided by element():

   'display' - The mailbox name run through IMP::displayFolder().
   'peek' - See peek().

• integer $mask: The mask to pass to next().
• boolean $open: If using the base folder icons, display a different icon whether the folder is opened or closed.

collapseAll (line 1415)

Should we collapse all elements?

current (line 684)

Return the current tree element.

• return: The current tree element or false if there is no element.

element (line 1930)

Return extended information on an element.

• return: Returns the element with extended information, or false if not found. The information returned is as follows:

   'alt' - The alt text for the icon.
   'base_elt' - The return from get().
   'children' - Does the element have children?
   'container' - Is this a container element?
   'editvfolder' - Can this virtual folder be edited?
   'icon' - The name of the icon graphic to use.
   'icondir' - The path of the icon directory.
   'level' - The deepness level of this element.
   'mbox_val' - A html-ized version of 'value'.
   'msgs' - The number of total messages in the element (if polled).
   'name' - A html-ized version of 'label'.
   'newmsg' - The number of new messages in the element (if polled).
   'parent' - The parent element value.
   'polled' - Show polled information?
   'special' - An integer mask indicating if this is a "special" element.
   'specialvfolder' - Is this a "special" virtual folder?
   'unseen' - The number of unseen messages in the element (if polled).
   'user_icon' - Use a user defined icon?
   'value' - The value of this element (i.e. element id).
   'vfolder' - Is this a virtual folder?

• since: IMP 4.2

• string $name: The name of the tree element.
• $mailbox

eltDiffStart (line 1580)

Set the start point for determining element differences via eltDiff().

• since: IMP 4.1

expandAll (line 1405)

Should we expand all elements?

get (line 716)

Returns the requested element.

• return: Returns the requested element or false if not found.

• string $name: The name of the tree element.

getElementInfo (line 1465)

Get information about new/unseen/total messages for the given element.

• return: Array with the following fields:

   'messages'  --  Number of total messages.
   'newmsg'    --  Number of new messages.
   'unseen'    --  Number of unseen messages.

• string $name: The element name.

hasChildren (line 1038)

Does the element have any active children?

• return: True if the element has active children.

• array $elt: A tree element.

insert (line 728)

Insert a folder/mailbox into the tree.

• mixed $id: The name of the folder (or a list of folder names) to add.

isContainer (line 1091)

Is this element a container only, not a mailbox (meaning you can not open it)?

• return: True if the element is a container.

• array $elt: A tree element.

isNamespace (line 1151)

Is the element a namespace container?

• return: True if the element is a namespace container.

• array $elt: A tree element.

isOpenSidebar (line 1857)

Is the mailbox open in the sidebar?

• return: True if the mailbox is open in the sidebar.
• since: IMP 4.1.1

• array $mbox: A mailbox name.

isSubscribed (line 1119)

Is the user subscribed to this element?

• return: True if the user is subscribed to the element.

• array $elt: A tree element.

next (line 588)

Sets the internal array pointer to the next element, and returns the next object.

• return: Returns the next element or false if the element doesn't exist.

• integer $mask: A mask with the following elements:

   IMPTREE_NEXT_SHOWCLOSED - Don't ignore closed elements.
   IMPTREE_NEXT_SHOWSUB - Only show subscribed elements.

removePollList (line 1286)

Remove element from the poll list.

• string $id: The folder/mailbox or a list of folders/mailboxes to remove.

reset (line 669)

Set internal pointer to the head of the tree.

This MUST be called before you can traverse the tree with next().

• return: Returns the element at the head of the tree or false if the element doesn't exist.

singleton (line 223)

Attempts to return a reference to a concrete IMP_Tree instance.

If an IMP_Tree object is currently stored in the local session, recreate that object. Else, create a new instance. Ensures that only one IMP_Tree instance is available at any time.

This method must be invoked as:

   $imp_tree = &IMP_Tree::singleton();

• return: The IMP_Tree object or null.

unsubscribe (line 980)

Unsubscribe an element from the tree.

• mixed $id: The element name or an array of element names.

_needSort (line 1385)

Does this element's children need sorting?

• return: True if the children need to be sorted.

• array $elt: A tree element.