Class Zend_Mail_Folder_Maildir

Description

Implements interfaces:

Located in /Mail/Folder/Maildir.php (line 40)

Zend_Mail_Abstract
   |
   --Zend_Mail_Maildir
      |
      --Zend_Mail_Folder_Maildir
Variable Summary
 mixed $_delim
 mixed $_rootdir
 mixed $_rootFolder
Method Summary
 Zend_Mail_Folder_Maildir __construct ($params $params)
 Zend_Mail_Folder getFolders ([string $rootFolder = null])
 void selectFolder (Zend_Mail_Folder|string $globalName)
Variables
mixed $_currentFolder (line 55)

name of current folder

  • access: protected
mixed $_delim (line 60)

delim char for subfolders

  • access: protected
mixed $_rootdir (line 50)

rootdir of folder structure

  • access: protected
mixed $_rootFolder (line 45)

Zend_Mail_Folder root folder for folder structure

  • access: protected

Inherited Variables

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

Supported parameters are:

  • rootdir rootdir of maildir structure
  • dirname alias for rootdir
  • delim delim char for folder structur, default is '.'
  • folder intial selected folder, default is 'INBOX'

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

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

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 157)

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 191)

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

Inherited Methods

Inherited From Zend_Mail_Maildir

 Zend_Mail_Maildir::__construct()
 Zend_Mail_Maildir::close()
 Zend_Mail_Maildir::countMessages()
 Zend_Mail_Maildir::getHeader()
 Zend_Mail_Maildir::getMessage()
 Zend_Mail_Maildir::getSize()
 Zend_Mail_Maildir::noop()
 Zend_Mail_Maildir::removeMessage()
 Zend_Mail_Maildir::_isMaildir()
 Zend_Mail_Maildir::_openMaildir()

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:02 -0800 by phpDocumentor 1.3.1