Class BatchEmailResponse

Namespace

Mailtrap.Emails.Responses

Assembly

Mailtrap.Abstractions.dll

Represents batch send email response object.

public sealed record BatchEmailResponse : IEquatable<BatchEmailResponse>

Inheritance

object

BatchEmailResponse

Implements

IEquatable<BatchEmailResponse>

Properties

Errors

Gets errors, associated with the response.

[JsonPropertyName("errors")]
[JsonPropertyOrder(3)]
[JsonObjectCreationHandling(JsonObjectCreationHandling.Populate)]
public IList<string> Errors { get; }

Property Value

IList<string>

Collection of error(s) details.

Responses

Gets a collection of individual message responses that have been sent.

[JsonPropertyName("responses")]
[JsonPropertyOrder(2)]
[JsonObjectCreationHandling(JsonObjectCreationHandling.Populate)]
public IList<BatchSendEmailResponse> Responses { get; }

Property Value

IList<BatchSendEmailResponse>

A collection of individual message responses that have been sent.

Remarks

The order of results is the same as the original messages.

Success

Gets a flag, indicating whether request succeeded or failed and response contains error(s).

[JsonPropertyName("success")]
[JsonPropertyOrder(1)]
[JsonInclude]
public bool Success { get; }

Property Value

bool

false when request failed and response contains error(s).
true when request succeeded.