Horde_ActiveSync_Imap_Strategy_Modseq
extends Horde_ActiveSync_Imap_Strategy_Base
in package
Handles fetching changes using the HIGHESTMODSEQ value of a QRESYNC/CONDSTORE enabled IMAP server.
Tags
Table of Contents
- $_folder : Horde_ActiveSync_Folder_Base
- The folder object.
- $_imap : Horde_ActiveSync_Interface_ImapFactory
- The imap factory. Needed to get list of custom flags.
- $_imap_ob : Horde_Imap_Client_Base
- The imap client object.
- $_logger : Horde_Log_Logger
- $_mbox : Horde_Imap_Client_Mailbox
- The current mailbox.
- $_modseq_valid : bool
- Flag to indicate if the HIGHESTMODSEQ value returned in the STATUS call is to be trusted.
- $_procid : int
- The process id for logging purposes.
- $_status : array<string|int, mixed>
- The IMAP status array.
- __construct() : mixed
- Const'r
- getChanges() : Horde_ActiveSync_Folder_Base
- Return a folder object containing all IMAP server change information.
- _buildModSeqChanges() : mixed
- Populates the changes, flags, and categories arrays with data from any messages added/changed on the IMAP server since the last poll.
- _getMsgFlags() : array<string|int, mixed>
- Return an array of custom IMAP flags.
- _searchQuery() : Horde_Imap_Client_Search_Results
- Return message UIDs that are now within the cureent FILTERTYPE value.
Properties
$_folder
The folder object.
protected
Horde_ActiveSync_Folder_Base
$_folder
$_imap
The imap factory. Needed to get list of custom flags.
protected
Horde_ActiveSync_Interface_ImapFactory
$_imap
$_imap_ob
The imap client object.
protected
Horde_Imap_Client_Base
$_imap_ob
$_logger
protected
Horde_Log_Logger
$_logger
$_mbox
The current mailbox.
protected
Horde_Imap_Client_Mailbox
$_mbox
$_modseq_valid
Flag to indicate if the HIGHESTMODSEQ value returned in the STATUS call is to be trusted.
protected
bool
$_modseq_valid
= \true
$_procid
The process id for logging purposes.
protected
int
$_procid
$_status
The IMAP status array.
protected
array<string|int, mixed>
$_status
Methods
__construct()
Const'r
public
__construct(Horde_ActiveSync_Interface_ImapFactory $imap, array<string|int, mixed> $status, Horde_ActiveSync_Folder_Base $folder, Horde_Log_Logger $logger) : mixed
Parameters
- $imap : Horde_ActiveSync_Interface_ImapFactory
-
The IMAP factory.
- $status : array<string|int, mixed>
-
The IMAP status array.
- $folder : Horde_ActiveSync_Folder_Base
-
The folder object.
- $logger : Horde_Log_Logger
-
The logger.
Return values
mixed —getChanges()
Return a folder object containing all IMAP server change information.
public
getChanges(array<string|int, mixed> $options) : Horde_ActiveSync_Folder_Base
Parameters
- $options : array<string|int, mixed>
-
An array of options. @see Horde_ActiveSync_Imap_Adapter::getMessageChanges
Return values
Horde_ActiveSync_Folder_Base —The populated folder object.
_buildModSeqChanges()
Populates the changes, flags, and categories arrays with data from any messages added/changed on the IMAP server since the last poll.
protected
_buildModSeqChanges(array<string|int, mixed> &$changes, array<string|int, mixed> &$flags, array<string|int, mixed> &$categories, Horde_Imap_Client_Fetch_Results $fetch_ret, array<string|int, mixed> $options, int $modseq) : mixed
Parameters
- $changes : array<string|int, mixed>
-
Changes array.
- $flags : array<string|int, mixed>
-
Flags array.
- $categories : array<string|int, mixed>
-
Categories array.
- $fetch_ret : Horde_Imap_Client_Fetch_Results
-
Fetch results.
- $options : array<string|int, mixed>
-
Options array.
- $modseq : int
-
Current MODSEQ.
Return values
mixed —_getMsgFlags()
Return an array of custom IMAP flags.
protected
_getMsgFlags() : array<string|int, mixed>
Return values
array<string|int, mixed> —_searchQuery()
Return message UIDs that are now within the cureent FILTERTYPE value.
protected
_searchQuery(array<string|int, mixed> $options, bool $is_delete) : Horde_Imap_Client_Search_Results
Parameters
- $options : array<string|int, mixed>
-
Options array.
- $is_delete : bool
-
If true, return messages to SOFTDELETE.