API Reference
EmailDiagnostic
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.Diagnostics
- Method EmailDiagnostic.FromLimit
- Property EmailLimitExceededException.Diagnostic
- Property EmailMailboxEntryReadResult.Diagnostics
- Property EmailMailboxReadResult.Diagnostics
- Property EmailPortableContentExportResult.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 System.String
- message System.String
- severity OfficeIMO.Email.EmailDiagnosticSeverity = Warning
- location System.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 System.String
- message System.String
- severity OfficeIMO.Email.EmailDiagnosticSeverity
- location System.String?
- lossKind OfficeIMO.OfficeConversionLossKind
public EmailDiagnostic(String code, String message, EmailDiagnosticSeverity severity, String? location, String? operation, Int64? byteOffset, String? limitName, Int64? actualValue, Int64? maximumValue, EmailDiagnosticDisposition disposition, EmailDataLossRisk dataLossRisk, String? suggestedAction, Boolean isRetryable = false) #Creates an actionable diagnostic with machine-readable operation and recovery context.
Parameters
- code System.String
- message System.String
- severity OfficeIMO.Email.EmailDiagnosticSeverity
- location System.String?
- operation System.String?
- byteOffset System.Int64?
- limitName System.String?
- actualValue System.Int64?
- maximumValue System.Int64?
- disposition OfficeIMO.Email.EmailDiagnosticDisposition
- dataLossRisk OfficeIMO.Email.EmailDataLossRisk
- suggestedAction System.String?
- isRetryable System.Boolean = false
public EmailDiagnostic(String code, String message, EmailDiagnosticSeverity severity, String? location, String? operation, Int64? byteOffset, String? limitName, Int64? actualValue, Int64? maximumValue, EmailDiagnosticDisposition disposition, EmailDataLossRisk dataLossRisk, String? suggestedAction, Boolean isRetryable, OfficeConversionLossKind lossKind) #Creates an actionable diagnostic with an explicit format-conversion fidelity effect.
Parameters
- code System.String
- message System.String
- severity OfficeIMO.Email.EmailDiagnosticSeverity
- location System.String?
- operation System.String?
- byteOffset System.Int64?
- limitName System.String?
- actualValue System.Int64?
- maximumValue System.Int64?
- disposition OfficeIMO.Email.EmailDiagnosticDisposition
- dataLossRisk OfficeIMO.Email.EmailDataLossRisk
- suggestedAction System.String?
- isRetryable System.Boolean
- lossKind OfficeIMO.OfficeConversionLossKind
Methods
public static EmailDiagnostic FromLimit(EmailLimitExceededException exception, String operation, String? location = null) #EmailDiagnosticCreates a non-sensitive actionable diagnostic for a bounded parser stop.
Parameters
- exception OfficeIMO.Email.EmailLimitExceededException
- operation System.String
- location System.String? = null
Inherited Methods
public virtual Boolean Equals(Object? obj) #BooleanParameters
- obj Object?
Properties
public String? Operation { get; } #Parser, writer, validation, or maintenance operation that emitted the diagnostic.
public Int64? 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 Boolean IsRetryable { get; } #Whether retrying the same operation without changing input or policy can be useful.