PHP Class IMP_Remote, horde

Author: Michael Slusarz ([email protected])
Inheritance: implements ArrayAccess, implements IteratorAggregate
Afficher le fichier Open project: horde/horde

Protected Properties

Свойство Type Description
$_accounts array The list of remote accounts.

Méthodes publiques

Méthode Description
__construct ( ) Constructor.
getIterator ( )
getMailboxById ( string $id ) : string Return the IMAP mailbox name for the given remote mailbox identifier.
getRemoteById ( string $id ) : mixed Return the remote account for a valid remote mailbox/identifier.
isRemoteMbox ( string $id ) : boolean Is the given mailbox a remote mailbox?
label ( string $id ) : string Return the label for the given mailbox.
offsetExists ( string $offset ) : boolean Does the account ID exist?
offsetGet ( string $offset ) : array Retrieve information on a single remote account.
offsetSet ( string $offset, $value ) Add a remote account.
offsetUnset ( string $offset ) Delete a remote account.

Méthodes protégées

Méthode Description
_save ( ) Save the remote accounts list to the prefs backend.
_strip ( string $id ) : string Strip the identifying label from a mailbox ID.

Method Details

__construct() public méthode

Constructor.
public __construct ( )

_save() protected méthode

Save the remote accounts list to the prefs backend.
protected _save ( )

_strip() protected méthode

Strip the identifying label from a mailbox ID.
protected _strip ( string $id ) : string
$id string The mailbox query ID.
Résultat string The remote ID, with any IMP specific identifying information stripped off.

getIterator() public méthode

public getIterator ( )

getMailboxById() public méthode

Return the IMAP mailbox name for the given remote mailbox identifier.
public getMailboxById ( string $id ) : string
$id string The mailbox name/identifier.
Résultat string The IMAP mailbox name.

getRemoteById() public méthode

Return the remote account for a valid remote mailbox/identifier.
public getRemoteById ( string $id ) : mixed
$id string The mailbox name/identifier.
Résultat mixed Either a IMP_Remote_Account object or null.

isRemoteMbox() public méthode

Is the given mailbox a remote mailbox?
public isRemoteMbox ( string $id ) : boolean
$id string The mailbox name/identifier.
Résultat boolean Whether the given mailbox name is a remote mailbox.

label() public méthode

Return the label for the given mailbox.
public label ( string $id ) : string
$id string The mailbox name/identifier.
Résultat string The mailbox label.

offsetExists() public méthode

Does the account ID exist?
public offsetExists ( string $offset ) : boolean
$offset string Account ID.
Résultat boolean True if the account ID exists.

offsetGet() public méthode

Retrieve information on a single remote account.
public offsetGet ( string $offset ) : array
$offset string Account ID.
Résultat array The configuration array, or false if ID not found.

offsetSet() public méthode

Add a remote account.
public offsetSet ( string $offset, $value )
$offset string Account ID.

offsetUnset() public méthode

Delete a remote account.
public offsetUnset ( string $offset )
$offset string Account ID.

Property Details

$_accounts protected_oe property

The list of remote accounts.
protected array $_accounts
Résultat array