Documentation

Horde_ActiveSync_Message_Contact extends Horde_ActiveSync_Message_Base
in package

Horde_ActiveSync_Message_Contact::

Tags
license

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

copyright

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

author

Michael J Rubinsky mrubinsk@horde.org

Table of Contents

ACCOUNTNAME  = 'POOMCONTACTS2:AccountName'
ALIAS  = 'POOMCONTACTS:Alias'
ANNIVERSARY  = 'POOMCONTACTS:Anniversary'
ASSISTANTNAME  = 'POOMCONTACTS:AssistantName'
ASSISTNAMEPHONENUMBER  = 'POOMCONTACTS:AssistnamePhoneNumber'
BIRTHDAY  = 'POOMCONTACTS:Birthday'
BODY  = 'POOMCONTACTS:Body'
BODYSIZE  = 'POOMCONTACTS:BodySize'
BODYTRUNCATED  = 'POOMCONTACTS:BodyTruncated'
BUSINESS2PHONENUMBER  = 'POOMCONTACTS:Business2PhoneNumber'
BUSINESSCITY  = 'POOMCONTACTS:BusinessCity'
BUSINESSCOUNTRY  = 'POOMCONTACTS:BusinessCountry'
BUSINESSFAXNUMBER  = 'POOMCONTACTS:BusinessFaxNumber'
BUSINESSPHONENUMBER  = 'POOMCONTACTS:BusinessPhoneNumber'
BUSINESSPOSTALCODE  = 'POOMCONTACTS:BusinessPostalCode'
BUSINESSSTATE  = 'POOMCONTACTS:BusinessState'
BUSINESSSTREET  = 'POOMCONTACTS:BusinessStreet'
CARPHONENUMBER  = 'POOMCONTACTS:CarPhoneNumber'
CATEGORIES  = 'POOMCONTACTS:Categories'
CATEGORY  = 'POOMCONTACTS:Category'
CHILD  = 'POOMCONTACTS:Child'
CHILDREN  = 'POOMCONTACTS:Children'
COMPANYMAINPHONE  = 'POOMCONTACTS2:CompanyMainPhone'
COMPANYNAME  = 'POOMCONTACTS:CompanyName'
CUSTOMERID  = 'POOMCONTACTS2:CustomerId'
DEPARTMENT  = 'POOMCONTACTS:Department'
EMAIL1ADDRESS  = 'POOMCONTACTS:Email1Address'
EMAIL2ADDRESS  = 'POOMCONTACTS:Email2Address'
EMAIL3ADDRESS  = 'POOMCONTACTS:Email3Address'
FILEAS  = 'POOMCONTACTS:FileAs'
FIRSTNAME  = 'POOMCONTACTS:FirstName'
GOVERNMENTID  = 'POOMCONTACTS2:GovernmentId'
HOME2PHONENUMBER  = 'POOMCONTACTS:Home2PhoneNumber'
HOMECITY  = 'POOMCONTACTS:HomeCity'
HOMECOUNTRY  = 'POOMCONTACTS:HomeCountry'
HOMEFAXNUMBER  = 'POOMCONTACTS:HomeFaxNumber'
HOMEPHONENUMBER  = 'POOMCONTACTS:HomePhoneNumber'
HOMEPOSTALCODE  = 'POOMCONTACTS:HomePostalCode'
HOMESTATE  = 'POOMCONTACTS:HomeState'
HOMESTREET  = 'POOMCONTACTS:HomeStreet'
IMADDRESS  = 'POOMCONTACTS2:IMAddress'
IMADDRESS2  = 'POOMCONTACTS2:IMAddress2'
IMADDRESS3  = 'POOMCONTACTS2:IMAddress3'
JOBTITLE  = 'POOMCONTACTS:JobTitle'
KEY_ATTRIBUTE  = 1
KEY_PROPERTY  = 4
KEY_TYPE  = 3
KEY_VALUES  = 2
LASTNAME  = 'POOMCONTACTS:LastName'
MANAGERNAME  = 'POOMCONTACTS2:ManagerName'
MIDDLENAME  = 'POOMCONTACTS:MiddleName'
MMS  = 'POOMCONTACTS2:MMS'
MOBILEPHONENUMBER  = 'POOMCONTACTS:MobilePhoneNumber'
NICKNAME  = 'POOMCONTACTS2:NickName'
OFFICELOCATION  = 'POOMCONTACTS:OfficeLocation'
OTHERCITY  = 'POOMCONTACTS:OtherCity'
OTHERCOUNTRY  = 'POOMCONTACTS:OtherCountry'
OTHERPOSTALCODE  = 'POOMCONTACTS:OtherPostalCode'
OTHERSTATE  = 'POOMCONTACTS:OtherState'
OTHERSTREET  = 'POOMCONTACTS:OtherStreet'
PAGERNUMBER  = 'POOMCONTACTS:PagerNumber'
PICTURE  = 'POOMCONTACTS:Picture'
PROPERTY_NO_CONTAINER  = 7
RADIOPHONENUMBER  = 'POOMCONTACTS:RadioPhoneNumber'
RTF  = 'POOMCONTACTS:Rtf'
SPOUSE  = 'POOMCONTACTS:Spouse'
SUFFIX  = 'POOMCONTACTS:Suffix'
TITLE  = 'POOMCONTACTS:Title'
TYPE_DATE  = 1
TYPE_DATE_DASHES  = 3
TYPE_DATE_LOCAL  = 6
TYPE_HEX  = 2
TYPE_MAPI_GOID  = 5
TYPE_MAPI_STREAM  = 4
WEBPAGE  = 'POOMCONTACTS:WebPage'
WEIGHTEDRANK  = 'POOMCONTACTS:WeightedRank'
YOMICOMPANYNAME  = 'POOMCONTACTS:YomiCompanyName'
YOMIFIRSTNAME  = 'POOMCONTACTS:YomiFirstName'
YOMILASTNAME  = 'POOMCONTACTS:YomiLastName'
$accountname  : string
$airsyncbasebody  : Horde_ActiveSync_Message_AirSyncBaseBody
$alias  : string
$anniversary  : Horde_Date
$assistantname  : string
$assistnamephonenumber  : string
$birthday  : Horde_Date
$body  : string
$bodysize  : int
$bodytruncated  : int
$business2phonenumber  : string
$businesscity  : string
$businesscountry  : string
$businessfaxnumber  : string
$businessphonenumber  : string
$businesspostalcode  : string
$businessstate  : string
$businessstreet  : string
$carphonenumber  : string
$categories  : array<string|int, mixed>
$categories  : mixed
$children  : array<string|int, mixed>
$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.
$companymainphone  : string
$companyname  : string
$customerid  : string
$department  : string
$email1address  : string
$email2address  : string
$email3address  : string
$fileas  : string
$firstname  : string
$flags  : mixed
Message flags
$governmentid  : string
$home2phonenumber  : string
$homecity  : string
$homecountry  : string
$homefaxnumber  : string
$homephonenumber  : string
$homepostalcode  : string
$homestate  : string
$homestreet  : string
$imaddress  : string
$imaddress2  : string
$imaddress3  : string
$jobtitle  : string
$lastname  : string
$managername  : string
$middlename  : string
$mms  : string
$mobilephonenumber  : string
$nickname  : string
$officelocation  : string
$othercity  : string
$othercountry  : string
$otherpostalcode  : string
$otherstate  : string
$otherstreet  : string
$pagernumber  : string
$picture  : string
$radiophonenumber  : string
$rtf  : int
$spouse  : string
$suffix  : string
$title  : string
$webpage  : string
$weightedrank  : string
$yomicompanyname  : string
$yomifirstname  : string
$yomilastname  : string
$_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 message type
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
Check if we should send a specific property even if it's empty.
_formatDate()  : string
Format a date string for sending to the EAS client.
_getAttribute()  : mixed
Helper method to allow default values for unset properties.
_parseDate()  : Horde_Date|bool
Override parent class so we can normalize the Date object before returning it.
_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.

