PHP Class Vilma_MailboxDriver, horde

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.
Author: Jason M. Felice ([email protected])
Show file Open project: horde/horde Class Usage Examples

Protected Properties

Property Type Description
$_params array A hash containing any parameters for the current driver.

Public Methods

Method Description
__construct ( array $params = [] ) Constructor.
checkMailbox ( string $user, string $domain ) : boolean Checks whether a mailbox exists and is set up properly.
createMailbox ( string $user, string $domain ) Creates a new mailbox.
deleteMailbox ( string $user, string $domain ) Deletes an existing mailbox.
factory ( string $driver = null, array $params = null ) : Vilma_MailboxDriver Creates a new mailbox driver instance.
getParam ( $param )

Method Details

__construct() public method

Constructor.
public __construct ( array $params = [] )
$params array Any parameters needed for this driver.

checkMailbox() abstract public method

Checks whether a mailbox exists and is set up properly.
abstract public checkMailbox ( string $user, string $domain ) : boolean
$user string The name of the mailbox to check.
$domain string The mailbox' domain.
return boolean True if the mailbox exists.

createMailbox() abstract public method

Creates a new mailbox.
abstract public createMailbox ( string $user, string $domain )
$user string The name of the mailbox to create.
$domain string The name of the domain in which to create the mailbox.

deleteMailbox() abstract public method

Deletes an existing mailbox.
abstract public deleteMailbox ( string $user, string $domain )
$user string The name of the mailbox to delete.
$domain string The name of the domain in which to delete the mailbox.

factory() public static method

Creates a new mailbox driver instance.
public static factory ( string $driver = null, array $params = null ) : Vilma_MailboxDriver
$driver string The name of the driver to create an instance of.
$params array Driver-specific parameters.
return Vilma_MailboxDriver The new driver instance.

getParam() public method

public getParam ( $param )

Property Details

$_params protected property

A hash containing any parameters for the current driver.
protected array $_params
return array