Skip to content

MailSlurp\ExportControllerApi

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

Method HTTP request Description
exportEntities() GET /export Export inboxes link callable via browser
getExportLink() POST /export Get export link

exportEntities()

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

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
);
$export_type = 'export_type_example'; // string
$api_key = 'api_key_example'; // string
$output_format = 'output_format_example'; // string
$filter = 'filter_example'; // string
$list_separator_token = 'list_separator_token_example'; // string
$exclude_previously_exported = True; // bool
$created_earliest_time = new DateTime("2013-10-20T19:20:30+01:00"); // DateTime
$created_oldest_time = new DateTime("2013-10-20T19:20:30+01:00"); // DateTime

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

Parameters

Name Type Description Notes
export_type string
api_key string
output_format string
filter string [optional]
list_separator_token string [optional]
exclude_previously_exported bool [optional]
created_earliest_time DateTime [optional]
created_oldest_time DateTime [optional]

Return type

string[]

Authorization

API_KEY

HTTP request headers

  • Content-Type: Not defined
  • Accept: */*

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

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

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
$export_options = new MailSlurpModelsExportOptions(); // MailSlurpModelsExportOptions
$api_key = 'api_key_example'; // string

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

Name Type Description Notes
export_type string
export_options MailSlurpModelsExportOptions
api_key string [optional]

Return type

MailSlurpModelsExportLink

Authorization

API_KEY

HTTP request headers

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

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