IMP_Mailbox_SessionCache
in package
implements
Serializable
This object manages IMP_Mailbox cache data that is stored in the session.
Tags
Table of Contents
Interfaces
- Serializable
Constants
- CACHE_ACL = 'a'
- Cache identifiers.
- CACHE_DISPLAY = 'd'
- CACHE_EXISTS = 'e'
- Cache identifiers - temporary data.
- CACHE_ICONHOOK = 'ic'
- CACHE_ICONS = 'i'
- CACHE_LABEL = 'l'
- CACHE_PREFTO = 'pt'
- CACHE_SPECIALMBOXES = 's'
- CACHE_UIDVALIDITY = 'v'
- CHANGED_NO = 0
- Changed constants.
- CHANGED_YES = 1
Properties
- $changed : bool
- $_cache : array<string|int, mixed>
- Cached data.
- $_changed : int
- Has this object changed?
- $_temp : array<string|int, mixed>
- Temporary (access-only) cached data.
Methods
- __get() : mixed
- __serialize() : array<string|int, mixed>
- __unserialize() : void
- exists() : bool
- Return whether the mailbox exists.
- expire() : mixed
- Expire cache entries.
- getAcl() : mixed
- Get ACL data.
- getDisplay() : mixed
- Get mailbox display label.
- getIcons() : mixed
- Get icon information.
- getLabel() : mixed
- Get the mailbox label.
- getPrefTo() : mixed
- Preference storage name.
- getSpecialMailboxes() : array<string|int, mixed>
- Return the list of special mailboxes.
- getUidvalidity() : mixed
- Get the UIDVALIDITY of the mailbox.
- serialize() : mixed
- setAcl() : mixed
- Set ACL data.
- setDisplay() : mixed
- Set mailbox display label.
- setLabel() : mixed
- Set the mailbox label.
- setPrefTo() : mixed
- Set the preference storage name.
- setUidvalidity() : mixed
- Set the UIDVALIDITY of the mailbox.
- unserialize() : mixed
Constants
CACHE_ACL
Cache identifiers.
public
mixed
CACHE_ACL
= 'a'
CACHE_DISPLAY
public
mixed
CACHE_DISPLAY
= 'd'
CACHE_EXISTS
Cache identifiers - temporary data.
public
mixed
CACHE_EXISTS
= 'e'
CACHE_ICONHOOK
public
mixed
CACHE_ICONHOOK
= 'ic'
CACHE_ICONS
public
mixed
CACHE_ICONS
= 'i'
CACHE_LABEL
public
mixed
CACHE_LABEL
= 'l'
CACHE_PREFTO
public
mixed
CACHE_PREFTO
= 'pt'
CACHE_SPECIALMBOXES
public
mixed
CACHE_SPECIALMBOXES
= 's'
CACHE_UIDVALIDITY
public
mixed
CACHE_UIDVALIDITY
= 'v'
CHANGED_NO
Changed constants.
public
mixed
CHANGED_NO
= 0
CHANGED_YES
public
mixed
CHANGED_YES
= 1
Properties
$changed read-only
public
bool
$changed
Has the internal object storage changed?
$_cache
Cached data.
protected
array<string|int, mixed>
$_cache
= array()
$_changed
Has this object changed?
protected
int
$_changed
= self::CHANGED_NO
$_temp
Temporary (access-only) cached data.
protected
array<string|int, mixed>
$_temp
= array()
Methods
__get()
public
__get(mixed $name) : mixed
Parameters
- $name : mixed
__serialize()
public
__serialize() : array<string|int, mixed>
Return values
array<string|int, mixed>__unserialize()
public
__unserialize(array<string|int, mixed> $data) : void
Parameters
- $data : array<string|int, mixed>
exists()
Return whether the mailbox exists.
public
exists(string $mbox) : bool
Parameters
- $mbox : string
-
Mailbox.
Return values
bool —True if mailbox exists.
expire()
Expire cache entries.
public
expire(mixed $entries[, IMP_Mailbox $mbox = null ]) : mixed
Parameters
- $entries : mixed
-
A CACHE_* constant (or array of constants). If null, expires all mailbox-level cache entries.
- $mbox : IMP_Mailbox = null
-
If set, only clear this mailbox's cache.
getAcl()
Get ACL data.
public
getAcl(string $mbox) : mixed
Parameters
- $mbox : string
-
Mailbox.
Return values
mixed —A Horde_Imap_Client_Data_Acl object, null if no ACL data, or false if not set.
getDisplay()
Get mailbox display label.
public
getDisplay(string $mbox) : mixed
Parameters
- $mbox : string
-
Mailbox.
Return values
mixed —Mailbox display label, or false if not set.
getIcons()
Get icon information.
public
getIcons(string $mbox) : mixed
Parameters
- $mbox : string
-
Mailbox.
Return values
mixed —Icon information (array), or false if not set.
getLabel()
Get the mailbox label.
public
getLabel(string $mbox) : mixed
Parameters
- $mbox : string
-
Mailbox.
Return values
mixed —Mailbox label, or false if not set.
getPrefTo()
Preference storage name.
public
getPrefTo(string $mbox) : mixed
Parameters
- $mbox : string
-
Mailbox.
Return values
mixed —Preference string, or false if not set.
getSpecialMailboxes()
Return the list of special mailboxes.
public
getSpecialMailboxes() : array<string|int, mixed>
Return values
array<string|int, mixed> —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()
Get the UIDVALIDITY of the mailbox.
public
getUidvalidity(string $mbox) : mixed
Parameters
- $mbox : string
-
Mailbox.
Return values
mixed —UIDVALIDITY, or false if not set.
serialize()
public
serialize() : mixed
setAcl()
Set ACL data.
public
setAcl(string $mbox, mixed $acl) : mixed
Parameters
- $mbox : string
-
Mailbox.
- $acl : mixed
-
Horde_Imap_Client_Data_Acl object, or null.
setDisplay()
Set mailbox display label.
public
setDisplay(string $mbox, string $display) : mixed
Parameters
- $mbox : string
-
Mailbox.
- $display : string
-
Display label.
setLabel()
Set the mailbox label.
public
setLabel(string $mbox, string $label) : mixed
Parameters
- $mbox : string
-
Mailbox.
- $label : string
-
Label.
setPrefTo()
Set the preference storage name.
public
setPrefTo(string $mbox, string $pref_to) : mixed
Parameters
- $mbox : string
-
Mailbox.
- $pref_to : string
-
Preference storage name.
setUidvalidity()
Set the UIDVALIDITY of the mailbox.
public
setUidvalidity(string $mbox, int $uidvalid) : mixed
Parameters
- $mbox : string
-
Mailbox.
- $uidvalid : int
-
UIDVALIDITY.
unserialize()
public
unserialize(mixed $data) : mixed
Parameters
- $data : mixed