ExportControllerAPI

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

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

exportEntities

    open class func exportEntities( apiKey: String,  exportType: ExportType_exportEntities,  outputFormat: OutputFormat_exportEntities,  createdEarliestTime: Date? = nil,  createdOldestTime: Date? = nil,  excludePreviouslyExported: Bool? = nil,  filter: String? = nil,  listSeparatorToken: String? = nil) -> Promise<Data>

Export inboxes link callable via browser

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import mailslurp

let apiKey = "apiKey_example" // String | apiKey
let exportType = "exportType_example" // String | exportType
let outputFormat = "outputFormat_example" // String | outputFormat
let createdEarliestTime = Date() // Date | createdEarliestTime (optional)
let createdOldestTime = Date() // Date | createdOldestTime (optional)
let excludePreviouslyExported = true // Bool | excludePreviouslyExported (optional)
let filter = "filter_example" // String | filter (optional)
let listSeparatorToken = "listSeparatorToken_example" // String | listSeparatorToken (optional)

// Export inboxes link callable via browser
ExportControllerAPI.exportEntities(apiKey: apiKey, exportType: exportType, outputFormat: outputFormat, createdEarliestTime: createdEarliestTime, createdOldestTime: createdOldestTime, excludePreviouslyExported: excludePreviouslyExported, filter: filter, listSeparatorToken: listSeparatorToken).then {
         // when the promise is fulfilled
     }.always {
         // regardless of whether the promise is fulfilled, or rejected
     }.catch { errorType in
         // when the promise is rejected
}

Parameters

NameTypeDescriptionNotes
apiKeyStringapiKey
exportTypeStringexportType
outputFormatStringoutputFormat
createdEarliestTimeDatecreatedEarliestTime[optional]
createdOldestTimeDatecreatedOldestTime[optional]
excludePreviouslyExportedBoolexcludePreviouslyExported[optional]
filterStringfilter[optional]
listSeparatorTokenStringlistSeparatorToken[optional]

Return type

Data

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 ]

    open class func getExportLink( exportType: ExportType_getExportLink,  exportOptions: ExportOptions,  apiKey: String? = nil) -> Promise<ExportLink>

Get export link

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import mailslurp

let exportType = "exportType_example" // String | exportType
let exportOptions = ExportOptions(outputFormat: "outputFormat_example", excludePreviouslyExported: false, createdEarliestTime: Date(), createdOldestTime: Date(), filter: "filter_example", listSeparatorToken: "TODO") // ExportOptions | exportOptions
let apiKey = "apiKey_example" // String | apiKey (optional)

// Get export link
ExportControllerAPI.getExportLink(exportType: exportType, exportOptions: exportOptions, apiKey: apiKey).then {
         // when the promise is fulfilled
     }.always {
         // regardless of whether the promise is fulfilled, or rejected
     }.catch { errorType in
         // when the promise is rejected
}

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 ]