maislurp-client-powershell.maislurp-client-powershell/Api.SentEmailsControllerApi

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

MethodHTTP requestDescription
Get-AllSentTrackingPixelsGET /sent/tracking-pixelsGet all sent email tracking pixels in paginated form
Get-SentEmailGET /sent/{id}Get sent email receipt
Get-SentEmailHTMLContentGET /sent/{id}/htmlGet sent email HTML content
Get-SentEmailTrackingPixelsGET /sent/{id}/tracking-pixelsGet all tracking pixels for a sent email in paginated form
Get-SentEmailsGET /sentGet all sent emails in paginated form
Get-SentOrganizationEmailsGET /sent/organizationGet all sent organization emails in paginated form

Get-AllSentTrackingPixels

PageTrackingPixelProjection Get-AllSentTrackingPixels         [-Before] <System.Nullable[System.DateTime]>         [-Page] <System.Nullable[Int32]>         [-SearchFilter]         [-Since] <System.Nullable[System.DateTime]>         [-Size] <System.Nullable[Int32]>         [-Sort]

Get all sent email tracking pixels in paginated form

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"

$Before = Get-Date # System.DateTime | Filter by created at before the given timestamp (optional)
$Page = 987 # Int32 | Optional page  in sent email tracking pixel list pagination (optional) (default to 0)
$SearchFilter = "SearchFilter_example" # String | Optional search filter (optional)
$Since = Get-Date # System.DateTime | Filter by created at after the given timestamp (optional)
$Size = 987 # Int32 | Optional page size in sent email tracking pixel list pagination (optional) (default to 20)
$Sort = "ASC" # String | Optional createdAt sort direction ASC or DESC (optional) (default to "ASC")

# Get all sent email tracking pixels in paginated form
try {
     $Result = Get-AllSentTrackingPixels -Before $Before -Page $Page -SearchFilter $SearchFilter -Since $Since -Size $Size -Sort $Sort
} catch {
    Write-Host ("Exception occured when calling Get-AllSentTrackingPixels: {0}" -f ($_.ErrorDetails | ConvertFrom-Json))
    Write-Host ("Response headers: {0}" -f ($_.Exception.Response.Headers | ConvertTo-Json))
}

Parameters

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

Return type

