API Documentation
\

\Horde_Imap_Client_Base_Deprecated

Class containing deprecated Horde_Imap_Client_Base methods that will be removed in version 3.0.

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
getCacheId()
parseCacheId()
No public properties found
No constants found
No protected methods found
No protected properties found
N/A
No private methods found
No private properties found
N/A

Methods

getCacheId()

getCacheId(\Horde_Imap_Client_Base  $base_ob, mixed  $mailbox, boolean  $condstore, array  $addl = array()) : string

Returns a unique identifier for the current mailbox status.

Parameters

\Horde_Imap_Client_Base $base_ob

The base driver object.
mixed $mailbox

A mailbox. Either a Horde_Imap_Client_Mailbox object or a string (UTF-8).
boolean $condstore

Is CONDSTORE enabled?
array $addl

Additional cache info to add to the cache ID string.

Throws

\Horde_Imap_Client_Exception

Returns

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()

parseCacheId(string  $id) : array

Parses a cacheID created by getCacheId().

Parameters

string $id

The cache ID.

Returns

array —

An array with the following information:

  • highestmodseq: (integer)
  • messages: (integer)
  • uidnext: (integer)
  • uidvalidity: (integer) Always present