| Fully Qualified Name: | Laminas\Mail\Storage\Folder |
| Implements: | RecursiveIterator |
| Name | Description | Defined By |
|---|---|---|
| __construct() | create a new mail folder instance | Folder |
| __get() | get subfolder named $name | Folder |
| __set() | add or replace subfolder named $name | Folder |
| __toString() | magic method for easy output of global name | Folder |
| __unset() | remove subfolder named $name | Folder |
| current() | implements Iterator::current() | Folder |
| getChildren() | implements RecursiveIterator::getChildren() | Folder |
| getGlobalName() | get global name | Folder |
| getLocalName() | get local name | Folder |
| hasChildren() | implements RecursiveIterator::hasChildren() | Folder |
| isLeaf() | check if folder has no subfolder | Folder |
| isSelectable() | is this folder selectable? | Folder |
| key() | implements Iterator::key() | Folder |
| next() | implements Iterator::next() | Folder |
| rewind() | implements Iterator::rewind() | Folder |
| valid() | implements Iterator::valid() | Folder |
create a new mail folder instance
| Parameter Name | Type | Description |
|---|---|---|
| $localName | string | name |
| $globalName | string | absolute |
| $selectable | bool | if |
| $folders | array | init |
Returns:
get subfolder named $name
| Parameter Name | Type | Description |
|---|---|---|
| $name | string | wanted |
Returns: \Laminas\Mail\Storage\Folder folder named $folder
add or replace subfolder named $name
| Parameter Name | Type | Description |
|---|---|---|
| $name | string | local |
| $folder | \Laminas\Mail\Storage\Folder | instance |
Returns:
magic method for easy output of global name
Returns: string global name of folder
remove subfolder named $name
| Parameter Name | Type | Description |
|---|---|---|
| $name | string | local |
Returns:
implements Iterator::current()
Returns: \Laminas\Mail\Storage\Folder current folder
implements RecursiveIterator::getChildren()
Returns: \Laminas\Mail\Storage\Folder same as self::current()
get global name
Returns: string global name
get local name
Returns: string local name
implements RecursiveIterator::hasChildren()
Returns: bool current element has children
check if folder has no subfolder
Returns: bool true if no subfolders
is this folder selectable?
Returns: bool selectable
implements Iterator::key()
Returns: string key/local name of current element
implements Iterator::next()
Returns:
implements Iterator::rewind()
Returns:
implements Iterator::valid()
Returns: bool check if there's a current element