PHP Class Vilma_MailboxDriver_Imap, 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])
Author: Jan Schneider ([email protected])
Inheritance: extends Vilma_MailboxDriver
Mostrar archivo Open project: horde/horde

Protected Properties

Property Type Description
$_imap Horde_Imap_Client_Base An IMAP client.

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.

Method Details

__construct() public method

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

checkMailbox() public method

Checks whether a mailbox exists and is set up properly.
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() public method

Creates a new mailbox.
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() public method

Deletes an existing mailbox.
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.

Property Details

$_imap protected_oe property

An IMAP client.
protected Horde_Imap_Client_Base $_imap
return Horde_Imap_Client_Base