Class Horde_Auth_Imap
The Horde_Auth_Imap:: class provides an IMAP implementation of the Horde
authentication system.
Copyright 1999-2012 Horde LLC (http://www.horde.org/)
See the enclosed file COPYING for license information (LGPL). If you did
not receive this file, http://www.horde.org/licenses/lgpl21
-
Horde_Auth_Base
-
Horde_Auth_Imap
Methods summary
public
|
#
__construct( array $params = array() )
Constructor.
Parameters
- $params
- Optional parameters:
<pre><span class="php-quote">'admin_password'</span> - (string) The password of the adminstrator.
<span class="php-keyword1">DEFAULT</span>: <span class="php-keyword1">null</span>
<span class="php-quote">'admin_user'</span> - (string) The name of a user with admin privileges.
<span class="php-keyword1">DEFAULT</span>: <span class="php-keyword1">null</span>
<span class="php-quote">'charset'</span> - (string) <span class="php-keyword1">Default</span> charset.
<span class="php-keyword1">DEFAULT</span>: NONE
<span class="php-quote">'hostspec'</span> - (string) The hostname <span class="php-keyword1">or</span> IP address of the server.
<span class="php-keyword1">DEFAULT</span>: <span class="php-quote">'localhost'</span>
<span class="php-quote">'port'</span> - (integer) The server port to which we will connect.
IMAP is generally <span class="php-num">143</span>, <span class="php-keyword1">while</span> IMAP-SSL is generally <span class="php-num">993</span>.
<span class="php-keyword1">DEFAULT</span>: Encryption port <span class="php-keyword1">default</span>
<span class="php-quote">'secure'</span> - (string) The encryption to <span class="php-keyword1">use</span>. Either <span class="php-quote">'none'</span>, <span class="php-quote">'ssl'</span>, <span class="php-keyword1">or</span>
<span class="php-quote">'tls'</span>.
<span class="php-keyword1">DEFAULT</span>: <span class="php-quote">'none'</span>
<span class="php-quote">'userhierarchy'</span> - (string) The hierarchy where user mailboxes are
stored.
<span class="php-keyword1">DEFAULT</span>: <span class="php-quote">'user.'</span></pre>
Overrides
|
public
|
#
addUser( string $userId, array $credentials )
Add a set of authentication credentials.
Add a set of authentication credentials.
Parameters
- $userId
- The userId to add.
- $credentials
- The credentials to use.
Throws
Overrides
|
public
|
#
removeUser( string $userId )
Delete a set of authentication credentials.
Delete a set of authentication credentials.
Parameters
- $userId
- The userId to delete.
Throws
Overrides
|
public
array
|
#
listUsers( mixed $sort = false )
List all users in the system.
List all users in the system.
Returns
array
The array of userIds.
Throws
Overrides
|
Methods inherited from Horde_Auth_Base
authenticate(),
exists(),
getCredential(),
getError(),
getParam(),
hasCapability(),
isLocked(),
lockUser(),
resetPassword(),
setCredential(),
setError(),
transparent(),
unlockUser(),
updateUser(),
validateAuth()
|