• Home
  • Horde_Imap_Client_Data_Sync

PHP Class Horde_Imap_Client_Data_Sync, horde

Since: 2.2.0
Author: Michael Slusarz ([email protected])
Show file Open project: horde/horde

Public Properties

Property Type Description
$flags boolean Are there messages that have had flag changes?
$highestmodseq integer The previous value of HIGHESTMODSEQ.
$mailbox Horde_Imap_Client_Mailbox The synchronized mailbox.
$map array Mappings of status() values to sync keys.
$messages integer The previous number of messages in the mailbox.
$newmsgs boolean Are there new messages?
$uidnext integer The previous value of UIDNEXT.
$uidvalidity integer 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.

Protected Properties

Property Type Description
$_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.

Public Methods

Method Description
__construct ( Horde_Imap_Client_Base $base_ob, mixed $mailbox, array $sync, array $curr, integer $criteria, Horde_Imap_Client_Ids $ids ) Constructor.
__get ( $name )

Method Details

__construct() public method

Constructor.
public __construct ( Horde_Imap_Client_Base $base_ob, mixed $mailbox, array $sync, array $curr, integer $criteria, Horde_Imap_Client_Ids $ids )
$base_ob Horde_Imap_Client_Base Base driver object.
$mailbox mixed Mailbox to sync.
$sync array Token sync data.
$curr array Current sync data.
$criteria integer Mask of criteria to return.
$ids Horde_Imap_Client_Ids List of known UIDs.

__get() public method

public __get ( $name )

Property Details

$_flagsuids protected property

UIDs of messages that have had flag changes.
protected Horde_Imap_Client_Ids $_flagsuids
return Horde_Imap_Client_Ids

$_newmsgsuids protected property

UIDs of new messages.
protected Horde_Imap_Client_Ids $_newmsgsuids
return Horde_Imap_Client_Ids

$_vanisheduids protected property

UIDs of messages that have vanished.
protected Horde_Imap_Client_Ids $_vanisheduids
return Horde_Imap_Client_Ids

$flags public property

Are there messages that have had flag changes?
public bool $flags
return boolean

$highestmodseq public property

The previous value of HIGHESTMODSEQ.
Since: 2.8.0
public int $highestmodseq
return integer

$mailbox public property

The synchronized mailbox.
public Horde_Imap_Client_Mailbox $mailbox
return Horde_Imap_Client_Mailbox

$map public static property

Mappings of status() values to sync keys.
Since: 2.8.0
public static array $map
return array

$messages public property

The previous number of messages in the mailbox.
Since: 2.8.0
public int $messages
return integer

$newmsgs public property

Are there new messages?
public bool $newmsgs
return boolean

$uidnext public property

The previous value of UIDNEXT.
Since: 2.8.0
public int $uidnext
return integer

$uidvalidity public property

The previous value of UIDVALIDITY.
Since: 2.8.0
public int $uidvalidity
return integer

$vanished public property

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
return Horde_Imap_Client_Ids