Mail/Storage/Pop3.php
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.
- Category
- Zend
- Copyright
- Copyright (c) 2005-2014 Zend Technologies USA Inc. (http://www.zend.com)
- License
- New BSD License
- Package
- Zend_Mail
- Subpackage
- Storage
- Version
- $Id$
\Zend_Mail_Storage_Pop3
Package: Zend_Mail\Storage- Parent(s)
- \Zend_Mail_Storage_Abstract
- Category
- Zend
- Copyright
- Copyright (c) 2005-2014 Zend Technologies USA Inc. (http://www.zend.com)
- License
- New BSD License
Properties
Methods
__construct(array $params) : voidcreate 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| Name | Type | Description |
|---|
| $params | array | mail reader specific parameters |
|---|
Throws __get(string $var) : stringSpecial handling for hasTop and hasUniqueid. The headers of the first message is
retrieved if Top wasn't needed/tried yet.
Parameters| Name | Type | Description |
|---|
| $var | string | |
|---|
ReturnsThrowsDetails- See
-
countMessages() : intCount messages all messages in current box
Returns| Type | Description |
|---|
| int | number of messages |
Throws getMessage(int $id) : \Zend_Mail_MessageParameters| Name | Type | Description |
|---|
| $id | int | number of message |
|---|
ReturnsThrows getNumberByUniqueId(string $id) : intget 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| Name | Type | Description |
|---|
| $id | string | unique id |
|---|
Returns| Type | Description |
|---|
| int | message number |
ThrowsgetSize(int $id = 0) : int | arrayget a list of messages with number and size
Parameters| Name | Type | Description |
|---|
| $id | int | number of message |
|---|
Returns| Type | Description |
|---|
| int | array | size of given message of list with all messages as array(num => size) |
Throws getUniqueId(int | null $id = null) : array | stringget unique id for one or all messages
if storage does not support unique ids it's the same as the message number
Parameters| Name | Type | Description |
|---|
| $id | int | null | message number |
|---|
Returns| Type | Description |
|---|
| array | string | message number for given message or all messages as array |
ThrowsremoveMessage(int $id) : nullRemove 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.
Parameters| Name | Type | Description |
|---|
| $id | int | number of message |
|---|
ReturnsThrows 
inherited
Classes
