POP3 Klassenreferenz

Öffentliche Methoden
	authorise ($host, $port=false, $timeout=false, $username= '', $password= '', $debug_level=0)
	connect ($host, $port=false, $tval=30)
	login ($username= '', $password= '')
	disconnect ()

Öffentliche, statische Methoden
static	popBeforeSmtp ($host, $port=false, $tval=false, $username= '', $password= '', $debug_level=0)

Datenfelder
	$Version = '5.2.9'
	$POP3_PORT = 110
	$POP3_TIMEOUT = 30
	$CRLF = "\r\n"
	$do_debug = 0
	$host
	$port
	$tval
	$username
	$password
const	CRLF = "\r\n"

Private Methoden
	getResponse ($size=128)
	sendString ($string)
	checkResponse ($string)
	setError ($error)
	catchWarning ($errno, $errstr, $errfile, $errline)

Private Attribute
	$pop_conn
	$connected = false
	$errors = array()

Ausführliche Beschreibung

Definiert in Zeile 30 der Datei class.pop3.php.

Dokumentation der Elementfunktionen

authorise	(		$host,
			$port = false,
			$timeout = false,
			$username = '',
			$password = '',
			$debug_level = 0
	)

Authenticate with a POP3 server. A connect, login, disconnect sequence appropriate for POP-before SMTP authorisation. public

Parameter

string	$host	The hostname to connect to
integer | boolean	$port	The port number to connect to
integer | boolean	$timeout	The timeout value
string	$username
string	$password
integer	$debug_level

Rückgabe

boolean

Definiert in Zeile 165 der Datei class.pop3.php.

Benutzt $host, $password, $POP3_PORT, $POP3_TIMEOUT, $port, $username, connect(), disconnect() und login().

Wird benutzt von popBeforeSmtp().

Hier ist ein Graph, der zeigt, was diese Funktion aufruft:

Hier ist ein Graph der zeigt, wo diese Funktion aufgerufen wird:

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

private

POP3 connection error handler.

Parameter

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

Definiert in Zeile 387 der Datei class.pop3.php.

Benutzt setError().

Hier ist ein Graph, der zeigt, was diese Funktion aufruft:

checkResponse (   $string)

private

Checks the POP3 server response. Looks for for +OK or -ERR.

Parameter

string

$string

Rückgabe

boolean private

Definiert in Zeile 348 der Datei class.pop3.php.

Benutzt setError().

Wird benutzt von connect() und login().

Hier ist ein Graph, der zeigt, was diese Funktion aufruft:

Hier ist ein Graph der zeigt, wo diese Funktion aufgerufen wird:

connect	(		$host,
			$port = false,
			$tval = 30
	)

Connect to a POP3 server. public

Parameter

string	$host
integer | boolean	$port
integer	$tval

Rückgabe

boolean

Definiert in Zeile 207 der Datei class.pop3.php.

Benutzt $host, $POP3_PORT, $port, $tval, checkResponse(), getResponse() und setError().

Wird benutzt von authorise().

Hier ist ein Graph, der zeigt, was diese Funktion aufruft:

Hier ist ein Graph der zeigt, wo diese Funktion aufgerufen wird:

disconnect

(

)

Disconnect from the POP3 server. public

Definiert in Zeile 296 der Datei class.pop3.php.

Benutzt sendString().

Wird benutzt von authorise().

Hier ist ein Graph, der zeigt, was diese Funktion aufruft:

Hier ist ein Graph der zeigt, wo diese Funktion aufgerufen wird:

getResponse (   $size = 128)

private

Get a response from the POP3 server. $size is the maximum number of bytes to retrieve

Parameter

integer

$size

Rückgabe

string private

Definiert in Zeile 315 der Datei class.pop3.php.

Wird benutzt von connect() und login().

Hier ist ein Graph der zeigt, wo diese Funktion aufgerufen wird:

login	(		$username = '',
			$password = ''
	)

Log in to the POP3 server. Does not support APOP (RFC 2828, 4949). public

Parameter

string	$username
string	$password

Rückgabe

boolean

Definiert in Zeile 266 der Datei class.pop3.php.

Benutzt $password, $username, checkResponse(), getResponse(), sendString() und setError().

Wird benutzt von authorise().

Hier ist ein Graph, der zeigt, was diese Funktion aufruft:

Hier ist ein Graph der zeigt, wo diese Funktion aufgerufen wird:

static popBeforeSmtp (   $host,   $port = false,   $tval = false,   $username = '',   $password = '',   $debug_level = 0  )

static

Simple static wrapper for all-in-one POP before SMTP

Parameter

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

Rückgabe

boolean

Definiert in Zeile 140 der Datei class.pop3.php.

Benutzt $host, $password, $port, $tval, $username und authorise().

Hier ist ein Graph, der zeigt, was diese Funktion aufruft:

sendString (   $string)

private

Send raw data to the POP3 server.

Parameter

string

$string

Rückgabe

integer private

Definiert in Zeile 330 der Datei class.pop3.php.

Wird benutzt von disconnect() und login().

Hier ist ein Graph der zeigt, wo diese Funktion aufgerufen wird:

setError (   $error)

private

Add an error to the internal error store. Also display debug output if it's enabled.

Parameter

$error

Definiert in Zeile 367 der Datei class.pop3.php.

Wird benutzt von catchWarning(), checkResponse(), connect() und login().

Hier ist ein Graph der zeigt, wo diese Funktion aufgerufen wird:

Dokumentation der Datenelemente

$connected = false

private

Are we connected? boolean private

Definiert in Zeile 116 der Datei class.pop3.php.

$CRLF = "\r\n"

POP3 Carriage Return + Line Feed. string public

Veraltet:

Use the constant instead

Definiert in Zeile 59 der Datei class.pop3.php.

$do_debug = 0

Debug display level. Options: 0 = no, 1+ = yes integer public

Definiert in Zeile 67 der Datei class.pop3.php.

$errors = array()

private

Error container. array private

Definiert in Zeile 123 der Datei class.pop3.php.

$host

POP3 mail server hostname. string public

Definiert in Zeile 74 der Datei class.pop3.php.

Wird benutzt von authorise(), connect() und popBeforeSmtp().

$password

POP3 password. string public

Definiert in Zeile 102 der Datei class.pop3.php.

Wird benutzt von authorise(), login() und popBeforeSmtp().

$POP3_PORT = 110

Default POP3 port number. integer public

Definiert in Zeile 44 der Datei class.pop3.php.

Wird benutzt von authorise() und connect().

$POP3_TIMEOUT = 30

Default timeout in seconds. integer public

Definiert in Zeile 51 der Datei class.pop3.php.

Wird benutzt von authorise().

$pop_conn

private

Resource handle for the POP3 connection socket. resource private

Definiert in Zeile 109 der Datei class.pop3.php.

$port

POP3 port number. integer public

Definiert in Zeile 81 der Datei class.pop3.php.

Wird benutzt von authorise(), connect() und popBeforeSmtp().

$tval

POP3 Timeout Value in seconds. integer public

Definiert in Zeile 88 der Datei class.pop3.php.

Wird benutzt von connect() und popBeforeSmtp().

$username

POP3 username string public

Definiert in Zeile 95 der Datei class.pop3.php.

Wird benutzt von authorise(), login() und popBeforeSmtp().

$Version = '5.2.9'

The POP3 PHPMailer Version number. string public

Definiert in Zeile 37 der Datei class.pop3.php.

const CRLF = "\r\n"

Line break constant

Definiert in Zeile 128 der Datei class.pop3.php.

---

Die Dokumentation für diese Klasse wurde erzeugt aufgrund der Datei:

• class.pop3.php