Public Member Functions | Protected Member Functions | Protected Attributes

Zend_Mail_Storage_Folder_Mbox Class Reference

Inheritance diagram for Zend_Mail_Storage_Folder_Mbox:
Zend_Mail_Storage_Mbox Zend_Mail_Storage_Folder_Interface Zend_Mail_Storage_Abstract

Public Member Functions

 __construct ($params)
 getFolders ($rootFolder=null)
 selectFolder ($globalName)
 getCurrentFolder ()
 __sleep ()
 __wakeup ()

Protected Member Functions

 _buildFolderTree ($currentDir, $parentFolder=null, $parentGlobalName= '')

Protected Attributes

 $_rootFolder
 $_rootdir
 $_currentFolder

Detailed Description

Definition at line 47 of file Mbox.php.


Constructor & Destructor Documentation

__construct ( params )

Create 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:
$paramsarray mail reader specific parameters
Exceptions:
Zend_Mail_Storage_Exception

See also:
Zend_Mail_Storage_Exception
Zend_Mail_Storage_Exception

Reimplemented from Zend_Mail_Storage_Mbox.

Definition at line 79 of file Mbox.php.


Member Function Documentation

__sleep (  )

magic method for serialize()

with this method you can cache the mbox class

Returns:
array name of variables

Reimplemented from Zend_Mail_Storage_Mbox.

Definition at line 247 of file Mbox.php.

__wakeup (  )

magic method for unserialize()

with this method you can cache the mbox class

Returns:
null

Reimplemented from Zend_Mail_Storage_Mbox.

Definition at line 259 of file Mbox.php.

_buildFolderTree ( currentDir,
parentFolder = null,
parentGlobalName = '' 
) [protected]

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.

Parameters:
string$currentDircall with root dir, also used for recursion.
Zend_Mail_Storage_Folder | null$parentFolderused for recursion
string$parentGlobalNameused for rescursion
Returns:
null
Exceptions:
Zend_Mail_Storage_Exception

See also:
Zend_Mail_Storage_Exception

Definition at line 121 of file Mbox.php.

getCurrentFolder (  )

get Zend_Mail_Storage_Folder instance for current folder

Returns:
Zend_Mail_Storage_Folder instance of current folder
Exceptions:
Zend_Mail_Storage_Exception

Implements Zend_Mail_Storage_Folder_Interface.

Definition at line 235 of file Mbox.php.

getFolders ( rootFolder = null )

get root folder or given folder

Parameters:
string$rootFolderget folder structure for given folder, else root
Returns:
Zend_Mail_Storage_Folder root or wanted folder
Exceptions:
Zend_Mail_Storage_Exception

See also:
Zend_Mail_Storage_Exception

Implements Zend_Mail_Storage_Folder_Interface.

Definition at line 165 of file Mbox.php.

selectFolder ( globalName )

select given folder

folder must be selectable!

Parameters:
Zend_Mail_Storage_Folder | string$globalNameglobal name of folder or instance for subfolder
Returns:
null
Exceptions:
Zend_Mail_Storage_Exception

See also:
Zend_Mail_Storage_Exception
Zend_Mail_Storage_Exception

Implements Zend_Mail_Storage_Folder_Interface.

Definition at line 200 of file Mbox.php.


The documentation for this class was generated from the following file: