Zend Framework  1.12
Public Member Functions | List of all members
Zend_Mail_Storage_Folder_Interface Interface Reference

Public Member Functions

 getFolders ($rootFolder=null)
 get root folder or given folder
 
 selectFolder ($globalName)
 select given folder
 
 getCurrentFolder ()
 get Zend_Mail_Storage_Folder instance for current folder
 

Member Function Documentation

getCurrentFolder ( )

get Zend_Mail_Storage_Folder instance for current folder

Returns
Zend_Mail_Storage_Folder instance of current folder
Exceptions
Zend_Mail_Storage_Exception

Implemented in Zend_Mail_Storage_Imap, Zend_Mail_Storage_Folder_Maildir, and Zend_Mail_Storage_Folder_Mbox.

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

Implemented in Zend_Mail_Storage_Imap, Zend_Mail_Storage_Folder_Maildir, and Zend_Mail_Storage_Folder_Mbox.

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

Implemented in Zend_Mail_Storage_Imap, Zend_Mail_Storage_Folder_Maildir, and Zend_Mail_Storage_Folder_Mbox.