Overview

Packages

  • None
  • Vilma

Classes

  • Vilma
  • Vilma_Api
  • Vilma_Driver
  • Vilma_Driver_Qmailldap
  • Vilma_Driver_Sql
  • Vilma_Form_DeleteDomain
  • Vilma_Form_EditAlias
  • Vilma_Form_EditDomain
  • Vilma_Form_EditForward
  • Vilma_Form_EditUser
  • Vilma_MailboxDriver
  • Vilma_MailboxDriver_Hooks
  • Vilma_MailboxDriver_Imap
  • Vilma_MailboxDriver_Maildrop
  • Vilma_MailboxDriver_Null
  • Vilma_Test
  • Overview
  • Package
  • Class
  • Tree

Class Vilma_Driver_Sql

Copyright 2003-2012 Horde LLC (http://www.horde.org/)

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
Extended by Vilma_Driver_Sql

Direct known subclasses

Vilma_Driver_Qmailldap
Package: Vilma
Author: Marko Djukic marko@oblo.com
Located at Driver/Sql.php
Methods summary
public
# __construct( array $params )

Constructor.

Constructor.

Parameters

$params
Any parameters needed for this driver.

Overrides

Vilma_Driver::__construct()
public array
# getDomains( )

Returns the list of domains from the backend.

Returns the list of domains from the backend.

Returns

array
All the domains and their data in an array.
public array
# getDomain( integer $domain_id )

Returns the specified domain information from the backend.

Returns the specified domain information from the backend.

Parameters

$domain_id
The id of the domain to fetch.

Returns

array
The domain's information in an array.
public array
# getDomainByName( string $domain_name )

Given a domain name returns the information from the backend.

Given a domain name returns the information from the backend.

Parameters

$domain_name
$name The name of the domain to fetch.

Returns

array
The domain's information in an array.
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.
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

Vilma_Exception
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.
public
# deleteUser( integer $user_id )

Deletes a user.

Deletes a user.

Parameters

$user_id
The id of the user to delete.

Throws

Vilma_Exception
public array
# getVirtuals( string $filter )

Returns available virtual emails.

Returns available virtual emails.

Parameters

$filter
<p>If passed a domain then return all virtual emails for the domain, otherwise if passed a user name return all virtual emails for that user.</p>

Returns

array
The available virtual emails.

Overrides

Vilma_Driver::getVirtuals()
public array
# getVirtual( integer $virtual_id )

Returns information for a virtual id.

Returns information for a virtual id.

Parameters

$virtual_id
<p>The virtual id for which to return information.</p>

Returns

array
The virtual email information.

Overrides

Vilma_Driver::getVirtual()
public
# saveVirtual( array $info, string $domain )

Saves virtual email address to the backend.

Saves virtual email address to the backend.

Parameters

$info
The virtual email data.
$domain
The name of the domain for this virtual email.

Throws

Vilma_Exception

Overrides

Vilma_Driver::saveVirtual()
public
# deleteVirtual( integer $virtual_id )

Deletes a virtual email.

Deletes a virtual email.

Parameters

$virtual_id
The id of the virtual email to delete.

Overrides

Vilma_Driver::deleteVirtual()
Methods inherited from Vilma_Driver
deleteAlias(), deleteDomain(), deleteForward(), factory(), getAddressInfo(), getAddresses(), getAllUsers(), getDomainAdmin(), getDomainMaxUsers(), getDomainQuota(), getUserFormAttributes(), getUserStatus(), isBelowMaxUsers(), saveAlias(), saveDomain(), saveForward(), saveUser()
API documentation generated by ApiGen