maislurp-client-powershell.maislurp-client-powershell/Api.InboxForwarderControllerApi
All URIs are relative to https://api.mailslurp.com
Method | HTTP request | Description |
---|---|---|
New-NewInboxForwarder | POST /forwarders | Create an inbox forwarder |
Invoke-DeleteInboxForwarder | DELETE /forwarders/{id} | Delete an inbox forwarder |
Invoke-DeleteInboxForwarders | DELETE /forwarders | Delete inbox forwarders |
Get-InboxForwarder | GET /forwarders/{id} | Get an inbox forwarder |
Get-InboxForwarderEvents | GET /forwarders/{id}/events | Get an inbox forwarder event list |
Get-InboxForwarders | GET /forwarders | List inbox forwarders |
Test-InboxForwarder | POST /forwarders/{id}/test | Test an inbox forwarder |
Test-InboxForwardersForInbox | PUT /forwarders | Test inbox forwarders for inbox |
Test-NewInboxForwarder | PATCH /forwarders | Test new inbox forwarder |
Update-InboxForwarder | PUT /forwarders/{id} | Update an inbox forwarder |
InboxForwarderDto New-NewInboxForwarder
[-InboxId]
[-CreateInboxForwarderOptions]
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"
$InboxId = "InboxId_example" # String | Inbox id to attach forwarder to
$CreateInboxForwarderOptions = (Initialize-CreateInboxForwarderOptions -Field "RECIPIENTS" -Match "Match_example" -ForwardToRecipients @("ForwardToRecipients_example")) # CreateInboxForwarderOptions |
# Create an inbox forwarder
try {
$Result = New-NewInboxForwarder -InboxId $InboxId -CreateInboxForwarderOptions $CreateInboxForwarderOptions
} 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
Name | Type | Description | Notes |
---|---|---|---|
InboxId | String | Inbox id to attach forwarder to | |
CreateInboxForwarderOptions | CreateInboxForwarderOptions |
Return type
InboxForwarderDto (PSCustomObject)
Authorization
HTTP request headers
- Content-Type: application/json
- Accept: /
[Back to top] [Back to API list] [Back to Model list] [Back to ]
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
Name | Type | Description | Notes |
---|---|---|---|
Id | String | ID of inbox forwarder |
Return type
void (empty response body)
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: Not defined
[Back to top] [Back to API list] [Back to Model list] [Back to ]
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
Name | Type | Description | Notes |
---|---|---|---|
InboxId | String | Optional inbox id to attach forwarder to | [optional] |
Return type
void (empty response body)
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: Not defined
[Back to top] [Back to API list] [Back to Model list] [Back to ]
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
Name | Type | Description | Notes |
---|---|---|---|
Id | String | ID of inbox forwarder |
Return type
InboxForwarderDto (PSCustomObject)
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: /
[Back to top] [Back to API list] [Back to Model list] [Back to ]
PageInboxForwarderEvents Get-InboxForwarderEvents
[-Id]
[-Page]
[-Size]
[-Sort]
Get an inbox forwarder event list
Get inbox ruleset events
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
$Page = 987 # Int32 | Optional page in inbox forwarder event list pagination (optional) (default to 0)
$Size = 987 # Int32 | Optional page size in inbox forwarder event list pagination (optional) (default to 20)
$Sort = "ASC" # String | Optional createdAt sort direction ASC or DESC (optional) (default to "ASC")
# Get an inbox forwarder event list
try {
$Result = Get-InboxForwarderEvents -Id $Id -Page $Page -Size $Size -Sort $Sort
} catch {
Write-Host ("Exception occured when calling Get-InboxForwarderEvents: {0}" -f ($_.ErrorDetails | ConvertFrom-Json))
Write-Host ("Response headers: {0}" -f ($_.Exception.Response.Headers | ConvertTo-Json))
}
Parameters
Name | Type | Description | Notes |
---|---|---|---|
Id | String | ID of inbox forwarder | |
Page | Int32 | Optional page in inbox forwarder event list pagination | [optional] [default to 0] |
Size | Int32 | Optional page size in inbox forwarder event list pagination | [optional] [default to 20] |
Sort | String | Optional createdAt sort direction ASC or DESC | [optional] [default to "ASC"] |
Return type
PageInboxForwarderEvents (PSCustomObject)
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: /
[Back to top] [Back to API list] [Back to Model list] [Back to ]
PageInboxForwarderDto Get-InboxForwarders
[-InboxId]
[-Page]
[-Size]
[-Sort]
[-SearchFilter]
[-Since]
[-Before]
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)
$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")
$SearchFilter = "SearchFilter_example" # String | Optional search filter (optional)
$Since = Get-Date # System.DateTime | Filter by created at after the given timestamp (optional)
$Before = Get-Date # System.DateTime | Filter by created at before the given timestamp (optional)
# List inbox forwarders
try {
$Result = Get-InboxForwarders -InboxId $InboxId -Page $Page -Size $Size -Sort $Sort -SearchFilter $SearchFilter -Since $Since -Before $Before
} 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
Name | Type | Description | Notes |
---|---|---|---|
InboxId | String | Optional inbox id to get forwarders from | [optional] |
Page | Int32 | Optional page in inbox forwarder list pagination | [optional] [default to 0] |
Size | Int32 | Optional page size in inbox forwarder list pagination | [optional] [default to 20] |
Sort | String | Optional createdAt sort direction ASC or DESC | [optional] [default to "ASC"] |
SearchFilter | String | Optional search filter | [optional] |
Since | System.DateTime | Filter by created at after the given timestamp | [optional] |
Before | System.DateTime | Filter by created at before the given timestamp | [optional] |
Return type
PageInboxForwarderDto (PSCustomObject)
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: /
[Back to top] [Back to API list] [Back to Model list] [Back to ]
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 |
# 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
Name | Type | Description | Notes |
---|---|---|---|
Id | String | ID of inbox forwarder | |
InboxForwarderTestOptions | InboxForwarderTestOptions |
Return type
InboxForwarderTestResult (PSCustomObject)
Authorization
HTTP request headers
- Content-Type: application/json
- Accept: /
[Back to top] [Back to API list] [Back to Model list] [Back to ]
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 |
# 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
Name | Type | Description | Notes |
---|---|---|---|
InboxId | String | ID of inbox | |
InboxForwarderTestOptions | InboxForwarderTestOptions |
Return type
InboxForwarderTestResult (PSCustomObject)
Authorization
HTTP request headers
- Content-Type: application/json
- Accept: /
[Back to top] [Back to API list] [Back to Model list] [Back to ]
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 |
# 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
Name | Type | Description | Notes |
---|---|---|---|
TestNewInboxForwarderOptions | TestNewInboxForwarderOptions |
Return type
InboxForwarderTestResult (PSCustomObject)
Authorization
HTTP request headers
- Content-Type: application/json
- Accept: /
[Back to top] [Back to API list] [Back to Model list] [Back to ]
InboxForwarderDto Update-InboxForwarder
[-Id]
[-CreateInboxForwarderOptions]
Update an inbox forwarder
Update 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
$CreateInboxForwarderOptions = # CreateInboxForwarderOptions |
# Update an inbox forwarder
try {
$Result = Update-InboxForwarder -Id $Id -CreateInboxForwarderOptions $CreateInboxForwarderOptions
} catch {
Write-Host ("Exception occured when calling Update-InboxForwarder: {0}" -f ($_.ErrorDetails | ConvertFrom-Json))
Write-Host ("Response headers: {0}" -f ($_.Exception.Response.Headers | ConvertTo-Json))
}
Parameters
Name | Type | Description | Notes |
---|---|---|---|
Id | String | ID of inbox forwarder | |
CreateInboxForwarderOptions | CreateInboxForwarderOptions |
Return type
InboxForwarderDto (PSCustomObject)
Authorization
HTTP request headers
- Content-Type: application/json
- Accept: /
[Back to top] [Back to API list] [Back to Model list] [Back to ]