Zend_Mail_Storage_Folder Class Reference

Public Member Functions
	__construct ($localName, $globalName= '', $selectable=true, array $folders=array())
	create a new mail folder instance
	hasChildren ()
	implements RecursiveIterator::hasChildren()
	getChildren ()
	implements RecursiveIterator::getChildren()
	valid ()
	implements Iterator::valid()
	next ()
	implements Iterator::next()
	key ()
	implements Iterator::key()
	current ()
	implements Iterator::current()
	rewind ()
	implements Iterator::rewind()
	__get ($name)
	get subfolder named $name
	__set ($name, Zend_Mail_Storage_Folder $folder)
	add or replace subfolder named $name
	__unset ($name)
	remove subfolder named $name
	__toString ()
	magic method for easy output of global name
	getLocalName ()
	get local name
	getGlobalName ()
	get global name
	isSelectable ()
	is this folder selectable?
	isLeaf ()
	check if folder has no subfolder

Protected Attributes
	$_folders
	$_localName
	$_globalName
	$_selectable = true

Constructor & Destructor Documentation

__construct	(		$localName,
			$globalName = '',
			$selectable = true,
		array	$folders = array()
	)

create a new mail folder instance

Parameters

string	$localName	name of folder in current subdirectory
string	$globalName	absolute name of folder
bool	$selectable	if true folder holds messages, if false it's just a parent for subfolders
array	$folders	init with given instances of Zend_Mail_Storage_Folder as subfolders

Member Function Documentation

__get

(

$name

)

get subfolder named $name

Parameters

string

$name

wanted subfolder

Returns

Zend_Mail_Storage_Folder folder named $folder

Exceptions

Zend_Mail_Storage_Exception

See Also

Zend_Mail_Storage_Exception

__set	(		$name,
		Zend_Mail_Storage_Folder	$folder
	)

add or replace subfolder named $name

Parameters

string	$name	local name of subfolder
Zend_Mail_Storage_Folder	$folder	instance for new subfolder

Returns

null

__toString

(

)

magic method for easy output of global name

Returns

string global name of folder

__unset

(

$name

)

remove subfolder named $name

Parameters

string

$name

local name of subfolder

Returns

null

current

(

)

implements Iterator::current()

Returns

Zend_Mail_Storage_Folder current folder

getChildren

(

)

implements RecursiveIterator::getChildren()

Returns

Zend_Mail_Storage_Folder same as self::current()

getGlobalName

(

)

get global name

Returns

string global name

getLocalName

(

)

get local name

Returns

string local name

hasChildren

(

)

implements RecursiveIterator::hasChildren()

Returns

bool current element has children

isLeaf

(

)

check if folder has no subfolder

Returns

bool true if no subfolders

isSelectable

(

)

is this folder selectable?

Returns

bool selectable

key

(

)

implements Iterator::key()

Returns

string key/local name of current element

next

(

)

implements Iterator::next()

Returns

null

rewind

(

)

implements Iterator::rewind()

Returns

null

valid

(

)

implements Iterator::valid()

Returns

bool check if there's a current element

Member Data Documentation

$_folders

protected

$_globalName

protected

$_localName

protected

$_selectable = true

protected