PHP Class SlightPHP\POP3

Public Properties

Property	Type	Description
$CRLF	string	POP3 Carriage Return + Line Feed
$POP3_PORT	integer	Default POP3 port
$POP3_TIMEOUT	integer	Default Timeout
$do_debug	integer	Displaying Debug warnings? (0 = now, 1+ = yes)
$host	string	POP3 Mail Server
$password	string	POP3 Password
$port	integer	POP3 Port
$tval	integer	POP3 Timeout Value
$username	string	POP3 Username

Public Methods

Method	Description
Authorise ( string $host, integer $port = false, integer $tval = false, string $username, string $password, $debug_level )	Combination of public events - connect, login, disconnect
Connect ( string $host, integer $port = false, integer $tval = 30 ) : boolean	Connect to the POP3 server
Disconnect ( )	Disconnect from the POP3 server
Login ( string $username = '', string $password = '' ) : boolean	Login to the POP3 server (does not support APOP yet)
__construct ( ) : POP3	Constructor, sets the initial values

Private Methods

Method	Description
catchWarning ( integer $errno, string $errstr, string $errfile, integer $errline )	Takes over from PHP for the socket warning handler
checkResponse ( string $string ) : boolean	Checks the POP3 server response for +OK or -ERR
displayErrors ( )	If debug is enabled, display the error message array
getResponse ( integer $size = 128 ) : string	Get the socket response back.
sendString ( string $string ) : integer	Send a string down the open socket connection to the POP3 server

Method Details

Authorise() public method

Combination of public events - connect, login, disconnect

public Authorise ( string $host, integer $port = false, integer $tval = false, string $username, string $password, $debug_level )
$host	string
$port	integer
$tval	integer
$username	string
$password	string

Connect() public method

Connect to the POP3 server

public Connect ( string $host, integer $port = false, integer $tval = 30 ) : boolean
$host	string
$port	integer
$tval	integer
return	boolean

Disconnect() public method

Disconnect from the POP3 server

public Disconnect ( )

Login() public method

public Login ( string $username = '', string $password = '' ) : boolean
$username	string
$password	string
return	boolean

__construct() public method

Constructor, sets the initial values

public __construct ( ) : POP3
return	POP3

Property Details

$CRLF public_oe property

POP3 Carriage Return + Line Feed

public string $CRLF
return	string

$POP3_PORT public_oe property

Default POP3 port

public int $POP3_PORT
return	integer

$POP3_TIMEOUT public_oe property

Default Timeout

public int $POP3_TIMEOUT
return	integer

$do_debug public_oe property

Displaying Debug warnings? (0 = now, 1+ = yes)

public int $do_debug
return	integer

$host public_oe property

POP3 Mail Server

public string $host
return	string

$password public_oe property

POP3 Password

public string $password
return	string

$port public_oe property

POP3 Port

public int $port
return	integer

$tval public_oe property

POP3 Timeout Value

public int $tval
return	integer

$username public_oe property

POP3 Username

public string $username
return	string