mailslurp_client.ExportControllerApi

All URIs are relative to https://api.mailslurp.com

MethodHTTP requestDescription
export_entitiesGET /exportExport inboxes link callable via browser
get_export_linkPOST /exportGet export link

export_entities

str export_entities(api_key, export_type, output_format, created_earliest_time=created_earliest_time, created_oldest_time=created_oldest_time, exclude_previously_exported=exclude_previously_exported, filter=filter, list_separator_token=list_separator_token)

Export inboxes link callable via browser

Example

  • Api Key Authentication (API_KEY):
from __future__ import print_function
import time
import mailslurp_client
from mailslurp_client.rest import ApiException
from pprint import pprint
# Defining the host is optional and defaults to https://api.mailslurp.com
# See configuration.py for a list of all supported configuration parameters.
configuration = mailslurp_client.Configuration(
    host = "https://api.mailslurp.com"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure API key authorization: API_KEY
configuration = mailslurp_client.Configuration(
    host = "https://api.mailslurp.com",
    api_key = {
        'x-api-key': 'YOUR_API_KEY'
    }
)
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['x-api-key'] = 'Bearer'

# Enter a context with an instance of the API client
with mailslurp_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = mailslurp_client.ExportControllerApi(api_client)
    api_key = 'api_key_example' # str | apiKey
export_type = 'export_type_example' # str | exportType
output_format = 'output_format_example' # str | outputFormat
created_earliest_time = '2013-10-20T19:20:30+01:00' # datetime | createdEarliestTime (optional)
created_oldest_time = '2013-10-20T19:20:30+01:00' # datetime | createdOldestTime (optional)
exclude_previously_exported = True # bool | excludePreviouslyExported (optional)
filter = 'filter_example' # str | filter (optional)
list_separator_token = 'list_separator_token_example' # str | listSeparatorToken (optional)

    try:
        # Export inboxes link callable via browser
        api_response = api_instance.export_entities(api_key, export_type, output_format, created_earliest_time=created_earliest_time, created_oldest_time=created_oldest_time, exclude_previously_exported=exclude_previously_exported, filter=filter, list_separator_token=list_separator_token)
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling ExportControllerApi->export_entities: %sn" % e)

Parameters

NameTypeDescriptionNotes
api_keystrapiKey
export_typestrexportType
output_formatstroutputFormat
created_earliest_timedatetimecreatedEarliestTime[optional]
created_oldest_timedatetimecreatedOldestTime[optional]
exclude_previously_exportedboolexcludePreviouslyExported[optional]
filterstrfilter[optional]
list_separator_tokenstrlistSeparatorToken[optional]

Return type

str

Authorization

API_KEY

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

HTTP response details

Status codeDescriptionResponse headers
200OK-
401Unauthorized-
403Forbidden-
404Not Found-

[Back to top] [Back to API list] [Back to Model list] [Back to ]

ExportLink get_export_link(export_type, export_options, api_key=api_key)

Get export link

Example

  • Api Key Authentication (API_KEY):
from __future__ import print_function
import time
import mailslurp_client
from mailslurp_client.rest import ApiException
from pprint import pprint
# Defining the host is optional and defaults to https://api.mailslurp.com
# See configuration.py for a list of all supported configuration parameters.
configuration = mailslurp_client.Configuration(
    host = "https://api.mailslurp.com"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure API key authorization: API_KEY
configuration = mailslurp_client.Configuration(
    host = "https://api.mailslurp.com",
    api_key = {
        'x-api-key': 'YOUR_API_KEY'
    }
)
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['x-api-key'] = 'Bearer'

# Enter a context with an instance of the API client
with mailslurp_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = mailslurp_client.ExportControllerApi(api_client)
    export_type = 'export_type_example' # str | exportType
export_options = mailslurp_client.ExportOptions() # ExportOptions | exportOptions
api_key = 'api_key_example' # str | apiKey (optional)

    try:
        # Get export link
        api_response = api_instance.get_export_link(export_type, export_options, api_key=api_key)
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling ExportControllerApi->get_export_link: %sn" % e)

Parameters

NameTypeDescriptionNotes
export_typestrexportType
export_optionsExportOptionsexportOptions
api_keystrapiKey[optional]

Return type

ExportLink

Authorization

API_KEY

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

HTTP response details

Status codeDescriptionResponse headers
200OK-
201Created-
401Unauthorized-
403Forbidden-
404Not Found-

[Back to top] [Back to API list] [Back to Model list] [Back to ]