Interface IEmailTemplateResource

Namespace

Mailtrap.EmailTemplates

Assembly

Mailtrap.Abstractions.dll

Represents Email Template resource.

public interface IEmailTemplateResource : IRestResource

Inherited Members

IRestResource.ResourceUri

Methods

Delete(CancellationToken)

Deletes an email template, represented by the current resource instance.

Task Delete(CancellationToken cancellationToken = default)

Parameters

cancellationToken CancellationToken

Token to control operation cancellation.

Returns

Task

Nothing is returned upon successful deletion.

Remarks

After deletion of the email template, represented by the current resource instance, it will no longer be available.
Thus any further operations on it will result in an error.

GetDetails(CancellationToken)

Gets details of the email template, represented by the current resource instance.

Task<EmailTemplate> GetDetails(CancellationToken cancellationToken = default)

Parameters

cancellationToken CancellationToken

Token to control operation cancellation.

Returns

Task<EmailTemplate>

Requested email template details.

Update(UpdateEmailTemplateRequest, CancellationToken)

Updates the email template, represented by the current resource instance, with details specified by request.

Task<EmailTemplate> Update(UpdateEmailTemplateRequest request, CancellationToken cancellationToken = default)

Parameters

request UpdateEmailTemplateRequest

Email template details for update.

cancellationToken CancellationToken

Token to control operation cancellation.

Returns

Task<EmailTemplate>

Updated email template details.