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_MailboxDriver

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

See the enclosed file LICENSE for license information (BSD). If you did not did not receive this file, see http://cvs.horde.org/co.php/vilma/LICENSE.

Direct known subclasses

Vilma_MailboxDriver_Hooks, Vilma_MailboxDriver_Imap, Vilma_MailboxDriver_Maildrop, Vilma_MailboxDriver_Null
Abstract
Package: Vilma
Author: Jason M. Felice jason.m.felice@gmail.com
Located at MailboxDriver.php
Methods summary
public
# __construct( array $params = array() )

Constructor.

Constructor.

Parameters

$params
Any parameters needed for this driver.
public
# getParam( mixed $param )
abstract public
# createMailbox( string $user, string $domain )

Creates a new mailbox.

Creates a new mailbox.

Parameters

$user
The name of the mailbox to create.
$domain
<p>The name of the domain in which to create the mailbox.</p>

Throws

Vilma_Exception
abstract public
# deleteMailbox( string $user, string $domain )

Deletes an existing mailbox.

Deletes an existing mailbox.

Parameters

$user
The name of the mailbox to delete.
$domain
<p>The name of the domain in which to delete the mailbox.</p>

Throws

Vilma_Exception
abstract public boolean
# checkMailbox( string $user, string $domain )

Checks whether a mailbox exists and is set up properly.

Checks whether a mailbox exists and is set up properly.

Parameters

$user
The name of the mailbox to check.
$domain
The mailbox' domain.

Returns

boolean
True if the mailbox exists.

Throws

Vilma_Exception
if the mailbox doesn't exist.
public static Vilma_MailboxDriver
# factory( string $driver = null, array $params = null )

Creates a new mailbox driver instance.

Creates a new mailbox driver instance.

Parameters

$driver
The name of the driver to create an instance of.
$params
Driver-specific parameters.

Returns

Vilma_MailboxDriver
The new driver instance.

Throws

Vilma_Exception
API documentation generated by ApiGen