Table of Contents

Interface IEmailClient

Namespace
Mailtrap.Emails
Assembly
Mailtrap.Abstractions.dll

Mailtrap API client for sending emails.

public interface IEmailClient : IRestResource
Inherited Members

Methods

Send(SendEmailRequest, CancellationToken)

Sends email, represented by the request, and returns send operation result.

Task<SendEmailResponse> Send(SendEmailRequest request, CancellationToken cancellationToken = default)

Parameters

request SendEmailRequest

Request object, containing email data.

cancellationToken CancellationToken

Token to control operation cancellation.

Returns

Task<SendEmailResponse>

SendEmailResponse instance with response data.

Remarks

Request is checked for validity before send.
ArgumentException is thrown if validation fails.

Exceptions

ArgumentNullException

When request is null.

ArgumentException

When request contains invalid data.

JsonException

When request serialization or API response deserialization fails for any reason.

TaskCanceledException

When operation is canceled by cancellationToken.

OperationCanceledException

When operation is canceled by cancellationToken.

HttpRequestException

When request to the API fails for any reason.

MailtrapApiException

When request failed for any other reason.