maislurp-client-powershell.maislurp-client-powershell/Api.ExportControllerApi

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

MethodHTTP requestDescription
Export-EntitiesGET /exportExport inboxes link callable via browser
Get-ExportLinkPOST /exportGet export link

Export-Entities

SystemByte Export-Entities         [-ApiKey]         [-ExportType]         [-OutputFormat]         [-CreatedEarliestTime] <System.Nullable[System.DateTime]>         [-CreatedOldestTime] <System.Nullable[System.DateTime]>         [-ExcludePreviouslyExported] <System.Nullable[Boolean]>         [-Filter]         [-ListSeparatorToken]

Export inboxes link callable via browser

Example

# general setting of the PowerShell module, e.g. base URL, authentication, etc
$Configuration = Get-Configuration
# Configure API key authorization: API_KEY
$Configuration.ApiKey.x-api-key = "YOUR_API_KEY"
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$Configuration.ApiKeyPrefix.x-api-key = "Bearer"

$ApiKey = "ApiKey_example" # String | apiKey
$ExportType = "INBOXES" # String | exportType
$OutputFormat = "CSV_DEFAULT" # String | outputFormat
$CreatedEarliestTime = Get-Date # System.DateTime | createdEarliestTime (optional)
$CreatedOldestTime = Get-Date # System.DateTime | createdOldestTime (optional)
$ExcludePreviouslyExported = true # Boolean | excludePreviouslyExported (optional)
$Filter = "Filter_example" # String | filter (optional)
$ListSeparatorToken = "ListSeparatorToken_example" # String | listSeparatorToken (optional)

# Export inboxes link callable via browser
try {
     $Result = Export-Entities -ApiKey $ApiKey -ExportType $ExportType -OutputFormat $OutputFormat -CreatedEarliestTime $CreatedEarliestTime -CreatedOldestTime $CreatedOldestTime -ExcludePreviouslyExported $ExcludePreviouslyExported -Filter $Filter -ListSeparatorToken $ListSeparatorToken
} catch {
    Write-Host ("Exception occured when calling Export-Entities: {0}" -f ($_.ErrorDetails | ConvertFrom-Json))
    Write-Host ("Response headers: {0}" -f ($_.Exception.Response.Headers | ConvertTo-Json))
}

Parameters

NameTypeDescriptionNotes
ApiKeyStringapiKey
ExportTypeStringexportType
OutputFormatStringoutputFormat
CreatedEarliestTimeSystem.DateTimecreatedEarliestTime[optional]
CreatedOldestTimeSystem.DateTimecreatedOldestTime[optional]
ExcludePreviouslyExportedBooleanexcludePreviouslyExported[optional]
FilterStringfilter[optional]
ListSeparatorTokenStringlistSeparatorToken[optional]

Return type

SystemByte (PSCustomObject)

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-ExportLink

ExportLink Get-ExportLink         [-ExportType]         [-ExportOptions]         [-ApiKey]

Get export link

Example

# general setting of the PowerShell module, e.g. base URL, authentication, etc
$Configuration = Get-Configuration
# Configure API key authorization: API_KEY
$Configuration.ApiKey.x-api-key = "YOUR_API_KEY"
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$Configuration.ApiKeyPrefix.x-api-key = "Bearer"

$ExportType = "INBOXES" # String | exportType
$ExportOptions = (Initialize-ExportOptions -OutputFormat "CSV_DEFAULT" -ExcludePreviouslyExported $false -CreatedEarliestTime Get-Date -CreatedOldestTime Get-Date -VarFilter "VarFilter_example" -ListSeparatorToken "TODO") # ExportOptions | exportOptions
$ApiKey = "ApiKey_example" # String | apiKey (optional)

# Get export link
try {
     $Result = Get-ExportLink -ExportType $ExportType -ExportOptions $ExportOptions -ApiKey $ApiKey
} catch {
    Write-Host ("Exception occured when calling Get-ExportLink: {0}" -f ($_.ErrorDetails | ConvertFrom-Json))
    Write-Host ("Response headers: {0}" -f ($_.Exception.Response.Headers | ConvertTo-Json))
}

Parameters

NameTypeDescriptionNotes
ExportTypeStringexportType
ExportOptionsExportOptionsexportOptions
ApiKeyStringapiKey[optional]

Return type

ExportLink (PSCustomObject)

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 ]