mailslurp
v15.17.22

MailSlurpAPI.Api.TemplateController (mailslurp v15.17.22)

API calls for all endpoints tagged TemplateController.

Summary

Functions

create_template(connection, create_template_options, opts \\ [])

Create a Template Create an email template with variables for use with templated transactional emails.

delete_template(connection, template_id, opts \\ [])

Delete email template Delete template

get_all_templates(connection, opts \\ [])

List templates Get all templates in paginated format

get_template(connection, template_id, opts \\ [])

Get template Get email template

get_template_preview_html(connection, template_id, opts \\ [])

Get template preview HTML Get email template preview with passed template variables in HTML format for browsers. Pass template variables as query params.

get_template_preview_json(connection, template_id, opts \\ [])

Get template preview Json Get email template preview with passed template variables in JSON format. Pass template variables as query params.

get_templates(connection, opts \\ [])

List templates Get all templates

update_template(connection, template_id, create_template_options, opts \\ [])

Update template Update email template

Functions

Link to this function

create_template(connection, create_template_options, opts \\ [])

@spec create_template(
  Tesla.Env.client(),
  MailSlurpAPI.Model.CreateTemplateOptions.t(),
  keyword()
) :: {:ok, MailSlurpAPI.Model.TemplateDto.t()} | {:error, Tesla.Env.t()}

Create a Template Create an email template with variables for use with templated transactional emails.

Parameters

  • connection (MailSlurpAPI.Connection): Connection to server
  • create_template_options (CreateTemplateOptions):
  • opts (KeywordList): [optional] Optional parameters

Returns

} on success {:error, info} on failure

Link to this function

delete_template(connection, template_id, opts \\ [])

@spec delete_template(Tesla.Env.client(), String.t(), keyword()) ::
  {:ok, nil} | {:error, Tesla.Env.t()}

Delete email template Delete template

Parameters

  • connection (MailSlurpAPI.Connection): Connection to server
  • template_id (String.t): Template ID
  • opts (KeywordList): [optional] Optional parameters

Returns

} on success {:error, info} on failure

Link to this function

get_all_templates(connection, opts \\ [])

@spec get_all_templates(Tesla.Env.client(), keyword()) ::
  {:ok, MailSlurpAPI.Model.PageTemplateProjection.t()} | {:error, Tesla.Env.t()}

List templates Get all templates in paginated format

Parameters

  • connection (MailSlurpAPI.Connection): Connection to server
  • opts (KeywordList): [optional] Optional parameters
    • :page (integer()): Optional page index in list pagination
    • :size (integer()): Optional page size in list pagination
    • :sort (String.t): Optional createdAt sort direction ASC or DESC
    • :since (DateTime.t): Filter by created at after the given timestamp
    • :before (DateTime.t): Filter by created at before the given timestamp

Returns

} on success {:error, info} on failure

Link to this function

get_template(connection, template_id, opts \\ [])

@spec get_template(Tesla.Env.client(), String.t(), keyword()) ::
  {:ok, MailSlurpAPI.Model.TemplateDto.t()} | {:error, Tesla.Env.t()}

Get template Get email template

Parameters

  • connection (MailSlurpAPI.Connection): Connection to server
  • template_id (String.t): Template ID
  • opts (KeywordList): [optional] Optional parameters

Returns

} on success {:error, info} on failure

Link to this function

get_template_preview_html(connection, template_id, opts \\ [])

@spec get_template_preview_html(Tesla.Env.client(), String.t(), keyword()) ::
  {:ok, String.t()} | {:error, Tesla.Env.t()}

Get template preview HTML Get email template preview with passed template variables in HTML format for browsers. Pass template variables as query params.

Parameters

  • connection (MailSlurpAPI.Connection): Connection to server
  • template_id (String.t): Template ID
  • opts (KeywordList): [optional] Optional parameters

Returns

} on success {:error, info} on failure

Link to this function

get_template_preview_json(connection, template_id, opts \\ [])

@spec get_template_preview_json(Tesla.Env.client(), String.t(), keyword()) ::
  {:ok, MailSlurpAPI.Model.TemplatePreview.t()} | {:error, Tesla.Env.t()}

Get template preview Json Get email template preview with passed template variables in JSON format. Pass template variables as query params.

Parameters

  • connection (MailSlurpAPI.Connection): Connection to server
  • template_id (String.t): Template ID
  • opts (KeywordList): [optional] Optional parameters

Returns

} on success {:error, info} on failure

Link to this function

get_templates(connection, opts \\ [])

@spec get_templates(Tesla.Env.client(), keyword()) ::
  {:ok, [MailSlurpAPI.Model.TemplateProjection.t()]} | {:error, Tesla.Env.t()}

List templates Get all templates

Parameters

  • connection (MailSlurpAPI.Connection): Connection to server
  • opts (KeywordList): [optional] Optional parameters

Returns

, ...]} on success {:error, info} on failure

Link to this function

update_template(connection, template_id, create_template_options, opts \\ [])

@spec update_template(
  Tesla.Env.client(),
  String.t(),
  MailSlurpAPI.Model.CreateTemplateOptions.t(),
  keyword()
) :: {:ok, MailSlurpAPI.Model.TemplateDto.t()} | {:error, Tesla.Env.t()}

Update template Update email template

Parameters

  • connection (MailSlurpAPI.Connection): Connection to server
  • template_id (String.t): Template ID
  • create_template_options (CreateTemplateOptions):
  • opts (KeywordList): [optional] Optional parameters

Returns

} on success {:error, info} on failure