API Documentation
\

\Horde_Imap_Client_Base_Mailbox

An object allowing management of mailbox state within a Horde_Imap_Client_Base object.

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.

Summary

Methods
Properties
Constants
__construct()
getStatus()
setStatus()
reset()
$map
$open
$sync
No constants found
No protected methods found
$_status
N/A
No private methods found
No private properties found
N/A

Properties

$open

$open : boolean

Is mailbox opened?

Type

boolean

$sync

$sync : boolean

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

Type

boolean

$_status

$_status : array

Status information.

Type

array

Methods

__construct()

__construct()

Constructor.

getStatus()

getStatus(integer  $entry) : mixed

Get status information for the mailbox.

Parameters

integer $entry

STATUS_* constant.

Returns

mixed —

Status information.

setStatus()

setStatus(integer  $entry, mixed  $value)

Set status information for the mailbox.

Parameters

integer $entry

STATUS_* constant.
mixed $value

Status information.

reset()

reset()

Reset the mailbox information.