maislurp-client-powershell.maislurp-client-powershell/Api.MissedEmailControllerApi

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

MethodHTTP requestDescription
Get-AllMissedEmailsGET /missed-emailsGet all MissedEmails in paginated format
Get-MissedEmailGET /missed-emails/{missedEmailId}Get MissedEmail
Wait-ForNthMissedEmailGET /missed-emails/waitForNthMissedEmailWait for Nth missed email

Get-AllMissedEmails

PageMissedEmailProjection Get-AllMissedEmails         [-InboxId]         [-Page] <System.Nullable[Int32]>         [-SearchFilter]         [-Size] <System.Nullable[Int32]>         [-Sort]

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"

$InboxId = "InboxId_example" # String | Optional inbox ID filter (optional)
$Page = 987 # Int32 | Optional page  in list pagination (optional) (default to 0)
$SearchFilter = "SearchFilter_example" # String | Optional search filter (optional)
$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")

# Get all MissedEmails in paginated format
try {
     $Result = Get-AllMissedEmails -InboxId $InboxId -Page $Page -SearchFilter $SearchFilter -Size $Size -Sort $Sort
} 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

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

Return type

PageMissedEmailProjection (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-MissedEmail

MissedEmail Get-MissedEmail         [-MissedEmailId]

Get MissedEmail

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

# 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

NameTypeDescriptionNotes
MissedEmailIdStringmissedEmailId

Return type

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

Wait-ForNthMissedEmail

MissedEmail Wait-ForNthMissedEmail         [-InboxId]         [-Index] <System.Nullable[Int32]>         [-Timeout] <System.Nullable[Int64]>

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"

$InboxId = "InboxId_example" # String | Optional inbox ID filter (optional)
$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 (optional)
$Timeout = 987 # Int64 | Optional timeout milliseconds (optional)

# Wait for Nth missed email
try {
     $Result = Wait-ForNthMissedEmail -InboxId $InboxId -Index $Index -Timeout $Timeout
} 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

NameTypeDescriptionNotes
InboxIdStringOptional inbox ID filter[optional]
IndexInt32Zero based of the email to wait for. If 1 missed email already and you want to wait for the 2nd email pass =1[optional]
TimeoutInt64Optional timeout milliseconds[optional]

Return type

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