category Zend
package Zend_Mail
subpackage Storage
copyright Copyright (c) 2005-2015 Zend Technologies USA Inc. (http://www.zend.com)
license New BSD License

 Methods

create a new mail folder instance

__construct(string $localName, string $globalName = '', boolean $selectable = true, array $folders = array()

Parameters

$localName

string

name of folder in current subdirectory

$globalName

string

absolute name of folder

$selectable

boolean

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 subfolder named $name

__get(string $name) : \Zend_Mail_Storage_Folder

Parameters

$name

string

wanted subfolder

Exceptions

\Zend_Mail_Storage_Exception

Returns

\Zend_Mail_Storage_Folderfolder named $folder

add or replace subfolder named $name

__set(string $name, \Zend_Mail_Storage_Folder $folder) : null

Parameters

$name

string

local name of subfolder

$folder

\Zend_Mail_Storage_Folder

instance for new subfolder

Returns

null

magic method for easy output of global name

__toString() : string

Returns

stringglobal name of folder

remove subfolder named $name

__unset(string $name) : null

Parameters

$name

string

local name of subfolder

Returns

null

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() : boolean

Returns

booleancurrent element has children

check if folder has no subfolder

isLeaf() : boolean

Returns

booleantrue if no subfolders

is this folder selectable?

isSelectable() : boolean

Returns

booleanselectable

implements Iterator::key()

key() : string

Returns

stringkey/local name of current element

implements Iterator::next()

next() : null

Returns

null

implements Iterator::rewind()

rewind() : null

Returns

null

implements Iterator::valid()

valid() : boolean

Returns

booleancheck if there's a current element

 Properties

 

subfolders of folder array(localName => Zend_Mail_Storage_Folder folder)

$_folders : array

Default

 

global name (absolute name of folder)

$_globalName : string

Default

 

local name (name of folder in parent folder)

$_localName : string

Default

 

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

$_selectable : boolean

Default

true