com.tecnick.tcexam

# Class: POP3 Source Location: /shared/phpmailer/class.pop3.php
### Class Overview
| ### Variables $connected $CRLF $do_debug $error $host $password $POP3_PORT $POP3_TIMEOUT $pop_conn $port $tval $username | ### Methods __construct Authorise catchWarning checkResponse Connect Disconnect displayErrors getResponse Login sendString
### Class Details [line 48] [ Top ] ### Class Variables #### $connected = [line 107] #### Tags:
access: | private
Type: | mixed
[ Top ] #### $CRLF = "\r\n" [line 65] POP3 Carriage Return + Line Feed #### Tags:
access: | public
Type: | string
[ Top ] #### $do_debug = 2 [line 71] Displaying Debug warnings? (0 = now, 1+ = yes) #### Tags:
access: | public
Type: | int
[ Top ] #### $error = [line 108] #### Tags:
access: | private
Type: | mixed
[ Top ] #### $host = [line 77] POP3 Mail Server #### Tags:
access: | public
Type: | string
[ Top ] #### $password = [line 101] POP3 Password #### Tags:
access: | public
Type: | string
[ Top ] #### $POP3_PORT = 110 [line 53] Default POP3 port #### Tags:
access: | public
Type: | int
[ Top ] #### $POP3_TIMEOUT = 30 [line 59] Default Timeout #### Tags:
access: | public
Type: | int
[ Top ] #### $pop_conn = [line 106] #### Tags:
access: | private
Type: | mixed
[ Top ] #### $port = [line 83] POP3 Port #### Tags:
access: | public
Type: | int
[ Top ] #### $tval = [line 89] POP3 Timeout Value #### Tags:
access: | public
Type: | int
[ Top ] #### $username = [line 95] POP3 Username #### Tags:
access: | public
Type: | string
[ Top ] ### Class Methods ### constructor __construct [line 116]
`POP3 __construct( )`
Constructor, sets the initial values #### Tags:
access: | public
[ Top ] ### method Authorise [line 131]
`void Authorise( string $host, [integer $port = false], [integer $tval = false], string $username, string $password, [ $debug_level = 0])`
Combination of public events - connect, login, disconnect #### Tags:
access: | public
#### Parameters:
string | $host |
integer | $port |
integer | $tval |
string | $username |
string | $password |
| $debug_level |
[ Top ] ### method catchWarning [line 383]
`void catchWarning( integer $errno, string $errstr, string $errfile, integer $errline)`
Takes over from PHP for the socket warning handler #### Tags:
access: | private
#### Parameters:
integer | $errno |
string | $errstr |
string | $errfile |
integer | $errline |
[ Top ] ### method checkResponse [line 342]
`boolean checkResponse( string $string)`
Checks the POP3 server response for +OK or -ERR #### Tags:
access: | private
#### Parameters:
string | $string |
[ Top ] ### method Connect [line 183]
`boolean Connect( string $host, [integer $port = false], [integer $tval = 30])`
Connect to the POP3 server #### Tags:
access: | public
#### Parameters:
string | $host |
integer | $port |
integer | $tval |
[ Top ] ### method Disconnect [line 301]
`void Disconnect( )`
Disconnect from the POP3 server #### Tags:
access: | public
[ Top ] ### method displayErrors [line 365]
`void displayErrors( )`
If debug is enabled, display the error message array #### Tags:
access: | private
[ Top ] ### method getResponse [line 318]
`string getResponse( [integer $size = 128])`
Get the socket response back. $size is the maximum number of bytes to retrieve #### Tags:
access: | private
#### Parameters:
integer | $size |
[ Top ] ### method Login [line 258]
`boolean Login( [string $username = ''], [string $password = ''])`
Login to the POP3 server (does not support APOP yet) #### Tags:
access: | public
#### Parameters:
string | $username |
string | $password |
[ Top ] ### method sendString [line 330]
`integer sendString( string $string)`
Send a string down the open socket connection to the POP3 server #### Tags:
access: | private
#### Parameters:
string | $string |
[ Top ] Documentation generated on Wed, 26 Aug 2009 09:06:48 +0200 by phpDocumentor 1.4.1