Zend Framework
Back to top  

 Methods

create a new mail folder instance

__construct(string $localName, string $globalName, bool $selectable, array $folders) 

Parameters

$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 (Default: true)

$folders

array

init with given instances of \Zend\Mail\Storage\Folder as subfolders

get subfolder named $name

__get(string $name) : \Zend\Mail\Storage\Folder

Parameters

$name

string

wanted subfolder

Exceptions

\Zend\Mail\Storage\Exception\InvalidArgumentException

Returns

\Zend\Mail\Storage\Folderfolder named $folder

add or replace subfolder named $name

__set(string $name, \Zend\Mail\Storage\Folder $folder) 

Parameters

$name

string

local name of subfolder

$folder

\Zend\Mail\Storage\Folder

instance for new subfolder

magic method for easy output of global name

__toString() : string

Returns

stringglobal name of folder

remove subfolder named $name

__unset(string $name) 

Parameters

$name

string

local name of subfolder

implements Iterator::current()

current() : \Zend\Mail\Storage\Folder

Returns

\Zend\Mail\Storage\Foldercurrent folder

implements RecursiveIterator::getChildren()

getChildren() : \Zend\Mail\Storage\Folder

Returns

\Zend\Mail\Storage\Foldersame as self::current()

get global name

getGlobalName() : string

Returns

stringglobal name

get local name

getLocalName() : string

Returns

stringlocal name

implements RecursiveIterator::hasChildren()

hasChildren() : bool

Returns

boolcurrent element has children

check if folder has no subfolder

isLeaf() : bool

Returns

booltrue if no subfolders

is this folder selectable?

isSelectable() : bool

Returns

boolselectable

implements Iterator::key()

key() : string

Returns

stringkey/local name of current element

implements Iterator::rewind()

rewind() 

implements Iterator::valid()

valid() : bool

Returns

boolcheck if there's a current element

 Properties

 

subfolders of folder array(localName => \Zend\Mail\Storage\Folder folder)

$folders : array

 

global name (absolute name of folder)

$globalName : string

 

local name (name of folder in parent folder)

$localName : string

 

folder is selectable if folder is able to hold messages, else it's just a parent folder

$selectable : bool