mailslurp v15.13.15

MailSlurpAPI.Api.ExportController (mailslurp v15.13.15)

API calls for all endpoints tagged ExportController.

Link to this section Summary

Functions

export_entities(connection, export_type, api_key, output_format, opts \\ [])

Export inboxes link callable via browser

get_export_link(connection, export_type, export_options, opts \\ [])

Get export link

Link to this section Functions

Link to this function

export_entities(connection, export_type, api_key, output_format, opts \\ [])

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

Export inboxes link callable via browser

parameters

 Parameters

  • connection (MailSlurpAPI.Connection): Connection to server
  • export_type (String.t):
  • api_key (String.t):
  • output_format (String.t):
  • opts (KeywordList): [optional] Optional parameters
    • :filter (String.t):
    • :list_separator_token (String.t):
    • :exclude_previously_exported (boolean()):
    • :created_earliest_time (DateTime.t):
    • :created_oldest_time (DateTime.t):

returns

 Returns

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

Link to this function

get_export_link(connection, export_type, export_options, opts \\ [])

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

Get export link

parameters

 Parameters

  • connection (MailSlurpAPI.Connection): Connection to server
  • export_type (String.t):
  • export_options (ExportOptions):
  • opts (KeywordList): [optional] Optional parameters
    • :api_key (String.t):

returns

 Returns

} on success {:error, info} on failure