mailslurp.api.ExportControllerApi

Load the API package

import 'package:mailslurp/api.dart';

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(apiKey, exportType, outputFormat, createdEarliestTime, createdOldestTime, excludePreviouslyExported, filter, listSeparatorToken)

Export inboxes link callable via browser

Example

import 'package:mailslurp/api.dart';
// TODO Configure API key authorization: API_KEY
//defaultApiClient.getAuthentication<ApiKeyAuth>('API_KEY').apiKey = 'YOUR_API_KEY';
// uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//defaultApiClient.getAuthentication<ApiKeyAuth>('API_KEY').apiKeyPrefix = 'Bearer';

final api_instance = ExportControllerApi();
final apiKey = apiKey_example; // String | apiKey
final exportType = exportType_example; // String | exportType
final outputFormat = outputFormat_example; // String | outputFormat
final createdEarliestTime = 2013-10-20T19:20:30+01:00; // DateTime | createdEarliestTime
final createdOldestTime = 2013-10-20T19:20:30+01:00; // DateTime | createdOldestTime
final excludePreviouslyExported = true; // bool | excludePreviouslyExported
final filter = filter_example; // String | filter
final listSeparatorToken = listSeparatorToken_example; // String | listSeparatorToken

try { 
    final result = api_instance.exportEntities(apiKey, exportType, outputFormat, createdEarliestTime, createdOldestTime, excludePreviouslyExported, filter, listSeparatorToken);
    print(result);
} catch (e) {
    print('Exception when calling ExportControllerApi->exportEntities: $en');
}

Parameters

NameTypeDescriptionNotes
apiKeyStringapiKey
exportTypeStringexportType
outputFormatStringoutputFormat
createdEarliestTimeDateTimecreatedEarliestTime[optional]
createdOldestTimeDateTimecreatedOldestTime[optional]
excludePreviouslyExportedboolexcludePreviouslyExported[optional]
filterStringfilter[optional]
listSeparatorTokenStringlistSeparatorToken[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 ]

getExportLink

ExportLink getExportLink(exportType, exportOptions, apiKey)

Get export link

Example

import 'package:mailslurp/api.dart';
// TODO Configure API key authorization: API_KEY
//defaultApiClient.getAuthentication<ApiKeyAuth>('API_KEY').apiKey = 'YOUR_API_KEY';
// uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//defaultApiClient.getAuthentication<ApiKeyAuth>('API_KEY').apiKeyPrefix = 'Bearer';

final api_instance = ExportControllerApi();
final exportType = exportType_example; // String | exportType
final exportOptions = ExportOptions(); // ExportOptions | exportOptions
final apiKey = apiKey_example; // String | apiKey

try { 
    final result = api_instance.getExportLink(exportType, exportOptions, apiKey);
    print(result);
} catch (e) {
    print('Exception when calling ExportControllerApi->getExportLink: $en');
}

Parameters

NameTypeDescriptionNotes
exportTypeStringexportType
exportOptionsExportOptionsexportOptions
apiKeyStringapiKey[optional]

Return type

ExportLink

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 ]