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

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

PageMissedEmailProjection Get-AllMissedEmails         [-Page] <System.Nullable[Int32]>         [-Size] <System.Nullable[Int32]>         [-Sort]         [-SearchFilter]         [-Since] <System.Nullable[System.DateTime]>         [-Before] <System.Nullable[System.DateTime]>         [-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

NameTypeDescriptionNotes
PageInt32Optional page in list pagination[optional] [default to 0]
SizeInt32Optional page size in list pagination[optional] [default to 20]
SortStringOptional createdAt sort direction ASC or DESC[optional] [default to “ASC”]
SearchFilterStringOptional search filter[optional]
SinceSystem.DateTimeFilter by created at after the given timestamp[optional]
BeforeSystem.DateTimeFilter by created at before the given timestamp[optional]
InboxIdStringOptional inbox ID filter[optional]

Return type

PageMissedEmailProjection (PSCustomObject)

Authorization

API_KEY

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] <System.Nullable[Int32]>         [-Size] <System.Nullable[Int32]>         [-Sort]         [-SearchFilter]         [-Since] <System.Nullable[System.DateTime]>         [-Before] <System.Nullable[System.DateTime]>         [-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

NameTypeDescriptionNotes
PageInt32Optional page in list pagination[optional] [default to 0]
SizeInt32Optional page size in list pagination[optional] [default to 20]
SortStringOptional createdAt sort direction ASC or DESC[optional] [default to “ASC”]
SearchFilterStringOptional search filter[optional]
SinceSystem.DateTimeFilter by created at after the given timestamp[optional]
BeforeSystem.DateTimeFilter by created at before the given timestamp[optional]
InboxIdStringOptional inbox ID filter[optional]

Return type

PageUnknownMissedEmailProjection (PSCustomObject)

Authorization

API_KEY

HTTP request headers

  • Content-Type: Not defined
  • Accept: /

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

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 | 

# 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
MissedEmailIdString

Return type

MissedEmail (PSCustomObject)

Authorization

API_KEY

HTTP request headers

  • Content-Type: Not defined
  • Accept: /

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

MissedEmail Wait-ForNthMissedEmail         [-Index]         [-InboxId]         [-Timeout] <System.Nullable[Int64]>         [-Since] <System.Nullable[System.DateTime]>         [-Before] <System.Nullable[System.DateTime]>

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

NameTypeDescriptionNotes
IndexInt32Zero based of the email to wait for. If 1 missed email already and you want to wait for the 2nd email pass =1
InboxIdStringOptional inbox ID filter[optional]
TimeoutInt64Optional timeout milliseconds[optional]
SinceSystem.DateTimeFilter by created at after the given timestamp[optional]
BeforeSystem.DateTimeFilter by created at before the given timestamp[optional]

Return type

MissedEmail (PSCustomObject)

Authorization

API_KEY

HTTP request headers

  • Content-Type: Not defined
  • Accept: /

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