\Horde_ActiveSync_Imap_Strategy_Modseq

Handles fetching changes using the HIGHESTMODSEQ value of a QRESYNC/CONDSTORE enabled IMAP server.

Summary

Methods
Properties
Constants
__construct()
getChanges()
No public properties found
No constants found
_getMsgFlags()
_searchQuery()
_buildModSeqChanges()
$_status
$_folder
$_logger
$_procid
$_mbox
$_imap_ob
$_imap
$_modseq_valid
N/A
No private methods found
No private properties found
N/A

Properties

$_status

$_status : array

The IMAP status array.

Type

array

$_logger

$_logger : \Horde_Log_Logger

Type

\Horde_Log_Logger

$_procid

$_procid : integer

The process id for logging purposes.

Type

integer

$_mbox

$_mbox : \Horde_Imap_Client_Mailbox

The current mailbox.

Type

\Horde_Imap_Client_Mailbox

$_imap_ob

$_imap_ob : \Horde_Imap_Client_Base

The imap client object.

Type

\Horde_Imap_Client_Base

$_modseq_valid

$_modseq_valid : boolean

Flag to indicate if the HIGHESTMODSEQ value returned in the STATUS call is to be trusted.

Type

boolean

Methods

__construct()

__construct(\Horde_ActiveSync_Interface_ImapFactory  $imap, array  $status, \Horde_ActiveSync_Folder_Base  $folder, \Horde_Log_Logger  $logger) 

Const'r

Parameters

\Horde_ActiveSync_Interface_ImapFactory $imap

The IMAP factory.

array $status

The IMAP status array.

\Horde_ActiveSync_Folder_Base $folder

The folder object.

\Horde_Log_Logger $logger

The logger.

getChanges()

getChanges(array  $options) : \Horde_ActiveSync_Folder_Base

Return a folder object containing all IMAP server change information.

Parameters

array $options

An array of options. @see Horde_ActiveSync_Imap_Adapter::getMessageChanges

Returns

\Horde_ActiveSync_Folder_Base

The populated folder object.

_getMsgFlags()

_getMsgFlags() : array

Return an array of custom IMAP flags.

Returns

array

_searchQuery()

_searchQuery(array  $options, boolean  $is_delete) : \Horde_Imap_Client_Search_Results

Return message UIDs that are now within the cureent FILTERTYPE value.

Parameters

array $options

Options array.

boolean $is_delete

If true, return messages to SOFTDELETE.

Returns

\Horde_Imap_Client_Search_Results

_buildModSeqChanges()

_buildModSeqChanges(  $changes,   $flags,   $categories, \Horde_Imap_Client_Fetch_Results  $fetch_ret, array  $options, integer  $modseq) 

Populates the changes, flags, and categories arrays with data from any messages added/changed on the IMAP server since the last poll.

Parameters

$changes
$flags
$categories
\Horde_Imap_Client_Fetch_Results $fetch_ret

Fetch results.

array $options

Options array.

integer $modseq

Current MODSEQ.