Skip to main content
SearchCtrl K
Community

Source code

OfficeIMO.NET libraries, PowerShell module, CLI, Studio and browser tools 606 stars

Talk and help

DiscordQuestions, ideas and show and tell Report an issueBugs and feature requests SponsorFund ongoing development

Mode

Background

Search OfficeIMO

Enter a topic, API type, or PowerShell command.

Search the whole siteOpen search page →
Documentation Search all OfficeIMO/

API Reference

Class

EmailStoreDiagnostic

Edit on GitHub
Namespace OfficeIMO.Email.Store
Assembly OfficeIMO.Email
Source revision 804a7612eee4 with working tree changes
Source EmailStoreDiagnostic.cs:27
Modifiers sealed

Structured diagnostic emitted while reading a mailbox store.

Inheritance

  • Object
  • EmailStoreDiagnostic

Usage

Explore 26 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.

Returned or exposed by 26

Constructors

EmailStoreDiagnostic 2 overloads
public EmailStoreDiagnostic(String code, String message, EmailStoreDiagnosticSeverity severity = Warning, String? location = null) #
EmailStoreDiagnostic.cs:27

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, Int64? byteOffset, String? limitName, Int64? actualValue, Int64? maximumValue, EmailDiagnosticDisposition disposition, EmailDataLossRisk dataLossRisk, String? suggestedAction, Boolean isRetryable = false) #
EmailStoreDiagnostic.cs:40

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.Int64? requiredposition: 5
limitName System.String? requiredposition: 6
actualValue System.Int64? requiredposition: 7
maximumValue 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") #
EmailStoreDiagnostic.cs:19
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; } #
EmailStoreDiagnostic.cs:61

Stable diagnostic code.

public String Message { get; } #
EmailStoreDiagnostic.cs:64

Human-readable description.

public EmailStoreDiagnosticSeverity Severity { get; } #
EmailStoreDiagnostic.cs:67

Diagnostic severity.

public String? Location { get; } #
EmailStoreDiagnostic.cs:70

Logical source location.

public String? Operation { get; } #
EmailStoreDiagnostic.cs:72

Store operation that emitted the diagnostic.

public Int64? ByteOffset { get; } #
EmailStoreDiagnostic.cs:74

Source byte offset when available.

public String? LimitName { get; } #
EmailStoreDiagnostic.cs:76

Configured resource limit associated with the diagnostic.

public Int64? ActualValue { get; } #
EmailStoreDiagnostic.cs:78

Observed resource value.

public Int64? MaximumValue { get; } #
EmailStoreDiagnostic.cs:80

Configured maximum resource value.

public EmailDiagnosticDisposition Disposition { get; } #
EmailStoreDiagnostic.cs:82

How processing continued after the condition.

public EmailDataLossRisk DataLossRisk { get; } #
EmailStoreDiagnostic.cs:84

Whether the condition can omit or alter user data.

public String? SuggestedAction { get; } #
EmailStoreDiagnostic.cs:86

Safe next action for an operator or calling application.

public Boolean IsRetryable { get; } #
EmailStoreDiagnostic.cs:88

Whether retrying without changing source or policy can be useful.