PHP 클래스 Horde_ActiveSync_Folder_Imap, horde

저자: Michael J Rubinsky ([email protected])
상속: extends Horde_ActiveSync_Folder_Base, implements Serializable
파일 보기 프로젝트 열기: horde/horde 1 사용 예제들

보호된 프로퍼티들

프로퍼티 타입 설명
$_added array Used for transporting changes back to activesync.
$_categories array Internal cache of custom message flags (i.e., categories). Should contain one entry for each UID listed in the $_changed array. An array keyed on message UID: uid => array('TestOne', 'TestTwo')
$_changed array Internal cache of message UIDs that have been modified on the server since the last sync. Used for transporting changes back to activesync.
$_flags array Internal cache of message flag changes. Should be one entry for each UID also listed in the $_changed array. Used for transporting changes back to activesync. An array keyed by message UID: uid => array('read' => 1)
$_messages array Note: This represents the folder list on the client and is affected by the FILTERTYPE on the collection.
$_primed boolean Internal flag to indicate initial first sync/prime.
$_removed array Internal cache of message UIDs that have been expunged from the IMAP server since last sync. Used for transporting changes back to activesync.
$_softDeleted array Array of messages to be SOFTDELETEd from client. Only used when we have a CONDSTORE server available, otherwise we calculate the uid list based on the cached data.

공개 메소드들

메소드 설명
__toString ( ) : string Convert the instance into a string.
added ( ) : array Return the list of UIDs that need to be added to the device.
categories ( ) : array Return the internal message category cache.
changed ( ) : array Return the list of UIDs that need to have flag changes sent to the device
checkValidity ( array $params = [] ) Check the validity of various values.
flags ( ) : array Return the internal message flags changes cache.
getSoftDeleted ( ) : array Return a list of message uids that should be SOFTDELETEd from the client.
messages ( ) : array Return the list of UIDs currently on the device.
minuid ( ) : integer Return the minimum IMAP UID contained in this folder.
modseq ( ) : string Return the folder's MODSEQ value.
primeFolder ( array $messages ) Sets initial message collection for servers that support MODSEQ. Much more effecient than using setChanges() when we know this is the initial folder "priming".
removed ( ) : array Return the list of UIDs that need to be removed from the device.
serialize ( ) : string Serialize this object.
setChanges ( array $messages, array $flags = [], array $categories = [], boolean $resetMinUid = false ) Set message changes.
setRemoved ( array $uids ) Set the list of expunged message UIDs.
setSoftDeleted ( array $softDeleted ) Set the list of uids to be SOFTDELETEd. Only needed for CONDSTORE servers.
total_messages ( ) : integer Return the total, unfiltered number of messages in the folder.
uidnext ( ) : string Return the folder's next UID number.
uidvalidity ( ) : string | boolean Return the folder's UID validity.
unserialize ( string $data ) Reconstruct the object from serialized data.
updateState ( ) Updates the internal UID cache if needed and clears the internal update/deleted/changed cache. To be called after all changes have been dealt with by the activesync client.

보호된 메소드들

메소드 설명
_fromSequenceString ( string $str ) : array Parse an IMAP message sequence string into a list of indices.
_toSequenceString ( array $ids ) : string Create an IMAP message sequence string from a list of indices.

메소드 상세

__toString() 공개 메소드

Convert the instance into a string.
public __toString ( ) : string
리턴 string The string representation for this instance.

_fromSequenceString() 보호된 메소드

Parse an IMAP message sequence string into a list of indices.
또한 보기: _toSequenceString()
protected _fromSequenceString ( string $str ) : array
$str string The IMAP message sequence string.
리턴 array An array of indices.

_toSequenceString() 보호된 메소드

Index Format: range_start:range_end,uid,uid2,...
protected _toSequenceString ( array $ids ) : string
$ids array An array of UIDs.
리턴 string The IMAP message sequence string.

added() 공개 메소드

Return the list of UIDs that need to be added to the device.
public added ( ) : array
리턴 array The list of UIDs.

categories() 공개 메소드

Return the internal message category cache.
public categories ( ) : array
리턴 array The array of message categories. @see self::$_categories

changed() 공개 메소드

Return the list of UIDs that need to have flag changes sent to the device
public changed ( ) : array
리턴 array The list of UIDs.

checkValidity() 공개 메소드

Check the validity of various values.
public checkValidity ( array $params = [] )
$params array A status array containing status to check.

