Mail/Storage/Folder/Mbox.php
Show:
inherited
inherited
Classes
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-2014 Zend Technologies USA Inc. (http://www.zend.com)
- License
- New BSD License
- Package
- Zend_Mail
- Subpackage
- Storage
- Version
- $Id$
\Zend_Mail_Storage_Folder_Mbox
Package: Zend_Mail\Storage
Throws
Returns
Throws
Returns
Throws
- Implements
- Parent(s)
- \Zend_Mail_Storage_Mbox < \Zend_Mail_Storage_Abstract
- Category
- Zend
- Copyright
- Copyright (c) 2005-2014 Zend Technologies USA Inc. (http://www.zend.com)
- License
- New BSD License
Properties
string $_currentFoldername of current folder
Details
- Type
- string
\Zend_Mail_Storage_Folder $_rootFolderZend_Mail_Storage_Folder root folder for folder structure
Details
string $_rootdirrootdir of folder structure
Details
- Type
- string
Methods
__construct(array $params) : voidCreate 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 |
| Exception | Description |
|---|---|
| \Zend_Mail_Storage_Exception |
__sleep() : arraymagic method for serialize()
with this method you can cache the mbox class
Returns| Type | Description |
|---|---|
| array | name of variables |
__wakeup() : nullmagic method for unserialize()
with this method you can cache the mbox class
Returns| Type | Description |
|---|---|
| null |
_buildFolderTree(string $currentDir, \Zend_Mail_Storage_Folder | null $parentFolder = null, string $parentGlobalName = '') : nullfind 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 |
| Type | Description |
|---|---|
| null |
| Exception | Description |
|---|---|
| \Zend_Mail_Storage_Exception |
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
Throws
| Name | Type | Description |
|---|---|---|
| $rootFolder | string | get folder structure for given folder, else root |
| Type | Description |
|---|---|
| \Zend_Mail_Storage_Folder | root or wanted folder |
| Exception | Description |
|---|---|
| \Zend_Mail_Storage_Exception |
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 |