Skip to main content

Search OfficeIMO

Enter a topic, API type, or PowerShell command.

Documentation Search all OfficeIMO/

API Reference

Class

MapiPropertyKey

Namespace OfficeIMO.Email
Assembly OfficeIMO.Email
Source revision a039964de4cc with working tree changes

Describes the canonical identity and supported wire types of a standard or named MAPI property.

Inheritance

  • Object
  • MapiPropertyKey

Methods

public Boolean Accepts(MapiPropertyType propertyType) #
Returns: Boolean

Returns whether a wire type is accepted by this key.

Parameters

propertyType OfficeIMO.Email.MapiPropertyType requiredposition: 0
public UInt16 GetStandardPropertyId() #
Returns: UInt16

Returns the standard property identifier, or throws when this key identifies a named property.

public Boolean Matches(MapiProperty property) #
Returns: Boolean

Returns whether a property has this key's canonical identity and an accepted wire type.

Parameters

property OfficeIMO.Email.MapiProperty requiredposition: 0
MatchesIdentity 2 overloads
public Boolean MatchesIdentity(MapiProperty property) #
Returns: Boolean

Returns whether a property has this key's canonical identity, without checking its wire type.

Parameters

property OfficeIMO.Email.MapiProperty requiredposition: 0
public Boolean MatchesIdentity(UInt16 propertyId) #
Returns: Boolean

Returns whether a standard property identifier has this key's canonical identity.

Parameters

propertyId System.UInt16 requiredposition: 0
public override String ToString() #
Returns: String

Returns a string that represents the current object.

Returns

A string that represents the current object.

Properties

public String CanonicalName { get; } #

Microsoft canonical name or a stable application-defined name.

public UInt16? PropertyId { get; } #

Standard property identifier, or null for a named property.

public MapiNamedProperty? Name { get; } #

Named-property identity, or null for a standard property.

public MapiPropertyType PreferredType { get; } #

Preferred wire type used when a new value is written.

public IReadOnlyList<MapiPropertyType> AcceptedTypes { get; } #

Wire types accepted when reading the property.

public Boolean IsNamed { get; } #

True when this key identifies a named property.

public virtual Type ValueType { get; } #

Managed value type exposed by a typed key.