Auth_Container_vpopmail Class Reference

Inheritance diagram for Auth_Container_vpopmail:

Collaboration diagram for Auth_Container_vpopmail:

Public Member Functions
	Auth_Container_vpopmail ()
	Constructor of the container class.
	fetchData ($username, $password)
	Get user information from vpopmail.
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.

Additional Inherited Members
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 48 of file vpopmail.php.

Member Function Documentation

Auth_Container_vpopmail::Auth_Container_vpopmail

(

)

Constructor of the container class.

Returns

void

Definition at line 57 of file vpopmail.php.

References PEAR_ERROR_DIE, and PEAR\raiseError().

    {
        if (!extension_loaded('vpopmail')) {
            return PEAR::raiseError('Cannot use VPOPMail authentication, '
                    .'VPOPMail extension not loaded!', 41, PEAR_ERROR_DIE);
        }
    }

Here is the call graph for this function:

Auth_Container_vpopmail::fetchData	(		$username,
			$password
	)

Get user information from vpopmail.

Parameters

string	Username - has to be valid email address
string	Password

Returns

boolean

Definition at line 75 of file vpopmail.php.

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

    {
        $this->log('Auth_Container_vpopmail::fetchData() called.', AUTH_LOG_DEBUG);
        $userdata = array();
        $userdata = preg_split("/@/", $username, 2);
        $result = @vpopmail_auth_user($userdata[0], $userdata[1], $password);

        return $result;
    }

Here is the call graph for this function:

---

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

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