API Documentation
\

\Vilma_MailboxDriver_Hooks

Copyright 2006-2017 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://www.horde.org/licenses/bsd.

Summary

Methods
Properties
Constants
__construct()
getParam()
createMailbox()
deleteMailbox()
checkMailbox()
factory()
No public properties found
No constants found
No protected methods found
$_params
N/A
No private methods found
No private properties found
N/A

Properties

$_params

$_params : array

A hash containing any parameters for the current driver.

Type

array

Methods

__construct()

__construct(array  $params = array())

Constructor.

Parameters

array $params

Any parameters needed for this driver.

getParam()

getParam(  $param)

Parameters

$param

createMailbox()

createMailbox(string  $user, string  $domain)

Creates a new mailbox.

Parameters

string $user

The name of the mailbox to create.
string $domain

The name of the domain in which to create the mailbox.

Throws

\Vilma_Exception

deleteMailbox()

deleteMailbox(string  $user, string  $domain)

Deletes an existing mailbox.

Parameters

string $user

The name of the mailbox to delete.
string $domain

The name of the domain in which to delete the mailbox.

Throws

\Vilma_Exception

checkMailbox()

checkMailbox(string  $user, string  $domain) : boolean

Checks whether a mailbox exists and is set up properly.

Parameters

string $user

The name of the mailbox to check.
string $domain

The mailbox' domain.

Throws

\Vilma_Exception

if the mailbox doesn't exist.

Returns

boolean —

True if the mailbox exists.

factory()

factory(string  $driver = null, array  $params = null) : \Vilma_MailboxDriver

Creates a new mailbox driver instance.

Parameters

string $driver

The name of the driver to create an instance of.
array $params

Driver-specific parameters.

Throws

\Vilma_Exception

Returns

\Vilma_MailboxDriver —

The new driver instance.