PHP Class Horde_Imap_Client_Base_Deprecated, 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 Class Usage Examples

Public Methods

Method	Description
getCacheId ( Horde_Imap_Client_Base $base_ob, mixed $mailbox, boolean $condstore, array $addl = [] ) : string	Returns a unique identifier for the current mailbox status.
parseCacheId ( string $id ) : array	Parses a cacheID created by getCacheId().

Method Details

getCacheId() public static method

Returns a unique identifier for the current mailbox status.

public static getCacheId ( Horde_Imap_Client_Base $base_ob, mixed $mailbox, boolean $condstore, array $addl = [] ) : string
$base_ob	Horde_Imap_Client_Base	The base driver object.
$mailbox	mixed	A mailbox. Either a Horde_Imap_Client_Mailbox object or a string (UTF-8).
$condstore	boolean	Is CONDSTORE enabled?
$addl	array	Additional cache info to add to the cache ID string.
return	string	The cache ID string, which will change when the composition of the mailbox changes. The uidvalidity will always be the first element, and will be delimited by the '\|' character.

parseCacheId() public static method

Parses a cacheID created by getCacheId().

public static parseCacheId ( string $id ) : array
$id	string	The cache ID.
return	array	An array with the following information: - highestmodseq: (integer) - messages: (integer) - uidnext: (integer) - uidvalidity: (integer) Always present