Auth_Container_POP3 Class Reference

Inheritance diagram for Auth_Container_POP3:

Collaboration diagram for Auth_Container_POP3:

Public Member Functions
	Auth_Container_POP3 ($server=null)
	Constructor of the container class.
	fetchData ($username, $password)
	Try to login to the POP3 server.
Public Member Functions inherited from Auth_Container
	Auth_Container ()
	Constructor.
	fetchData ($username, $password, $isChallengeResponse=false)
	Fetch data from storage container.
	verifyPassword ($password1, $password2, $cryptType="md5")
	Crypt and verfiy the entered password.
	supportsChallengeResponse ()
	Returns true if the container supports Challenge Response password authentication.
	getCryptType ()
	Returns the crypt current crypt type of the container.
	listUsers ()
	List all users that are available from the storage container.
	getUser ($username)
	Returns a user assoc array.
	addUser ($username, $password, $additional=null)
	Add a new user to the storage container.
	removeUser ($username)
	Remove user from the storage container.
	changePassword ($username, $password)
	Change password for user in the storage container.
	log ($message, $level=AUTH_LOG_DEBUG)
	Log a message to the Auth log.
Public Member Functions inherited from ilAuthContainerBase
	loginObserver ($a_username, $a_auth)
	Called after successful login.
	failedLoginObserver ($a_username, $a_auth)
	Called after failed login.
	checkAuthObserver ($a_username, $a_auth)
	Called after check auth requests.
	logoutObserver ($a_username, $a_auth)
	Called after logout.
	supportsCaptchaVerification ()
	Returns whether or not the auth container supports the verification of captchas This should be true for those auth methods, which are available in the default login form.

Data Fields
	$server = 'localhost'
	$port = '110'
	$method = true
Data Fields inherited from Auth_Container
	$activeUser = ""
	User that is currently selected from the storage container.
	$_auth_obj = null
	The Auth object this container is attached to.

Detailed Description

Definition at line 55 of file POP3.php.

Member Function Documentation

Auth_Container_POP3::Auth_Container_POP3

(

$server = null

)

Constructor of the container class.

Parameters

$server

string server or server:port combination

Returns

object Returns an error object if something went wrong

Definition at line 93 of file POP3.php.

References $server.

    {
        if (isset($server) && !is_null($server)) {
            if (is_array($server)) {
                if (isset($server['host'])) {
                    $this->server = $server['host'];
                }
                if (isset($server['port'])) {
                    $this->port = $server['port'];
                }
                if (isset($server['method'])) {
                    $this->method = $server['method'];
                }
            } else {
                if (strstr($server, ':')) {
                    $serverparts = explode(':', trim($server));
                    $this->server = $serverparts[0];
                    $this->port = $serverparts[1];
                } else {
                    $this->server = $server;
                }
            }
        }
    }

Auth_Container_POP3::fetchData	(		$username,
			$password
	)

Try to login to the POP3 server.

Parameters

string	Username
string	Password

Returns

boolean

Definition at line 128 of file POP3.php.

References $res, $result, AUTH_LOG_DEBUG, and Auth_Container\log().

    {
        $this->log('Auth_Container_POP3::fetchData() called.', AUTH_LOG_DEBUG);
        $pop3 =& new Net_POP3();
        $res = $pop3->connect($this->server, $this->port, $this->method);
        if (!$res) {
            $this->log('Connection to POP3 server failed.', AUTH_LOG_DEBUG);
            return $res;
        }
        $result = $pop3->login($username, $password);
        $pop3->disconnect();
        return $result;
    }

Here is the call graph for this function:

Field Documentation

Auth_Container_POP3::$method = true

Definition at line 82 of file POP3.php.

Auth_Container_POP3::$port = '110'

Definition at line 70 of file POP3.php.

Auth_Container_POP3::$server = 'localhost'

Definition at line 64 of file POP3.php.

Referenced by Auth_Container_POP3().

---

The documentation for this class was generated from the following file:

• Services/PEAR/lib/Auth/Container/POP3.php