Constants

ACCOUNTNAME

public mixed ACCOUNTNAME = 'POOMCONTACTS2:AccountName'

ALIAS

public mixed ALIAS = 'POOMCONTACTS:Alias'

ANNIVERSARY

public mixed ANNIVERSARY = 'POOMCONTACTS:Anniversary'

ASSISTANTNAME

public mixed ASSISTANTNAME = 'POOMCONTACTS:AssistantName'

ASSISTNAMEPHONENUMBER

public mixed ASSISTNAMEPHONENUMBER = 'POOMCONTACTS:AssistnamePhoneNumber'

BIRTHDAY

public mixed BIRTHDAY = 'POOMCONTACTS:Birthday'

BODY

public mixed BODY = 'POOMCONTACTS:Body'

BODYSIZE

public mixed BODYSIZE = 'POOMCONTACTS:BodySize'

BODYTRUNCATED

public mixed BODYTRUNCATED = 'POOMCONTACTS:BodyTruncated'

BUSINESS2PHONENUMBER

public mixed BUSINESS2PHONENUMBER = 'POOMCONTACTS:Business2PhoneNumber'

BUSINESSCITY

public mixed BUSINESSCITY = 'POOMCONTACTS:BusinessCity'

BUSINESSCOUNTRY

public mixed BUSINESSCOUNTRY = 'POOMCONTACTS:BusinessCountry'

