MailSlurpExportControllerApi

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

MethodHTTP requestDescription
exportEntitiesGET /exportExport inboxes link callable via browser
getExportLinkPOST /exportGet export link

exportEntities

string exportEntities($api_key, $export_type, $output_format, $created_earliest_time, $created_oldest_time, $exclude_previously_exported, $filter, $list_separator_token)

Export inboxes link callable via browser

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure API key authorization: API_KEY
$config = MailSlurpConfiguration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = MailSlurpConfiguration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');


$apiInstance = new MailSlurpApiExportControllerApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttpClientInterface`.
    // This is optional, `GuzzleHttpClient` will be used as default.
    new GuzzleHttpClient(),
    $config
);
$api_key = 'api_key_example'; // string | apiKey
$export_type = 'export_type_example'; // string | exportType
$output_format = 'output_format_example'; // string | outputFormat
$created_earliest_time = new DateTime("2013-10-20T19:20:30+01:00"); // DateTime | createdEarliestTime
$created_oldest_time = new DateTime("2013-10-20T19:20:30+01:00"); // DateTime | createdOldestTime
$exclude_previously_exported = True; // bool | excludePreviouslyExported
$filter = 'filter_example'; // string | filter
$list_separator_token = 'list_separator_token_example'; // string | listSeparatorToken

try {
    $result = $apiInstance->exportEntities($api_key, $export_type, $output_format, $created_earliest_time, $created_oldest_time, $exclude_previously_exported, $filter, $list_separator_token);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ExportControllerApi->exportEntities: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

NameTypeDescriptionNotes
api_keystringapiKey
export_typestringexportType
output_formatstringoutputFormat
created_earliest_timeDateTimecreatedEarliestTime[optional]
created_oldest_timeDateTimecreatedOldestTime[optional]
exclude_previously_exportedboolexcludePreviouslyExported[optional]
filterstringfilter[optional]
list_separator_tokenstringlistSeparatorToken[optional]

Return type

string

Authorization

API_KEY

HTTP request headers

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

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

MailSlurpModelsExportLink getExportLink($export_type, $export_options, $api_key)

Get export link

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure API key authorization: API_KEY
$config = MailSlurpConfiguration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = MailSlurpConfiguration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');


$apiInstance = new MailSlurpApiExportControllerApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttpClientInterface`.
    // This is optional, `GuzzleHttpClient` will be used as default.
    new GuzzleHttpClient(),
    $config
);
$export_type = 'export_type_example'; // string | exportType
$export_options = new MailSlurpModelsExportOptions(); // MailSlurpModelsExportOptions | exportOptions
$api_key = 'api_key_example'; // string | apiKey

try {
    $result = $apiInstance->getExportLink($export_type, $export_options, $api_key);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ExportControllerApi->getExportLink: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

NameTypeDescriptionNotes
export_typestringexportType
export_optionsMailSlurpModelsExportOptionsexportOptions
api_keystringapiKey[optional]

Return type

MailSlurpModelsExportLink

Authorization

API_KEY

HTTP request headers

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

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