Zend Framework
LICENSE
This source file is subject to the new BSD license that is bundled with this package in the file LICENSE.txt. It is also available through the world-wide-web at this URL: http://framework.zend.com/license/new-bsd If you did not receive a copy of the license and are unable to obtain it through the world-wide-web, please send an email to license@zend.com so we can send you a copy immediately.

array
$_folders= ''
subfolders of folder array(localName => Zend_Mail_Storage_Folder folder)

__construct(
string $localName, string $globalName
=
'', bool $selectable
=
true, array $folders
=
array()
)
:
void
create a new mail folder instance
Name | Type | Description |
---|---|---|
$localName | string | name of folder in current subdirectory |
$globalName | string | absolute name of folder |
$selectable | bool | if true folder holds messages, if false it's just a parent for subfolders |
$folders | array | init with given instances of Zend_Mail_Storage_Folder as subfolders |

__get(
string $name
)
:
\Zend_Mail_Storage_Folder
get subfolder named $name
Name | Type | Description |
---|---|---|
$name | string | wanted subfolder |
Type | Description |
---|---|
\Zend_Mail_Storage_Folder | folder named $folder |
Exception | Description |
---|---|
\Zend_Mail_Storage_Exception |

__set(
string $name, \Zend_Mail_Storage_Folder $folder
)
:
null
add or replace subfolder named $name
Name | Type | Description |
---|---|---|
$name | string | local name of subfolder |
$folder | \Zend_Mail_Storage_Folder | instance for new subfolder |
Type | Description |
---|---|
null |

__toString(
)
:
string
magic method for easy output of global name
Type | Description |
---|---|
string | global name of folder |

__unset(
string $name
)
:
null
remove subfolder named $name
Name | Type | Description |
---|---|---|
$name | string | local name of subfolder |
Type | Description |
---|---|
null |

current(
)
:
\Zend_Mail_Storage_Folder
implements Iterator::current()
Type | Description |
---|---|
\Zend_Mail_Storage_Folder | current folder |

getChildren(
)
:
\Zend_Mail_Storage_Folder
implements RecursiveIterator::getChildren()
Type | Description |
---|---|
\Zend_Mail_Storage_Folder | same as self::current() |

hasChildren(
)
:
bool
implements RecursiveIterator::hasChildren()
Type | Description |
---|---|
bool | current element has children |

isLeaf(
)
:
bool
check if folder has no subfolder
Type | Description |
---|---|
bool | true if no subfolders |

key(
)
:
string
implements Iterator::key()
Type | Description |
---|---|
string | key/local name of current element |