POP3 Class Reference

Public Member Functions
	__construct ()
	Authorise ($host, $port=false, $tval=false, $username, $password, $debug_level=0)
	Connect ($host, $port=false, $tval=30)
	Disconnect ()
	Login ($username= '', $password= '')

Public Attributes
	$CRLF = "\r\n"
	$do_debug = 2
	$host
	$password
	$POP3_PORT = 110
	$POP3_TIMEOUT = 30
	$port
	$tval
	$username
	$Version = '5.2.1'

Private Member Functions
	catchWarning ($errno, $errstr, $errfile, $errline)
	checkResponse ($string)
	displayErrors ()
	getResponse ($size=128)
	sendString ($string)

Private Attributes
	$connected
	$error
	$pop_conn

Detailed Description

Definition at line 59 of file class.pop3.php.

Constructor & Destructor Documentation

POP3::__construct

(

)

Constructor, sets the initial values public

Returns

POP3

Definition at line 133 of file class.pop3.php.

Member Function Documentation

POP3::Authorise	(		$host,
			$port = false,
			$tval = false,
			$username,
			$password,
			$debug_level = 0
	)

Combination of public events - connect, login, disconnect public

Parameters

string	$host
integer	$port
integer	$tval
string	$username
string	$password

Definition at line 148 of file class.pop3.php.

References $host, $password, $POP3_PORT, $POP3_TIMEOUT, $port, $result, $tval, $username, Connect(), Disconnect(), and Login().

Here is the call graph for this function:

POP3::catchWarning (   $errno,   $errstr,   $errfile,   $errline  )

private

Takes over from PHP for the socket warning handler private

Parameters

integer	$errno
string	$errstr
string	$errfile
integer	$errline

Definition at line 400 of file class.pop3.php.

POP3::checkResponse (   $string )

private

Checks the POP3 server response for +OK or -ERR private

Parameters

string

$string

Returns

boolean

Definition at line 359 of file class.pop3.php.

References displayErrors().

Referenced by Connect(), and Login().

Here is the call graph for this function:

Here is the caller graph for this function:

POP3::Connect	(		$host,
			$port = false,
			$tval = 30
	)

Connect to the POP3 server public

Parameters

string	$host
integer	$port
integer	$tval

Returns

boolean

Definition at line 200 of file class.pop3.php.

References $host, $port, $tval, checkResponse(), displayErrors(), and getResponse().

Referenced by Authorise().

Here is the call graph for this function:

Here is the caller graph for this function:

POP3::Disconnect

(

)

Disconnect from the POP3 server public

Definition at line 318 of file class.pop3.php.

References sendString().

Referenced by Authorise().

Here is the call graph for this function:

Here is the caller graph for this function:

POP3::displayErrors ( )

private

If debug is enabled, display the error message array private

Definition at line 382 of file class.pop3.php.

Referenced by checkResponse(), Connect(), and Login().

Here is the caller graph for this function:

POP3::getResponse (   $size = 128 )

private

Get the socket response back. $size is the maximum number of bytes to retrieve private

Parameters

integer

$size

Returns

string

Definition at line 335 of file class.pop3.php.

Referenced by Connect(), and Login().

Here is the caller graph for this function:

POP3::Login	(		$username = '',
			$password = ''
	)

Login to the POP3 server (does not support APOP yet) public

Parameters

string	$username
string	$password

Returns

boolean

Definition at line 275 of file class.pop3.php.

References $CRLF, $password, $username, checkResponse(), displayErrors(), getResponse(), and sendString().

Referenced by Authorise().

Here is the call graph for this function:

Here is the caller graph for this function:

POP3::sendString (   $string )

private

Send a string down the open socket connection to the POP3 server private

Parameters

string

$string

Returns

integer

Definition at line 347 of file class.pop3.php.

Referenced by Disconnect(), and Login().

Here is the caller graph for this function:

Member Data Documentation

POP3::$connected

private

Definition at line 125 of file class.pop3.php.

POP3::$CRLF = "\r\n"

Definition at line 76 of file class.pop3.php.

Referenced by Login().

POP3::$do_debug = 2

Definition at line 82 of file class.pop3.php.

POP3::$error

private

Definition at line 126 of file class.pop3.php.

POP3::$host

Definition at line 88 of file class.pop3.php.

Referenced by Authorise(), and Connect().

POP3::$password

Definition at line 112 of file class.pop3.php.

Referenced by Authorise(), and Login().

POP3::$POP3_PORT = 110

Definition at line 64 of file class.pop3.php.

Referenced by Authorise().

POP3::$POP3_TIMEOUT = 30

Definition at line 70 of file class.pop3.php.

Referenced by Authorise().

POP3::$pop_conn

private

Definition at line 124 of file class.pop3.php.

POP3::$port

Definition at line 94 of file class.pop3.php.

Referenced by Authorise(), and Connect().

POP3::$tval

Definition at line 100 of file class.pop3.php.

Referenced by Authorise(), and Connect().

POP3::$username

Definition at line 106 of file class.pop3.php.

Referenced by Authorise(), and Login().

POP3::$Version = '5.2.1'

Definition at line 118 of file class.pop3.php.

---

The documentation for this class was generated from the following file:

• L:/0xoops/xoops-2.5.6/htdocs/class/mail/phpmailer/class.pop3.php