PageTrackingPixelProjection (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-SentEmail

SentEmailDto Get-SentEmail         [-Id]

Get sent email receipt

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

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

Parameters

NameTypeDescriptionNotes
IdStringid

Return type

SentEmailDto (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-SentEmailHTMLContent

String Get-SentEmailHTMLContent         [-Id]

Get sent email HTML content

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

# Get sent email HTML content
try {
     $Result = Get-SentEmailHTMLContent -Id $Id
} catch {
    Write-Host ("Exception occured when calling Get-SentEmailHTMLContent: {0}" -f ($_.ErrorDetails | ConvertFrom-Json))
    Write-Host ("Response headers: {0}" -f ($_.Exception.Response.Headers | ConvertTo-Json))
}

Parameters

NameTypeDescriptionNotes
IdStringid

Return type

String

Authorization

API_KEY

HTTP request headers

  • Content-Type: Not defined
  • Accept: text/html

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

Get-SentEmailTrackingPixels

PageTrackingPixelProjection Get-SentEmailTrackingPixels         [-Id]         [-Before] <System.Nullable[System.DateTime]>         [-Page] <System.Nullable[Int32]>         [-SearchFilter]         [-Since] <System.Nullable[System.DateTime]>         [-Size] <System.Nullable[Int32]>         [-Sort]

Get all tracking pixels for a sent email in paginated form

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
$Before = Get-Date # System.DateTime | Filter by created at before the given timestamp (optional)
$Page = 987 # Int32 | Optional page  in sent email tracking pixel list pagination (optional) (default to 0)
$SearchFilter = "SearchFilter_example" # String | Optional search filter (optional)
$Since = Get-Date # System.DateTime | Filter by created at after the given timestamp (optional)
$Size = 987 # Int32 | Optional page size in sent email tracking pixel list pagination (optional) (default to 20)
$Sort = "ASC" # String | Optional createdAt sort direction ASC or DESC (optional) (default to "ASC")

# Get all tracking pixels for a sent email in paginated form
try {
     $Result = Get-SentEmailTrackingPixels -Id $Id -Before $Before -Page $Page -SearchFilter $SearchFilter -Since $Since -Size $Size -Sort $Sort
} catch {
    Write-Host ("Exception occured when calling Get-SentEmailTrackingPixels: {0}" -f ($_.ErrorDetails | ConvertFrom-Json))
    Write-Host ("Response headers: {0}" -f ($_.Exception.Response.Headers | ConvertTo-Json))
}

Parameters

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

Return type

PageTrackingPixelProjection (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-SentEmails

PageSentEmailProjection Get-SentEmails         [-Before] <System.Nullable[System.DateTime]>         [-InboxId]         [-Page] <System.Nullable[Int32]>         [-SearchFilter]         [-Since] <System.Nullable[System.DateTime]>         [-Size] <System.Nullable[Int32]>         [-Sort]

Get all sent emails in paginated form

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"

$Before = Get-Date # System.DateTime | Filter by created at before the given timestamp (optional)
$InboxId = "InboxId_example" # String | Optional inboxId to filter sender of sent emails by (optional)
$Page = 987 # Int32 | Optional page  in inbox sent email list pagination (optional) (default to 0)
$SearchFilter = "SearchFilter_example" # String | Optional search filter (optional)
$Since = Get-Date # System.DateTime | Filter by created at after the given timestamp (optional)
$Size = 987 # Int32 | Optional page size in inbox sent email list pagination (optional) (default to 20)
$Sort = "ASC" # String | Optional createdAt sort direction ASC or DESC (optional) (default to "ASC")

# Get all sent emails in paginated form
try {
     $Result = Get-SentEmails -Before $Before -InboxId $InboxId -Page $Page -SearchFilter $SearchFilter -Since $Since -Size $Size -Sort $Sort
} catch {
    Write-Host ("Exception occured when calling Get-SentEmails: {0}" -f ($_.ErrorDetails | ConvertFrom-Json))
    Write-Host ("Response headers: {0}" -f ($_.Exception.Response.Headers | ConvertTo-Json))
}

Parameters

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

Return type

PageSentEmailProjection (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-SentOrganizationEmails

PageSentEmailProjection Get-SentOrganizationEmails         [-Before] <System.Nullable[System.DateTime]>         [-InboxId]         [-Page] <System.Nullable[Int32]>         [-SearchFilter]         [-Since] <System.Nullable[System.DateTime]>         [-Size] <System.Nullable[Int32]>         [-Sort]

Get all sent organization emails in paginated form

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"

$Before = Get-Date # System.DateTime | Filter by created at before the given timestamp (optional)
$InboxId = "InboxId_example" # String | Optional inboxId to filter sender of sent emails by (optional)
$Page = 987 # Int32 | Optional page  in sent email list pagination (optional) (default to 0)
$SearchFilter = "SearchFilter_example" # String | Optional search filter (optional)
$Since = Get-Date # System.DateTime | Filter by created at after the given timestamp (optional)
$Size = 987 # Int32 | Optional page size in sent email list pagination (optional) (default to 20)
$Sort = "ASC" # String | Optional createdAt sort direction ASC or DESC (optional) (default to "ASC")

# Get all sent organization emails in paginated form
try {
     $Result = Get-SentOrganizationEmails -Before $Before -InboxId $InboxId -Page $Page -SearchFilter $SearchFilter -Since $Since -Size $Size -Sort $Sort
} catch {
    Write-Host ("Exception occured when calling Get-SentOrganizationEmails: {0}" -f ($_.ErrorDetails | ConvertFrom-Json))
    Write-Host ("Response headers: {0}" -f ($_.Exception.Response.Headers | ConvertTo-Json))
}

Parameters

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

Return type

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