Class IMP_Imap_Tree

The IMP_Imap_Tree class provides a tree view of the mailboxes in an IMAP/POP3 repository. It provides access functions to iterate through this tree and query information about individual mailboxes. In IMP, folders = IMAP mailboxes so the two terms are used interchangably.

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

IMP_Imap_Tree implements ArrayAccess, Countable, Iterator, Serializable

Package: IMP
Category: Horde
License: GPL
Author: Chuck Hagenbuch chuck@horde.org
Author: Jon Parise jon@horde.org
Author: Anil Madhavapeddy avsm@horde.org
Author: Michael Slusarz slusarz@horde.org
Located at Imap/Tree.php

Methods summary
`public`	# `__construct( )` Constructor. Constructor.
`public`	# `init( )` Initalize the tree. Initalize the tree.
`public`	# `expand( string $folder, boolean $expandall = false )` Expand a mail folder. Expand a mail folder. Parameters `$folder` The folder name to expand. `$expandall` Expand all folders under this one?
`public`	# `collapse( string $folder )` Collapse a mail folder. Collapse a mail folder. Parameters `$folder` The folder name to collapse.
`public`	# `insert( mixed $id )` Insert a folder/mailbox into the tree. Insert a folder/mailbox into the tree. Parameters `$id` <p>The name of the folder (or a list of folder names) to add.</p>
`public boolean`	# `delete( mixed $id )` Delete an element from the tree. Delete an element from the tree. Parameters `$id` The element name or an array of element names. Returns `boolean` Return true on success, false on error.
`public`	# `subscribe( mixed $id )` Subscribe an element to the tree. Subscribe an element to the tree. Parameters `$id` The element name or an array of element names.
`public`	# `unsubscribe( mixed $id )` Unsubscribe an element from the tree. Unsubscribe an element from the tree. Parameters `$id` The element name or an array of element names.
`public boolean`	# `hasChildren( mixed $in )` Does the element have any active children? Does the element have any active children? Parameters `$in` A mailbox name or a tree element. Returns `boolean` True if the element has active children.
`public integer`	# `isOpen( mixed $in )` Is the tree element open? Is the tree element open? Parameters `$in` A mailbox name or a tree element. Returns `integer` True if the element is open.
`public integer`	# `isContainer( mixed $in )` Is this element a container only, not a mailbox (meaning you can not open it)? Is this element a container only, not a mailbox (meaning you can not open it)? Parameters `$in` A mailbox name or a tree element. Returns `integer` True if the element is a container.
`public integer`	# `isSubscribed( mixed $in )` Is the user subscribed to this element? Is the user subscribed to this element? Parameters `$in` A mailbox name or a tree element. Returns `integer` True if the user is subscribed to the element.
`public integer`	# `isNamespace( mixed $in )` Is the element a namespace container? Is the element a namespace container? Parameters `$in` A mailbox name or a tree element. Returns `integer` True if the element is a namespace container.
`public integer`	# `isNonImapElt( mixed $in )` Is the element a non-IMAP element? Is the element a non-IMAP element? Parameters `$in` A mailbox name or a tree element. Returns `integer` True if the element is a non-IMAP element.
`public array`	# `getPollList( boolean $sort = false )` Initializes and returns the list of mailboxes to poll. Initializes and returns the list of mailboxes to poll. Parameters `$sort` Sort the directory list? Returns `array` The list of mailboxes to poll (IMP_Mailbox objects).
`public`	# `addPollList( mixed $id )` Add element to the poll list. Add element to the poll list. Parameters `$id` The element name or a list of element names to add.
`public`	# `removePollList( mixed $id )` Remove element from the poll list. Remove element from the poll list. Parameters `$id` <p>The folder/mailbox or a list of folders/mailboxes to remove.</p>
`public`	# `prunePollList( )` Prune non-existent folders from poll list. Prune non-existent folders from poll list.
`public integer`	# `isPolled( mixed $in )` Does the user want to poll this mailbox for new/unseen messages? Does the user want to poll this mailbox for new/unseen messages? Parameters `$in` A mailbox name or a tree element. Returns `integer` True if the user wants to poll the element.
`public integer`	# `isInvisible( mixed $in )` Is the element invisible? Is the element invisible? Parameters `$in` A mailbox name or a tree element. Returns `integer` True if the element is marked as invisible.
`public`	# `expandAll( )` Should we expand all elements? Should we expand all elements?
`public`	# `collapseAll( )` Should we collapse all elements? Should we collapse all elements?
`public`	# `showUnsubscribed( boolean $unsub )` Switch subscribed/unsubscribed viewing. Switch subscribed/unsubscribed viewing. Parameters `$unsub` Show unsubscribed elements?
`public`	# `eltDiffStart( )` Set the start point for determining element differences via eltDiff(). Set the start point for determining element differences via eltDiff().
`public array`	# `eltDiff( )` Return the list of elements that have changed since eltDiffStart() was last called. Return the list of elements that have changed since eltDiffStart() was last called. Returns `array` Returns false if no changes have occurred, or an array with the following keys: - a: (array) Elements that have been added. - c: (array) Elements that have been changed. - d: (array) Elements that have been deleted.
`public`	# `updateVFolders( array $vfolders )` Updates the virtual folder list in the tree. Updates the virtual folder list in the tree. Parameters `$vfolders` A list of IMP_Search_VFolder objects.
`public integer`	# `isVFolder( mixed $in )` Returns whether this element is a virtual folder. Returns whether this element is a virtual folder. Parameters `$in` A mailbox name or a tree element. Returns `integer` True if the element is a virtual folder.
`public`	# `rename( string $old, string $new )` Rename a current folder. Rename a current folder. Parameters `$old` The old mailbox name. `$new` The new mailbox name.
`public IMP_Mailbox`	# `createMailboxName( string $parent, string $new )` Determines the mailbox name to create given a parent and the new name. Determines the mailbox name to create given a parent and the new name. Parameters `$parent` The parent name (UTF7-IMAP). `$new` $parent The new mailbox name (UTF7-IMAP). Returns `IMP_Mailbox` The new mailbox. Throws `IMP_Exception`
`public Horde_Tree`	# `createTree( string\|Horde_Tree $name, array $opts = array() )` Creates a Horde_Tree representation of the current tree (respecting the current iterator filter). Creates a Horde_Tree representation of the current tree (respecting the current iterator filter). Parameters `$name` <p>Either the tree name, or a Horde_Tree object to add nodes to.</p> `$opts` <p>Additional options: - basename: (boolean) Use raw basename instead of abbreviated label? DEFAULT: false - checkbox: (boolean) Display checkboxes? DEFAULT: false - editvfolder: (boolean) Display vfolder edit links? DEFAULT: false - open: (boolean) Force child mailboxes to this status. DEFAULT: null - parent: (string) The parent object of the current level. DEFAULT: null (add to base level) - poll_info: (boolean) Include poll information? DEFAULT: false - render_params: (array) List of params to pass to renderer if auto-creating. DEFAULT: 'alternate', 'lines', and 'lines_base' are passed in with true values. - render_type: (string) The renderer name. DEFAULT: Javascript</p> Returns `Horde_Tree` The tree object.
`public mixed`	# `getElement( mixed $in )` Returns the internal IMAP Tree element for a given mailbox. Returns the internal IMAP Tree element for a given mailbox. Parameters `$in` $elt A mailbox name or a tree element. Returns `mixed` The element array, or null if not found.
`public`	# `offsetExists( mixed $offset )` Implementation of `ArrayAccess::offsetExists()`
`public`	# `offsetGet( mixed $offset )` Implementation of `ArrayAccess::offsetGet()`
`public`	# `offsetSet( mixed $offset, mixed $value )` Implementation of `ArrayAccess::offsetSet()`
`public`	# `offsetUnset( mixed $offset )` Implementation of `ArrayAccess::offsetUnset()`
`public`	# `count( )` Return the number of mailboxes on the server. Return the number of mailboxes on the server. Implementation of `Countable::count()`
`public`	# `current( )` Implementation of `Iterator::current()`
`public`	# `key( )` Implementation of `Iterator::key()`
`public`	# `next( )` Implementation of `Iterator::next()`
`public`	# `rewind( )` Implementation of `Iterator::rewind()`
`public`	# `valid( )` Implementation of `Iterator::valid()`
`public`	# `setIteratorFilter( integer $mask = 0, string $base = null )` Set the current iterator filter and reset the internal pointer. Set the current iterator filter and reset the internal pointer. Parameters `$mask` A mask with the following possible elements: <ul> <li> IMP_Imap_Tree::FLIST_NOCONTAINER: Don't include container elements. </li> <li> IMP_Imap_Tree::FLIST_UNSUB: Include unsubscribed elements. </li> <li> IMP_Imap_Tree::FLIST_VFOLDER: Include Virtual Folders. </li> <li> IMP_Imap_Tree::FLIST_NOCHILDREN: Don't include child elements. </li> <li> IMP_Imap_Tree::FLIST_EXPANDED: Only include expanded folders. </li> <li> IMP_Imap_Tree::FLIST_ASIS: Display the list as is currently cached in this object. </li> <li>Options that require $base to be set: <ul> <li> IMP_Imap_Tree::FLIST_ANCESTORS: Include ancestors of $base. </li> <li> IMP_Imap_Tree::FLIST_SAMELEVEL: Include all mailboxes at the same level as $base. </li> <li> IMP_Imap_Tree::FLIST_NOBASE: Don't include $base in the return. </li> </ul> </li> </ul> `$base` Include all mailboxes below this element.
`public`	# `serialize( )` Implementation of `Serializable::serialize()`
`public`	# `unserialize( mixed $data )` Throws Exception Implementation of `Serializable::unserialize()`

