Public Member Functions
	__construct ($params)
	Create instance with parameters.

	getFolders ($rootFolder=null)
	get root folder or given folder

	selectFolder ($globalName)
	select given folder

	getCurrentFolder ()
	get Zend_Mail_Storage_Folder instance for current folder

	__sleep ()
	magic method for serialize()

	__wakeup ()
	magic method for unserialize()

Public Member Functions inherited from Zend_Mail_Storage_Mbox
	countMessages ()
	Count messages all messages in current box.

	getSize ($id=0)
	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

	__sleep ()
	magic method for serialize()

	__wakeup ()
	magic method for unserialize()

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 ($currentDir, $parentFolder=null, $parentGlobalName= '')
	find all subfolders and mbox files for folder structure

Protected Member Functions inherited from Zend_Mail_Storage_Mbox
	_getPos ($id)
	Get positions for mail message or throw exeption if id is invalid.

	_isMboxFile ($file, $fileIsString=true)
	check if given file is a mbox file

	_openMboxFile ($filename)
	open given file as current mbox file

Protected Attributes
	$_rootFolder

	$_rootdir

	$_currentFolder

Protected Attributes inherited from Zend_Mail_Storage_Mbox
	$_fh

	$_filename

	$_filemtime

	$_positions

	$_messageClass = 'Zend_Mail_Message_File'

Protected Attributes inherited from Zend_Mail_Storage_Abstract
	$_has

	$_iterationPos = 0

	$_iterationMax = null

	$_messageClass = 'Zend_Mail_Message'

Constructor & Destructor Documentation

__construct ( $params )

Create instance with parameters.

Disallowed parameters are:

filename use Zend_Mail_Storage_Mbox for a single file Supported parameters are:
dirname rootdir of mbox structure
folder intial selected folder, default is 'INBOX'

Parameters

array $params mail reader specific parameters

Exceptions

Zend_Mail_Storage_Exception

See Also: Zend_Mail_Storage_Exception; Zend_Mail_Storage_Exception

Member Function Documentation

__sleep ( )

magic method for serialize()

with this method you can cache the mbox class

Returns: array name of variables

__wakeup ( )

magic method for unserialize()

with this method you can cache the mbox class

Returns: null

_buildFolderTree	(	$currentDir,
		$parentFolder = `null`,
		$parentGlobalName = `''`
	)

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.

Parameters

string	$currentDir	call with root dir, also used for recursion.
Zend_Mail_Storage_Folder \| null	$parentFolder	used for recursion
string	$parentGlobalName	used for rescursion