$_db
$_db : \Horde_Db
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://www.horde.org/licenses/bsd.
getUsers(string $domain = null) : array
Returns all available users, if a domain name is passed then limit the list of users only to those users.
| string | $domain | The name of the domain for which to fetch the users. |
The available users and their stored information.
getDomainMaxUsers(string $domain_name) : integer
Returns the maximum number of users allowed for a given domain.
| string | $domain_name | The name of the domain for which to return the maximum users. |
The maximum number of allowed users.
isBelowMaxUsers(string $domain) : boolean
Checks if the given domain is below the maximum allowed users.
| string | $domain | The domain name to check. |
True if the domain does not have a maximum limit (0) or current number of users is below the maximum number allowed.
getUserStatus(array $user) : array
Does a series of checks for a given user to determine the status.
| array | $user | The user's details in an array as returned by the getUser() function. |
if an error occurs looking up the user status.
Either an array of error messages found during the checks or an array with a single element stating that the user is ready.
getAddresses(string $domain, string $type = 'all', string $key = 'user_name', integer $direction) : array
Returns a list of all users, aliases, or groups and forwards for a domain.
| string | $domain | Domain on which to search. |
| string | $type | Only return a specific type. One of 'all', 'user', 'alias', 'forward', or 'group'. |
| string | $key | Sort list by this key. |
| integer | $direction | Sort direction. |
Account information for this domain.
getAddressInfo(string $address, string $type = 'all') : array
Returns an array of information related to the address passed in.
| string | $address | Address for which information will be pulled. |
| string | $type | Address type to request. One of 'all', 'user', 'alias', 'forward' or 'group'. |
if address of that type doesn't exist.
Array of user information on success or empty array if the user does not exist.
saveAlias(array $info)
Saves or creates alias records for a user.
| array | $info | The info used to store the information. Required fields are:
|
saveForward(array $info)
Saves or creates forward records for a given user.
| array | $info | The info used to store the information. Required fields are:
|
factory(string $driver = null, array $params = null) : \Vilma_Driver
Attempts to return a concrete Vilma_Driver instance based on $driver.
| string | $driver | The type of concrete Vilma_Driver subclass to return. |
| array | $params | A hash containing any additional configuration or connection parameters a subclass might need. |
The newly created concrete Vilma_Driver instance.
_getAddresses(string $domain, string $type = 'all') : array
Returns a list of all users, aliases, or groups and forwards for a domain.
| string | $domain | Domain on which to search. |
| string | $type | Only return a specific type. One of 'all', 'user', 'alias','forward', or 'group'. |
Account information for this domain
_getAliases(string $target = null) : array
Returns available email address aliases.
| string | $target | If passed a domain then return all alias emails for the domain, otherwise if passed a user name return all virtual emails for that user. |
The used email aliases.
_getGroupsAndForwards(string $acquire = null, string $domain = null) : array
Returns all available groups and forwards unless otherwise specified.
If a domain name is passed then limit the results to groups or forwards in that domain.
| string | $acquire | The default behavior is to acquire both groups and forwards; a value of 'group' will return only groups and a value of 'forward' will return only forwards. |
| string | $domain | The name of the domain from which to fetch. |
The available groups and forwards with details.