API Documentation

Zend/Mail/Storage/Folder/Mbox.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: Mbox.php 24594 2012-01-05 21:27:01Z matthew $  

\Zend_Mail_Storage_Folder_Mbox

Package: Zend\Mail\Storage

Implements
\Zend_Mail_Storage_Folder_Interface
Parent(s)
\Zend_Mail_Storage_Mbox < \Zend_Mail_Storage_Abstract
Category
Zend  
Copyright
Copyright (c) 2005-2012 Zend Technologies USA Inc. (http://www.zend.com)  
License
New BSD License  

Properties

Propertyprotectedstring  $_currentFolder= ''

name of current folder

Details
Type
string
Propertyprotected\Zend_Mail_Storage_Folder  $_rootFolder= ''

Zend_Mail_Storage_Folder root folder for folder structure

Propertyprotectedstring  $_rootdir= ''

rootdir of folder structure

Details
Type
string

Methods

methodpublic__construct( array $params ) : void

Create instance with parameters

Disallowed parameters are: - filename use Zend_Mail_Storage_Mbox for a single file Supported parameters are: - dirname rootdir of mbox structure - folder intial selected folder, default is 'INBOX'

Parameters
Name Type Description
$params array

mail reader specific parameters

Throws
Exception Description
\Zend_Mail_Storage_Exception
methodpublic__sleep( ) : array

magic method for serialize()

with this method you can cache the mbox class

Returns
Type Description
array name of variables
methodpublic__wakeup( ) : null

magic method for unserialize()

with this method you can cache the mbox class

Returns
Type Description
null
methodprotected_buildFolderTree( string $currentDir, \Zend_Mail_Storage_Folder|null $parentFolder = null, string $parentGlobalName = '' ) : null

find all subfolders and mbox files for folder structure

Result is save in Zend_Mail_Storage_Folder instances with the root in $this->_rootFolder. $parentFolder and $parentGlobalName are only used internally for recursion.

Parameters
Name Type Description
$currentDir string

call with root dir, also used for recursion.

$parentFolder \Zend_Mail_Storage_Folder|null

used for recursion

$parentGlobalName string

used for rescursion

Returns
Type Description
null
Throws
Exception Description
\Zend_Mail_Storage_Exception
methodpublicgetCurrentFolder( ) : \Zend_Mail_Storage_Folder

get Zend_Mail_Storage_Folder instance for current folder

Returns
Type Description
\Zend_Mail_Storage_Folder instance of current folder
Throws
Exception Description
\Zend_Mail_Storage_Exception
methodpublicgetFolders( string $rootFolder = null ) : \Zend_Mail_Storage_Folder

get root folder or given folder

Parameters
Name Type Description
$rootFolder string

get folder structure for given folder, else root

Returns
Type Description
\Zend_Mail_Storage_Folder root or wanted folder
Throws
Exception Description
\Zend_Mail_Storage_Exception
methodpublicselectFolder( \Zend_Mail_Storage_Folder|string $globalName ) : null

select given folder

folder must be selectable!

Parameters
Name Type Description
$globalName \Zend_Mail_Storage_Folder|string

global name of folder or instance for subfolder

Returns
Type Description
null
Throws
Exception Description
\Zend_Mail_Storage_Exception
Documentation was generated by DocBlox 0.15.1.