BUSINESSFAXNUMBER

public mixed BUSINESSFAXNUMBER = 'POOMCONTACTS:BusinessFaxNumber'

BUSINESSPHONENUMBER

public mixed BUSINESSPHONENUMBER = 'POOMCONTACTS:BusinessPhoneNumber'

BUSINESSPOSTALCODE

public mixed BUSINESSPOSTALCODE = 'POOMCONTACTS:BusinessPostalCode'

BUSINESSSTATE

public mixed BUSINESSSTATE = 'POOMCONTACTS:BusinessState'

BUSINESSSTREET

public mixed BUSINESSSTREET = 'POOMCONTACTS:BusinessStreet'

CARPHONENUMBER

public mixed CARPHONENUMBER = 'POOMCONTACTS:CarPhoneNumber'

CATEGORIES

public mixed CATEGORIES = 'POOMCONTACTS:Categories'

CATEGORY

public mixed CATEGORY = 'POOMCONTACTS:Category'

CHILD

public mixed CHILD = 'POOMCONTACTS:Child'

CHILDREN

public mixed CHILDREN = 'POOMCONTACTS:Children'

COMPANYMAINPHONE

public mixed COMPANYMAINPHONE = 'POOMCONTACTS2:CompanyMainPhone'

COMPANYNAME

public mixed COMPANYNAME = 'POOMCONTACTS:CompanyName'

CUSTOMERID

public mixed CUSTOMERID = 'POOMCONTACTS2:CustomerId'

DEPARTMENT

public mixed DEPARTMENT = 'POOMCONTACTS:Department'

EMAIL1ADDRESS

public mixed EMAIL1ADDRESS = 'POOMCONTACTS:Email1Address'

EMAIL2ADDRESS

public mixed EMAIL2ADDRESS = 'POOMCONTACTS:Email2Address'

EMAIL3ADDRESS

public mixed EMAIL3ADDRESS = 'POOMCONTACTS:Email3Address'

FILEAS

public mixed FILEAS = 'POOMCONTACTS:FileAs'

FIRSTNAME

public mixed FIRSTNAME = 'POOMCONTACTS:FirstName'

GOVERNMENTID

public mixed GOVERNMENTID = 'POOMCONTACTS2:GovernmentId'

HOME2PHONENUMBER

public mixed HOME2PHONENUMBER = 'POOMCONTACTS:Home2PhoneNumber'

HOMECITY

public mixed HOMECITY = 'POOMCONTACTS:HomeCity'

HOMECOUNTRY

public mixed HOMECOUNTRY = 'POOMCONTACTS:HomeCountry'

HOMEFAXNUMBER

public mixed HOMEFAXNUMBER = 'POOMCONTACTS:HomeFaxNumber'

