PHP Class IMP_Remote, horde

Author: Michael Slusarz ([email protected])

Inheritance: implements ArrayAccess, implements IteratorAggregate

Protected Properties

Property	Type	Description
$_accounts	array	The list of remote accounts.

Method	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.

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

Constructor.

public __construct ( )

Save the remote accounts list to the prefs backend.

protected _save ( )

Strip the identifying label from a mailbox ID.

protected _strip ( string $id ) : string
$id	string	The mailbox query ID.
return	string	The remote ID, with any IMP specific identifying information stripped off.

public getIterator ( )

Return the IMAP mailbox name for the given remote mailbox identifier.

public getMailboxById ( string $id ) : string
$id	string	The mailbox name/identifier.
return	string	The IMAP mailbox name.

Return the remote account for a valid remote mailbox/identifier.

public getRemoteById ( string $id ) : mixed
$id	string	The mailbox name/identifier.
return	mixed	Either a IMP_Remote_Account object or null.

Is the given mailbox a remote mailbox?

public isRemoteMbox ( string $id ) : boolean
$id	string	The mailbox name/identifier.
return	boolean	Whether the given mailbox name is a remote mailbox.

Return the label for the given mailbox.

public label ( string $id ) : string
$id	string	The mailbox name/identifier.
return	string	The mailbox label.

Does the account ID exist?

public offsetExists ( string $offset ) : boolean
$offset	string	Account ID.
return	boolean	True if the account ID exists.

Retrieve information on a single remote account.

public offsetGet ( string $offset ) : array
$offset	string	Account ID.
return	array	The configuration array, or false if ID not found.

Add a remote account.

public offsetSet ( string $offset, $value )
$offset	string	Account ID.

Delete a remote account.

public offsetUnset ( string $offset )
$offset	string	Account ID.

The list of remote accounts.

protected array $_accounts
return	array