PathToExtendedFieldType
extends BasePathToElementType
in package
Represents an extended property.
Note that there are only a couple of valid attribute combinations. Note that all occurrences require the PropertyType attribute.
- (DistinguishedPropertySetId || PropertySetId) + (PropertyName || Property Id)
- PropertyTag
Table of Contents
Properties
- $DistinguishedPropertySetId : string
- Defines the well-known property set IDs for extended MAPI properties.
- $PropertyId : string
- Identifies an extended property by its dispatch ID.
- $PropertyName : string
- Identifies an extended property by its name.
- $PropertySetId : string
- Identifies a MAPI extended property set or namespace by its identifying GUID.
- $PropertyTag : string
- Identifies the property tag without the type part of the tag.
- $PropertyType : string
- Represents the property type of a property tag.
Methods
- __clone() : mixed
- Clones any object properties on a type object when it is cloned. Allows for a deep clone required when using object to represent data types when making a SOAP call.
Properties
$DistinguishedPropertySetId
Defines the well-known property set IDs for extended MAPI properties.
public
string
$DistinguishedPropertySetId
If this attribute is used, the PropertySetId and PropertyTag attributes cannot be used. This attribute must be used with either the PropertyId or PropertyName attribute, and the PropertyType attribute.
This attribute is optional.
Tags
$PropertyId
Identifies an extended property by its dispatch ID.
public
string
$PropertyId
The dispatch ID can be identified in either decimal or hexadecimal formats. This property must be coupled with either DistinguishedPropertySetId or PropertySetId. If this attribute is used, the PropertyName and PropertyTag attributes cannot be used.
This attribute is optional.
Tags
$PropertyName
Identifies an extended property by its name.
public
string
$PropertyName
This property must be coupled with either DistinguishedPropertySetId or PropertySetId. If this attribute is used, the PropertyId and PropertyTag attributes cannot be used.
This attribute is optional.
Tags
$PropertySetId
Identifies a MAPI extended property set or namespace by its identifying GUID.
public
string
$PropertySetId
If this attribute is used, the DistinguishedPropertySetId and PropertyTag attribute cannot be used. This attribute must be used with either the PropertyId or PropertyName attribute, and the PropertyType attribute.
This attribute is optional.
Tags
$PropertyTag
Identifies the property tag without the type part of the tag.
public
string
$PropertyTag
The PropertyTag can be represented as either a hexadecimal or a short integer. The range between 0x8000 and 0xFFFE represents the custom range of properties. When a mailbox database encounters a custom property for the first time, it assigns that custom property a property tag within the custom property range of 0x8000-0xFFFE. A given custom property tag will most likely differ across databases. Therefore, a custom property request by property tag can return different properties on different databases.
The use of the PropertyTag attribute is prohibited for custom properties. Instead, use the PropertySetId attribute and the PropertyName or PropertyId attribute.
Important: Access any custom property between 0x8000 and 0xFFFE by using the GUID + name/ID.
If the PropertyTag attribute is used, the DistinguishedPropertySetId, PropertySetId, PropertyName, and PropertyId attributes cannot be used.
Note: You cannot use a property tag attribute for properties within the custom range 0x8000-0xFFFE. You must use a named property in this case.
This attribute is optional.
Tags
$PropertyType
Represents the property type of a property tag.
public
string
$PropertyType
This corresponds to the least significant word in a property tag. The PropertyType Attribute table later in this topic contains the possible values for this attribute.
This attribute is required.
Tags
Methods
__clone()
Clones any object properties on a type object when it is cloned. Allows for a deep clone required when using object to represent data types when making a SOAP call.
public
__clone() : mixed