API Documentation

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

\Zend_Mail_Storage_Folder_Maildir

Package: Zend\Mail\Storage

Implements
\Zend_Mail_Storage_Folder_Interface
Parent(s)
\Zend_Mail_Storage_Maildir < \Zend_Mail_Storage_Abstract
Children
\Zend_Mail_Storage_Writable_Maildir
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
Propertyprotectedstring  $_delim= ''

delim char for subfolders

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 Supported parameters are: - dirname rootdir of maildir structure - delim delim char for folder structur, default is '.' - folder intial selected folder, default is 'INBOX'

Parameters
Name Type Description
$params array

mail reader specific parameters

Throws
Exception Description
\Zend_Mail_Storage_Exception
methodprotected_buildFolderTree( ) : 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.

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.