maislurp-client-powershell.maislurp-client-powershell/Api.ExportControllerApi
All URIs are relative to https://api.mailslurp.com
Method | HTTP request | Description |
---|---|---|
Export-Entities | GET /export | Export inboxes link callable via browser |
Get-ExportLink | POST /export | Get export link |
SystemByte[] Export-Entities
[-ExportType]
[-ApiKey]
[-OutputFormat]
[-Filter]
[-ListSeparatorToken]
[-ExcludePreviouslyExported]
[-CreatedEarliestTime]
[-CreatedOldestTime]
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"
$ExportType = "INBOXES" # String |
$ApiKey = "ApiKey_example" # String |
$OutputFormat = "CSV_DEFAULT" # String |
$Filter = "Filter_example" # String | (optional)
$ListSeparatorToken = "ListSeparatorToken_example" # String | (optional)
$ExcludePreviouslyExported = true # Boolean | (optional)
$CreatedEarliestTime = Get-Date # System.DateTime | (optional)
$CreatedOldestTime = Get-Date # System.DateTime | (optional)
# Export inboxes link callable via browser
try {
$Result = Export-Entities -ExportType $ExportType -ApiKey $ApiKey -OutputFormat $OutputFormat -Filter $Filter -ListSeparatorToken $ListSeparatorToken -ExcludePreviouslyExported $ExcludePreviouslyExported -CreatedEarliestTime $CreatedEarliestTime -CreatedOldestTime $CreatedOldestTime
} 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
Name | Type | Description | Notes |
---|---|---|---|
ExportType | String | ||
ApiKey | String | ||
OutputFormat | String | ||
Filter | String | [optional] | |
ListSeparatorToken | String | [optional] | |
ExcludePreviouslyExported | Boolean | [optional] | |
CreatedEarliestTime | System.DateTime | [optional] | |
CreatedOldestTime | System.DateTime | [optional] |
Return type
SystemByte[] (PSCustomObject)
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: /
[Back to top] [Back to API list] [Back to Model list] [Back to ]
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 |
$ExportOptions = (Initialize-ExportOptions -OutputFormat "CSV_DEFAULT" -ExcludePreviouslyExported $false -CreatedEarliestTime Get-Date -CreatedOldestTime Get-Date -VarFilter "VarFilter_example" -ListSeparatorToken "ListSeparatorToken_example") # ExportOptions |
$ApiKey = "ApiKey_example" # String | (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
Name | Type | Description | Notes |
---|---|---|---|
ExportType | String | ||
ExportOptions | ExportOptions | ||
ApiKey | String | [optional] |
Return type
ExportLink (PSCustomObject)
Authorization
HTTP request headers
- Content-Type: application/json
- Accept: /
[Back to top] [Back to API list] [Back to Model list] [Back to ]