Mail/Storage/Folder.php

Show: PublicProtectedPrivateinherited
Table of Contents
Zend Framework
LICENSE This source file is subject to the new BSD license that is bundled with this package in the file LICENSE.txt. It is also available through the world-wide-web at this URL: http://framework.zend.com/license/new-bsd If you did not receive a copy of the license and are unable to obtain it through the world-wide-web, please send an email to license@zend.com so we can send you a copy immediately.
Category
Zend  
Copyright
Copyright (c) 2005-2014 Zend Technologies USA Inc. (http://www.zend.com)  
License
New BSD License  
Package
Zend_Mail  
Subpackage
Storage  
Version
$Id$  

\Zend_Mail_Storage_Folder
jump to top

Package: Zend_Mail\Storage
Implements
Category
Zend  
Copyright
Copyright (c) 2005-2014 Zend Technologies USA Inc. (http://www.zend.com)  
License
New BSD License  

Properties

>VPropertyprotectedarray $_folders
subfolders of folder array(localName => Zend_Mail_Storage_Folder folder)
Details
Type
array
>VPropertyprotectedstring $_globalName
global name (absolute name of folder)
Details
Type
string
>VPropertyprotectedstring $_localName
local name (name of folder in parent folder)
Details
Type
string
>VPropertyprotectedbool $_selectable = true
folder is selectable if folder is able to hold messages, else it's just a parent folder
Default valuetrueDetails
Type
bool

Methods

methodpublic__construct(string $localName, string $globalName = '', bool $selectable = true, array $folders = array()) : void

create a new mail folder instance

Parameters
NameTypeDescription
$localNamestring

name of folder in current subdirectory

$globalNamestring

absolute name of folder

$selectablebool

if true folder holds messages, if false it's just a parent for subfolders

$foldersarray

init with given instances of Zend_Mail_Storage_Folder as subfolders

methodpublic__get(string $name) : \Zend_Mail_Storage_Folder

get subfolder named $name

Parameters
NameTypeDescription
$namestring

wanted subfolder

Returns
TypeDescription
\Zend_Mail_Storage_Folderfolder named $folder
Throws
ExceptionDescription
\Zend_Mail_Storage_Exception
methodpublic__set(string $name, \Zend_Mail_Storage_Folder $folder) : null

add or replace subfolder named $name

Parameters
NameTypeDescription
$namestring

local name of subfolder

$folder\Zend_Mail_Storage_Folder

instance for new subfolder

Returns
TypeDescription
null
methodpublic__toString() : string

magic method for easy output of global name

Returns
TypeDescription
stringglobal name of folder
methodpublic__unset(string $name) : null

remove subfolder named $name

Parameters
NameTypeDescription
$namestring

local name of subfolder

Returns
TypeDescription
null
methodpubliccurrent() : \Zend_Mail_Storage_Folder

implements Iterator::current()

Returns
TypeDescription
\Zend_Mail_Storage_Foldercurrent folder
methodpublicgetChildren() : \Zend_Mail_Storage_Folder

implements RecursiveIterator::getChildren()

Returns
TypeDescription
\Zend_Mail_Storage_Foldersame as self::current()
methodpublicgetGlobalName() : string

get global name

Returns
TypeDescription
stringglobal name
methodpublicgetLocalName() : string

get local name

Returns
TypeDescription
stringlocal name
methodpublichasChildren() : bool

implements RecursiveIterator::hasChildren()

Returns
TypeDescription
boolcurrent element has children
methodpublicisLeaf() : bool

check if folder has no subfolder

Returns
TypeDescription
booltrue if no subfolders
methodpublicisSelectable() : bool

is this folder selectable?

Returns
TypeDescription
boolselectable
methodpublickey() : string

implements Iterator::key()

Returns
TypeDescription
stringkey/local name of current element
methodpublicnext() : null

implements Iterator::next()

Returns
TypeDescription
null
methodpublicrewind() : null

implements Iterator::rewind()

Returns
TypeDescription
null
methodpublicvalid() : bool

implements Iterator::valid()

Returns
TypeDescription
boolcheck if there's a current element
Documentation was generated by phpDocumentor 2.2.0 .