API Documentation

Mail/Storage/Folder/Interface.php

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-2011 Zend Technologies USA Inc. (http://www.zend.com)  
license
New BSD License  
package
Zend_Mail  
subpackage
Storage  
version
$Id: Interface.php 23775 2011-03-01 17:25:24Z ralph $  

\Zend_Mail_Storage_Folder_Interface

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

Methods

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
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.13.3.