flags() 공개 메소드

Return the internal message flags changes cache.
public flags ( ) : array
리턴 array The array of message flag changes.

getSoftDeleted() 공개 메소드

Must be called after setChanges and setRemoved, but before updateState.
public getSoftDeleted ( ) : array
리턴 array

messages() 공개 메소드

Return the list of UIDs currently on the device.
public messages ( ) : array
리턴 array The list of backend messages.

minuid() 공개 메소드

Return the minimum IMAP UID contained in this folder.
public minuid ( ) : integer
리턴 integer The IMAP UID.

modseq() 공개 메소드

Return the folder's MODSEQ value.
public modseq ( ) : string
리턴 string The MODSEQ number.

primeFolder() 공개 메소드

Sets initial message collection for servers that support MODSEQ. Much more effecient than using setChanges() when we know this is the initial folder "priming".
public primeFolder ( array $messages )
$messages array Array of message UIDs for the initial message set for this folder.

removed() 공개 메소드

Return the list of UIDs that need to be removed from the device.
public removed ( ) : array
리턴 array The list of UIDs.

serialize() 공개 메소드

Serialize this object.
public serialize ( ) : string
리턴 string The serialized data.

setChanges() 공개 메소드

Set message changes.
public setChanges ( array $messages, array $flags = [], array $categories = [], boolean $resetMinUid = false )
$messages array An array of message UIDs.
$flags array A hash of message read flags, keyed by UID.
$categories array A hash of custom message flags, keyed by UID. @since 2.17.0
$resetMinUid boolean If true, reset the minimum UID. Should be used when FilterType has widened and messages older than originally selected are being returned. @since 2.24.0

setRemoved() 공개 메소드

Set the list of expunged message UIDs.
public setRemoved ( array $uids )
$uids array An array of message UIDs that have been expunged.

setSoftDeleted() 공개 메소드

Set the list of uids to be SOFTDELETEd. Only needed for CONDSTORE servers.
public setSoftDeleted ( array $softDeleted )
$softDeleted array The message UID list.

total_messages() 공개 메소드

Return the total, unfiltered number of messages in the folder.
public total_messages ( ) : integer
리턴 integer The total number of messages.

uidnext() 공개 메소드

Return the folder's next UID number.
public uidnext ( ) : string
리턴 string The next UID number.

uidvalidity() 공개 메소드

Return the folder's UID validity.
public uidvalidity ( ) : string | boolean
리턴 string | boolean The folder UID validity marker, or false if not set.

unserialize() 공개 메소드

Reconstruct the object from serialized data.
public unserialize ( string $data )
$data string The serialized data.

updateState() 공개 메소드

Updates the internal UID cache if needed and clears the internal update/deleted/changed cache. To be called after all changes have been dealt with by the activesync client.
public updateState ( )

프로퍼티 상세

$_added 보호되어 있는 프로퍼티

Used for transporting changes back to activesync.
protected array $_added
리턴 array

$_categories 보호되어 있는 프로퍼티

Internal cache of custom message flags (i.e., categories). Should contain one entry for each UID listed in the $_changed array. An array keyed on message UID: uid => array('TestOne', 'TestTwo')
protected array $_categories
리턴 array

$_changed 보호되어 있는 프로퍼티

Internal cache of message UIDs that have been modified on the server since the last sync. Used for transporting changes back to activesync.
protected array $_changed
리턴 array

$_flags 보호되어 있는 프로퍼티

Internal cache of message flag changes. Should be one entry for each UID also listed in the $_changed array. Used for transporting changes back to activesync. An array keyed by message UID: uid => array('read' => 1)
protected array $_flags
리턴 array

$_messages 보호되어 있는 프로퍼티

Note: This represents the folder list on the client and is affected by the FILTERTYPE on the collection.
protected array $_messages
리턴 array

$_primed 보호되어 있는 프로퍼티

Internal flag to indicate initial first sync/prime.
protected bool $_primed
리턴 boolean

$_removed 보호되어 있는 프로퍼티

Internal cache of message UIDs that have been expunged from the IMAP server since last sync. Used for transporting changes back to activesync.
protected array $_removed
리턴 array

$_softDeleted 보호되어 있는 프로퍼티

Array of messages to be SOFTDELETEd from client. Only used when we have a CONDSTORE server available, otherwise we calculate the uid list based on the cached data.
protected array $_softDeleted
리턴 array