Class Zend_Mail_Storage_Folder_Maildir

Description

Implements interfaces:

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

Zend_Mail_Storage_Abstract
   |
   --Zend_Mail_Storage_Maildir
      |
      --Zend_Mail_Storage_Folder_Maildir
Variable Summary
Method Summary
 Zend_Mail_Storage_Folder_Maildir __construct ($params $params)
 Zend_Mail_Storage_Folder getFolders ([string $rootFolder = null])
 null selectFolder (Zend_Mail_Storage_Folder|string $globalName)
Variables
string $_currentFolder (line 58)

name of current folder

  • access: protected
string $_delim (line 64)

delim char for subfolders

  • access: protected
string $_rootdir (line 52)

rootdir of folder structure

  • access: protected
Zend_Mail_Storage_Folder $_rootFolder (line 46)

Zend_Mail_Storage_Folder root folder for folder structure

  • access: protected

Inherited Variables

Inherited from Zend_Mail_Storage_Maildir

Zend_Mail_Storage_Maildir::$_files
Zend_Mail_Storage_Maildir::$_knownFlags

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

Create instance with parameters

Supported parameters are:

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

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

Redefinition of:
Zend_Mail_Storage_Maildir::__construct()
Create instance with parameters Supported parameters are:
  • dirname dirname of mbox file
getCurrentFolder (line 223)

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

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

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

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

Inherited Methods

Inherited From Zend_Mail_Storage_Maildir

 Zend_Mail_Storage_Maildir::__construct()
 Zend_Mail_Storage_Maildir::close()
 Zend_Mail_Storage_Maildir::countMessages()
 Zend_Mail_Storage_Maildir::getMessage()
 Zend_Mail_Storage_Maildir::getRawContent()
 Zend_Mail_Storage_Maildir::getRawHeader()
 Zend_Mail_Storage_Maildir::getSize()
 Zend_Mail_Storage_Maildir::noop()
 Zend_Mail_Storage_Maildir::removeMessage()
 Zend_Mail_Storage_Maildir::_getFileData()
 Zend_Mail_Storage_Maildir::_isMaildir()
 Zend_Mail_Storage_Maildir::_openMaildir()

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