Package io.mailtrap.api.templates

Class TemplatesImpl

java.lang.Object

io.mailtrap.api.apiresource.ApiResource

io.mailtrap.api.apiresource.ApiResourceWithValidation

io.mailtrap.api.templates.TemplatesImpl

All Implemented Interfaces:

Templates

public class TemplatesImpl
extends ApiResourceWithValidation
implements Templates

Field Summary

Fields inherited from class io.mailtrap.api.apiresource.ApiResourceWithValidation

mailtrapValidator

Fields inherited from class io.mailtrap.api.apiresource.ApiResource

apiHost, httpClient, token

Constructor Summary

Constructors

Constructor	Description
TemplatesImpl(MailtrapConfig config, MailtrapValidator mailtrapValidator)

Method Summary

Modifier and Type	Method	Description
TemplateResponse	createTemplate(long accountId, CreateTemplateRequest request)	Create a new template
void	deleteTemplate(long accountId, long templateId)	Delete a template
TemplateResponse	getTemplate(long accountId, long templateId)	Get a template by ID
TemplateListResponse	getTemplates(long accountId, TemplateListFilter filter)	Get a page of templates existing in your account.
TemplateResponse	updateTemplate(long accountId, long templateId, UpdateTemplateRequest request)	Update a template

Methods inherited from class io.mailtrap.api.apiresource.ApiResourceWithValidation

validateRequestBodyAndThrowException

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

TemplatesImpl

public TemplatesImpl(MailtrapConfig config,
 MailtrapValidator mailtrapValidator)

Method Details

getTemplates

public TemplateListResponse getTemplates(long accountId,
 TemplateListFilter filter)

Description copied from interface: Templates

Get a page of templates existing in your account. Unlike EmailTemplates.getAllTemplates(long), it does not return every template: pass getPagination().getNextToken() with the same perPage to get the next page.

Specified by:

getTemplates in interface Templates

Parameters:

accountId - unique account ID

filter - pagination parameters, may be null

Returns:

templates of the requested page with pagination metadata

createTemplate

public TemplateResponse createTemplate(long accountId,
 CreateTemplateRequest request)

Description copied from interface: Templates

Create a new template

Specified by:

createTemplate in interface Templates

Parameters:

accountId - unique account ID

request - template create payload

Returns:

created template

getTemplate

public TemplateResponse getTemplate(long accountId,
 long templateId)

Description copied from interface: Templates

Get a template by ID

Specified by:

getTemplate in interface Templates

Parameters:

accountId - unique account ID

templateId - unique template ID

Returns:

template attributes

updateTemplate

public TemplateResponse updateTemplate(long accountId,
 long templateId,
 UpdateTemplateRequest request)

Description copied from interface: Templates

Update a template

Specified by:

updateTemplate in interface Templates

Parameters:

accountId - unique account ID

templateId - unique template ID

request - template update payload, only the provided fields are changed

Returns:

updated template

deleteTemplate

public void deleteTemplate(long accountId,
 long templateId)

Description copied from interface: Templates

Delete a template

Specified by:

deleteTemplate in interface Templates

Parameters:

accountId - unique account ID

templateId - unique template ID