Zend Framework  1.12
Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
Zend_Mail_Storage_Folder_Maildir Class Reference

Public Member Functions

 __construct ($params)
 Create instance with parameters Supported parameters are:
 
 getFolders ($rootFolder=null)
 get root folder or given folder
 
 selectFolder ($globalName)
 select given folder
 
 getCurrentFolder ()
 get Zend_Mail_Storage_Folder instance for current folder
 
- Public Member Functions inherited from Zend_Mail_Storage_Maildir
 countMessages ($flags=null)
 Count messages all messages in current box.
 
 getSize ($id=null)
 Get a list of messages with number and size.
 
 getMessage ($id)
 Fetch a message.
 
 getRawHeader ($id, $part=null, $topLines=0)
 
 getRawContent ($id, $part=null)
 
 __construct ($params)
 Create instance with parameters Supported parameters are:
 
 close ()
 Close resource for mail lib.
 
 noop ()
 Waste some CPU cycles doing nothing.
 
 removeMessage ($id)
 stub for not supported message deletion
 
 getUniqueId ($id=null)
 get unique id for one or all messages
 
 getNumberByUniqueId ($id)
 get a message number from a unique id
 
- Public Member Functions inherited from Zend_Mail_Storage_Abstract
 __get ($var)
 Getter for has-properties.
 
 getCapabilities ()
 Get a full list of features supported by the specific mail lib and the server.
 
 countMessages ()
 Count messages messages in current box/folder.
 
 getSize ($id=0)
 Get a list of messages with number and size.
 
 getMessage ($id)
 Get a message with headers and body.
 
 getRawHeader ($id, $part=null, $topLines=0)
 Get raw header of message or part.
 
 getRawContent ($id, $part=null)
 Get raw content of message or part.
 
 __construct ($params)
 Create instance with parameters.
 
 __destruct ()
 Destructor calls close() and therefore closes the resource.
 
 close ()
 Close resource for mail lib.
 
 noop ()
 Keep the resource alive.
 
 removeMessage ($id)
 delete a message from current box/folder
 
 getUniqueId ($id=null)
 get unique id for one or all messages
 
 getNumberByUniqueId ($id)
 get a message number from a unique id
 
 count ()
 Countable::count()
 
 offsetExists ($id)
 ArrayAccess::offsetExists()
 
 offsetGet ($id)
 ArrayAccess::offsetGet()
 
 offsetSet ($id, $value)
 ArrayAccess::offsetSet()
 
 offsetUnset ($id)
 ArrayAccess::offsetUnset()
 
 rewind ()
 Iterator::rewind()
 
 current ()
 Iterator::current()
 
 key ()
 Iterator::key()
 
 next ()
 Iterator::next()
 
 valid ()
 Iterator::valid()
 
 seek ($pos)
 SeekableIterator::seek()
 

Protected Member Functions

 _buildFolderTree ()
 find all subfolders and mbox files for folder structure
 
- Protected Member Functions inherited from Zend_Mail_Storage_Maildir
 _getFileData ($id, $field=null)
 Get one or all fields from file structure.
 
 _isMaildir ($dirname)
 check if a given dir is a valid maildir
 
 _openMaildir ($dirname)
 open given dir as current maildir
 
 _getMaildirFiles ($dh, $dirname, $default_flags=array())
 find all files in opened dir handle and add to maildir files
 

Protected Attributes

 $_rootFolder
 
 $_rootdir
 
 $_currentFolder
 
 $_delim
 
- Protected Attributes inherited from Zend_Mail_Storage_Maildir
 $_messageClass = 'Zend_Mail_Message_File'
 
 $_files = array()
 
- Protected Attributes inherited from Zend_Mail_Storage_Abstract
 $_has
 
 $_iterationPos = 0
 
 $_iterationMax = null
 
 $_messageClass = 'Zend_Mail_Message'
 

Additional Inherited Members

- Static Protected Attributes inherited from Zend_Mail_Storage_Maildir
static $_knownFlags
 

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
array$paramsmail reader specific parameters
Exceptions
Zend_Mail_Storage_Exception
See Also
Zend_Mail_Storage_Exception

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
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.

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.

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.

Member Data Documentation

$_currentFolder
protected
$_delim
protected
$_rootdir
protected
$_rootFolder
protected