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.6'

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

Attributs privés
	$pop_conn
	$connected
	$error

Description détaillée

Définition à la ligne 60 du fichier pop3.php.

Documentation des constructeurs et destructeur

POP3::__construct ( )

Constructor, sets the initial values public

Renvoie:: POP3

Définition à la ligne 143 du fichier pop3.php.

                                {
    $this->pop_conn  = 0;
    $this->connected = false;
    $this->error     = 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
bool \| int	$port
bool \| int	$tval
string	$username
string	$password
int	$debug_level

Renvoie:: bool

Définition à la ligne 160 du fichier pop3.php.

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

                                                                                                          {
    $this->host = $host;
    //  If no port value is passed, retrieve it
    if ($port == false) {
      $this->port = $this->POP3_PORT;
    } else {
      $this->port = $port;
    }
    //  If no port value is passed, retrieve it
    if ($tval == false) {
      $this->tval = $this->POP3_TIMEOUT;
    } else {
      $this->tval = $tval;
    }
    $this->do_debug = $debug_level;
    $this->username = $username;
    $this->password = $password;
    //  Refresh the error log
    $this->error = null;
    //  Connect
    $result = $this->Connect($this->host, $this->port, $this->tval);
    if ($result) {
      $login_result = $this->Login($this->username, $this->password);
      if ($login_result) {
        $this->Disconnect();
        return true;
      }
    }
    //  We need to disconnect regardless if the login succeeded
    $this->Disconnect();
    return false;
  }

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

Définition à la ligne 409 du fichier pop3.php.

                                                                      {
    $this->error[] = array(
      'error' => "Connecting to the POP3 server raised a PHP warning: ",
      'errno' => $errno,
      'errstr' => $errstr
    );
  }

POP3::checkResponse ( $string )

private

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

Paramètres:

string $string

Renvoie:: boolean

Définition à la ligne 368 du fichier pop3.php.

Références displayErrors().

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

                                           {
    if (substr($string, 0, 3) !== '+OK') {
      $this->error = array(
        'error' => "Server reported an error: $string",
        'errno' => 0,
        'errstr' => ''
      );
      if ($this->do_debug >= 1) {
        $this->displayErrors();
      }
      return false;
    } else {
      return true;
    }
  }

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
bool \| int	$port
integer	$tval

Renvoie:: boolean

Définition à la ligne 212 du fichier pop3.php.

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

Référencé par Authorise().

                                                             {
    //  Are we already connected?
    if ($this->connected) {
      return true;
    }
    /*
    On Windows this will raise a PHP Warning error if the hostname doesn't exist.
    Rather than suppress it with @fsockopen, let's capture it cleanly instead
    */
    set_error_handler(array(&$this, 'catchWarning'));
    //  Connect to the POP3 server
    $this->pop_conn = fsockopen($host,    //  POP3 Host
                  $port,    //  Port #
                  $errno,   //  Error Number
                  $errstr,  //  Error Message
                  $tval);   //  Timeout (seconds)
    //  Restore the error handler
    restore_error_handler();
    //  Does the Error Log now contain anything?
    if ($this->error && $this->do_debug >= 1) {
      $this->displayErrors();
    }
    //  Did we connect?
    if ($this->pop_conn == false) {
      //  It would appear not...
      $this->error = array(
        'error' => "Failed to connect to server $host on port $port",
        'errno' => $errno,
        'errstr' => $errstr
      );
      if ($this->do_debug >= 1) {
        $this->displayErrors();
      }
      return false;
    }
    //  Increase the stream time-out
    //  Check for PHP 4.3.0 or later
    if (version_compare(phpversion(), '5.0.0', 'ge')) {
      stream_set_timeout($this->pop_conn, $tval, 0);
    } else {
      //  Does not work on Windows
      if (substr(PHP_OS, 0, 3) !== 'WIN') {
        socket_set_timeout($this->pop_conn, $tval, 0);
      }
    }
    //  Get the POP3 server response
    $pop3_response = $this->getResponse();
    //  Check for the +OK
    if ($this->checkResponse($pop3_response)) {
      //  The connection is established and the POP3 server is talking
      $this->connected = true;
      return true;
    }
    return false;
  }

Voici le graphe d'appel pour cette fonction :

Voici le graphe des appelants de cette fonction :

POP3::Disconnect ( )

Disconnect from the POP3 server public

Définition à la ligne 327 du fichier pop3.php.

Références sendString().

Référencé par Authorise().

                                {
    $this->sendString('QUIT');
    fclose($this->pop_conn);
  }

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

Définition à la ligne 391 du fichier pop3.php.

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

                                    {
    echo '<pre>';
    foreach ($this->error as $single_error) {
      print_r($single_error);
    }
    echo '</pre>';
  }

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

Définition à la ligne 344 du fichier pop3.php.

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

                                             {
    $pop3_response = fgets($this->pop_conn, $size);
    return $pop3_response;
  }

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

Définition à la ligne 287 du fichier pop3.php.

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

Référencé par Authorise().

                                                         {
    if ($this->connected == false) {
      $this->error = 'Not connected to POP3 server';
      if ($this->do_debug >= 1) {
        $this->displayErrors();
      }
    }
    if (empty($username)) {
      $username = $this->username;
    }
    if (empty($password)) {
      $password = $this->password;
    }
    $pop_username = "USER $username" . $this->CRLF;
    $pop_password = "PASS $password" . $this->CRLF;
    //  Send the Username
    $this->sendString($pop_username);
    $pop3_response = $this->getResponse();
    if ($this->checkResponse($pop3_response)) {
      //  Send the Password
      $this->sendString($pop_password);
      $pop3_response = $this->getResponse();
      if ($this->checkResponse($pop3_response)) {
        return true;
      }
    }
    return false;
  }

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

Définition à la ligne 356 du fichier pop3.php.

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

                                        {
    $bytes_sent = fwrite($this->pop_conn, $string, strlen($string));
    return $bytes_sent;
  }

Voici le graphe des appelants de cette fonction :

Documentation des données membres

POP3::$connected

private

Définition à la ligne 132 du fichier pop3.php.

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

Définition à la ligne 77 du fichier pop3.php.

Référencé par Login().

POP3::$do_debug = 2

Définition à la ligne 83 du fichier pop3.php.

POP3::$error

private

Définition à la ligne 136 du fichier pop3.php.

POP3::$host

Définition à la ligne 89 du fichier pop3.php.

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

POP3::$password

Définition à la ligne 113 du fichier pop3.php.

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

POP3::$POP3_PORT = 110

Définition à la ligne 65 du fichier pop3.php.

Référencé par Authorise().

POP3::$POP3_TIMEOUT = 30

Définition à la ligne 71 du fichier pop3.php.

Référencé par Authorise().

POP3::$pop_conn

private

Définition à la ligne 128 du fichier pop3.php.

POP3::$port

Définition à la ligne 95 du fichier pop3.php.

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

POP3::$tval

Définition à la ligne 101 du fichier pop3.php.

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

POP3::$username

Définition à la ligne 107 du fichier pop3.php.

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

POP3::$Version = '5.2.6'

Définition à la ligne 119 du fichier pop3.php.

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

jplatform-13.1/phpmailer/pop3.php

Fonctions membres publiques

Attributs publics

Fonctions membres privées

Attributs privés

Description détaillée

Documentation des constructeurs et destructeur

Documentation des fonctions membres

Documentation des données membres