Joomla CMS  3.8.5 (avec JPlatform 13.1 inclus)
Documentation des API du CMS Joomla en version 3.8.5 et du framework Joomla Platform intégré
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

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

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 = array()
 

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. public

Paramètres
string$hostThe hostname to connect to
integer | boolean$portThe port number to connect to
integer | boolean$timeoutThe timeout value
string$username
string$password
integer$debug_level
Renvoie
boolean

Références $host, $password, $POP3_PORT, $POP3_TIMEOUT, $port, $username, connect(), disconnect(), et login().

Référencé par popBeforeSmtp().

◆ catchWarning()

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

POP3 connection error handler.

Paramètres
integer$errno
string$errstr
string$errfile
integer$errlineprotected

Références setError().

◆ checkResponse()

checkResponse (   $string)
protected

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

Paramètres
string$string
Renvoie
boolean protected

Références setError().

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

◆ connect()

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

Connect to a POP3 server. public

Paramètres
string$host
integer | boolean$port
integer$tval
Renvoie
boolean

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

Référencé par authorise().

◆ disconnect()

disconnect ( )

Disconnect from the POP3 server. public

Références sendString().

Référencé par authorise().

◆ getErrors()

getErrors ( )

Get an array of error messages, if any.

Renvoie
array

Références $errors.

◆ getResponse()

getResponse (   $size = 128)
protected

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

Paramètres
integer$size
Renvoie
string protected

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

◆ login()

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

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

Paramètres
string$username
string$password
Renvoie
boolean

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

Référencé par 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
$host
integer | boolean$portThe port number to connect to
integer | boolean$timeoutThe timeout value
string$username
string$password
integer$debug_level
Renvoie
boolean

Références $host, $password, $port, $username, et authorise().

◆ sendString()

sendString (   $string)
protected

Send raw data to the POP3 server.

Paramètres
string$string
Renvoie
integer protected

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

◆ setError()

setError (   $error)
protected

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

Paramètres
$errorprotected

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

Documentation des champs

◆ $connected

$connected = false
protected

◆ $CRLF

$CRLF = "\r\n"

◆ $do_debug

$do_debug = 0

◆ $errors

$errors = array()
protected

Référencé par getErrors().

◆ $host

$host

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

◆ $password

$password

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

◆ $POP3_PORT

$POP3_PORT = 110

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

◆ $POP3_TIMEOUT

$POP3_TIMEOUT = 30

Référencé par authorise().

◆ $pop_conn

$pop_conn
protected

◆ $port

$port

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

◆ $tval

$tval

Référencé par connect().

◆ $username

$username

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

◆ $Version

$Version = '5.2.26'

◆ CRLF

const CRLF = "\r\n"

Line break constant


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