Class Vilma_Driver_Qmailldap
Copyright 2006-2007 Alkaloid Networks http://www.alkaloid.net
See the enclosed file LICENSE for license information (BSD). If you did
did not receive this file, see http://cvs.horde.org/co.php/vilma/LICENSE.
-
Vilma_Driver
-
Vilma_Driver_Sql
-
Vilma_Driver_Qmailldap
Methods summary
public
|
#
__construct( array $params )
Constructor.
Parameters
- $params
- Any parameters needed for this driver.
Overrides
|
public
integer
|
#
getDomainNumUsers( string $domain_name )
Returns the current number of users for a domain.
Returns the current number of users for a domain.
Parameters
- $domain_name
- <p>The name of the domain for which to
get the current number of users.</p>
Returns
integer
The current number of users.
Overrides
|
public
array
|
#
getUsers( string $domain = null )
Returns all available users, if a domain name is passed then limit the
list of users only to those users.
Returns all available users, if a domain name is passed then limit the
list of users only to those users.
Parameters
- $domain
- <p>The name of the domain for which to fetch the
users.</p>
Returns
array
The available users and their stored information.
Throws
Overrides
|
public
array
|
#
getUser( integer $user_id )
Returns the user information for a given user id.
Returns the user information for a given user id.
Parameters
- $user_id
- <p>The id of the user for which to fetch
information.</p>
Returns
array
The user information.
Overrides
|
public
|
#
deleteUser( integer $user_id )
Deletes a user.
Parameters
- $user_id
- The id of the user to delete.
Throws
Overrides
|
public
|
|
public
array
|
#
getAddressInfo( string $address, string $type = 'all' )
Returns an array of information related to the address passed in.
Returns an array of information related to the address passed in.
Parameters
- $address
- Address for which information will be pulled.
- $type
- <p>Address type to request.
One of 'all', 'user', 'alias', 'forward' or
'group'.</p>
Returns
arrayArray of user information on success or empty array
if the user does not exist.
Throws
Overrides
|
public
|
#
saveAlias( array $info )
Saves or creates alias records for a user.
Saves or creates alias records for a user.
Parameters
- $info
- <p>The info used to store the information.
Required fields are:
- 'address': The destination address (used for LDAP
ID lookup).
- 'alias_address': The alias to create or the new
data for the modified entry.
- 'alias': The alias we are modifying, if we are
modifying an existing one.</p>
Throws
Overrides
|
public
|
#
deleteAlias( array $info )
Deletes alias records for a given user.
Deletes alias records for a given user.
Parameters
- $info
- <p>The info used to store the information.
Required fields are:
- 'address': The destination address (used for LDAP
ID lookup).
- 'alias': The alias we are deleting.</p>
Throws
Overrides
|
public
|
#
saveForward( array $info )
Saves or creates forward records for a given user.
Saves or creates forward records for a given user.
Parameters
- $info
- <p>The info used to store the information.
Required fields are:
- 'address': The destination address (used for LDAP
ID lookup).
- 'forward_address': The forward to create or the
new data for the modified entry.
- 'forward': The forward we are modifying, if we are
modifying an existing one.</p>
Throws
Overrides
|
public
|
#
deleteForward( array $info )
Deletes forward records for a given user.
Deletes forward records for a given user.
Parameters
- $info
- <p>The info used to store the information.
Required fields are:
- 'address': The destination address (used for LDAP
ID lookup).
- 'forward': The forward we are deleting.</p>
Throws
Overrides
|
public
|
|
Methods inherited from Vilma_Driver
deleteDomain(),
factory(),
getAddresses(),
getAllUsers(),
getDomainAdmin(),
getDomainMaxUsers(),
getDomainQuota(),
getUserStatus(),
isBelowMaxUsers(),
saveDomain(),
saveUser()
|