Mail/Storage/Folder/Interface.php
- category
- Zend
- copyright
- Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
- license
- http://framework.zend.com/license/new-bsd New BSD License
- package
- Zend_Mail
- subpackage
- Storage
- version
- $Id: Interface.php 20096 2010-01-06 02:05:09Z bkarwin $
- Interfaces
- Zend_Mail_Storage_Folder_Interface
Description
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.
Zend_Mail_Storage_Folder_Interface
- category
- Zend
- copyright
- Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
- license
- http://framework.zend.com/license/new-bsd New BSD License
- package
- Zend_Mail
- subpackage
- Storage
- Methods
- getFolders
- selectFolder
- getCurrentFolder
Description
Methods
getCurrentFolder
getCurrentFolder(
)
:
Zend_Mail_Storage_Folderget Zend_Mail_Storage_Folder instance for current folder
Output
- Zend_Mail_Storage_Folder
- instance of current folder
Details
- visibility
- public
- final
- false
- static
- false
- throws
getFolders
getFolders(
string $rootFolder
=
null
)
:
Zend_Mail_Storage_Folderget root folder or given folder
Arguments
- $rootFolder
- string
get folder structure for given folder, else root
Output
- Zend_Mail_Storage_Folder
- root or wanted folder
Details
- visibility
- public
- final
- false
- static
- false
selectFolder
selectFolder(
Zend_Mail_Storage_Folder|string $globalName
)
:
nullselect given folder
folder must be selectable!
Arguments
- $globalName
- Zend_Mail_Storage_Folderstring
global name of folder or instance for subfolder
Output
- null
Details
- visibility
- public
- final
- false
- static
- false
- throws