API Documentation
\

\Horde_Imap_Client_Ids_Map

An object implementing lookups between UIDs and message sequence numbers.

Summary

Methods
Properties
Constants
__construct()
__get()
update()
lookup()
remove()
sort()
count()
getIterator()
serialize()
unserialize()
$map
$seq
$uids
No constants found
No protected methods found
$_ids
$_sorted
N/A
No private methods found
No private properties found
N/A

Properties

$map

$map : array

The raw ID mapping data.

Type

array

$seq

$seq : \Horde_Imap_Client_Ids

The sorted sequence values.

Type

\Horde_Imap_Client_Ids

$uids

$uids : \Horde_Imap_Client_Ids

The sorted UIDs.

Type

\Horde_Imap_Client_Ids

$_ids

$_ids : array

Sequence -> UID mapping.

Type

array

$_sorted

$_sorted : boolean

Is the array sorted?

Type

boolean

Methods

__construct()

__construct(array  $ids = array())

Constructor.

Parameters

array $ids

Array of sequence -> UID mapping.

__get()

__get(  $name)

Parameters

$name

update()

update(array  $ids) : boolean

Updates the mapping.

Parameters

array $ids

Array of sequence -> UID mapping.

Returns

boolean —

True if the mapping changed.

lookup()

lookup(\Horde_Imap_Client_Ids  $ids) : array

Create a Sequence <-> UID lookup table.

Parameters

\Horde_Imap_Client_Ids $ids

IDs to lookup.

Returns

array —

Keys are sequence numbers, values are UIDs.

remove()

remove(\Horde_Imap_Client_Ids  $ids)

Removes messages from the ID mapping.

Parameters

\Horde_Imap_Client_Ids $ids

IDs to remove.

sort()

sort()

Sort the map.

count()

count()

getIterator()

getIterator()

serialize()

serialize()

unserialize()

unserialize(  $data)

Parameters

$data