maislurp-client-powershell.maislurp-client-powershell/Api.InboxForwarderControllerApi

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

MethodHTTP requestDescription
New-NewInboxForwarderPOST /forwardersCreate an inbox forwarder
Invoke-DeleteInboxForwarderDELETE /forwarders/{id}Delete an inbox forwarder
Invoke-DeleteInboxForwardersDELETE /forwardersDelete inbox forwarders
Get-InboxForwarderGET /forwarders/{id}Get an inbox forwarder
Get-InboxForwardersGET /forwardersList inbox forwarders
Test-InboxForwarderPOST /forwarders/{id}/testTest an inbox forwarder
Test-InboxForwardersForInboxPUT /forwardersTest inbox forwarders for inbox
Test-NewInboxForwarderPATCH /forwardersTest new inbox forwarder

New-NewInboxForwarder

InboxForwarderDto New-NewInboxForwarder         [-CreateInboxForwarderOptions]         [-InboxId]

Create an inbox forwarder

Create a new inbox rule for forwarding, blocking, and allowing emails when sending and receiving

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"

$CreateInboxForwarderOptions = (Initialize-CreateInboxForwarderOptions -Field "RECIPIENTS" -Match "Match_example" -ForwardToRecipients @("ForwardToRecipients_example")) # CreateInboxForwarderOptions | createInboxForwarderOptions
$InboxId = "InboxId_example" # String | Inbox id to attach forwarder to (optional)

# Create an inbox forwarder
try {
     $Result = New-NewInboxForwarder -CreateInboxForwarderOptions $CreateInboxForwarderOptions -InboxId $InboxId
} catch {
    Write-Host ("Exception occured when calling New-NewInboxForwarder: {0}" -f ($_.ErrorDetails | ConvertFrom-Json))
    Write-Host ("Response headers: {0}" -f ($_.Exception.Response.Headers | ConvertTo-Json))
}

Parameters

NameTypeDescriptionNotes
CreateInboxForwarderOptionsCreateInboxForwarderOptionscreateInboxForwarderOptions
InboxIdStringInbox id to attach forwarder to[optional]

Return type

InboxForwarderDto (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 ]

Invoke-DeleteInboxForwarder

void Invoke-DeleteInboxForwarder         [-Id]

Delete an inbox forwarder

Delete inbox forwarder

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"

$Id = "Id_example" # String | ID of inbox forwarder

# Delete an inbox forwarder
try {
     $Result = Invoke-DeleteInboxForwarder -Id $Id
} catch {
    Write-Host ("Exception occured when calling Invoke-DeleteInboxForwarder: {0}" -f ($_.ErrorDetails | ConvertFrom-Json))
    Write-Host ("Response headers: {0}" -f ($_.Exception.Response.Headers | ConvertTo-Json))
}

Parameters

NameTypeDescriptionNotes
IdStringID of inbox forwarder

Return type

void (empty response body)

Authorization

API_KEY

HTTP request headers

  • Content-Type: Not defined
  • Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to ]

Invoke-DeleteInboxForwarders

void Invoke-DeleteInboxForwarders         [-InboxId]

Delete inbox forwarders

Delete inbox forwarders. Accepts optional inboxId filter.

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"

$InboxId = "InboxId_example" # String | Optional inbox id to attach forwarder to (optional)

# Delete inbox forwarders
try {
     $Result = Invoke-DeleteInboxForwarders -InboxId $InboxId
} catch {
    Write-Host ("Exception occured when calling Invoke-DeleteInboxForwarders: {0}" -f ($_.ErrorDetails | ConvertFrom-Json))
    Write-Host ("Response headers: {0}" -f ($_.Exception.Response.Headers | ConvertTo-Json))
}

Parameters

NameTypeDescriptionNotes
InboxIdStringOptional inbox id to attach forwarder to[optional]

Return type

void (empty response body)

Authorization

API_KEY

HTTP request headers

  • Content-Type: Not defined
  • Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to ]

Get-InboxForwarder

InboxForwarderDto Get-InboxForwarder         [-Id]

Get an inbox forwarder

Get inbox ruleset

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"

$Id = "Id_example" # String | ID of inbox forwarder

# Get an inbox forwarder
try {
     $Result = Get-InboxForwarder -Id $Id
} catch {
    Write-Host ("Exception occured when calling Get-InboxForwarder: {0}" -f ($_.ErrorDetails | ConvertFrom-Json))
    Write-Host ("Response headers: {0}" -f ($_.Exception.Response.Headers | ConvertTo-Json))
}

Parameters

NameTypeDescriptionNotes
IdStringID of inbox forwarder

Return type