HOMEPHONENUMBER

public mixed HOMEPHONENUMBER = 'POOMCONTACTS:HomePhoneNumber'

HOMEPOSTALCODE

public mixed HOMEPOSTALCODE = 'POOMCONTACTS:HomePostalCode'

HOMESTATE

public mixed HOMESTATE = 'POOMCONTACTS:HomeState'

HOMESTREET

public mixed HOMESTREET = 'POOMCONTACTS:HomeStreet'

IMADDRESS

public mixed IMADDRESS = 'POOMCONTACTS2:IMAddress'

IMADDRESS2

public mixed IMADDRESS2 = 'POOMCONTACTS2:IMAddress2'

IMADDRESS3

public mixed IMADDRESS3 = 'POOMCONTACTS2:IMAddress3'

JOBTITLE

public mixed JOBTITLE = 'POOMCONTACTS:JobTitle'

KEY_ATTRIBUTE

public mixed KEY_ATTRIBUTE = 1

KEY_PROPERTY

public mixed KEY_PROPERTY = 4

KEY_TYPE

public mixed KEY_TYPE = 3

KEY_VALUES

public mixed KEY_VALUES = 2

LASTNAME

public mixed LASTNAME = 'POOMCONTACTS:LastName'

MANAGERNAME

public mixed MANAGERNAME = 'POOMCONTACTS2:ManagerName'

MIDDLENAME

public mixed MIDDLENAME = 'POOMCONTACTS:MiddleName'

MMS

public mixed MMS = 'POOMCONTACTS2:MMS'

MOBILEPHONENUMBER

public mixed MOBILEPHONENUMBER = 'POOMCONTACTS:MobilePhoneNumber'

NICKNAME

public mixed NICKNAME = 'POOMCONTACTS2:NickName'

OFFICELOCATION

public mixed OFFICELOCATION = 'POOMCONTACTS:OfficeLocation'

OTHERCITY

public mixed OTHERCITY = 'POOMCONTACTS:OtherCity'

OTHERCOUNTRY

public mixed OTHERCOUNTRY = 'POOMCONTACTS:OtherCountry'

OTHERPOSTALCODE

public mixed OTHERPOSTALCODE = 'POOMCONTACTS:OtherPostalCode'

OTHERSTATE

public mixed OTHERSTATE = 'POOMCONTACTS:OtherState'

OTHERSTREET

public mixed OTHERSTREET = 'POOMCONTACTS:OtherStreet'

PAGERNUMBER

public mixed PAGERNUMBER = 'POOMCONTACTS:PagerNumber'

PICTURE

public mixed PICTURE = 'POOMCONTACTS:Picture'

PROPERTY_NO_CONTAINER

public mixed PROPERTY_NO_CONTAINER = 7

RADIOPHONENUMBER

public mixed RADIOPHONENUMBER = 'POOMCONTACTS:RadioPhoneNumber'

RTF

public mixed RTF = 'POOMCONTACTS:Rtf'

SPOUSE

public mixed SPOUSE = 'POOMCONTACTS:Spouse'

SUFFIX

public mixed SUFFIX = 'POOMCONTACTS:Suffix'

TITLE

public mixed TITLE = 'POOMCONTACTS:Title'

TYPE_DATE

public mixed TYPE_DATE = 1

TYPE_DATE_DASHES

public mixed TYPE_DATE_DASHES = 3

TYPE_DATE_LOCAL

public mixed TYPE_DATE_LOCAL = 6

TYPE_HEX

public mixed TYPE_HEX = 2

TYPE_MAPI_GOID

public mixed TYPE_MAPI_GOID = 5

TYPE_MAPI_STREAM

public mixed TYPE_MAPI_STREAM = 4

WEBPAGE

public mixed WEBPAGE = 'POOMCONTACTS:WebPage'

WEIGHTEDRANK

public mixed WEIGHTEDRANK = 'POOMCONTACTS:WeightedRank'

YOMICOMPANYNAME

public mixed YOMICOMPANYNAME = 'POOMCONTACTS:YomiCompanyName'

