Public Member Functions
	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
	_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
	$_messageClass = 'Zend_Mail_Message_File'

	$_files = array()

Protected Attributes inherited from Zend_Mail_Storage_Abstract
	$_has

	$_iterationPos = 0

	$_iterationMax = null

	$_messageClass = 'Zend_Mail_Message'

Static Protected Attributes
static	$_knownFlags

Constructor & Destructor Documentation

__construct ( $params )

Create instance with parameters Supported parameters are:

dirname dirname of mbox file

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

_getFileData	(	$id,
		$field = `null`
	)

protected

Get one or all fields from file structure.

Also checks if message is valid

Parameters

int	$id	message number
string \| null	$field	wanted field

Returns: string|array wanted field or all fields as array

Exceptions

Zend_Mail_Storage_Exception

See Also: Zend_Mail_Storage_Exception; Zend_Mail_Storage_Exception

_getMaildirFiles	(	$dh,
		$dirname,
		$default_flags = `array()`
	)

protected

find all files in opened dir handle and add to maildir files

Parameters

resource	$dh	dir handle used for search
string	$dirname	dirname of dir in $dh
array	$default_flags	default flags for given dir

Returns: null

_isMaildir ( $dirname )

protected

check if a given dir is a valid maildir

Parameters

string $dirname name of dir

Returns: bool dir is valid maildir

_openMaildir ( $dirname )

protected

open given dir as current maildir

Parameters

string $dirname name of maildir

Returns: null

Exceptions

Zend_Mail_Storage_Exception

See Also: Zend_Mail_Storage_Exception; Zend_Mail_Storage_Exception

close ( )

Close resource for mail lib.

If you need to control, when the resource is closed. Otherwise the destructor would call this.

Returns: void

countMessages ( $flags = null )

Count messages all messages in current box.

Returns: int number of messages

Exceptions

Zend_Mail_Storage_Exception

getMessage ( $id )

Fetch a message.

Parameters

int $id number of message

Returns: Zend_Mail_Message_File

Exceptions

Zend_Mail_Storage_Exception

getNumberByUniqueId ( $id )

get a message number from a unique id

I.e. if you have a webmailer that supports deleting messages you should use unique ids as parameter and use this method to translate it to message number right before calling removeMessage()

Parameters

string $id unique id

Returns: int message number

Exceptions

Zend_Mail_Storage_Exception

See Also: Zend_Mail_Storage_Exception

getRawContent	(	$id,
		$part = `null`
	)

See Also: Zend_Mail_Storage_Exception

getRawHeader	(	$id,
		$part = `null`,
		$topLines = `0`
	)

See Also: Zend_Mail_Storage_Exception

getSize ( $id = null )

Get a list of messages with number and size.

Parameters

int | null $id number of message or null for all messages

Returns: int|array size of given message of list with all messages as array(num => size)

Exceptions

Zend_Mail_Storage_Exception

getUniqueId ( $id = null )

get unique id for one or all messages

if storage does not support unique ids it's the same as the message number

Parameters

int | null $id message number

Returns: array|string message number for given message or all messages as array

Exceptions

Zend_Mail_Storage_Exception

noop ( )

Waste some CPU cycles doing nothing.

Returns: void

removeMessage ( $id )

stub for not supported message deletion

Returns: null

Exceptions

Zend_Mail_Storage_Exception

See Also: Zend_Mail_Storage_Exception

Member Data Documentation

$_files = array()

protected

$_knownFlags

staticprotected

Initial value:

= array('D' => Zend_Mail_Storage::FLAG_DRAFT,
                                          'F' => Zend_Mail_Storage::FLAG_FLAGGED,
                                          'P' => Zend_Mail_Storage::FLAG_PASSED,
                                          'R' => Zend_Mail_Storage::FLAG_ANSWERED,
                                          'S' => Zend_Mail_Storage::FLAG_SEEN,
                                          'T' => Zend_Mail_Storage::FLAG_DELETED)

$_messageClass = 'Zend_Mail_Message_File'

protected

Public Member Functions

Protected Member Functions

Protected Attributes

Static Protected Attributes

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation