Public Member Functions | Protected Member Functions | Protected Attributes

Zend_Mail_Storage_Folder_Maildir Class Reference

Inheritance diagram for Zend_Mail_Storage_Folder_Maildir:
Zend_Mail_Storage_Maildir Zend_Mail_Storage_Folder_Interface Zend_Mail_Storage_Abstract Zend_Mail_Storage_Writable_Maildir

Public Member Functions

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

Protected Member Functions

 _buildFolderTree ()

Protected Attributes

 $_rootFolder
 $_rootdir
 $_currentFolder
 $_delim

Detailed Description

Definition at line 47 of file Maildir.php.


Constructor & Destructor Documentation

__construct ( params )

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

See also:
Zend_Mail_Storage_Exception

Reimplemented from Zend_Mail_Storage_Maildir.

Reimplemented in Zend_Mail_Storage_Writable_Maildir.

Definition at line 83 of file Maildir.php.


Member Function Documentation

_buildFolderTree (  ) [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.

Returns:
null
Exceptions:
Zend_Mail_Storage_Exception

See also:
Zend_Mail_Storage_Exception
Zend_Mail_Storage_Exception
Zend_Mail_Storage_Exception

Definition at line 116 of file Maildir.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 261 of file Maildir.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 187 of file Maildir.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 226 of file Maildir.php.


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