Zend Framework
LICENSE
This source file is subject to the new BSD license that is bundled with this package in the file LICENSE.txt. It is also available through the world-wide-web at this URL: http://framework.zend.com/license/new-bsd If you did not receive a copy of the license and are unable to obtain it through the world-wide-web, please send an email to license@zend.com so we can send you a copy immediately.

null|\Zend_Mail_Protocol_Pop3
$_protocol= ''
protocol handler

__construct(
array $params
)
:
void
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
Name | Type | Description |
---|---|---|
$params | array | mail reader specific parameters |
Exception | Description |
---|---|
\Zend_Mail_Storage_Exception | |
\Zend_Mail_Protocol_Exception |

__destruct(
)
:
void
Destructor calls close() and therefore closes the resource.
Inherited from: \Zend_Mail_Storage_Abstract::__destruct()
__get(
string $var
)
:
string
Special handling for hasTop and hasUniqueid. The headers of the first message is retrieved if Top wasn't needed/tried yet.
The valid values for the has-properties are: - true if a feature is supported - false if a feature is not supported - null is it's not yet known or it can't be know if a feature is supported
Name | Type | Description |
---|---|---|
$var | string |
Type | Description |
---|---|
string |
Exception | Description |
---|---|
\Zend_Mail_Storage_Exception |

close(
)
:
null
Close resource for mail lib. If you need to control, when the resource is closed. Otherwise the destructor would call this.
Type | Description |
---|---|
null |

count(
)
:
int
Countable::count()
Inherited from: \Zend_Mail_Storage_Abstract::count()Type | Description |
---|---|
int |

countMessages(
)
:
int
Count messages all messages in current box
Type | Description |
---|---|
int | number of messages |
Exception | Description |
---|---|
\Zend_Mail_Storage_Exception | |
\Zend_Mail_Protocol_Exception |

current(
)
:
\Zend_Mail_Message
Iterator::current()
Inherited from: \Zend_Mail_Storage_Abstract::current()Type | Description |
---|---|
\Zend_Mail_Message | current message |

getCapabilities(
)
:
array
Get a full list of features supported by the specific mail lib and the server
Inherited from: \Zend_Mail_Storage_Abstract::getCapabilities()Type | Description |
---|---|
array | list of features as array(featurename => true|false[|null]) |

getMessage(
int $id
)
:
\Zend_Mail_Message
Fetch a message
Name | Type | Description |
---|---|---|
$id | int | number of message |
Type | Description |
---|---|
\Zend_Mail_Message |
Exception | Description |
---|---|
\Zend_Mail_Protocol_Exception |

getNumberByUniqueId(
string $id
)
:
int
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()
Name | Type | Description |
---|---|---|
$id | string | unique id |
Type | Description |
---|---|
int | message number |
Exception | Description |
---|---|
\Zend_Mail_Storage_Exception |

getRawContent(
int $id, null|array|string $part
=
null
)
:
string
Get raw content of message or part
Name | Type | Description |
---|---|---|
$id | int | number of message |
$part | null|array|string | path to part or null for messsage content |
Type | Description |
---|---|
string | raw content |

getRawHeader(
int $id, null|array|string $part
=
null, int $topLines
=
0
)
:
string
Get raw header of message or part
Name | Type | Description |
---|---|---|
$id | int | number of message |
$part | null|array|string | path to part or null for messsage header |
$topLines | int | include this many lines with header (after an empty line) |
Type | Description |
---|---|
string | raw header |

getSize(
int $id
=
0
)
:
int|array
get a list of messages with number and size
Name | Type | Description |
---|---|---|
$id | int | number of message |
Type | Description |
---|---|
intarray | size of given message of list with all messages as array(num => size) |
Exception | Description |
---|---|
\Zend_Mail_Protocol_Exception |

getUniqueId(
int|null $id
=
null
)
:
array|string
get unique id for one or all messages
if storage does not support unique ids it's the same as the message number
Name | Type | Description |
---|---|---|
$id | int|null | message number |
Type | Description |
---|---|
arraystring | message number for given message or all messages as array |
Exception | Description |
---|---|
\Zend_Mail_Storage_Exception |

key(
)
:
int
Iterator::key()
Inherited from: \Zend_Mail_Storage_Abstract::key()Type | Description |
---|---|
int | id of current position |

offsetExists(
int $id
)
:
boolean
ArrayAccess::offsetExists()
Inherited from: \Zend_Mail_Storage_Abstract::offsetExists()Name | Type | Description |
---|---|---|
$id | int |
Type | Description |
---|---|
boolean |

offsetGet(
int $id
)
:
\Zend_Mail_Message
ArrayAccess::offsetGet()
Inherited from: \Zend_Mail_Storage_Abstract::offsetGet()
offsetSet(
\id $id, mixed $value
)
:
void
ArrayAccess::offsetSet()
Inherited from: \Zend_Mail_Storage_Abstract::offsetSet()Name | Type | Description |
---|---|---|
$id | \id | |
$value | mixed |
Exception | Description |
---|---|
\Zend_Mail_Storage_Exception |

offsetUnset(
int $id
)
:
boolean
ArrayAccess::offsetUnset()
Inherited from: \Zend_Mail_Storage_Abstract::offsetUnset()Name | Type | Description |
---|---|---|
$id | int |
Type | Description |
---|---|
boolean | success |

removeMessage(
int $id
)
:
null
Remove a message from server. If you're doing that from a web enviroment you should be careful and use a uniqueid as parameter if possible to identify the message.
Name | Type | Description |
---|---|---|
$id | int | number of message |
Type | Description |
---|---|
null |
Exception | Description |
---|---|
\Zend_Mail_Protocol_Exception |

rewind(
)
:
void
Iterator::rewind()
Inherited from: \Zend_Mail_Storage_Abstract::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.

seek(
int $pos
)
:
void
SeekableIterator::seek()
Inherited from: \Zend_Mail_Storage_Abstract::seek()
valid(
)
:
boolean
Iterator::valid()
Inherited from: \Zend_Mail_Storage_Abstract::valid()Type | Description |
---|---|
boolean |