Mail/Storage/Folder/Interface.php
Show:
inherited
inheritedZend 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 [email protected] so we can send you a copy immediately.
- Category
- Zend
- Copyright
- Copyright (c) 2005-2014 Zend Technologies USA Inc. (http://www.zend.com)
- License
- New BSD License
- Package
- Zend_Mail
- Subpackage
- Storage
- Version
- $Id$
\Zend_Mail_Storage_Folder_Interface
Package: Zend_Mail\Storage
Returns
Throws
- Category
- Zend
- Copyright
- Copyright (c) 2005-2014 Zend Technologies USA Inc. (http://www.zend.com)
- License
- New BSD License
Methods
getCurrentFolder() : \Zend_Mail_Storage_Folderget Zend_Mail_Storage_Folder instance for current folder
Returns
Throws
| Type | Description |
|---|---|
| \Zend_Mail_Storage_Folder | instance of current folder |
| Exception | Description |
|---|---|
| \Zend_Mail_Storage_Exception |
getFolders(string $rootFolder = null) : \Zend_Mail_Storage_Folderget root folder or given folder
Parameters
Returns
| Name | Type | Description |
|---|---|---|
| $rootFolder | string | get folder structure for given folder, else root |
| Type | Description |
|---|---|
| \Zend_Mail_Storage_Folder | root or wanted folder |
selectFolder(\Zend_Mail_Storage_Folder | string $globalName) : nullselect given folder
folder must be selectable!
Parameters| Name | Type | Description |
|---|---|---|
| $globalName | \Zend_Mail_Storage_Folder | string | global name of folder or instance for subfolder |
| Type | Description |
|---|---|
| null |
| Exception | Description |
|---|---|
| \Zend_Mail_Storage_Exception |