Référence de la classe POP3

Liste de tous les membres

Fonctions membres publiques
	__construct ()
	Authorise ($host, $port=false, $tval=false, $username, $password, $debug_level=0)
	Connect ($host, $port=false, $tval=30)
	Login ($username= '', $password= '')
	Disconnect ()

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

Fonctions membres privées
	getResponse ($size=128)
	sendString ($string)
	checkResponse ($string)
	displayErrors ()
	catchWarning ($errno, $errstr, $errfile, $errline)

Attributs privés
	$pop_conn
	$connected
	$error

---

Documentation des constructeurs et destructeur

POP3::__construct

(

)

Constructor, sets the initial values public

Renvoie:

POP3

Références null.

---

Documentation des fonctions membres

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

Combination of public events - connect, login, disconnect public

Paramètres:

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

Références $host, $password, $POP3_PORT, $POP3_TIMEOUT, $port, $tval, $username, Connect(), Disconnect(), Login(), et null.

Voici le graphe d'appel pour cette fonction :

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

private

Takes over from PHP for the socket warning handler private

Paramètres:

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

POP3::checkResponse (   $string )

private

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

Paramètres:

string

$string

Renvoie:

boolean

Références displayErrors().

Référencé par Connect(), et Login().

Voici le graphe d'appel pour cette fonction :

Voici le graphe des appelants de cette fonction :

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

Connect to the POP3 server public

Paramètres:

string	$host
integer	$port
integer	$tval

Renvoie:

boolean

Références $host, $port, $tval, checkResponse(), displayErrors(), et getResponse().

Référencé par Authorise().

Voici le graphe d'appel pour cette fonction :

Voici le graphe des appelants de cette fonction :

POP3::Disconnect

(

)

Disconnect from the POP3 server public

Références sendString().

Référencé par Authorise().

Voici le graphe d'appel pour cette fonction :

Voici le graphe des appelants de cette fonction :

POP3::displayErrors ( )

private

If debug is enabled, display the error message array private

Référencé par checkResponse(), Connect(), et Login().

Voici le graphe des appelants de cette fonction :

POP3::getResponse (   $size = 128 )

private

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

Paramètres:

integer

$size

Renvoie:

string

Référencé par Connect(), et Login().

Voici le graphe des appelants de cette fonction :

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

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

Paramètres:

string	$username
string	$password

Renvoie:

boolean

Références $CRLF, $password, $username, checkResponse(), displayErrors(), getResponse(), et sendString().

Référencé par Authorise().

Voici le graphe d'appel pour cette fonction :

Voici le graphe des appelants de cette fonction :

POP3::sendString (   $string )

private

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

Paramètres:

string

$string

Renvoie:

integer

Référencé par Disconnect(), et Login().

Voici le graphe des appelants de cette fonction :

---

Documentation des données membres

POP3::$connected

private

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

Référencé par Login().

POP3::$do_debug = 2

POP3::$error

private

POP3::$host

Référencé par Authorise(), et Connect().

POP3::$password

Référencé par Authorise(), et Login().

POP3::$POP3_PORT = 110

Référencé par Authorise().

POP3::$POP3_TIMEOUT = 30

Référencé par Authorise().

POP3::$pop_conn

private

POP3::$port

Référencé par Authorise(), et Connect().

POP3::$tval

Référencé par Authorise(), et Connect().

POP3::$username

Référencé par Authorise(), et Login().

POP3::$Version = '5.2.1'

---

La documentation de cette classe a été générée à partir du fichier suivant :

• pop3.php