mailslurp_netstandard_2x.Api.ExportControllerApi

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

MethodHTTP requestDescription
ExportEntitiesGET /exportExport inboxes link callable via browser
GetExportLinkPOST /exportGet export link

ExportEntities

byte[] ExportEntities (string apiKey, string exportType, string outputFormat, DateTime? createdEarliestTime = null, DateTime? createdOldestTime = null, bool? excludePreviouslyExported = null, string filter = null, string listSeparatorToken = null)

Export inboxes link callable via browser

Example

using System.Collections.Generic;
using System.Diagnostics;
using mailslurp_netstandard_2x.Api;
using mailslurp_netstandard_2x.Client;
using mailslurp_netstandard_2x.Model;

namespace Example
{
    public class ExportEntitiesExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "https://api.mailslurp.com";
            // Configure API key authorization: API_KEY
            config.AddApiKey("x-api-key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // config.AddApiKeyPrefix("x-api-key", "Bearer");

            var apiInstance = new ExportControllerApi(config);
            var apiKey = apiKey_example;  // string | apiKey
            var exportType = exportType_example;  // string | exportType
            var outputFormat = outputFormat_example;  // string | outputFormat
            var createdEarliestTime = 2013-10-20T19:20:30+01:00;  // DateTime? | createdEarliestTime (optional) 
            var createdOldestTime = 2013-10-20T19:20:30+01:00;  // DateTime? | createdOldestTime (optional) 
            var excludePreviouslyExported = true;  // bool? | excludePreviouslyExported (optional) 
            var filter = filter_example;  // string | filter (optional) 
            var listSeparatorToken = listSeparatorToken_example;  // string | listSeparatorToken (optional) 

            try
            {
                // Export inboxes link callable via browser
                byte[] result = apiInstance.ExportEntities(apiKey, exportType, outputFormat, createdEarliestTime, createdOldestTime, excludePreviouslyExported, filter, listSeparatorToken);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling ExportControllerApi.ExportEntities: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

NameTypeDescriptionNotes
apiKeystringapiKey
exportTypestringexportType
outputFormatstringoutputFormat
createdEarliestTimeDateTime?createdEarliestTime[optional]
createdOldestTimeDateTime?createdOldestTime[optional]
excludePreviouslyExportedbool?excludePreviouslyExported[optional]
filterstringfilter[optional]
listSeparatorTokenstringlistSeparatorToken[optional]

Return type

byte[]

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 ]

GetExportLink

ExportLink GetExportLink (string exportType, ExportOptions exportOptions, string apiKey = null)

Get export link

Example

using System.Collections.Generic;
using System.Diagnostics;
using mailslurp_netstandard_2x.Api;
using mailslurp_netstandard_2x.Client;
using mailslurp_netstandard_2x.Model;

namespace Example
{
    public class GetExportLinkExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "https://api.mailslurp.com";
            // Configure API key authorization: API_KEY
            config.AddApiKey("x-api-key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // config.AddApiKeyPrefix("x-api-key", "Bearer");

            var apiInstance = new ExportControllerApi(config);
            var exportType = exportType_example;  // string | exportType
            var exportOptions = new ExportOptions(); // ExportOptions | exportOptions
            var apiKey = apiKey_example;  // string | apiKey (optional) 

            try
            {
                // Get export link
                ExportLink result = apiInstance.GetExportLink(exportType, exportOptions, apiKey);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling ExportControllerApi.GetExportLink: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

NameTypeDescriptionNotes
exportTypestringexportType
exportOptionsExportOptionsexportOptions
apiKeystringapiKey[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 ]