API Documentation

Zend/Mail/Storage/Folder.php

Show: inherited
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-2012 Zend Technologies USA Inc. (http://www.zend.com)  
License
New BSD License  
Package
Zend_Mail  
Subpackage
Storage  
Version
$Id: Folder.php 24594 2012-01-05 21:27:01Z matthew $  

\Zend_Mail_Storage_Folder

Package: Zend\Mail\Storage

Implements
Category
Zend  
Copyright
Copyright (c) 2005-2012 Zend Technologies USA Inc. (http://www.zend.com)  
License
New BSD License  

Properties

Propertyprotectedarray  $_folders= ''

subfolders of folder array(localName => Zend_Mail_Storage_Folder folder)

Details
Type
array
Propertyprotectedstring  $_globalName= ''

global name (absolute name of folder)

Details
Type
string
Propertyprotectedstring  $_localName= ''

local name (name of folder in parent folder)

Details
Type
string
Propertyprotectedbool  $_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
Name Type Description
$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

$folders array

init with given instances of Zend_Mail_Storage_Folder as subfolders

methodpublic__get( string $name ) : \Zend_Mail_Storage_Folder

get subfolder named $name

Parameters
Name Type Description
$name string

wanted subfolder

Returns
Type Description
\Zend_Mail_Storage_Folder folder named $folder
Throws
Exception Description
\Zend_Mail_Storage_Exception
methodpublic__set( string $name, \Zend_Mail_Storage_Folder $folder ) : null

add or replace subfolder named $name

Parameters
Name Type Description
$name string

local name of subfolder

$folder \Zend_Mail_Storage_Folder

instance for new subfolder

Returns
Type Description
null
methodpublic__toString( ) : string

magic method for easy output of global name

Returns
Type Description
string global name of folder
methodpublic__unset( string $name ) : null

remove subfolder named $name

Parameters
Name Type Description
$name string

local name of subfolder

Returns
Type Description
null
methodpubliccurrent( ) : \Zend_Mail_Storage_Folder

implements Iterator::current()

Returns
Type Description
\Zend_Mail_Storage_Folder current folder
methodpublicgetChildren( ) : \Zend_Mail_Storage_Folder

implements RecursiveIterator::getChildren()

Returns
Type Description
\Zend_Mail_Storage_Folder same as self::current()
methodpublicgetGlobalName( ) : string

get global name

Returns
Type Description
string global name
methodpublicgetLocalName( ) : string

get local name

Returns
Type Description
string local name
methodpublichasChildren( ) : bool

implements RecursiveIterator::hasChildren()

Returns
Type Description
bool current element has children
methodpublicisLeaf( ) : bool

check if folder has no subfolder

Returns
Type Description
bool true if no subfolders
methodpublicisSelectable( ) : bool

is this folder selectable?

Returns
Type Description
bool selectable
methodpublickey( ) : string

implements Iterator::key()

Returns
Type Description
string key/local name of current element
methodpublicnext( ) : null

implements Iterator::next()

Returns
Type Description
null
methodpublicrewind( ) : null

implements Iterator::rewind()

Returns
Type Description
null
methodpublicvalid( ) : bool

implements Iterator::valid()

Returns
Type Description
bool check if there's a current element
Documentation was generated by DocBlox 0.15.1.