Class Auth_imp

Description
Description | Methods (details)

The Auth_imp:: class provides an IMP implementation of the Horde authentication system.

Required parameters:

   None.

Optional parameters:

   None.

$Horde: imp/lib/Auth/imp.php,v 1.16.6.21 2009/01/06 15:24:05 jan Exp $

Copyright 2003-2009 The Horde Project (http://www.horde.org/)

See the enclosed file COPYING for license information (LGPL). If you did not receive this file, see http://www.fsf.org/copyleft/lgpl.html.

Located in /lib/Auth/imp.php (line 23) 

Auth
   |
   --Auth_imp
Method Summary
Description | Methods (details)
Auth_imp Auth_imp ([array $params = array()])
boolean authenticate ([string $userID = null], [array $credentials = array()], [boolean $login = false])
void IMPsetAuthErrorMsg (string $msg)
Methods
Description | Methods (details)
Constructor Auth_imp (line 30)

Constructs a new IMP authentication object.

Auth_imp Auth_imp ([array $params = array()])
  • array $params: A hash containing connection parameters.
authenticate (line 49)

Find out if a set of login credentials are valid, and if requested, mark the user as logged in in the current session.

  • return: Whether or not the credentials are valid.
boolean authenticate ([string $userID = null], [array $credentials = array()], [boolean $login = false])
  • string $userID: The userID to check.
  • array $credentials: The credentials to check.
  • boolean $login: Whether to log the user in. If false, we'll only test the credentials and won't modify the current session.
IMPsetAuthErrorMsg (line 158)

Somewhat of a hack to allow IMP to set an authentication error message that may occur outside of this file.

void IMPsetAuthErrorMsg (string $msg)
  • string $msg: The error message to set.

Documentation generated on Sun, 30 Jan 2011 05:28:13 +0000 by phpDocumentor 1.4.3