Skip to main content

Search OfficeIMO

Enter a topic, API type, or PowerShell command.

Documentation Search all OfficeIMO/

API Reference

Class

MapiPropertyExtensions

Namespace OfficeIMO.Email
Assembly OfficeIMO.Email
Source revision 804a7612eee4 with working tree changes
Modifiers static

Convenience lookup APIs for retained standard and named MAPI properties.

Inheritance

  • Object
  • MapiPropertyExtensions

Methods

GetMapiProperty 4 overloads
public static MapiProperty? GetMapiProperty(IEnumerable<MapiProperty> properties, MapiPropertyKey key) #
Returns: MapiProperty?

Finds the last property matching a typed key's identity and accepted wire types.

Parameters

properties System.Collections.Generic.IEnumerable<OfficeIMO.Email.MapiProperty> requiredposition: 0
key OfficeIMO.Email.MapiPropertyKey requiredposition: 1
public static MapiProperty? GetMapiProperty(IEnumerable<MapiProperty> properties, UInt16 propertyId) #
Returns: MapiProperty?

Finds the last standard property with the specified property identifier.

Parameters

properties System.Collections.Generic.IEnumerable<OfficeIMO.Email.MapiProperty> requiredposition: 0
propertyId System.UInt16 requiredposition: 1
public static MapiProperty? GetMapiProperty(IEnumerable<MapiProperty> properties, Guid propertySet, UInt32 localId) #
Returns: MapiProperty?

Finds the last numeric named property with the specified canonical identity.

Parameters

properties System.Collections.Generic.IEnumerable<OfficeIMO.Email.MapiProperty> requiredposition: 0
propertySet System.Guid requiredposition: 1
localId System.UInt32 requiredposition: 2
public static MapiProperty? GetMapiProperty(IEnumerable<MapiProperty> properties, Guid propertySet, String name) #
Returns: MapiProperty?

Finds the last string named property with the specified canonical identity.

Parameters

properties System.Collections.Generic.IEnumerable<OfficeIMO.Email.MapiProperty> requiredposition: 0
propertySet System.Guid requiredposition: 1
name System.String requiredposition: 2
public static T? GetMapiValueOrDefault<T>(IEnumerable<MapiProperty> properties, MapiPropertyKey<T?> key) #
Returns: T?

Reads a typed property, or the managed default when it is absent or incompatible.

Type Parameters

T

Parameters

properties System.Collections.Generic.IEnumerable<OfficeIMO.Email.MapiProperty> requiredposition: 0
key OfficeIMO.Email.MapiPropertyKey<T?> requiredposition: 1
GetMapiValue``1 3 overloads
public static T? GetMapiValue<T>(IEnumerable<MapiProperty> properties, UInt16 propertyId) #
Returns: T?

Gets a typed standard property value, or the default value when it is absent or has another type.

Type Parameters

T

Parameters

properties System.Collections.Generic.IEnumerable<OfficeIMO.Email.MapiProperty> requiredposition: 0
propertyId System.UInt16 requiredposition: 1
public static T? GetMapiValue<T>(IEnumerable<MapiProperty> properties, Guid propertySet, UInt32 localId) #
Returns: T?

Gets a typed numeric named property value, or the default value when it is absent or has another type.

Type Parameters

T

Parameters

properties System.Collections.Generic.IEnumerable<OfficeIMO.Email.MapiProperty> requiredposition: 0
propertySet System.Guid requiredposition: 1
localId System.UInt32 requiredposition: 2
public static T? GetMapiValue<T>(IEnumerable<MapiProperty> properties, Guid propertySet, String name) #
Returns: T?

Gets a typed string named property value, or the default value when it is absent or has another type.

Type Parameters

T

Parameters

properties System.Collections.Generic.IEnumerable<OfficeIMO.Email.MapiProperty> requiredposition: 0
propertySet System.Guid requiredposition: 1
name System.String requiredposition: 2
public static T? GetNullableMapiValue<T>(IEnumerable<MapiProperty> properties, MapiPropertyKey<T> key) #
Returns: T?

Reads a value-type property, or null when it is absent or incompatible.

Type Parameters

T

Parameters

properties System.Collections.Generic.IEnumerable<OfficeIMO.Email.MapiProperty> requiredposition: 0
key OfficeIMO.Email.MapiPropertyKey<T> requiredposition: 1
public static MapiProperty? GetRawMapiProperty(IEnumerable<MapiProperty> properties, MapiPropertyKey key) #
Returns: MapiProperty?

Finds the last property matching a typed key's identity without checking its wire type.

Parameters

properties System.Collections.Generic.IEnumerable<OfficeIMO.Email.MapiProperty> requiredposition: 0
key OfficeIMO.Email.MapiPropertyKey requiredposition: 1
public static Boolean TryGetMapiValue<T>(IEnumerable<MapiProperty> properties, MapiPropertyKey<T?> key, out T? value) #
Returns: Boolean

Attempts to read a property using a typed key.

Type Parameters

T

Parameters

properties System.Collections.Generic.IEnumerable<OfficeIMO.Email.MapiProperty> requiredposition: 0
key OfficeIMO.Email.MapiPropertyKey<T?> requiredposition: 1
value T? requiredposition: 2