Class EmailSendResult

Namespace

CMS.EmailEngine

Assembly

CMS.EmailEngine.dll

Represents state of the send operation made by an instance of IEmailClient.

public record EmailSendResult

Inheritance

object

EmailSendResult

Extension Methods

DataExtensions.With<T>(T, Action<T>)

QueryExtensions.AsLiteral<T>(T)

QueryExtensions.AsValue<T>(T, bool)

Constructors

EmailSendResult(EmailSendResult)

protected EmailSendResult(EmailSendResult original)

Parameters

original EmailSendResult

EmailSendResult(bool, string)

Creates instance of EmailSendResult.

public EmailSendResult(bool success, string sendResult = null)

Parameters

success bool

true indicates that the send operation was successful.

sendResult string

Allows to pass details about the send operation.

Properties

EqualityContract

protected virtual Type EqualityContract { get; }

Property Value

Type

SendResult

May contain details about the send operation in case of failure.

public string SendResult { get; init; }

Property Value

string

Success

Indicates if the send operation was successful or not.

public bool Success { get; init; }

Property Value

bool

Methods

Equals(EmailSendResult?)

public virtual bool Equals(EmailSendResult? other)

Parameters

other EmailSendResult

Returns

bool

Equals(object?)

public override bool Equals(object? obj)

Parameters

obj object

Returns

bool

GetHashCode()

public override int GetHashCode()

Returns

int

PrintMembers(StringBuilder)

protected virtual bool PrintMembers(StringBuilder builder)

Parameters

builder StringBuilder

Returns

bool

ToString()

public override string ToString()

Returns

string

Operators

operator ==(EmailSendResult?, EmailSendResult?)

public static bool operator ==(EmailSendResult? left, EmailSendResult? right)

Parameters

left EmailSendResult

right EmailSendResult

Returns

bool

operator !=(EmailSendResult?, EmailSendResult?)

public static bool operator !=(EmailSendResult? left, EmailSendResult? right)

Parameters

left EmailSendResult

right EmailSendResult

Returns

bool

See Also

SendEmail(EmailMessage, CancellationToken)