YOMIFIRSTNAME

public mixed YOMIFIRSTNAME = 'POOMCONTACTS:YomiFirstName'

YOMILASTNAME

public mixed YOMILASTNAME = 'POOMCONTACTS:YomiLastName'

Properties

$accountname

public string $accountname

$alias

public string $alias

(EAS >= 14.0 only)

$anniversary

public Horde_Date $anniversary

$assistantname

public string $assistantname

$assistnamephonenumber

public string $assistnamephonenumber

$birthday

public Horde_Date $birthday

$body

public string $body

(EAS 2.5 only)

$bodysize

public int $bodysize

(EAS 2.5 only)

$bodytruncated

public int $bodytruncated

(EAS 2.5 only)

$business2phonenumber

public string $business2phonenumber

$businesscity

public string $businesscity

$businesscountry

public string $businesscountry

$businessfaxnumber

public string $businessfaxnumber

$businessphonenumber

public string $businessphonenumber

$businesspostalcode

public string $businesspostalcode

$businessstate

public string $businessstate

$businessstreet

public string $businessstreet

$carphonenumber

public string $carphonenumber

$categories

public array<string|int, mixed> $categories

$categories

public mixed $categories = array()

$children

public array<string|int, mixed> $children

$commandType

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.

public string $commandType

@since 2.31.0

$companymainphone

public string $companymainphone

$companyname

public string $companyname

$customerid

public string $customerid

$department

public string $department

$email1address

public string $email1address

$email2address

public string $email2address

$email3address

public string $email3address

$flags

Message flags

public mixed $flags = \false

Horde_ActiveSync::FLAG_* constant

$governmentid

public string $governmentid

$home2phonenumber

public string $home2phonenumber

$homecountry

public string $homecountry

$homefaxnumber

public string $homefaxnumber

$homephonenumber

public string $homephonenumber

$homepostalcode

public string $homepostalcode

$homestreet

public string $homestreet

$imaddress2

public string $imaddress2

$imaddress3

public string $imaddress3

$managername

public string $managername

$middlename

public string $middlename

$mobilephonenumber

public string $mobilephonenumber

$officelocation

public string $officelocation

$othercountry

public string $othercountry

$otherpostalcode

public string $otherpostalcode

$otherstate

public string $otherstate

$otherstreet

public string $otherstreet

$pagernumber

public string $pagernumber

$radiophonenumber

public string $radiophonenumber

$weightedrank

public string $weightedrank

(EAS >= 14.0 only)

$yomicompanyname

public string $yomicompanyname

$yomifirstname

public string $yomifirstname

$yomilastname

public string $yomilastname

$_exists

Existence cache, used for working with ghosted properties.

protected array<string|int, mixed> $_exists = array()

$_logger

Logger

protected Horde_Log_Logger $_logger

$_mapping

Property mapping.

