Class ProviderDeliveryResult

Namespace

MailForge.Models

Assembly

MailForge.dll

The outcome of a single delivery attempt reported by an IEmailProvider. Providers report transient service failures by throwing EmailException with IsTransient set to true.

public sealed class ProviderDeliveryResult

Inheritance

object

ProviderDeliveryResult

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.ReferenceEquals(object, object)

object.ToString()

Constructors

ProviderDeliveryResult(bool, string?, string?)

Creates a result.

public ProviderDeliveryResult(bool succeeded, string? providerMessageId = null, string? details = null)

Parameters

succeeded bool

providerMessageId string

details string

Properties

Details

A human-readable description of the outcome.

public string? Details { get; }

Property Value

string

ProviderMessageId

A provider-specific message identifier (for example, a Resend or SES id).

public string? ProviderMessageId { get; }

Property Value

string

Succeeded

True when the provider accepted the message for delivery.

public bool Succeeded { get; }

Property Value

bool

Methods

Failure(string)

A failed result.

public static ProviderDeliveryResult Failure(string details)

Parameters

details string

Returns

ProviderDeliveryResult

Success(string?, string?)

A successful result without a provider message id.

public static ProviderDeliveryResult Success(string? providerMessageId = null, string? details = null)

Parameters

providerMessageId string

details string

Returns

ProviderDeliveryResult