Public Member Functions
	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 paramters are

	close ()
	Close resource for mail lib.

	noop ()
	Keep the server busy.

	removeMessage ($id)
	Remove a message from server.

	getUniqueId ($id=null)
	get unique id for one or all messages

	getNumberByUniqueId ($id)
	get a message number from a unique id

	__get ($var)
	Special handling for hasTop and hasUniqueid.

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 Attributes
	$_protocol

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 Supported paramters are

host hostname or ip address of POP3 server
user username
password password for user 'username' [optional, default = '']
port port for POP3 server [optional, default = 110]
ssl 'SSL' or 'TLS' for secure sockets

Parameters

array $params mail reader specific parameters

Exceptions

Zend_Mail_Storage_Exception
Zend_Mail_Protocol_Exception

See Also: Zend_Mail_Storage_Exception

Member Function Documentation

__get ( $var )

Special handling for hasTop and hasUniqueid.

The headers of the first message is retrieved if Top wasn't needed/tried yet.

See Also: Zend_Mail_Storage_Abstract:__get()

Parameters

string $var

Returns: string

Exceptions

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: null

countMessages ( )

Count messages all messages in current box.

Returns: int number of messages

Exceptions

Zend_Mail_Storage_Exception
Zend_Mail_Protocol_Exception

getMessage ( $id )

Fetch a message.

Parameters

int $id number of message

Returns: Zend_Mail_Message

Exceptions

Zend_Mail_Protocol_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