API Documentation
\

\Horde_Kolab_Storage_Folder_Stamp

Defines unique stamps that allow to determine if folder data has changed or not.

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
Constants
isReset()
ids()
getChanges()
getToken()
DELETED
ADDED
No protected methods found
N/A
No private methods found
N/A

Constants

DELETED

DELETED

List of deleted IDs

ADDED

ADDED

List of added IDs

Methods

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.

ids()

ids() : array

Return the backend object IDs in the folder.

Returns

array —

The list of backend IDs.

getChanges()

getChanges(\Horde_Kolab_Storage_Folder_Stamp  $stamp) : array|boolean

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

Parameters

\Horde_Kolab_Storage_Folder_Stamp $stamp

Returns

array|boolean —

False if there was no change, an array of two elements (added IDs, deleted IDs) otherwise.

getToken()

getToken() : string|\boolen

Return the sync token.

Returns

string|\boolen —

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