Package io.mailtrap.api.templates

Interface Templates

All Known Implementing Classes:
TemplatesImpl
public interface Templates
Templates API. The /api/templates endpoints are experimental: their request and response shapes may change before general availability.

  • Method Details

    • getTemplates

      TemplateListResponse getTemplates(long accountId, TemplateListFilter filter)
      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.
      Parameters:
      accountId - unique account ID
      filter - pagination parameters, may be null
      Returns:
      templates of the requested page with pagination metadata

    • createTemplate

      TemplateResponse createTemplate(long accountId, CreateTemplateRequest request)
      Create a new template
      Parameters:
      accountId - unique account ID
      request - template create payload
      Returns:
      created template

    • getTemplate

      TemplateResponse getTemplate(long accountId, long templateId)
      Get a template by ID
      Parameters:
      accountId - unique account ID
      templateId - unique template ID
      Returns:
      template attributes

    • updateTemplate

      TemplateResponse updateTemplate(long accountId, long templateId, UpdateTemplateRequest request)
      Update a template
      Parameters:
      accountId - unique account ID
      templateId - unique template ID
      request - template update payload, only the provided fields are changed
      Returns:
      updated template

    • deleteTemplate

      void deleteTemplate(long accountId, long templateId)
      Delete a template
      Parameters:
      accountId - unique account ID
      templateId - unique template ID