1818. Class

1818.1. Zend\Mail\Storage\Folder

1818.1.1. Methods

1818.1.1.1. __construct

__construct()

create a new mail folder instance

Parameters:

• string – name of folder in current subdirectory
• string – absolute name of folder
• bool – if true folder holds messages, if false it’s just a parent for subfolders (Default: true)
• array – init with given instances of ZendMailStorageFolder as subfolders

1818.1.1.2. hasChildren

hasChildren()

implements RecursiveIterator::hasChildren()

Return type:bool current element has children

1818.1.1.3. getChildren

getChildren()

implements RecursiveIterator::getChildren()

Return type:ZendMailStorageFolder same as self::current()

1818.1.1.4. valid

valid()

implements Iterator::valid()

Return type:bool check if there’s a current element

1818.1.1.5. next

next()

implements Iterator::next()

1818.1.1.6. key

key()

implements Iterator::key()

Return type:string key/local name of current element

1818.1.1.7. current

current()

implements Iterator::current()

Return type:ZendMailStorageFolder current folder

1818.1.1.8. rewind

rewind()

implements Iterator::rewind()

1818.1.1.9. __get

__get()

get subfolder named $name

Parameters:string – wanted subfolder Throws ExceptionInvalidArgumentException:   Return type:ZendMailStorageFolder folder named $folder

1818.1.1.10. __set

__set()

add or replace subfolder named $name

Parameters:

• string – local name of subfolder
• ZendMailStorageFolder – instance for new subfolder

1818.1.1.11. __unset

__unset()

remove subfolder named $name

Parameters:string – local name of subfolder

1818.1.1.12. __toString

__toString()

magic method for easy output of global name

Return type:string global name of folder

1818.1.1.13. getLocalName

getLocalName()

get local name

Return type:string local name

1818.1.1.14. getGlobalName

getGlobalName()

get global name

Return type:string global name

1818.1.1.15. isSelectable

isSelectable()

is this folder selectable?

Return type:bool selectable

1818.1.1.16. isLeaf

isLeaf()

check if folder has no subfolder

Return type:bool true if no subfolders