MailSlurp::ExportControllerApi

Load the API package

use MailSlurp::Object::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

string export_entities(api_key => $api_key, export_type => $export_type, output_format => $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

use Data::Dumper;
use MailSlurp::ExportControllerApi;
my $api_instance = MailSlurp::ExportControllerApi->new(

    # Configure API key authorization: API_KEY
    api_key => {'x-api-key' => 'YOUR_API_KEY'},
    # uncomment below to setup prefix (e.g. Bearer) for API key, if needed
    #api_key_prefix => {'x-api-key' => 'Bearer'},
);

my $api_key = "api_key_example"; # string | apiKey
my $export_type = "export_type_example"; # string | exportType
my $output_format = "output_format_example"; # string | outputFormat
my $created_earliest_time = DateTime->from_epoch(epoch => str2time('null')); # DateTime | createdEarliestTime
my $created_oldest_time = DateTime->from_epoch(epoch => str2time('null')); # DateTime | createdOldestTime
my $exclude_previously_exported = null; # boolean | excludePreviouslyExported
my $filter = "filter_example"; # string | filter
my $list_separator_token = "list_separator_token_example"; # string | listSeparatorToken

eval { 
    my $result = $api_instance->export_entities(api_key => $api_key, export_type => $export_type, output_format => $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);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ExportControllerApi->export_entities: $@n";
}

Parameters

NameTypeDescriptionNotes
api_keystringapiKey
export_typestringexportType
output_formatstringoutputFormat
created_earliest_timeDateTimecreatedEarliestTime[optional]
created_oldest_timeDateTimecreatedOldestTime[optional]
exclude_previously_exportedbooleanexcludePreviouslyExported[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 ]

get_export_link

ExportLink get_export_link(export_type => $export_type, export_options => $export_options, api_key => $api_key)

Get export link

Example

use Data::Dumper;
use MailSlurp::ExportControllerApi;
my $api_instance = MailSlurp::ExportControllerApi->new(

    # Configure API key authorization: API_KEY
    api_key => {'x-api-key' => 'YOUR_API_KEY'},
    # uncomment below to setup prefix (e.g. Bearer) for API key, if needed
    #api_key_prefix => {'x-api-key' => 'Bearer'},
);

my $export_type = "export_type_example"; # string | exportType
my $export_options = MailSlurp::Object::ExportOptions->new(); # ExportOptions | exportOptions
my $api_key = "api_key_example"; # string | apiKey

eval { 
    my $result = $api_instance->get_export_link(export_type => $export_type, export_options => $export_options, api_key => $api_key);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ExportControllerApi->get_export_link: $@n";
}

Parameters

NameTypeDescriptionNotes
export_typestringexportType
export_optionsExportOptionsexportOptions
api_keystringapiKey[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 ]