POP3 Klassenreferenz

Aufstellung aller Elemente

Öffentliche Methoden
	__construct ()
	Authorise ($host, $port=false, $tval=false, $username, $password, $debug_level=0)
	Connect ($host, $port=false, $tval=30)
	Login ($username= '', $password= '')
	Disconnect ()
Öffentliche Attribute
	$POP3_PORT = 110
	$POP3_TIMEOUT = 30
	$CRLF = "\r\n"
	$do_debug = 2
	$host
	$port
	$tval
	$username
	$password

---

Ausführliche Beschreibung

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

---

Beschreibung der Konstruktoren und Destruktoren

POP3::__construct

(

)

Constructor, sets the initial values public

Rückgabe:

POP3

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

                                {
    $this->pop_conn  = 0;
    $this->connected = false;
    $this->error     = null;
  }

---

Dokumentation der Elementfunktionen

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

Combination of public events - connect, login, disconnect public

Parameter:

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

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

                                                                                                          {
    $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;
  }

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

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

Connect to the POP3 server public

Parameter:

	string	$host
	integer	$port
	integer	$tval

Rückgabe:

boolean

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

                                                             {
    //  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 supress 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;
    }

  }

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

POP3::Disconnect

(

)

Disconnect from the POP3 server public

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

                                {
    $this->sendString('QUIT');

    fclose($this->pop_conn);
  }

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

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

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

Parameter:

	string	$username
	string	$password

Rückgabe:

boolean

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

                                                         {
    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;
      } else {
        return false;
      }
    } else {
      return false;
    }
  }

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

---

Dokumentation der Datenelemente

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

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

POP3::$do_debug = 2

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

POP3::$host

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

POP3::$password

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

POP3::$POP3_PORT = 110

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

POP3::$POP3_TIMEOUT = 30

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

POP3::$port

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

POP3::$tval

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

POP3::$username

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

---

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

• class.pop3.php