Class Zend_Mail_Storage_Folder_Mbox

Description

Implements interfaces:

Located in /Zend/Mail/Storage/Folder/Mbox.php (line 45)

Zend_Mail_Storage_Abstract
   |
   --Zend_Mail_Storage_Mbox
      |
      --Zend_Mail_Storage_Folder_Mbox
Variable Summary
Method Summary
 Zend_Mail_Storage_Folder_Mbox __construct ($params $params)
 Zend_Mail_Storage_Folder getFolders ([string $rootFolder = null])
 null selectFolder (Zend_Mail_Storage_Folder|string $globalName)
 null _buildFolderTree (string $currentDir, [Zend_Mail_Storage_Folder|null $parentFolder = null], [string $parentGlobalName = ''])
 array __sleep ()
 null __wakeup ()
Variables
string $_currentFolder (line 63)

name of current folder

  • access: protected
string $_rootdir (line 57)

rootdir of folder structure

  • access: protected
Zend_Mail_Storage_Folder $_rootFolder (line 51)

Zend_Mail_Storage_Folder root folder for folder structure

  • access: protected

Inherited Variables

Inherited from Zend_Mail_Storage_Mbox

Zend_Mail_Storage_Mbox::$_fh
Zend_Mail_Storage_Mbox::$_filemtime
Zend_Mail_Storage_Mbox::$_filename
Zend_Mail_Storage_Mbox::$_positions

Inherited from Zend_Mail_Storage_Abstract

Zend_Mail_Storage_Abstract::$_has
Zend_Mail_Storage_Abstract::$_iterationMax
Zend_Mail_Storage_Abstract::$_iterationPos
Methods
Constructor __construct (line 77)

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'

  • access: public
  • throws: Zend_Mail_Storage_Exception
Zend_Mail_Storage_Folder_Mbox __construct ($params $params)
  • $params $params: array mail reader specific parameters

Redefinition of:
Zend_Mail_Storage_Mbox::__construct()
Create instance with parameters Supported parameters are:
  • filename filename of mbox file
getCurrentFolder (line 202)

get Zend_Mail_Storage_Folder instance for current folder

  • return: instance of current folder
  • access: public
  • throws: Zend_Mail_Storage_Exception
Zend_Mail_Storage_Folder getCurrentFolder ()

Implementation of:
Zend_Mail_Storage_Folder_Interface::getCurrentFolder()
get Zend_Mail_Storage_Folder instance for current folder
getFolders (line 146)

get root folder or given folder

  • return: root or wanted folder
  • access: public
  • throws: Zend_Mail_Storage_Exception
Zend_Mail_Storage_Folder getFolders ([string $rootFolder = null])
  • string $rootFolder: get folder structure for given folder, else root

Implementation of:
Zend_Mail_Storage_Folder_Interface::getFolders()
get root folder or given folder
selectFolder (line 177)

select given folder

folder must be selectable!

  • access: public
  • throws: Zend_Mail_Storage_Exception
null selectFolder (Zend_Mail_Storage_Folder|string $globalName)

Implementation of:
Zend_Mail_Storage_Folder_Interface::selectFolder()
select given folder
_buildFolderTree (line 106)

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.

  • access: protected
  • throws: Zend_Mail_Storage_Exception
null _buildFolderTree (string $currentDir, [Zend_Mail_Storage_Folder|null $parentFolder = null], [string $parentGlobalName = ''])
  • string $currentDir: call with root dir, also used for recursion.
  • Zend_Mail_Storage_Folder|null $parentFolder: used for recursion
  • string $parentGlobalName: used for rescursion
__sleep (line 214)

magic method for serialize()

with this method you can cache the mbox class

  • return: name of variables
  • access: public
array __sleep ()

Redefinition of:
Zend_Mail_Storage_Mbox::__sleep()
magic method for serialize()
__wakeup (line 226)

magic method for unserialize()

with this method you can cache the mbox class

  • access: public
null __wakeup ()

Redefinition of:
Zend_Mail_Storage_Mbox::__wakeup()
magic method for unserialize()

Inherited Methods

Inherited From Zend_Mail_Storage_Mbox

 Zend_Mail_Storage_Mbox::__construct()
 Zend_Mail_Storage_Mbox::close()
 Zend_Mail_Storage_Mbox::countMessages()
 Zend_Mail_Storage_Mbox::getMessage()
 Zend_Mail_Storage_Mbox::getRawContent()
 Zend_Mail_Storage_Mbox::getRawHeader()
 Zend_Mail_Storage_Mbox::getSize()
 Zend_Mail_Storage_Mbox::noop()
 Zend_Mail_Storage_Mbox::removeMessage()
 Zend_Mail_Storage_Mbox::_getPos()
 Zend_Mail_Storage_Mbox::_isMboxFile()
 Zend_Mail_Storage_Mbox::_openMboxFile()
 Zend_Mail_Storage_Mbox::__sleep()
 Zend_Mail_Storage_Mbox::__wakeup()

Inherited From Zend_Mail_Storage_Abstract

 Zend_Mail_Storage_Abstract::__construct()
 Zend_Mail_Storage_Abstract::close()
 Zend_Mail_Storage_Abstract::count()
 Zend_Mail_Storage_Abstract::countMessages()
 Zend_Mail_Storage_Abstract::current()
 Zend_Mail_Storage_Abstract::getCapabilities()
 Zend_Mail_Storage_Abstract::getMessage()
 Zend_Mail_Storage_Abstract::getRawContent()
 Zend_Mail_Storage_Abstract::getRawHeader()
 Zend_Mail_Storage_Abstract::getSize()
 Zend_Mail_Storage_Abstract::key()
 Zend_Mail_Storage_Abstract::next()
 Zend_Mail_Storage_Abstract::noop()
 Zend_Mail_Storage_Abstract::offsetExists()
 Zend_Mail_Storage_Abstract::offsetGet()
 Zend_Mail_Storage_Abstract::offsetSet()
 Zend_Mail_Storage_Abstract::offsetUnset()
 Zend_Mail_Storage_Abstract::removeMessage()
 Zend_Mail_Storage_Abstract::rewind()
 Zend_Mail_Storage_Abstract::seek()
 Zend_Mail_Storage_Abstract::valid()
 Zend_Mail_Storage_Abstract::__destruct()
 Zend_Mail_Storage_Abstract::__get()

Documentation generated on Wed, 21 Feb 2007 11:53:45 -0800 by phpDocumentor 1.3.1