Fully Qualified Name: | Zend\Mail\Storage\Pop3 |
Extends: | AbstractStorage |
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 |
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 |
---|---|---|
array | $params | |
$params |
Returns:
Destructor calls close() and therefore closes the resource.
Returns:
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 resource for mail lib. If you need to control, when the resource is closed. Otherwise the destructor would call this.
Returns:
Countable::count()
Returns: int
Count messages all messages in current box
Returns: int number of messages
Iterator::current()
Returns: \Message current message
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])
Fetch a message
Parameter Name | Type | Description |
---|---|---|
$id | int | number |
Returns: \Zend\Mail\Storage\Message
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
Parameter Name | Type | Description |
---|---|---|
$id | ||
$part |
Returns: void
Parameter Name | Type | Description |
---|---|---|
$id | ||
$part | ||
$topLines |
Returns: void
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)
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
Iterator::key()
Returns: int id of current position
Iterator::next()
Returns:
Keep the server busy.
Returns:
ArrayAccess::offsetExists()
Parameter Name | Type | Description |
---|---|---|
$id | int |
Returns: bool
ArrayAccess::offsetGet()
Parameter Name | Type | Description |
---|---|---|
$id | int |
Returns: \Zend\Mail\Storage\Message message object
ArrayAccess::offsetSet()
Parameter Name | Type | Description |
---|---|---|
$id | mixed | |
$value | mixed |
Returns:
ArrayAccess::offsetUnset()
Parameter Name | Type | Description |
---|---|---|
$id | int |
Returns: bool success
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:
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:
SeekableIterator::seek()
Parameter Name | Type | Description |
---|---|---|
$pos | int |
Returns:
Iterator::valid()
Returns: bool