API Reference

Class

EmailStoreDiagnostic

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

Structured diagnostic emitted while reading a mailbox store.

Inheritance

  • Object
  • EmailStoreDiagnostic

Usage

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

Constructors

EmailStoreDiagnostic 2 overloads
public EmailStoreDiagnostic(String code, String message, EmailStoreDiagnosticSeverity severity = Warning, String location = null) #

Creates a diagnostic.

Parameters

code System.String requiredposition: 0
message System.String requiredposition: 1
severity OfficeIMO.Email.Store.EmailStoreDiagnosticSeverity = Warning optionalposition: 2
location System.String = null optionalposition: 3
public EmailStoreDiagnostic(String code, String message, EmailStoreDiagnosticSeverity severity, String location, String operation, Nullable<Int64> byteOffset, String limitName, Nullable<Int64> actualValue, Nullable<Int64> maximumValue, EmailDiagnosticDisposition disposition, EmailDataLossRisk dataLossRisk, String suggestedAction, Boolean isRetryable = false) #

Creates an actionable store diagnostic with machine-readable operation and recovery context.

Parameters

code System.String requiredposition: 0
message System.String requiredposition: 1
severity OfficeIMO.Email.Store.EmailStoreDiagnosticSeverity requiredposition: 2
location System.String requiredposition: 3
operation System.String requiredposition: 4
byteOffset System.Nullable{System.Int64} requiredposition: 5
limitName System.String requiredposition: 6
actualValue System.Nullable{System.Int64} requiredposition: 7
maximumValue System.Nullable{System.Int64} requiredposition: 8
disposition OfficeIMO.Email.EmailDiagnosticDisposition requiredposition: 9
dataLossRisk OfficeIMO.Email.EmailDataLossRisk requiredposition: 10
suggestedAction System.String requiredposition: 11
isRetryable System.Boolean = false optionalposition: 12

Methods

public static EmailStoreDiagnostic FromLimit(EmailStoreLimitExceededException exception, String operation, String location = null, EmailDiagnosticDisposition disposition = Stopped, String code = "EMAIL_STORE_LIMIT_EXCEEDED") #
Returns: EmailStoreDiagnostic

Creates a non-sensitive actionable diagnostic for a bounded Store stop or skip.

Parameters

exception OfficeIMO.Email.Store.EmailStoreLimitExceededException requiredposition: 0
operation System.String requiredposition: 1
location System.String = null optionalposition: 2
disposition OfficeIMO.Email.EmailDiagnosticDisposition = Stopped optionalposition: 3
code System.String = "EMAIL_STORE_LIMIT_EXCEEDED" optionalposition: 4

Properties

public String Code { get; } #

Stable diagnostic code.

public String Message { get; } #

Human-readable description.

public EmailStoreDiagnosticSeverity Severity { get; } #

Diagnostic severity.

public String Location { get; } #

Logical source location.

public String Operation { get; } #

Store operation that emitted the diagnostic.

public Nullable<Int64> ByteOffset { get; } #

Source byte offset when available.

public String LimitName { get; } #

Configured resource limit associated with the diagnostic.

public Nullable<Int64> ActualValue { get; } #

Observed resource value.

public Nullable<Int64> MaximumValue { get; } #

Configured maximum resource value.

public EmailDiagnosticDisposition Disposition { get; } #

How processing continued after the condition.

public EmailDataLossRisk DataLossRisk { get; } #

Whether the condition can omit or alter user data.

public String SuggestedAction { get; } #

Safe next action for an operator or calling application.

public Boolean IsRetryable { get; } #

Whether retrying without changing source or policy can be useful.