Zend\Mail\Storage\Folder
Synopsis
class Folder
implements
RecursiveIterator
{
- // members
- protected array $folders;
- protected string $localName;
- protected string $globalName;
- protected bool $selectable;
- // methods
- public void __construct()
- public bool hasChildren()
- public Folder getChildren()
- public bool valid()
- public void next()
- public string key()
- public Folder current()
- public void rewind()
- public Folder __get()
- public void __set()
- public void __unset()
- public string __toString()
- public string getLocalName()
- public string getGlobalName()
- public bool isSelectable()
- public bool isLeaf()
Hierarchy
Implements
Members
protected
- $folders
—
array
subfolders of folder array(localName => \Zend\Mail\Storage\Folder folder) - $globalName
—
string
global name (absolute name of folder) - $localName
—
string
local name (name of folder in parent folder) - $selectable
—
Zend\Mail\Storage\bool
folder is selectable if folder is able to hold messages, else it's just a parent folder
Methods
public
- __construct() — create a new mail folder instance
- __get() — get subfolder named $name
- __set() — add or replace subfolder named $name
- __toString() — magic method for easy output of global name
- __unset() — remove subfolder named $name
- current() — implements Iterator::current()
- getChildren() — implements RecursiveIterator::getChildren()
- getGlobalName() — get global name
- getLocalName() — get local name
- hasChildren() — implements RecursiveIterator::hasChildren()
- isLeaf() — check if folder has no subfolder
- isSelectable() — is this folder selectable?
- key() — implements Iterator::key()
- next() — implements Iterator::next()
- rewind() — implements Iterator::rewind()
- valid() — implements Iterator::valid()