Public Member Functions |
| __construct ($host= '', $port=null, $ssl=false) |
| __destruct () |
| connect ($host, $port=null, $ssl=false) |
| sendRequest ($request) |
| readResponse ($multiline=false) |
| request ($request, $multiline=false) |
| logout () |
| capa () |
| login ($user, $password, $tryApop=true) |
| status (&$messages, &$octets) |
| getList ($msgno=null) |
| uniqueid ($msgno=null) |
| top ($msgno, $lines=0, $fallback=false) |
| retrive ($msgno) |
| retrieve ($msgno) |
| noop () |
| delete ($msgno) |
| undelete () |
Data Fields |
const | TIMEOUT_CONNECTION = 30 |
| $hasTop = null |
Protected Attributes |
| $_socket |
| $_timestamp |
Detailed Description
Definition at line 31 of file Pop3.php.
Constructor & Destructor Documentation
__construct |
( |
$ |
host = '' , |
|
|
$ |
port = null , |
|
|
$ |
ssl = false |
|
) |
| |
Public constructor
- Parameters:
-
string | $host | hostname or IP address of POP3 server, if given connect() is called |
int | null | $port | port of POP3 server, null for default (110 or 995 for ssl) |
bool | string | $ssl | use ssl? 'SSL', 'TLS' or false |
- Exceptions:
-
Definition at line 65 of file Pop3.php.
Public destructor
Definition at line 76 of file Pop3.php.
Member Function Documentation
Get capabilities from POP3 server
- Returns:
- array list of capabilities
- Exceptions:
-
Definition at line 254 of file Pop3.php.
connect |
( |
$ |
host, |
|
|
$ |
port = null , |
|
|
$ |
ssl = false |
|
) |
| |
Open connection to POP3 server
- Parameters:
-
string | $host | hostname or IP address of POP3 server |
int | null | $port | of POP3 server, default is 110 (995 for ssl) |
string | bool | $ssl | use 'SSL', 'TLS' or false |
- Returns:
- string welcome message
- Exceptions:
-
- See also:
- Zend_Mail_Protocol_Exception
-
Zend_Mail_Protocol_Exception
Definition at line 91 of file Pop3.php.
Make a DELE count to remove a message
- Returns:
- null
- Exceptions:
-
Definition at line 456 of file Pop3.php.
getList |
( |
$ |
msgno = null ) |
|
Make LIST call for size of message(s)
- Parameters:
-
int | null | $msgno | number of message, null for all |
- Returns:
- int|array size of given message or list with array(num => size)
- Exceptions:
-
Definition at line 311 of file Pop3.php.
login |
( |
$ |
user, |
|
|
$ |
password, |
|
|
$ |
tryApop = true |
|
) |
| |
Login to POP3 server. Can use APOP
- Parameters:
-
string | $user | username |
string | $password | password |
bool | $try_apop | should APOP be tried? |
- Returns:
- void
- Exceptions:
-
Definition at line 270 of file Pop3.php.
End communication with POP3 server (also closes socket)
- Returns:
- null
Definition at line 231 of file Pop3.php.
Make a NOOP call, maybe needed for keeping the server happy
- Returns:
- null
- Exceptions:
-
Definition at line 444 of file Pop3.php.
readResponse |
( |
$ |
multiline = false ) |
|
request |
( |
$ |
request, |
|
|
$ |
multiline = false |
|
) |
| |
Make a RETR call for retrieving a full message with headers and body
- Parameters:
-
- Returns:
- string message
- Exceptions:
-
Definition at line 432 of file Pop3.php.
Make a RETR call for retrieving a full message with headers and body
- Deprecated:
- since 1.1.0; this method has a typo - please use retrieve()
- Parameters:
-
- Returns:
- string message
- Exceptions:
-
Definition at line 419 of file Pop3.php.
sendRequest |
( |
$ |
request ) |
|
status |
( |
&$ |
messages, |
|
|
&$ |
octets |
|
) |
| |
Make STAT call for message count and size sum
- Parameters:
-
int | $messages | out parameter with count of messages |
int | $octets | out parameter with size in octects of messages |
- Returns:
- void
- Exceptions:
-
Definition at line 294 of file Pop3.php.
top |
( |
$ |
msgno, |
|
|
$ |
lines = 0 , |
|
|
$ |
fallback = false |
|
) |
| |
Make TOP call for getting headers and maybe some body lines This method also sets hasTop - before it it's not known if top is supported
The fallback makes normale RETR call, which retrieves the whole message. Additional lines are not removed.
- Parameters:
-
int | $msgno | number of message |
int | $lines | number of wanted body lines (empty line is inserted after header lines) |
bool | $fallback | fallback with full retrieve if top is not supported |
- Returns:
- string message headers with wanted body lines
- Exceptions:
-
- See also:
- Zend_Mail_Protocol_Exception
Definition at line 379 of file Pop3.php.
Make RSET call, which rollbacks delete requests
- Returns:
- null
- Exceptions:
-
Definition at line 468 of file Pop3.php.
uniqueid |
( |
$ |
msgno = null ) |
|
Make UIDL call for getting a uniqueid
- Parameters:
-
int | null | $msgno | number of message, null for all |
- Returns:
- string|array uniqueid of message or list with array(num => uniqueid)
- Exceptions:
-
Definition at line 340 of file Pop3.php.
Field Documentation
Default timeout in seconds for initiating session
Definition at line 36 of file Pop3.php.
The documentation for this class was generated from the following file:
- E:/E/GEAMP/www/openbiz/openbiz/others/Zend/Mail/Protocol/Pop3.php