Class SendEmailRequest

Namespace

Mailtrap.Emails.Requests

Assembly

Mailtrap.Abstractions.dll

Represents request object used to send email, including recipient lists.

public sealed record SendEmailRequest : EmailRequest, IValidatable, IEquatable<EmailRequest>, IEquatable<SendEmailRequest>

Inheritance

object

EmailRequest

SendEmailRequest

Implements

IValidatable

IEquatable<EmailRequest>

IEquatable<SendEmailRequest>

Inherited Members

EmailRequest.From

EmailRequest.ReplyTo

EmailRequest.Subject

EmailRequest.TextBody

EmailRequest.HtmlBody

EmailRequest.Attachments

EmailRequest.Headers

EmailRequest.Category

EmailRequest.CustomVariables

EmailRequest.TemplateId

EmailRequest.TemplateVariables

Extension Methods

EmailRequestBuilder.Attach<T>(T, params Attachment[])

EmailRequestBuilder.Attach<T>(T, string, string, DispositionType?, string?, string?)

EmailRequestBuilder.Category<T>(T, string?)

EmailRequestBuilder.CustomVariable<T>(T, params KeyValuePair<string, string>[])

EmailRequestBuilder.CustomVariable<T>(T, string, string)

EmailRequestBuilder.From<T>(T, EmailAddress)

EmailRequestBuilder.From<T>(T, string, string?)

EmailRequestBuilder.Header<T>(T, params KeyValuePair<string, string>[])

EmailRequestBuilder.Header<T>(T, string, string)

EmailRequestBuilder.Html<T>(T, string?)

EmailRequestBuilder.ReplyTo<T>(T, EmailAddress?)

EmailRequestBuilder.ReplyTo<T>(T, string, string?)

EmailRequestBuilder.Subject<T>(T, string)

EmailRequestBuilder.TemplateVariables<T>(T, object?)

EmailRequestBuilder.Template<T>(T, string)

EmailRequestBuilder.Text<T>(T, string?)

SendEmailRequestBuilder.Bcc(SendEmailRequest, params EmailAddress[])

SendEmailRequestBuilder.Bcc(SendEmailRequest, string, string?)

SendEmailRequestBuilder.Cc(SendEmailRequest, params EmailAddress[])

SendEmailRequestBuilder.Cc(SendEmailRequest, string, string?)

SendEmailRequestBuilder.To(SendEmailRequest, params EmailAddress[])

SendEmailRequestBuilder.To(SendEmailRequest, string, string?)

Properties

Bcc

Gets or sets a collection of EmailAddress objects, defining who will receive a blind carbon copy of email.

[JsonPropertyName("bcc")]
[JsonPropertyOrder(230)]
public IList<EmailAddress> Bcc { get; set; }

Property Value

IList<EmailAddress>

A collection of EmailAddress objects.

Remarks

Each object in this collection must contain the recipient's email address.
Each object in this collection may optionally contain the recipient's name.
At least one recipient must be specified in one of the collections: To, Cc or Bcc.
The total recipients across To, Cc and Bcc must not exceed 1000.

Cc

Gets or sets a collection of EmailAddress objects, defining who will receive a carbon copy of email.

[JsonPropertyName("cc")]
[JsonPropertyOrder(220)]
public IList<EmailAddress> Cc { get; set; }

Property Value

IList<EmailAddress>

A collection of EmailAddress objects.

Remarks

Each object in this collection must contain the recipient's email address.
Each object in this collection may optionally contain the recipient's name.
At least one recipient must be specified in one of the collections: To, Cc or Bcc.
The total recipients across To, Cc and Bcc must not exceed 1000.

To

Gets or sets a collection of EmailAddress objects, defining who will receive a copy of email.

[JsonPropertyName("to")]
[JsonPropertyOrder(210)]
public IList<EmailAddress> To { get; set; }

Property Value

IList<EmailAddress>

A collection of EmailAddress objects.

Remarks

Each object in this collection must contain the recipient's email address.
Each object in this collection may optionally contain the recipient's name.
At least one recipient must be specified in one of the collections: To, Cc or Bcc.
The total recipients across To, Cc and Bcc must not exceed 1000.

Methods

Create()

Factory method that creates a new instance of SendEmailRequest request.

public static SendEmailRequest Create()

Returns

SendEmailRequest

New SendEmailRequest instance.

Validate()

Validates the current instance.

public override ValidationResult Validate()

Returns

ValidationResult

Object containing validation errors, if any.