Documentation

Horde_Imap_Client_Data_Sync
in package

Mailbox synchronization results.

Tags
author

Michael Slusarz slusarz@horde.org

category

Horde

copyright

2012-2017 Horde LLC

license

http://www.horde.org/licenses/lgpl21 LGPL 2.1

since
2.2.0

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

$highestmodseq

The previous value of HIGHESTMODSEQ.

public int $highestmodseq = \null
Tags
since
2.8.0

$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
since
2.8.0

$messages

The previous number of messages in the mailbox.

public int $messages = \null
Tags
since
2.8.0

$newmsgs

Are there new messages?

public bool $newmsgs = \null

$uidnext

The previous value of UIDNEXT.

public int $uidnext = \null
Tags
since
2.8.0

$uidvalidity

The previous value of UIDVALIDITY.

public int $uidvalidity = \null
Tags
since
2.8.0

$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

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
throws
Horde_Imap_Client_Exception
throws
Horde_Imap_Client_Exception_Sync
Return values
mixed

__get()

public __get(mixed $name) : mixed
Parameters
$name : mixed
Return values
mixed

Search results