Documentation

Horde_ActiveSync_Message_Flag extends Horde_ActiveSync_Message_Base

in package

• ActiveSync

Horde_ActiveSync_Message_Flag::

Tags

license

http://www.horde.org/licenses/gpl GPLv2

copyright

2012-2020 Horde LLC (http://www.horde.org)

author

Michael J Rubinsky mrubinsk@horde.org

Table of Contents

FLAG_STATUS_ACTIVE  = 2

FLAG_STATUS_CLEAR  = 0

FLAG_STATUS_COMPLETE  = 1

KEY_ATTRIBUTE  = 1

KEY_PROPERTY  = 4

KEY_TYPE  = 3

KEY_VALUES  = 2

POOMMAIL_COMPLETETIME  = 'POOMMAIL:CompleteTime'

POOMMAIL_FLAGSTATUS  = 'POOMMAIL:FlagStatus'

POOMMAIL_FLAGTYPE  = 'POOMMAIL:FlagType'

PROPERTY_NO_CONTAINER  = 7

TYPE_DATE  = 1

TYPE_DATE_DASHES  = 3

TYPE_DATE_LOCAL  = 6

TYPE_HEX  = 2

TYPE_MAPI_GOID  = 5

TYPE_MAPI_STREAM  = 4

$commandType  : string

Request type. One of: Horde_ActiveSync::SYNC_ADD, SYNC_MODIFY, SYNC_REMOVE, or SYNC_FETCH. Used internally for enforcing various protocol rules depending on request.

$completetime  : int

$datecompleted  : Horde_Date

$duedate  : Horde_Date

$flags  : mixed

Message flags

$flagstatus  : int

$flagtype  : int

$ordinaldate  : Horde_Date

$reminderset  : int

$remindertime  : int

$startdate  : Horde_Date

$subject  : string

$subordinaldate  : string

$utcduedate  : Horde_Date

$utcstartdate  : Horde_Date

$_device  : Horde_ActiveSync_Device

The device object

$_exists  : array<string|int, mixed>

Existence cache, used for working with ghosted properties.

$_logger  : Horde_Log_Logger

Logger

$_mapping  : array<string|int, mixed>

Property mapping

$_properties  : array<string|int, mixed>

Property values.

$_streamFilters  : array<string|int, mixed>

Cache of current stream filters.

$_supported  : array<string|int, mixed>

An array describing the non-ghosted elements this message supports.

$_version  : float

The version of EAS we are to support.

__call()  : mixed

Magic caller method.

__construct()  : Horde_ActiveSync_Message_Base

Const'r

__destruct()  : mixed

__get()  : mixed

Accessor

__isset()  : mixed

Magic method.

__set()  : mixed

Setter

decodeStream()  : mixed

Recursively decodes the WBXML from input stream. This means that if this message contains complex types (like Appointment.Recuurence for example) the sub-objects are auto-instantiated and decoded as well. Places the decoded objects in the local properties array.

encodeStream()  : mixed

Encodes this object (and any sub-objects) as wbxml to the output stream.

getClass()  : string

Return the message class.

getProtocolVersion()  : float

Return the EAS version this object supports.

getSupported()  : array<string|int, mixed>

Get the list of non-ghosted properties for this message.

isEmpty()  : bool

Returns whether or not this message actually contains any data to send.

isGhosted()  : bool

Determines if the property specified has been ghosted by the client.

propertyExists()  : bool

Check the existence of a property in this message.

setSupported()  : mixed

Set the list of non-ghosted fields for this message.

_checkEncoding()  : mixed

Checks if the data needs to be encoded like e.g., when outputing binary data in-line during ITEMOPERATIONS requests. Concrete classes should override this if needed.

_checkSendEmpty()  : bool

Checks to see if we should send an empty value.

_formatDate()  : string

Oh yeah. This is beautiful. Exchange outputs date fields differently in calendar items and emails. We could just always send one or the other, but unfortunately nokia's 'Mail for exchange' depends on this quirk.

_getAttribute()  : mixed

Helper method to allow default values for unset properties.

_parseDate()  : Horde_Date|bool

Get a Horde_Date from a timestamp, ensuring it's in the correct format.

_preEncodeValidation()  : bool

Give concrete classes the chance to enforce rules before encoding messages to send to the client.

_validateDecodedValues()  : bool

Give concrete classes the chance to enforce rules.

_hex2bin()  : string

Function which converts a hex entryid to a binary entryid.