EmailDiagnostic
OfficeIMO.Email
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.
Returned or exposed by 24
- Property OfflineAddressBookDiscoveryReport.Diagnostics
- Property OfflineAddressBookEntry.Diagnostics
- Property OfflineAddressBookIdentityIndex.Diagnostics
- Property OfflineAddressBookSearchReport.Diagnostics
- Property OfflineAddressBookSession.Diagnostics
- Property OfflineAddressBookValidationResult.Diagnostics
- Property EmailAttachmentExtractionEntry.Diagnostics
- Property EmailAttachmentExtractionResult.Diagnostics
- Property EmailAttachmentTextResult.Diagnostics
- Property EmailCompositionResult.Diagnostics
- Property EmailContactReviewResult.Diagnostics
- Property EmailConversionReport.NativeDiagnostics
- Method EmailDiagnostic.FromLimit
- Property EmailLimitExceededException.Diagnostic
- Property EmailMailboxEntryReadResult.Diagnostics
- Property EmailMailboxReadResult.Diagnostics
- Property EmailPortableContentExportResult<T>.Diagnostics
- Property EmailReadResult.Diagnostics
- Property EmailShareCopyResult.Diagnostics
- Property EmailSmimeCreationResult.Diagnostics
- Property EmailSmimeDecryptionResult.Diagnostics
- Property EmailSmimeProcessingResult.Diagnostics
- Property EmailSmimeVerificationResult.Diagnostics
- Property EmailWriteResult.Diagnostics
Constructors
public EmailDiagnostic(string code, string message, EmailDiagnosticSeverity severity = Warning, string? location = null) #Creates a diagnostic.
Parameters
- code string
- message string
- severity OfficeIMO.Email.EmailDiagnosticSeverity = Warning
- location string? = null
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
- message string
- severity OfficeIMO.Email.EmailDiagnosticSeverity
- location string?
- lossKind OfficeIMO.OfficeConversionLossKind
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
- message string
- severity OfficeIMO.Email.EmailDiagnosticSeverity
- location string?
- operation string?
- byteOffset long?
- limitName string?
- actualValue long?
- maximumValue long?
- disposition OfficeIMO.Email.EmailDiagnosticDisposition
- dataLossRisk OfficeIMO.Email.EmailDataLossRisk
- suggestedAction string?
- isRetryable bool = false
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
- message string
- severity OfficeIMO.Email.EmailDiagnosticSeverity
- location string?
- operation string?
- byteOffset long?
- limitName string?
- actualValue long?
- maximumValue long?
- disposition OfficeIMO.Email.EmailDiagnosticDisposition
- dataLossRisk OfficeIMO.Email.EmailDataLossRisk
- suggestedAction string?
- isRetryable bool
- lossKind OfficeIMO.OfficeConversionLossKind
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
- operation string
- location string? = null
Returns
EmailDiagnosticInherited Methods
Properties
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 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.