Detailed Description
Definition at line 47 of file Pop3.php.
Constructor & Destructor Documentation
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:
-
$params | array mail reader specific parameters |
- Exceptions:
-
- See also:
- Zend_Mail_Storage_Exception
Reimplemented from Zend_Mail_Storage_Abstract.
Definition at line 161 of file Pop3.php.
Member Function Documentation
Close resource for mail lib. If you need to control, when the resource is closed. Otherwise the destructor would call this.
- Returns:
- null
Reimplemented from Zend_Mail_Storage_Abstract.
Definition at line 200 of file Pop3.php.
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:
-
- Returns:
- int message number
- Exceptions:
-
- See also:
- Zend_Mail_Storage_Exception
Reimplemented from Zend_Mail_Storage_Abstract.
Definition at line 266 of file Pop3.php.
getRawContent |
( |
$ |
id, |
|
|
$ |
part = null |
|
) |
| |
getRawHeader |
( |
$ |
id, |
|
|
$ |
part = null , |
|
|
$ |
topLines = 0 |
|
) |
| |
Get raw header of message or part
- Parameters:
-
int | $id | number of message |
null | array | string | $part | path to part or null for messsage header |
int | $topLines | include this many lines with header (after an empty line) |
- Returns:
- string raw header
- See also:
- Zend_Mail_Storage_Exception
Reimplemented from Zend_Mail_Storage_Abstract.
Definition at line 108 of file Pop3.php.
get a list of messages with number and size
- Parameters:
-
- Returns:
- int|array size of given message of list with all messages as array(num => size)
- Exceptions:
-
Reimplemented from Zend_Mail_Storage_Abstract.
Definition at line 76 of file Pop3.php.
getUniqueId |
( |
$ |
id = null ) |
|
get unique id for one or all messages
if storage does not support unique ids it's the same as the message number
- Parameters:
-
int | null | $id | message number |
- Returns:
- array|string message number for given message or all messages as array
- Exceptions:
-
Reimplemented from Zend_Mail_Storage_Abstract.
Definition at line 239 of file Pop3.php.
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.
- Parameters:
-
- Returns:
- null
- Exceptions:
-
Reimplemented from Zend_Mail_Storage_Abstract.
Definition at line 225 of file Pop3.php.
The documentation for this class was generated from the following file:
- E:/E/GEAMP/www/openbiz/openbiz/others/Zend/Mail/Storage/Pop3.php