• Home
  • IMP_Mailbox_SessionCache

PHP Class IMP_Mailbox_SessionCache, horde

Author: Michael Slusarz ([email protected])
Inheritance: implements Serializable
Mostra file Open project: horde/horde

Protected Properties

Property Type Description
$_cache array Cached data.
$_changed integer Has this object changed?
$_temp array Temporary (access-only) cached data.

Public Methods

Method Description
__get ( $name )
exists ( string $mbox ) : boolean Return whether the mailbox exists.
expire ( mixed $entries, IMP_Mailbox $mbox = null ) Expire cache entries.
getAcl ( string $mbox ) : mixed Get ACL data.
getDisplay ( string $mbox ) : mixed Get mailbox display label.
getIcons ( string $mbox ) : mixed Get icon information.
getLabel ( string $mbox ) : mixed Get the mailbox label.
getPrefTo ( string $mbox ) : mixed Preference storage name.
getSpecialMailboxes ( ) : array Return the list of special mailboxes.
getUidvalidity ( string $mbox ) : mixed Get the UIDVALIDITY of the mailbox.
serialize ( )
setAcl ( string $mbox, mixed $acl ) Set ACL data.
setDisplay ( string $mbox, string $display ) Set mailbox display label.
setLabel ( string $mbox, string $label ) Set the mailbox label.
setPrefTo ( string $mbox, string $pref_to ) Set the preference storage name.
setUidvalidity ( string $mbox, integer $uidvalid ) Set the UIDVALIDITY of the mailbox.
unserialize ( $data )

Method Details

__get() public method

public __get ( $name )

exists() public method

Return whether the mailbox exists.
public exists ( string $mbox ) : boolean
$mbox string Mailbox.
return boolean True if mailbox exists.

expire() public method

Expire cache entries.
public expire ( mixed $entries, IMP_Mailbox $mbox = null )
$entries mixed A CACHE_* constant (or array of constants). If null, expires all mailbox-level cache entries.
$mbox IMP_Mailbox If set, only clear this mailbox's cache.

getAcl() public method

Get ACL data.
public getAcl ( string $mbox ) : mixed
$mbox string Mailbox.
return mixed A Horde_Imap_Client_Data_Acl object, null if no ACL data, or false if not set.

getDisplay() public method

Get mailbox display label.
public getDisplay ( string $mbox ) : mixed
$mbox string Mailbox.
return mixed Mailbox display label, or false if not set.

getIcons() public method

Get icon information.
public getIcons ( string $mbox ) : mixed
$mbox string Mailbox.
return mixed Icon information (array), or false if not set.

getLabel() public method

Get the mailbox label.
public getLabel ( string $mbox ) : mixed
$mbox string Mailbox.
return mixed Mailbox label, or false if not set.

getPrefTo() public method

Preference storage name.
public getPrefTo ( string $mbox ) : mixed
$mbox string Mailbox.
return mixed Preference string, or false if not set.

getSpecialMailboxes() public method

Return the list of special mailboxes.
public getSpecialMailboxes ( ) : array
return array A list of mailboxes, with the SPECIAL_* constants as keys and values containing the IMP_Mailbox objects or null if the mailbox doesn't exist (SPECIAL_SENT contains an array of objects).

getUidvalidity() public method

Get the UIDVALIDITY of the mailbox.
public getUidvalidity ( string $mbox ) : mixed
$mbox string Mailbox.
return mixed UIDVALIDITY, or false if not set.

serialize() public method

public serialize ( )

setAcl() public method

Set ACL data.
public setAcl ( string $mbox, mixed $acl )
$mbox string Mailbox.
$acl mixed Horde_Imap_Client_Data_Acl object, or null.

setDisplay() public method

Set mailbox display label.
public setDisplay ( string $mbox, string $display )
$mbox string Mailbox.
$display string Display label.

setLabel() public method

Set the mailbox label.
public setLabel ( string $mbox, string $label )
$mbox string Mailbox.
$label string Label.

setPrefTo() public method

Set the preference storage name.
public setPrefTo ( string $mbox, string $pref_to )
$mbox string Mailbox.
$pref_to string Preference storage name.

setUidvalidity() public method

Set the UIDVALIDITY of the mailbox.
public setUidvalidity ( string $mbox, integer $uidvalid )
$mbox string Mailbox.
$uidvalid integer UIDVALIDITY.

unserialize() public method

public unserialize ( $data )

Property Details

$_cache protected_oe property

Cached data.
protected array $_cache
return array

$_changed protected_oe property

Has this object changed?
protected int $_changed
return integer

$_temp protected_oe property

Temporary (access-only) cached data.
protected array $_temp
return array