protected array<string|int, mixed> $_mapping = array( self::ANNIVERSARY => array(self::KEY_ATTRIBUTE => 'anniversary', self::KEY_TYPE => self::TYPE_DATE_DASHES), self::BIRTHDAY => array(self::KEY_ATTRIBUTE => 'birthday', self::KEY_TYPE => self::TYPE_DATE_DASHES), self::WEBPAGE => array(self::KEY_ATTRIBUTE => 'webpage'), self::CHILDREN => array(self::KEY_ATTRIBUTE => 'children', self::KEY_VALUES => self::CHILD), self::BUSINESSCOUNTRY => array(self::KEY_ATTRIBUTE => 'businesscountry'), self::DEPARTMENT => array(self::KEY_ATTRIBUTE => 'department'), self::EMAIL1ADDRESS => array(self::KEY_ATTRIBUTE => 'email1address'), self::EMAIL2ADDRESS => array(self::KEY_ATTRIBUTE => 'email2address'), self::EMAIL3ADDRESS => array(self::KEY_ATTRIBUTE => 'email3address'), self::BUSINESSFAXNUMBER => array(self::KEY_ATTRIBUTE => 'businessfaxnumber'), self::FILEAS => array(self::KEY_ATTRIBUTE => 'fileas'), self::FIRSTNAME => array(self::KEY_ATTRIBUTE => 'firstname'), self::HOMECITY => array(self::KEY_ATTRIBUTE => 'homecity'), self::HOMECOUNTRY => array(self::KEY_ATTRIBUTE => 'homecountry'), self::HOMEFAXNUMBER => array(self::KEY_ATTRIBUTE => 'homefaxnumber'), self::HOMEPHONENUMBER => array(self::KEY_ATTRIBUTE => 'homephonenumber'), self::HOME2PHONENUMBER => array(self::KEY_ATTRIBUTE => 'home2phonenumber'), self::HOMEPOSTALCODE => array(self::KEY_ATTRIBUTE => 'homepostalcode'), self::HOMESTATE => array(self::KEY_ATTRIBUTE => 'homestate'), self::HOMESTREET => array(self::KEY_ATTRIBUTE => 'homestreet'), self::BUSINESSCITY => array(self::KEY_ATTRIBUTE => 'businesscity'), self::MIDDLENAME => array(self::KEY_ATTRIBUTE => 'middlename'), self::MOBILEPHONENUMBER => array(self::KEY_ATTRIBUTE => 'mobilephonenumber'), self::SUFFIX => array(self::KEY_ATTRIBUTE => 'suffix'), self::COMPANYNAME => array(self::KEY_ATTRIBUTE => 'companyname'), self::OTHERCITY => array(self::KEY_ATTRIBUTE => 'othercity'), self::OTHERCOUNTRY => array(self::KEY_ATTRIBUTE => 'othercountry'), self::CARPHONENUMBER => array(self::KEY_ATTRIBUTE => 'carphonenumber'), self::OTHERPOSTALCODE => array(self::KEY_ATTRIBUTE => 'otherpostalcode'), self::OTHERSTATE => array(self::KEY_ATTRIBUTE => 'otherstate'), self::OTHERSTREET => array(self::KEY_ATTRIBUTE => 'otherstreet'), self::PAGERNUMBER => array(self::KEY_ATTRIBUTE => 'pagernumber'), self::TITLE => array(self::KEY_ATTRIBUTE => 'title'), self::BUSINESSPOSTALCODE => array(self::KEY_ATTRIBUTE => 'businesspostalcode'), self::ASSISTANTNAME => array(self::KEY_ATTRIBUTE => 'assistantname'), self::ASSISTNAMEPHONENUMBER => array(self::KEY_ATTRIBUTE => 'assistnamephonenumber'), self::LASTNAME => array(self::KEY_ATTRIBUTE => 'lastname'), self::SPOUSE => array(self::KEY_ATTRIBUTE => 'spouse'), self::BUSINESSSTATE => array(self::KEY_ATTRIBUTE => 'businessstate'), self::BUSINESSSTREET => array(self::KEY_ATTRIBUTE => 'businessstreet'), self::BUSINESSPHONENUMBER => array(self::KEY_ATTRIBUTE => 'businessphonenumber'), self::BUSINESS2PHONENUMBER => array(self::KEY_ATTRIBUTE => 'business2phonenumber'), self::JOBTITLE => array(self::KEY_ATTRIBUTE => 'jobtitle'), self::YOMIFIRSTNAME => array(self::KEY_ATTRIBUTE => 'yomifirstname'), self::YOMILASTNAME => array(self::KEY_ATTRIBUTE => 'yomilastname'), self::YOMICOMPANYNAME => array(self::KEY_ATTRIBUTE => 'yomicompanyname'), self::OFFICELOCATION => array(self::KEY_ATTRIBUTE => 'officelocation'), self::RADIOPHONENUMBER => array(self::KEY_ATTRIBUTE => 'radiophonenumber'), self::CATEGORIES => array(self::KEY_ATTRIBUTE => 'categories', self::KEY_VALUES => self::CATEGORY), self::PICTURE => array(self::KEY_ATTRIBUTE => 'picture'), // POOMCONTACTS2 self::CUSTOMERID => array(self::KEY_ATTRIBUTE => 'customerid'), self::GOVERNMENTID => array(self::KEY_ATTRIBUTE => 'governmentid'), self::IMADDRESS => array(self::KEY_ATTRIBUTE => 'imaddress'), self::IMADDRESS2 => array(self::KEY_ATTRIBUTE => 'imaddress2'), self::IMADDRESS3 => array(self::KEY_ATTRIBUTE => 'imaddress3'), self::MANAGERNAME => array(self::KEY_ATTRIBUTE => 'managername'), self::COMPANYMAINPHONE => array(self::KEY_ATTRIBUTE => 'companymainphone'), self::ACCOUNTNAME => array(self::KEY_ATTRIBUTE => 'accountname'), self::NICKNAME => array(self::KEY_ATTRIBUTE => 'nickname'), self::MMS => array(self::KEY_ATTRIBUTE => 'mms'), )

$_properties

Property values.

protected array<string|int, mixed> $_properties = array( 'anniversary' => \false, 'assistantname' => \false, 'assistnamephonenumber' => \false, 'birthday' => \false, 'business2phonenumber' => \false, 'businesscity' => \false, 'businesscountry' => \false, 'businesspostalcode' => \false, 'businessstate' => \false, 'businessstreet' => \false, 'businessfaxnumber' => \false, 'businessphonenumber' => \false, 'carphonenumber' => \false, 'children' => array(), 'companyname' => \false, 'department' => \false, 'email1address' => \false, 'email2address' => \false, 'email3address' => \false, 'fileas' => \false, 'firstname' => \false, 'home2phonenumber' => \false, 'homecity' => \false, 'homecountry' => \false, 'homepostalcode' => \false, 'homestate' => \false, 'homestreet' => \false, 'homefaxnumber' => \false, 'homephonenumber' => \false, 'jobtitle' => \false, 'lastname' => \false, 'middlename' => \false, 'mobilephonenumber' => \false, 'officelocation' => \false, 'othercity' => \false, 'othercountry' => \false, 'otherpostalcode' => \false, 'otherstate' => \false, 'otherstreet' => \false, 'pagernumber' => \false, 'radiophonenumber' => \false, 'spouse' => \false, 'suffix' => \false, 'title' => \false, 'webpage' => \false, 'yomicompanyname' => \false, 'yomifirstname' => \false, 'yomilastname' => \false, 'picture' => \false, 'categories' => \false, // POOMCONTACTS2 'customerid' => \false, 'governmentid' => \false, 'imaddress' => \false, 'imaddress2' => \false, 'imaddress3' => \false, 'managername' => \false, 'companymainphone' => \false, 'accountname' => \false, 'nickname' => \false, 'mms' => \false, )

$_streamFilters

Cache of current stream filters.

protected array<string|int, mixed> $_streamFilters = array()

$_supported

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

protected array<string|int, mixed> $_supported = array()

$_version

The version of EAS we are to support.

protected float $_version = \Horde_ActiveSync::VERSION_TWOFIVE

Methods

__call()

Magic caller method.

public __call(mixed $method, array<string|int, mixed> $arg) : mixed
Parameters
$method : mixed

The method to call.

$arg : array<string|int, mixed>

Method arguments.

Return values
mixed

__construct()

Const'r

public __construct([array<string|int, mixed> $options = array() ]) : Horde_ActiveSync_Message_Base
Parameters
$options : array<string|int, mixed> = array()

Configuration options for the message:

  • logger: (Horde_Log_Logger) A logger instance DEFAULT: none (No logging).
  • protocolversion: (float) The version of EAS to support. DEFAULT: Horde_ActiveSync::VERSION_TWOFIVE (2.5)
  • device: (Horde_ActiveSync_Device) The device object. @since 2.9.2
Tags
see
Horde_ActiveSync_Message_Base::__construct()
Return values
Horde_ActiveSync_Message_Base

__destruct()

public __destruct() : mixed
Return values
mixed

__get()

Accessor

public & __get(string $property) : mixed
Parameters
$property : string

Property to get.

Tags
todo:

Return boolean false if not set. Not BC to change it.

Return values
mixed

The value of the requested property.

__isset()

Magic method.

public __isset(string $property) : mixed
Parameters
$property : string

The property name to check.

Return values
mixed

__set()

Setter

public __set(string $property, mixed $value) : mixed
Parameters
$property : string

The property to set.

$value : mixed

The value to set it to.

Tags
throws
InvalidArgumentException
Return values
mixed

decodeStream()

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.

public decodeStream(Horde_ActiveSync_Wbxml_Decoder &$decoder) : mixed
Parameters
$decoder : Horde_ActiveSync_Wbxml_Decoder
Tags
throws
Horde_ActiveSync_Exception
Return values
mixed

getClass()

Return message type

public getClass() : string
Return values
string

getProtocolVersion()

Return the EAS version this object supports.

public getProtocolVersion() : float
Return values
float

A Horde_ActiveSync::VERSION_* constant.

getSupported()

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

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

The array of non-ghosted properties

isEmpty()

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

public isEmpty() : bool
Tags
since
2.34.0
Return values
bool

True if message is empty, otherwise false.

isGhosted()

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

public isGhosted(string $property[, array<string|int, mixed> $options = array() ]) : bool

A property is ghosted if it is NOT listed in the SUPPORTED list sent by the client AND is NOT present in the request data.

Parameters
$property : string

The property to check

$options : array<string|int, mixed> = array()

An array of options:

  • ignoreEmptyPictureTagCheck: boolean If true, will not check for the QUIRK_INCORRECTLY_SENDS_EMPTY_PICTURE_TAG quirk. @since 2.32.0
Return values
bool

propertyExists()

Check the existence of a property in this message.

public propertyExists(string $property) : bool
Parameters
$property : string

The property name

Return values
bool

setSupported()

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

public setSupported(array<string|int, mixed> $fields) : mixed
Parameters
$fields : array<string|int, mixed>

The array of fields, keyed by the fully qualified property name i.e., POOMCONTACTS:Anniversary. To signify an empty SUPPORTED container $fields should contain a single element equal to Horde_ActiveSync::ALL_GHOSTED.

Return values
mixed

_checkEncoding()

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.

protected _checkEncoding(mixed $data, string $tag) : mixed
Parameters
$data : mixed

The data to check. A string or stream resource.

$tag : string

The tag we are outputing.

Return values
mixed

The encoded data. A string or stream resource with a filter attached.

_checkSendEmpty()

Check if we should send a specific property even if it's empty.

protected _checkSendEmpty(string $tag) : bool
Parameters
$tag : string

The property tag.

Return values
bool

_formatDate()

Format a date string for sending to the EAS client.

protected _formatDate(Horde_Date $dt, int $type) : string
Parameters
$dt : Horde_Date

The Horde_Date object to format (should normally be in local tz).

$type : int

The type to format as (TYPE_DATE or TYPE_DATE_DASHES)

Return values
string

The formatted date

_getAttribute()

Helper method to allow default values for unset properties.

protected _getAttribute(string $name[, stting $default = null ]) : mixed
Parameters
$name : string

The property name

$default : stting = null

The default value to return if $property is empty

Return values
mixed

_parseDate()

Override parent class so we can normalize the Date object before returning it.

protected _parseDate(string $ts) : Horde_Date|bool
Parameters
$ts : string

The timestamp

Return values
Horde_Date|bool

The Horde_Date object (UTC) or false if unable to parse the date.

_preEncodeValidation()

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

protected _preEncodeValidation() : bool
Tags
since
2.31.0
Return values
bool

True if values were valid (or could be made valid). False if values are unable to be validated.

_validateDecodedValues()

Give concrete classes the chance to enforce rules.

protected _validateDecodedValues() : bool
Tags
since
2.31.0
Return values
bool

True on success, otherwise false.

_hex2bin()

Function which converts a hex entryid to a binary entryid.

private static _hex2bin(string $data) : string
Parameters
$data : string

The hexadecimal string

Return values
string

The binary data

Search results