Summary

Fully Qualified Name:	Laminas\Mail\Storage\Pop3
Extends:	AbstractStorage

Description

Methods

Name	Description	Defined By
__construct()	create instance with parameters Supported parameters 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	Pop3
__destruct()	Destructor calls close() and therefore closes the resource.	AbstractStorage
__get()	Special handling for hasTop and hasUniqueid. The headers of the first message is retrieved if Top wasn't needed/tried yet.	Pop3
close()	Close resource for mail lib. If you need to control, when the resource is closed. Otherwise the destructor would call this.	Pop3
count()	Countable::count()	AbstractStorage
countMessages()	Count messages all messages in current box	Pop3
current()	Iterator::current()	AbstractStorage
getCapabilities()	Get a full list of features supported by the specific mail lib and the server	AbstractStorage
getMessage()	Fetch a message	Pop3
getNumberByUniqueId()	get a message number from a unique id	Pop3
getRawContent()		Pop3
getRawHeader()		Pop3
getSize()	get a list of messages with number and size	Pop3
getUniqueId()	get unique id for one or all messages	Pop3
key()	Iterator::key()	AbstractStorage
next()	Iterator::next()	AbstractStorage
noop()	Keep the server busy.	Pop3
offsetExists()	ArrayAccess::offsetExists()	AbstractStorage
offsetGet()	ArrayAccess::offsetGet()	AbstractStorage
offsetSet()	ArrayAccess::offsetSet()	AbstractStorage
offsetUnset()	ArrayAccess::offsetUnset()	AbstractStorage
removeMessage()	Remove a message from server. If you're doing that from a web environment you should be careful and use a uniqueid as parameter if possible to identify the message.	Pop3
rewind()	Iterator::rewind()	AbstractStorage
seek()	SeekableIterator::seek()	AbstractStorage
valid()	Iterator::valid()	AbstractStorage

Method Details

__construct()

create instance with parameters Supported parameters 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

Parameter Name	Type	Description
	$params
$params

Returns:

__destruct()

Destructor calls close() and therefore closes the resource.

Returns:

__get()

Special handling for hasTop and hasUniqueid. The headers of the first message is retrieved if Top wasn't needed/tried yet.

Parameter Name	Type	Description
$var	string

Returns: string

close()

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

Returns:

count()

Countable::count()

Returns: int

countMessages()

Count messages all messages in current box

Returns: int number of messages

current()

Iterator::current()

Returns: \Message current message

getCapabilities()

Get a full list of features supported by the specific mail lib and the server

Returns: array list of features as array(feature_name => true|false[|null])

getMessage()

Fetch a message

Parameter Name	Type	Description
$id	int	number

Returns: \Laminas\Mail\Storage\Message

getNumberByUniqueId()

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()

Parameter Name	Type	Description
$id	string	unique

Returns: int message number

getRawContent()

Parameter Name	Type	Description
$id
$part

Returns: void

getRawHeader()

Parameter Name	Type	Description
$id
$part
$topLines

Returns: void

getSize()

get a list of messages with number and size

Parameter Name	Type	Description
$id	int	number

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

getUniqueId()

get unique id for one or all messages

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

Parameter Name	Type	Description
$id	int|null	message

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

key()

Iterator::key()

Returns: int id of current position

next()

Iterator::next()

Returns:

noop()

Keep the server busy.

Returns:

offsetExists()

ArrayAccess::offsetExists()

Parameter Name	Type	Description
$id	int

Returns: bool

offsetGet()

ArrayAccess::offsetGet()

Parameter Name	Type	Description
$id	int

Returns: \Laminas\Mail\Storage\Message message object

offsetSet()

ArrayAccess::offsetSet()

Parameter Name	Type	Description
$id	mixed
$value	mixed

Returns:

offsetUnset()

ArrayAccess::offsetUnset()

Parameter Name	Type	Description
$id	int

Returns: bool success

removeMessage()

Remove a message from server. If you're doing that from a web environment you should be careful and use a uniqueid as parameter if possible to identify the message.

Parameter Name	Type	Description
$id	int	number

Returns:

rewind()

Iterator::rewind()

Rewind always gets the new count from the storage. Thus if you use the interfaces and your scripts take long you should use reset() from time to time.

Returns:

seek()

SeekableIterator::seek()

Parameter Name	Type	Description
$pos	int

Returns:

valid()

Iterator::valid()

Returns: bool