mailslurp v12.4.2

MailSlurpAPI.Api.ExportController (mailslurp v12.4.2)

API calls for all endpoints tagged ExportController.

Link to this section Summary

Functions

export_entities(connection, api_key, export_type, 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, api_key, export_type, output_format, opts \\ [])

Specs

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

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

      Returns

} on success {:error, info} on failure

Link to this function

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

Specs

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

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

      Returns

} on success {:error, info} on failure