Référence de la classe POP3

Fonctions membres publiques
	authorise ($host, $port=false, $timeout=false, $username='', $password='', $debug_level=0)
	connect ($host, $port=false, $tval=30)
	login ($username='', $password='')
	disconnect ()
	getErrors ()

Fonctions membres publiques statiques
static	popBeforeSmtp ( $host, $port=false, $timeout=false, $username='', $password='', $debug_level=0)

Champs de données
const	VERSION = '6.6.0'
const	DEFAULT_PORT = 110
const	DEFAULT_TIMEOUT = 30
	$do_debug = self::DEBUG_OFF
	$host
	$port
	$tval
	$username
	$password
const	LE = "\r\n"
const	DEBUG_OFF = 0
const	DEBUG_SERVER = 1
const	DEBUG_CLIENT = 2

Fonctions membres protégées
	getResponse ($size=128)
	sendString ($string)
	checkResponse ($string)
	setError ($error)
	catchWarning ($errno, $errstr, $errfile, $errline)

Attributs protégés
	$pop_conn
	$connected = false
	$errors = []

Description détaillée

PHPMailer POP-Before-SMTP Authentication Class. Specifically for PHPMailer to use for RFC1939 POP-before-SMTP authentication. 1) This class does not support APOP authentication. 2) Opening and closing lots of POP3 connections can be quite slow. If you need to send a batch of emails then just perform the authentication once at the start, and then loop through your mail sending script. Providing this process doesn't take longer than the verification period lasts on your POP3 server, you should be fine. 3) This is really ancient technology; you should only need to use it to talk to very old systems. 4) This POP3 class is deliberately lightweight and incomplete, implementing just enough to do authentication. If you want a more complete class there are other POP3 classes for PHP available.

Auteur

Richard Davey (original author) rich@.nosp@m.core.nosp@m.php.c.nosp@m.o.uk

Marcus Bointon (Synchro/coolbru) phpma.nosp@m.iler.nosp@m.@sync.nosp@m.hrom.nosp@m.edia..nosp@m.co.u.nosp@m.k

Jim Jagielski (jimjag) jimja.nosp@m.g@gm.nosp@m.ail.c.nosp@m.om

Andy Prevost (codeworxtech) codew.nosp@m.orxt.nosp@m.ech@u.nosp@m.sers.nosp@m..sour.nosp@m.cefo.nosp@m.rge.n.nosp@m.et

Documentation des fonctions membres

authorise()

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.

Paramètres

string	$host	The hostname to connect to
int | bool	$port	The port number to connect to
int | bool	$timeout	The timeout value
string	$username
string	$password
int	$debug_level

Renvoie

bool

Références POP3\$host, POP3\$password, POP3\$port, $result, POP3\$username, POP3\connect(), POP3\disconnect(), et POP3\login().

catchWarning()

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

protected

POP3 connection error handler.

Paramètres

int	$errno
string	$errstr
string	$errfile
int	$errline

Références POP3\setError().

checkResponse()

checkResponse (   $string )

protected

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

Paramètres

string

$string

Renvoie

bool

Références POP3\setError().

Référencé par POP3\connect(), et POP3\login().

connect()

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

Connect to a POP3 server.

Paramètres

string	$host
int | bool	$port
int	$tval

Renvoie

bool

Références POP3\$host, POP3\$port, $this, POP3\$tval, POP3\checkResponse(), POP3\getResponse(), et POP3\setError().

Référencé par POP3\authorise().

disconnect()

disconnect

(

)

Disconnect from the POP3 server.

Références POP3\getResponse(), et POP3\sendString().

Référencé par POP3\authorise().

getErrors()

getErrors

(

)

Get an array of error messages, if any.

Renvoie

array

Références POP3\$errors.

getResponse()

getResponse (   $size = 128 )

protected

Get a response from the POP3 server.

Paramètres

int

$size

The maximum number of bytes to retrieve

Renvoie

string

Références $size.

Référencé par POP3\connect(), POP3\disconnect(), et POP3\login().

login()

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

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

Paramètres

string	$username
string	$password

Renvoie

bool

Références POP3\$password, POP3\$username, POP3\checkResponse(), POP3\getResponse(), POP3\sendString(), et POP3\setError().

Référencé par POP3\authorise().

popBeforeSmtp()

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

static

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

Paramètres

string	$host	The hostname to connect to
int | bool	$port	The port number to connect to
int | bool	$timeout	The timeout value
string	$username
string	$password
int	$debug_level

Renvoie

bool

Références POP3\$host, POP3\$password, POP3\$port, et POP3\$username.

sendString()

sendString (   $string )

protected

Send raw data to the POP3 server.

Paramètres

string

$string

Renvoie

int

Référencé par POP3\disconnect(), et POP3\login().

setError()

setError (   $error )

protected

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

Paramètres

string

$error

Référencé par POP3\catchWarning(), POP3\checkResponse(), POP3\connect(), et POP3\login().

Documentation des champs

$connected

$connected = false

protected

$do_debug

$do_debug = self::DEBUG_OFF

$errors

$errors = []

protected

Référencé par POP3\getErrors().

$host

$host

Référencé par POP3\authorise(), POP3\connect(), et POP3\popBeforeSmtp().

$password

$password

Référencé par POP3\authorise(), POP3\login(), et POP3\popBeforeSmtp().

$pop_conn

$pop_conn

protected

$port

$port

Référencé par POP3\authorise(), POP3\connect(), et POP3\popBeforeSmtp().

$tval

$tval

Référencé par POP3\connect().

$username

$username

Référencé par POP3\authorise(), POP3\login(), et POP3\popBeforeSmtp().

DEBUG_CLIENT

const DEBUG_CLIENT = 2

DEBUG_OFF

const DEBUG_OFF = 0

DEBUG_SERVER

const DEBUG_SERVER = 1

DEFAULT_PORT

const DEFAULT_PORT = 110

DEFAULT_TIMEOUT

const DEFAULT_TIMEOUT = 30

LE

const LE = "\r\n"

Line break constant.

VERSION

const VERSION = '6.6.0'

---

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

• POP3.php