API Documentation
\

\Horde_Kolab_Storage_Folder_Stamp_Uids

A folder stamp that includes a list of UIDs.

Copyright 2011-2017 Horde LLC (http://www.horde.org/)

See the enclosed file LICENSE for license information (LGPL). If you did not receive this file, see http://www.horde.org/licenses/lgpl21.

Summary

Methods
Properties
Constants
__construct()
uidvalidity()
uidnext()
ids()
getToken()
isReset()
getChanges()
serialize()
unserialize()
__toString()
No public properties found
UIDVALIDITY
UIDNEXT
TOKEN
No protected methods found
$_status
$_ids
N/A
No private methods found
No private properties found
N/A

Constants

UIDVALIDITY

UIDVALIDITY

The UID validity status

UIDNEXT

UIDNEXT

The next UID status

TOKEN

TOKEN

The sync token

Properties

$_status

$_status : array

The folder status.

Type

array

$_ids

$_ids : array

The list of backend object IDs.

Type

array

Methods

__construct()

__construct(array  $status, array  $ids)

Constructor.

Parameters

array $status

The folder status.
array $ids

The list of undeleted objects in the folder.

uidvalidity()

uidvalidity() : string

Return the folder UID validity.

Returns

string —

The folder UID validity marker.

uidnext()

uidnext() : string

Return the folder next UID number.

Returns

string —

The next UID number.

ids()

ids() : array

Return the backend object IDs in the folder.

Returns

array —

The list of backend IDs.

getToken()

getToken() : string|\boolen

Return the sync token.

Returns

string|\boolen —

The token provided by the IMAP client, or false if unavailable.

isReset()

isReset(\Horde_Kolab_Storage_Folder_Stamp  $stamp) : boolean

Indicate if there was a complete folder reset.

Parameters

\Horde_Kolab_Storage_Folder_Stamp $stamp

Returns

boolean —

True if there was a complete folder reset stamps are different, false if not.

getChanges()

getChanges(\Horde_Kolab_Storage_Folder_Stamp_Uids  $stamp) : array

What changed between this old stamp and the new provided stamp?

Parameters

\Horde_Kolab_Storage_Folder_Stamp_Uids $stamp

The new stamp to compare against.

Returns

array —

An array of two elements (added IDs, deleted IDs).

serialize()

serialize() : string

Serialize this object.

Returns

string —

The serialized data.

unserialize()

unserialize(string  $data)

Reconstruct the object from serialized data.

Parameters

string $data

The serialized data.

__toString()

__toString() : string

Convert the instance into a string.

Returns

string —

The string representation for this instance.