InboxForwarderDto (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-InboxForwarders

PageInboxForwarderDto Get-InboxForwarders         [-InboxId]         [-Page] <System.Nullable[Int32]>         [-SearchFilter]         [-Size] <System.Nullable[Int32]>         [-Sort]

List inbox forwarders

List all forwarders attached to an inbox

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"

$InboxId = "InboxId_example" # String | Optional inbox id to get forwarders from (optional)
$Page = 987 # Int32 | Optional page  in inbox forwarder list pagination (optional) (default to 0)
$SearchFilter = "SearchFilter_example" # String | Optional search filter (optional)
$Size = 987 # Int32 | Optional page size in inbox forwarder list pagination (optional) (default to 20)
$Sort = "ASC" # String | Optional createdAt sort direction ASC or DESC (optional) (default to "ASC")

# List inbox forwarders
try {
     $Result = Get-InboxForwarders -InboxId $InboxId -Page $Page -SearchFilter $SearchFilter -Size $Size -Sort $Sort
} catch {
    Write-Host ("Exception occured when calling Get-InboxForwarders: {0}" -f ($_.ErrorDetails | ConvertFrom-Json))
    Write-Host ("Response headers: {0}" -f ($_.Exception.Response.Headers | ConvertTo-Json))
}

Parameters

NameTypeDescriptionNotes
InboxIdStringOptional inbox id to get forwarders from[optional]
PageInt32Optional page in inbox forwarder list pagination[optional] [default to 0]
SearchFilterStringOptional search filter[optional]
SizeInt32Optional page size in inbox forwarder list pagination[optional] [default to 20]
SortStringOptional createdAt sort direction ASC or DESC[optional] [default to “ASC”]

Return type

PageInboxForwarderDto (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 ]

Test-InboxForwarder

InboxForwarderTestResult Test-InboxForwarder         [-Id]         [-InboxForwarderTestOptions]

Test an inbox forwarder

Test an inbox forwarder

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"

$Id = "Id_example" # String | ID of inbox forwarder
$InboxForwarderTestOptions = (Initialize-InboxForwarderTestOptions -TestValue "TestValue_example") # InboxForwarderTestOptions | inboxForwarderTestOptions

# Test an inbox forwarder
try {
     $Result = Test-InboxForwarder -Id $Id -InboxForwarderTestOptions $InboxForwarderTestOptions
} catch {
    Write-Host ("Exception occured when calling Test-InboxForwarder: {0}" -f ($_.ErrorDetails | ConvertFrom-Json))
    Write-Host ("Response headers: {0}" -f ($_.Exception.Response.Headers | ConvertTo-Json))
}

Parameters

NameTypeDescriptionNotes
IdStringID of inbox forwarder
InboxForwarderTestOptionsInboxForwarderTestOptionsinboxForwarderTestOptions

Return type

InboxForwarderTestResult (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 ]

Test-InboxForwardersForInbox

InboxForwarderTestResult Test-InboxForwardersForInbox         [-InboxId]         [-InboxForwarderTestOptions]

Test inbox forwarders for inbox

Test inbox forwarders for inbox

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"

$InboxId = "InboxId_example" # String | ID of inbox
$InboxForwarderTestOptions = (Initialize-InboxForwarderTestOptions -TestValue "TestValue_example") # InboxForwarderTestOptions | inboxForwarderTestOptions

# Test inbox forwarders for inbox
try {
     $Result = Test-InboxForwardersForInbox -InboxId $InboxId -InboxForwarderTestOptions $InboxForwarderTestOptions
} catch {
    Write-Host ("Exception occured when calling Test-InboxForwardersForInbox: {0}" -f ($_.ErrorDetails | ConvertFrom-Json))
    Write-Host ("Response headers: {0}" -f ($_.Exception.Response.Headers | ConvertTo-Json))
}

Parameters

NameTypeDescriptionNotes
InboxIdStringID of inbox
InboxForwarderTestOptionsInboxForwarderTestOptionsinboxForwarderTestOptions

Return type

InboxForwarderTestResult (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 ]

Test-NewInboxForwarder

InboxForwarderTestResult Test-NewInboxForwarder         [-TestNewInboxForwarderOptions]

Test new inbox forwarder

Test new inbox forwarder

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"

$TestNewInboxForwarderOptions = (Initialize-TestNewInboxForwarderOptions -InboxForwarderTestOptions  -CreateInboxForwarderOptions (Initialize-CreateInboxForwarderOptions -Field "RECIPIENTS" -Match "Match_example" -ForwardToRecipients @("ForwardToRecipients_example"))) # TestNewInboxForwarderOptions | testNewInboxForwarderOptions

# Test new inbox forwarder
try {
     $Result = Test-NewInboxForwarder -TestNewInboxForwarderOptions $TestNewInboxForwarderOptions
} catch {
    Write-Host ("Exception occured when calling Test-NewInboxForwarder: {0}" -f ($_.ErrorDetails | ConvertFrom-Json))
    Write-Host ("Response headers: {0}" -f ($_.Exception.Response.Headers | ConvertTo-Json))
}

Parameters

NameTypeDescriptionNotes
TestNewInboxForwarderOptionsTestNewInboxForwarderOptionstestNewInboxForwarderOptions

Return type

InboxForwarderTestResult (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 ]