Class IMP_Mailbox_SessionCache

This object manages IMP_Mailbox cache data that is stored in the session.

IMP_Mailbox_SessionCache implements Serializable

Package: IMP
Category: Horde
Copyright: 2014 Horde LLC
License: GPL
Author: Michael Slusarz slusarz@horde.org
Located at Mailbox/SessionCache.php

Methods summary
`public`	# `__get( mixed $name )`
`public mixed`	# `getAcl( string $mbox )` Get ACL data. Get ACL data. Parameters `$mbox` Mailbox. Returns `mixed` A Horde_Imap_Client_Data_Acl object, null if no ACL data, or false if not set.
`public`	# `setAcl( string $mbox, mixed $acl )` Set ACL data. Set ACL data. Parameters `$mbox` Mailbox. `$acl` Horde_Imap_Client_Data_Acl object, or null.
`public mixed`	# `getLabel( string $mbox )` Get the mailbox label. Get the mailbox label. Parameters `$mbox` Mailbox. Returns `mixed` Mailbox label, or false if not set.
`public`	# `setLabel( string $mbox, string $label )` Set the mailbox label. Set the mailbox label. Parameters `$mbox` Mailbox. `$label` Label.
`public mixed`	# `getPrefTo( string $mbox )` Preference storage name. Preference storage name. Parameters `$mbox` Mailbox. Returns `mixed` Preference string, or false if not set.
`public`	# `setPrefTo( string $mbox, string $pref_to )` Set the preference storage name. Set the preference storage name. Parameters `$mbox` Mailbox. `$pref_to` Preference storage name.
`public mixed`	# `getUidvalidity( string $mbox )` Get the UIDVALIDITY of the mailbox. Get the UIDVALIDITY of the mailbox. Parameters `$mbox` Mailbox. Returns `mixed` UIDVALIDITY, or false if not set.
`public`	# `setUidvalidity( string $mbox, integer $uidvalid )` Set the UIDVALIDITY of the mailbox. Set the UIDVALIDITY of the mailbox. Parameters `$mbox` Mailbox. `$uidvalid` UIDVALIDITY.
`public mixed`	# `getDisplay( string $mbox )` Get mailbox display label. Get mailbox display label. Parameters `$mbox` Mailbox. Returns `mixed` Mailbox display label, or false if not set.
`public`	# `setDisplay( string $mbox, string $display )` Set mailbox display label. Set mailbox display label. Parameters `$mbox` Mailbox. `$display` Display label.
`public mixed`	# `getIcons( string $mbox )` Get icon information. Get icon information. Parameters `$mbox` Mailbox. Returns `mixed` Icon information (array), or false if not set.
`public array`	# `getSpecialMailboxes( )` Return the list of special mailboxes. Return the list of special mailboxes. Returns `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).
`public boolean`	# `exists( string $mbox )` Return whether the mailbox exists. Return whether the mailbox exists. Parameters `$mbox` Mailbox. Returns `boolean` True if mailbox exists.
`public`	# `expire( mixed $entries, IMP_Mailbox $mbox = null )` Expire cache entries. Expire cache entries. Parameters `$entries` <p>A CACHE_* constant (or array of constants). If null, expires all mailbox-level cache entries.</p> `$mbox` If set, only clear this mailbox's cache.
`public`	# `serialize( )` Implementation of `Serializable::serialize()`
`public`	# `unserialize( mixed $data )` Implementation of `Serializable::unserialize()`

Constants summary
`integer`	`CHANGED_NO` Changed constants. Changed constants.	# `0`
`integer`	`CHANGED_YES`	# `1`
`string`	`CACHE_ACL` Cache identifiers. Cache identifiers.	# `'a'`
`string`	`CACHE_DISPLAY`	# `'d'`
`string`	`CACHE_ICONS`	# `'i'`
`string`	`CACHE_LABEL`	# `'l'`
`string`	`CACHE_UIDVALIDITY`	# `'v'`
`string`	`CACHE_EXISTS` Cache identifiers - temporary data. Cache identifiers - temporary data.	# `'e'`
`string`	`CACHE_ICONHOOK`	# `'ic'`
`string`	`CACHE_PREFTO`	# `'pt'`
`string`	`CACHE_SPECIALMBOXES`	# `'s'`

Magic properties summary
`public boolean`	`$changed` Has the internal object storage changed?

Packages

Classes

Interfaces

Class IMP_Mailbox_SessionCache

Parameters

Returns

Parameters

Parameters

Returns

Parameters

Parameters

Returns

Parameters

Parameters

Returns

Parameters

Parameters

Returns

Parameters

Parameters

Returns

Returns

Parameters

Returns

Parameters

Implementation of

Implementation of