Constants summary
`integer`	`VERSION`	# `1`
`integer`	`ELT_NOSELECT`	# `1`
`integer`	`ELT_NAMESPACE`	# `2`
`integer`	`ELT_IS_OPEN`	# `4`
`integer`	`ELT_IS_SUBSCRIBED`	# `8`
`integer`	`ELT_IS_POLLED`	# `32`
`integer`	`ELT_NEED_SORT`	# `64`
`integer`	`ELT_VFOLDER`	# `128`
`integer`	`ELT_NONIMAP`	# `256`
`integer`	`ELT_INVISIBLE`	# `512`
`integer`	`OPEN_NONE`	# `0`
`integer`	`OPEN_ALL`	# `1`
`integer`	`OPEN_USER`	# `2`
`integer`	`FLIST_NOCONTAINER`	# `1`
`integer`	`FLIST_UNSUB`	# `2`
`integer`	`FLIST_VFOLDER`	# `4`
`integer`	`FLIST_NOCHILDREN`	# `8`
`integer`	`FLIST_EXPANDED`	# `16`
`integer`	`FLIST_ANCESTORS`	# `32`
`integer`	`FLIST_SAMELEVEL`	# `64`
`integer`	`FLIST_NOBASE`	# `128`
`integer`	`FLIST_ASIS`	# `256`
`string`	`BASE_ELT`	# `"base\0"`
`string`	`VFOLDER_KEY`	# `"vfolder\0"`
`string`	`SHARED_KEY`	# `"shared\0"`
`string`	`OTHER_KEY`	# `"other\0"`

Properties summary
`public boolean`	`$changed` Tree changed flag. Set when something in the tree has been altered. Tree changed flag. Set when something in the tree has been altered.	# `false`
`public array`	`$unseen` Unseen count. Unseen count.	# `0`

Packages

Classes

Class IMP_Imap_Tree

Parameters

Parameters

Parameters

Parameters

Returns

Parameters

Parameters

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Parameters

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Parameters

Returns

Parameters

Parameters

Returns

Throws

Parameters

Returns

Parameters

Returns

Implementation of

Implementation of

Implementation of

Implementation of

Implementation of

Implementation of

Implementation of

Implementation of

Implementation of

Implementation of

Parameters

Implementation of

Throws

Implementation of