API Reference

Class

EmailStoreConfigurationDictionary

Namespace OfficeIMO.Email.Store
Assembly OfficeIMO.Email
Modifiers sealed

Lossless typed editor for the documented Outlook roaming dictionary XML schema. Unsupported entries and unknown XML nodes are retained.

Inheritance

  • Object
  • EmailStoreConfigurationDictionary

Usage

This type appears in these public API surfaces even when no hand-authored example is attached directly to the page.

Methods

public static EmailStoreConfigurationDictionary Create(String producerVersion = "OfficeIMO.1") #
Returns: EmailStoreConfigurationDictionary

Creates an empty dictionary with an OfficeIMO producer version.

Parameters

producerVersion System.String = "OfficeIMO.1" optionalposition: 0
public static EmailStoreConfigurationDictionary Parse(Byte[] bytes, Int32 maxXmlBytes = 4194304) #
Returns: EmailStoreConfigurationDictionary

Parses one bounded PidTagRoamingDictionary stream.

Parameters

bytes System.Byte[] requiredposition: 0
maxXmlBytes System.Int32 = 4194304 optionalposition: 1
public Boolean Remove(String key) #
Returns: Boolean

Removes one exact dictionary key.

Parameters

key System.String requiredposition: 0
Set 3 overloads
public Void Set(String key, Boolean value) #
Returns: Void

Creates or replaces a Boolean entry.

Parameters

key System.String requiredposition: 0
value System.Boolean requiredposition: 1
public Void Set(String key, Int32 value) #
Returns: Void

Creates or replaces a signed Int32 entry.

Parameters

key System.String requiredposition: 0
value System.Int32 requiredposition: 1
public Void Set(String key, String value) #
Returns: Void

Creates or replaces a Unicode string entry.

Parameters

key System.String requiredposition: 0
value System.String requiredposition: 1
public Byte[] ToXml() #
Returns: Byte[]

Serializes the current lossless dictionary XML.

public Boolean TryGet(String key, out EmailStoreConfigurationValue value) #
Returns: Boolean

Gets one decoded entry.

Parameters

key System.String requiredposition: 0
value OfficeIMO.Email.Store.EmailStoreConfigurationValue@ requiredposition: 1

Properties

public String ProducerVersion { get; } #

Producer/version string declared by the dictionary.

public IReadOnlyDictionary<String, EmailStoreConfigurationValue> Entries { get; } #

Decoded entries keyed case-sensitively as required by the XML uniqueness contract.

public Boolean IsProtocolEnvelopeValid { get; } #

True when the envelope, producer version, keys, and all values use supported valid encodings.