PHP Class Horde_Imap_Client_Base_Mailbox, horde

NOTE: This class is NOT intended to be accessed outside of a Base object. There is NO guarantees that the API of this class will not change across versions.

Author: Michael Slusarz ([email protected])

Show file Open project: horde/horde

Public Properties

Property	Type	Description
$map	Horde_Imap_Client_Ids_Map	Mapping object.
$open	boolean	Is mailbox opened?
$sync	boolean	Is mailbox sync'd with remote server (via CONDSTORE/QRESYNC)?

Protected Properties

Property	Type	Description
$_status	array	Status information.

Public Methods

Method	Description
__construct ( )	Constructor.
getStatus ( integer $entry ) : mixed	Get status information for the mailbox.
reset ( )	Reset the mailbox information.
setStatus ( integer $entry, mixed $value )	Set status information for the mailbox.

Method Details

__construct() public method

Constructor.

public __construct ( )

getStatus() public method

Get status information for the mailbox.

public getStatus ( integer $entry ) : mixed
$entry	integer	STATUS_* constant.
return	mixed	Status information.

reset() public method

Reset the mailbox information.

public reset ( )

setStatus() public method

Set status information for the mailbox.

public setStatus ( integer $entry, mixed $value )
$entry	integer	STATUS_* constant.
$value	mixed	Status information.

Property Details

$_status protected property

Status information.

protected array $_status
return	array

$map public property

Mapping object.

public Horde_Imap_Client_Ids_Map $map
return	Horde_Imap_Client_Ids_Map

$open public property

Is mailbox opened?

public bool $open
return	boolean

$sync public property

Is mailbox sync'd with remote server (via CONDSTORE/QRESYNC)?

public bool $sync
return	boolean