Class SendEmailRequestBuilder

Namespace

Mailtrap.Emails.Requests

Assembly

Mailtrap.dll

A set of helper methods to streamline SendEmailRequest instance construction using fluent style.

public static class SendEmailRequestBuilder

Inheritance

object

SendEmailRequestBuilder

Methods

Bcc(SendEmailRequest, params EmailAddress[])

Adds provided recipients to the Bcc recipient collection of the request.

public static SendEmailRequest Bcc(this SendEmailRequest request, params EmailAddress[] recipients)

Parameters

request SendEmailRequest

EmailRequest instance to update.

recipients EmailAddress[]

One or more EmailAddress objects to add to the request's recipient collection.

Returns

SendEmailRequest

Updated EmailRequest instance so subsequent calls can be chained.

Remarks

Duplicates can be added by calling this method multiple times with the same recipients.

Exceptions

ArgumentNullException

When request or recipients is null.

Bcc(SendEmailRequest, string, string?)

Adds provided email and displayName tuple as recipient to the Bcc recipient collection of the request.

public static SendEmailRequest Bcc(this SendEmailRequest request, string email, string? displayName = null)

Parameters

request SendEmailRequest

EmailRequest instance to update.

email string

Recipient's email address.

Required. Must be valid email address.

displayName string

Optional recipient's display name.

Returns

SendEmailRequest

Updated EmailRequest instance so subsequent calls can be chained.

Remarks

Duplicates can be added by calling this method multiple times with the same recipients.

Exceptions

ArgumentNullException

When request is null.
When email is null or Empty.

Cc(SendEmailRequest, params EmailAddress[])

Adds provided recipients to the Cc recipient collection of the request.

public static SendEmailRequest Cc(this SendEmailRequest request, params EmailAddress[] recipients)

Parameters

request SendEmailRequest

EmailRequest instance to update.

recipients EmailAddress[]

One or more EmailAddress objects to add to the request's recipient collection.

Returns

SendEmailRequest

Updated EmailRequest instance so subsequent calls can be chained.

Remarks

Duplicates can be added by calling this method multiple times with the same recipients.

Exceptions

ArgumentNullException

When request or recipients is null.

Cc(SendEmailRequest, string, string?)

Adds provided email and displayName tuple as recipient to the Cc recipient collection of the request.

public static SendEmailRequest Cc(this SendEmailRequest request, string email, string? displayName = null)

Parameters

request SendEmailRequest

EmailRequest instance to update.

email string

Recipient's email address.

Required. Must be valid email address.

displayName string

Optional recipient's display name.

Returns

SendEmailRequest

Updated EmailRequest instance so subsequent calls can be chained.

Remarks

Duplicates can be added by calling this method multiple times with the same recipients.

Exceptions

ArgumentNullException

When request is null.
When email is null or Empty.

To(SendEmailRequest, params EmailAddress[])

Adds provided recipients to the To recipient collection of the request.

public static SendEmailRequest To(this SendEmailRequest request, params EmailAddress[] recipients)

Parameters

request SendEmailRequest

EmailRequest instance to update.

recipients EmailAddress[]

One or more EmailAddress objects to add to the request's recipient collection.

Returns

SendEmailRequest

Updated EmailRequest instance so subsequent calls can be chained.

Remarks

Duplicates can be added by calling this method multiple times with the same recipients.

Exceptions

ArgumentNullException

When request or recipients is null.

To(SendEmailRequest, string, string?)

Adds provided email and displayName tuple as recipient to the To recipient collection of the request.

public static SendEmailRequest To(this SendEmailRequest request, string email, string? displayName = null)

Parameters

request SendEmailRequest

EmailRequest instance to update.

email string

Recipient's email address.

Required. Must be valid email address.

displayName string

Optional recipient's display name.

Returns

SendEmailRequest

Updated EmailRequest instance so subsequent calls can be chained.

Remarks

Duplicates can be added by calling this method multiple times with the same recipients.

Exceptions

ArgumentNullException

When request is null.
When email is null or Empty.