Class IMP_Remote

Interface to deal with storing connection details of remote accounts.

IMP_Remote implements ArrayAccess, IteratorAggregate

Package: IMP
Category: Horde
Copyright: 2013-2014 Horde LLC
License: GPL
Author: Michael Slusarz slusarz@horde.org
Located at Remote.php

Methods summary
`public`	# `__construct( )` Constructor. Constructor.
`public boolean`	# `isRemoteMbox( string $id )` Is the given mailbox a remote mailbox? Is the given mailbox a remote mailbox? Parameters `$id` The mailbox name/identifier. Returns `boolean` Whether the given mailbox name is a remote mailbox.
`public mixed`	# `getRemoteById( string $id )` Return the remote account for a valid remote mailbox/identifier. Return the remote account for a valid remote mailbox/identifier. Parameters `$id` The mailbox name/identifier. Returns `mixed` Either a IMP_Remote_Account object or null.
`public string`	# `getMailboxById( string $id )` Return the IMAP mailbox name for the given remote mailbox identifier. Return the IMAP mailbox name for the given remote mailbox identifier. Parameters `$id` The mailbox name/identifier. Returns `string` The IMAP mailbox name.
`public string`	# `label( string $id )` Return the label for the given mailbox. Return the label for the given mailbox. Parameters `$id` The mailbox name/identifier. Returns `string` The mailbox label.
`public boolean`	# `offsetExists( string $offset )` Does the account ID exist? Does the account ID exist? Parameters `$offset` Account ID. Returns `boolean` True if the account ID exists. Implementation of `ArrayAccess::offsetExists()`
`public array`	# `offsetGet( string $offset )` Retrieve information on a single remote account. Retrieve information on a single remote account. Parameters `$offset` Account ID. Returns `array` The configuration array, or false if ID not found. Implementation of `ArrayAccess::offsetGet()`
`public`	# `offsetSet( string $offset, IMP_Remote_Account $value )` Add a remote account. Add a remote account. Parameters `$offset` Account ID. `$value` $ob Account object. Implementation of `ArrayAccess::offsetSet()`
`public`	# `offsetUnset( string $offset )` Delete a remote account. Delete a remote account. Parameters `$offset` Account ID. Implementation of `ArrayAccess::offsetUnset()`
`public`	# `getIterator( )` Implementation of `IteratorAggregate::getIterator()`

Constants summary
`string`	`MBOX_PREFIX`	# `"remotembox\0"`

Packages

Classes

Interfaces

Class IMP_Remote

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Implementation of

Parameters

Returns

Implementation of

Parameters

Implementation of

Parameters

Implementation of

Implementation of