Horde_Imap_Client_Data_Sync
in package
Mailbox synchronization results.
Tags
Table of Contents
- $flags : bool
- Are there messages that have had flag changes?
- $flagsuids : Horde_Imap_Client_Ids
- $highestmodseq : int
- The previous value of HIGHESTMODSEQ.
- $mailbox : Horde_Imap_Client_Mailbox
- The synchronized mailbox.
- $map : array<string|int, mixed>
- Mappings of status() values to sync keys.
- $messages : int
- The previous number of messages in the mailbox.
- $newmsgs : bool
- Are there new messages?
- $newmsgsuids : Horde_Imap_Client_Ids
- $uidnext : int
- The previous value of UIDNEXT.
- $uidvalidity : int
- The previous value of UIDVALIDITY.
- $vanished : Horde_Imap_Client_Ids
- The UIDs of messages that are guaranteed to have vanished. This list is only guaranteed to be available if the server supports QRESYNC or a list of known UIDs is passed to the sync() method.
- $vanisheduids : Horde_Imap_Client_Ids
- $_flagsuids : Horde_Imap_Client_Ids
- UIDs of messages that have had flag changes.
- $_newmsgsuids : Horde_Imap_Client_Ids
- UIDs of new messages.
- $_vanisheduids : Horde_Imap_Client_Ids
- UIDs of messages that have vanished.
- __construct() : mixed
- Constructor.
- __get() : mixed
Properties
$flags
Are there messages that have had flag changes?
public
bool
$flags
= \null
$flagsuids read-only
public
Horde_Imap_Client_Ids
$flagsuids
List of messages with flag changes.
$highestmodseq
The previous value of HIGHESTMODSEQ.
public
int
$highestmodseq
= \null
Tags
$mailbox
The synchronized mailbox.
public
Horde_Imap_Client_Mailbox
$mailbox
$map
Mappings of status() values to sync keys.
public
static array<string|int, mixed>
$map
= array('H' => 'highestmodseq', 'M' => 'messages', 'U' => 'uidnext', 'V' => 'uidvalidity')
Tags
$messages
The previous number of messages in the mailbox.
public
int
$messages
= \null
Tags
$newmsgs
Are there new messages?
public
bool
$newmsgs
= \null
$newmsgsuids read-only
public
Horde_Imap_Client_Ids
$newmsgsuids
List of new messages.
$uidnext
The previous value of UIDNEXT.
public
int
$uidnext
= \null
Tags
$uidvalidity
The previous value of UIDVALIDITY.
public
int
$uidvalidity
= \null
Tags
$vanished
The UIDs of messages that are guaranteed to have vanished. This list is only guaranteed to be available if the server supports QRESYNC or a list of known UIDs is passed to the sync() method.
public
Horde_Imap_Client_Ids
$vanished
= \null
$vanisheduids read-only
public
Horde_Imap_Client_Ids
$vanisheduids
List of messages that have vanished.
$_flagsuids
UIDs of messages that have had flag changes.
protected
Horde_Imap_Client_Ids
$_flagsuids
$_newmsgsuids
UIDs of new messages.
protected
Horde_Imap_Client_Ids
$_newmsgsuids
$_vanisheduids
UIDs of messages that have vanished.
protected
Horde_Imap_Client_Ids
$_vanisheduids
Methods
__construct()
Constructor.
public
__construct(Horde_Imap_Client_Base $base_ob, mixed $mailbox, array<string|int, mixed> $sync, array<string|int, mixed> $curr, int $criteria, Horde_Imap_Client_Ids $ids) : mixed
Parameters
- $base_ob : Horde_Imap_Client_Base
-
Base driver object.
- $mailbox : mixed
-
Mailbox to sync.
- $sync : array<string|int, mixed>
-
Token sync data.
- $curr : array<string|int, mixed>
-
Current sync data.
- $criteria : int
-
Mask of criteria to return.
- $ids : Horde_Imap_Client_Ids
-
List of known UIDs.
Tags
Return values
mixed —__get()
public
__get(mixed $name) : mixed
Parameters
- $name : mixed