Class Zend_Mail_Folder_Mbox

Description

Implements interfaces:

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

Zend_Mail_Abstract
   |
   --Zend_Mail_Mbox
      |
      --Zend_Mail_Folder_Mbox
Variable Summary
Method Summary
 Zend_Mail_Folder_Mbox __construct ($params $params)
 Zend_Mail_Folder getFolders ([string $rootFolder = null])
 void selectFolder (Zend_Mail_Folder|string $globalName)
 array __sleep ()
 void __wakeup ()
Variables
mixed $_currentFolder (line 60)

name of current folder

  • access: protected
mixed $_rootdir (line 55)

rootdir of folder structure

  • access: protected
mixed $_rootFolder (line 50)

Zend_Mail_Folder root folder for folder structure

  • access: protected

Inherited Variables

Inherited from Zend_Mail_Mbox

Zend_Mail_Mbox::$_filemtime
Zend_Mail_Mbox::$_filename
Zend_Mail_Mbox::$_positions

Inherited from Zend_Mail_Abstract

Zend_Mail_Abstract::$_has
Zend_Mail_Abstract::$_iterationMax
Zend_Mail_Abstract::$_iterationPos
Methods
Constructor __construct (line 73)

Create instance with parameters

Disallowed parameters are:

  • filename use Zend_Mail_Mbox for a single file
Supported parameters are:
  • rootdir rootdir of mbox structure
  • folder intial selected folder, default is 'INBOX'

  • access: public
  • throws: Zend_Mail_Exception
Zend_Mail_Folder_Mbox __construct ($params $params)
  • $params $params: array mail reader specific parameters

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

get Zend_Mail_Folder instance for current folder

  • return: instance of current folder
  • access: public
  • throws: Zend_Mail_Exception
Zend_Mail_Folder getCurrentFolder ()

Implementation of:
Zend_Mail_Folder_Interface::getCurrentFolder()
get Zend_Mail_Folder instance for current folder
getFolders (line 139)

get root folder or given folder

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

Implementation of:
Zend_Mail_Folder_Interface::getFolders()
get root folder or given folder
selectFolder (line 169)

select given folder

folder must be selectable!

  • access: public
  • throws: Zend_Mail_Exception
void selectFolder (Zend_Mail_Folder|string $globalName)
  • Zend_Mail_Folder|string $globalName: global name of folder or instance for subfolder

Implementation of:
Zend_Mail_Folder_Interface::selectFolder()
select given folder
__sleep (line 206)

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_Mbox::__sleep()
magic method for serialize()
__wakeup (line 216)

magic method for unserialize()

with this method you can cache the mbox class

  • access: public
void __wakeup ()

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

Inherited Methods

Inherited From Zend_Mail_Mbox

 Zend_Mail_Mbox::__construct()
 Zend_Mail_Mbox::close()
 Zend_Mail_Mbox::countMessages()
 Zend_Mail_Mbox::getHeader()
 Zend_Mail_Mbox::getMessage()
 Zend_Mail_Mbox::getSize()
 Zend_Mail_Mbox::noop()
 Zend_Mail_Mbox::removeMessage()
 Zend_Mail_Mbox::_isMboxFile()
 Zend_Mail_Mbox::_openMboxFile()
 Zend_Mail_Mbox::__sleep()
 Zend_Mail_Mbox::__wakeup()

Inherited From Zend_Mail_Abstract

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

Documentation generated on Thu, 18 Jan 2007 10:01:03 -0800 by phpDocumentor 1.3.1