maislurp-client-powershell.maislurp-client-powershell/Api.MissedEmailControllerApi
All URIs are relative to https://api.mailslurp.com
Method | HTTP request | Description |
---|---|---|
Get-AllMissedEmails | GET /missed-emails | Get all MissedEmails in paginated format |
Get-AllUnknownMissedEmails | GET /missed-emails/unknown | Get all unknown missed emails in paginated format |
Get-MissedEmail | GET /missed-emails/{missedEmailId} | Get MissedEmail |
Restore-MissedEmails | POST /missed-emails/restore | Restore missed emails |
Wait-ForNthMissedEmail | GET /missed-emails/waitForNthMissedEmail | Wait for Nth missed email |
PageMissedEmailProjection Get-AllMissedEmails
[-Page]
[-Size]
[-Sort]
[-SearchFilter]
[-Since]
[-Before]
[-InboxId]
Get all MissedEmails in paginated format
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"
$Page = 987 # Int32 | Optional page in list pagination (optional) (default to 0)
$Size = 987 # Int32 | Optional page size in 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)
$InboxId = "InboxId_example" # String | Optional inbox ID filter (optional)
# Get all MissedEmails in paginated format
try {
$Result = Get-AllMissedEmails -Page $Page -Size $Size -Sort $Sort -SearchFilter $SearchFilter -Since $Since -Before $Before -InboxId $InboxId
} catch {
Write-Host ("Exception occured when calling Get-AllMissedEmails: {0}" -f ($_.ErrorDetails | ConvertFrom-Json))
Write-Host ("Response headers: {0}" -f ($_.Exception.Response.Headers | ConvertTo-Json))
}
Parameters
Name | Type | Description | Notes |
---|---|---|---|
Page | Int32 | Optional page in list pagination | [optional] [default to 0] |
Size | Int32 | Optional page size in 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] |
InboxId | String | Optional inbox ID filter | [optional] |
Return type
PageMissedEmailProjection (PSCustomObject)
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: /
[Back to top] [Back to API list] [Back to Model list] [Back to ]
PageUnknownMissedEmailProjection Get-AllUnknownMissedEmails
[-Page]
[-Size]
[-Sort]
[-SearchFilter]
[-Since]
[-Before]
[-InboxId]
Get all unknown missed emails in paginated format
Unknown missed emails are emails that were sent to MailSlurp but could not be assigned to an existing 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"
$Page = 987 # Int32 | Optional page in list pagination (optional) (default to 0)
$Size = 987 # Int32 | Optional page size in 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)
$InboxId = "InboxId_example" # String | Optional inbox ID filter (optional)
# Get all unknown missed emails in paginated format
try {
$Result = Get-AllUnknownMissedEmails -Page $Page -Size $Size -Sort $Sort -SearchFilter $SearchFilter -Since $Since -Before $Before -InboxId $InboxId
} catch {
Write-Host ("Exception occured when calling Get-AllUnknownMissedEmails: {0}" -f ($_.ErrorDetails | ConvertFrom-Json))
Write-Host ("Response headers: {0}" -f ($_.Exception.Response.Headers | ConvertTo-Json))
}
Parameters
Name | Type | Description | Notes |
---|---|---|---|
Page | Int32 | Optional page in list pagination | [optional] [default to 0] |
Size | Int32 | Optional page size in 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] |
InboxId | String | Optional inbox ID filter | [optional] |
Return type
PageUnknownMissedEmailProjection (PSCustomObject)
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: /
[Back to top] [Back to API list] [Back to Model list] [Back to ]
MissedEmailDto Get-MissedEmail
[-MissedEmailId]
Get MissedEmail
List emails that were missed due to plan limits.
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"
$MissedEmailId = "MissedEmailId_example" # String |
# Get MissedEmail
try {
$Result = Get-MissedEmail -MissedEmailId $MissedEmailId
} catch {
Write-Host ("Exception occured when calling Get-MissedEmail: {0}" -f ($_.ErrorDetails | ConvertFrom-Json))
Write-Host ("Response headers: {0}" -f ($_.Exception.Response.Headers | ConvertTo-Json))
}
Parameters
Name | Type | Description | Notes |
---|---|---|---|
MissedEmailId | String |
Return type
MissedEmailDto (PSCustomObject)
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: /
[Back to top] [Back to API list] [Back to Model list] [Back to ]
void Restore-MissedEmails
Restore missed emails
If emails were missed due to a plan limit they are saved as missed emails. If support team enables the canRestore flag these emails can be reload into your account using this method.
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"
# Restore missed emails
try {
$Result = Restore-MissedEmails
} catch {
Write-Host ("Exception occured when calling Restore-MissedEmails: {0}" -f ($_.ErrorDetails | ConvertFrom-Json))
Write-Host ("Response headers: {0}" -f ($_.Exception.Response.Headers | ConvertTo-Json))
}
Parameters
This endpoint does not need any parameter.
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 ]
MissedEmailDto Wait-ForNthMissedEmail
[-Index]
[-InboxId]
[-Timeout]
[-Since]
[-Before]
Wait for Nth missed email
Wait for 0 based missed email
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"
$Index = 987 # Int32 | Zero based of the email to wait for. If 1 missed email already and you want to wait for the 2nd email pass =1
$InboxId = "InboxId_example" # String | Optional inbox ID filter (optional)
$Timeout = 987 # Int64 | Optional timeout milliseconds (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)
# Wait for Nth missed email
try {
$Result = Wait-ForNthMissedEmail -Index $Index -InboxId $InboxId -Timeout $Timeout -Since $Since -Before $Before
} catch {
Write-Host ("Exception occured when calling Wait-ForNthMissedEmail: {0}" -f ($_.ErrorDetails | ConvertFrom-Json))
Write-Host ("Response headers: {0}" -f ($_.Exception.Response.Headers | ConvertTo-Json))
}
Parameters
Name | Type | Description | Notes |
---|---|---|---|
Index | Int32 | Zero based of the email to wait for. If 1 missed email already and you want to wait for the 2nd email pass =1 | |
InboxId | String | Optional inbox ID filter | [optional] |
Timeout | Int64 | Optional timeout milliseconds | [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
MissedEmailDto (PSCustomObject)
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: /
[Back to top] [Back to API list] [Back to Model list] [Back to ]