Documentation

Horde_ActiveSync_Folder_Imap extends Horde_ActiveSync_Folder_Base

in package

• ActiveSync

implements Serializable

The class contains functionality for maintaining state for a single IMAP folder, and generating server deltas.

Tags

license

http://www.horde.org/licenses/gpl GPLv2

copyright

2012-2020 Horde LLC (http://www.horde.org)

author

Michael J Rubinsky mrubinsk@horde.org

Interfaces, Classes, Traits and Enums

Serializable

Table of Contents

COMPRESSION_LIMIT  = 500

HIGHESTMODSEQ  = 'highestmodseq'

MESSAGES  = 'messages'

UIDNEXT  = 'uidnext'

UIDVALIDITY  = 'uidvalidity'

VERSION  = 2

$haveInitialSync  : bool

Flag for indicating we have an initial sync for this collection.

$_added  : array<string|int, mixed>

Internal cache of message UIDs that have been added since last sync.

$_categories  : array<string|int, mixed>

Internal cache of custom message flags (i.e., categories). Should contain one entry for each UID listed in the $_changed array. An array keyed on message UID: uid => array('TestOne', 'TestTwo')

$_changed  : array<string|int, mixed>

Internal cache of message UIDs that have been modified on the server since the last sync. Used for transporting changes back to activesync.

$_class  : string

The collection class.

$_flags  : array<string|int, mixed>

Internal cache of message flag changes. Should be one entry for each UID also listed in the $_changed array. Used for transporting changes back to activesync. An array keyed by message UID: uid => array('read' => 1)

$_lastSinceDate  : int

Timestamp for the last sincedate used for SOFTDELETE.

$_messages  : array<string|int, mixed>

The folder's current message list.

$_primed  : bool

Internal flag to indicate initial first sync/prime.

$_removed  : array<string|int, mixed>

Internal cache of message UIDs that have been expunged from the IMAP server since last sync. Used for transporting changes back to activesync.

$_serverid  : string

The backend server id for this folder.

$_softDelete  : int

Timestamp for the last time we performed a SOFTDELETE

$_softDeleted  : array<string|int, mixed>

Array of messages to be SOFTDELETEd from client. Only used when we have a CONDSTORE server available, otherwise we calculate the uid list based on the cached data.

$_status  : array<string|int, mixed>

The folder's current internal property state.

__construct()  : mixed

Const'r

__toString()  : string

Convert the instance into a string.

added()  : array<string|int, mixed>

Return the list of UIDs that need to be added to the device.

categories()  : array<string|int, mixed>

Return the internal message category cache.

changed()  : array<string|int, mixed>

Return the list of UIDs that need to have flag changes sent to the device

checkValidity()  : mixed

Check the validity of various values.

collectionClass()  : string

Return the collection class for this collection.

flags()  : array<string|int, mixed>

Return the internal message flags changes cache.

getSoftDeleted()  : array<string|int, mixed>

Return a list of message uids that should be SOFTDELETEd from the client.

getSoftDeleteTimes()  : array<string|int, mixed>

Return the softdelete timestamps.

messages()  : array<string|int, mixed>

Return the list of UIDs currently on the device.

minuid()  : int

Return the minimum IMAP UID contained in this folder.

modseq()  : string

Return the folder's MODSEQ value.

primeFolder()  : mixed

Sets initial message collection for servers that support MODSEQ. Much more effecient than using setChanges() when we know this is the initial folder "priming".

removed()  : array<string|int, mixed>

Return the list of UIDs that need to be removed from the device.

serialize()  : string

Serialize this object.

serverid()  : string

Return the serverid for this collection.

setChanges()  : mixed

Set message changes.

setRemoved()  : mixed

Set the list of expunged message UIDs.

setServerId()  : mixed

Set a new value for the serverid.

setSoftDeleted()  : mixed

Set the list of uids to be SOFTDELETEd. Only needed for CONDSTORE servers.

setSoftDeleteTimes()  : mixed

Set the last softdelete timestamps used.

setStatus()  : mixed

Set the status for this collection.

total_messages()  : int

Return the total, unfiltered number of messages in the folder.

uidnext()  : string

Return the folder's next UID number.

uidvalidity()  : string|bool

Return the folder's UID validity.

unserialize()  : mixed

Reconstruct the object from serialized data.

updateState()  : mixed

Updates the internal UID cache if needed and clears the internal update/deleted/changed cache. To be called after all changes have been dealt with by the activesync client.

_fromSequenceString()  : array<string|int, mixed>

Parse an IMAP message sequence string into a list of indices.

_toSequenceString()  : string

Create an IMAP message sequence string from a list of indices.