Skip to main content

Search OfficeIMO

Enter a topic, API type, or PowerShell command.

Documentation Search all OfficeIMO/
Class

EmailDiagnostic

OfficeIMO.Email

Namespace
OfficeIMO.Email
Assembly
OfficeIMO.Email
Source revision
9931e96ab849 with working tree changes
Modifiers
sealed

Structured diagnostic produced while reading or writing an email artifact.

Inheritance

  • object
  • EmailDiagnostic

Usage

Explore 24 API references to this type

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

Constructors

EmailDiagnostic 4 overloads
public EmailDiagnostic(string code, string message, EmailDiagnosticSeverity severity = Warning, string? location = null) #

Creates a diagnostic.

Parameters

code string required
message string required
severity OfficeIMO.Email.EmailDiagnosticSeverity = Warning optional
location string? = null optional
public EmailDiagnostic(string code, string message, EmailDiagnosticSeverity severity, string? location, OfficeConversionLossKind lossKind) #

Creates a diagnostic with an explicit format-conversion fidelity effect.

Parameters

code string required
message string required
severity OfficeIMO.Email.EmailDiagnosticSeverity required
location string? required
lossKind OfficeIMO.OfficeConversionLossKind required
public EmailDiagnostic(string code, string message, EmailDiagnosticSeverity severity, string? location, string? operation, long? byteOffset, string? limitName, long? actualValue, long? maximumValue, EmailDiagnosticDisposition disposition, EmailDataLossRisk dataLossRisk, string? suggestedAction, bool isRetryable = false) #

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

Parameters

code string required
message string required
severity OfficeIMO.Email.EmailDiagnosticSeverity required
location string? required
operation string? required
byteOffset long? required
limitName string? required
actualValue long? required
maximumValue long? required
disposition OfficeIMO.Email.EmailDiagnosticDisposition required
dataLossRisk OfficeIMO.Email.EmailDataLossRisk required
suggestedAction string? required
isRetryable bool = false optional
public EmailDiagnostic(string code, string message, EmailDiagnosticSeverity severity, string? location, string? operation, long? byteOffset, string? limitName, long? actualValue, long? maximumValue, EmailDiagnosticDisposition disposition, EmailDataLossRisk dataLossRisk, string? suggestedAction, bool isRetryable, OfficeConversionLossKind lossKind) #

Creates an actionable diagnostic with an explicit format-conversion fidelity effect.

Parameters

code string required
message string required
severity OfficeIMO.Email.EmailDiagnosticSeverity required
location string? required
operation string? required
byteOffset long? required
limitName string? required
actualValue long? required
maximumValue long? required
disposition OfficeIMO.Email.EmailDiagnosticDisposition required
dataLossRisk OfficeIMO.Email.EmailDataLossRisk required
suggestedAction string? required
isRetryable bool required
lossKind OfficeIMO.OfficeConversionLossKind required

Methods

public static EmailDiagnostic FromLimit(EmailLimitExceededException exception, string operation, string? location = null) #

Creates a non-sensitive actionable diagnostic for a bounded parser stop.

Parameters

exception OfficeIMO.Email.EmailLimitExceededException required
operation string required
location string? = null optional

Properties

public string Code { get; } #

Stable diagnostic identifier.

public string Message { get; } #

Human-readable diagnostic message.

public EmailDiagnosticSeverity Severity { get; } #

Diagnostic severity.

public string? Location { get; } #

Logical source location.

public string? Operation { get; } #

Parser, writer, validation, or maintenance operation that emitted the diagnostic.

public long? ByteOffset { get; } #

Source byte offset when the format exposes a stable position.

public string? LimitName { get; } #

Configured resource limit associated with the diagnostic.

public long? ActualValue { get; } #

Observed resource value.

public long? 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 OfficeConversionLossKind LossKind { get; } #

Exact fidelity effect when this diagnostic participates in a format conversion.

public string? SuggestedAction { get; } #

Safe next action for an operator or calling application.

public bool IsRetryable { get; } #

Whether retrying the same operation without changing input or policy can be useful.