maislurp-client-powershell.maislurp-client-powershell/Api.BulkActionsControllerApi
All URIs are relative to https://api.mailslurp.com
Method | HTTP request | Description |
---|---|---|
Invoke-BulkCreateInboxes | POST /bulk/inboxes | Bulk create Inboxes (email addresses) |
Invoke-BulkDeleteInboxes | DELETE /bulk/inboxes | Bulk Delete Inboxes |
Invoke-BulkSendEmails | POST /bulk/send | Bulk Send Emails |
InboxDto[] Invoke-BulkCreateInboxes
[-Count]
Bulk create Inboxes (email addresses)
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"
$Count = 987 # Int32 | Number of inboxes to be created in bulk
# Bulk create Inboxes (email addresses)
try {
$Result = Invoke-BulkCreateInboxes -Count $Count
} catch {
Write-Host ("Exception occured when calling Invoke-BulkCreateInboxes: {0}" -f ($_.ErrorDetails | ConvertFrom-Json))
Write-Host ("Response headers: {0}" -f ($_.Exception.Response.Headers | ConvertTo-Json))
}
Parameters
Name | Type | Description | Notes |
---|---|---|---|
Count | Int32 | Number of inboxes to be created in bulk |
Return type
InboxDto[] (PSCustomObject)
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: /
[Back to top] [Back to API list] [Back to Model list] [Back to ]
void Invoke-BulkDeleteInboxes
[-RequestBody]
Bulk Delete Inboxes
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"
$RequestBody = @("Property_example") # String[] |
# Bulk Delete Inboxes
try {
$Result = Invoke-BulkDeleteInboxes -RequestBody $RequestBody
} catch {
Write-Host ("Exception occured when calling Invoke-BulkDeleteInboxes: {0}" -f ($_.ErrorDetails | ConvertFrom-Json))
Write-Host ("Response headers: {0}" -f ($_.Exception.Response.Headers | ConvertTo-Json))
}
Parameters
Name | Type | Description | Notes |
---|---|---|---|
RequestBody | String[] |
Return type
void (empty response body)
Authorization
HTTP request headers
- Content-Type: application/json
- Accept: Not defined
[Back to top] [Back to API list] [Back to Model list] [Back to ]
void Invoke-BulkSendEmails
[-BulkSendEmailOptions]
Bulk Send Emails
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"
$BulkSendEmailOptions = (Initialize-BulkSendEmailOptions -InboxIds @("InboxIds_example") -SendEmailOptions (Initialize-SendEmailOptions -ToContacts @("ToContacts_example") -ToGroup "ToGroup_example" -To @("To_example") -VarFrom "VarFrom_example" -Cc @("Cc_example") -Bcc @("Bcc_example") -Subject "Subject_example" -ReplyTo "ReplyTo_example" -Body "Body_example" -Html $false -IsHTML $false -Charset "Charset_example" -Attachments @("Attachments_example") -TemplateVariables "TODO" -Template "Template_example" -SendStrategy "SINGLE_MESSAGE" -UseInboxName $false -AddTrackingPixel $false -FilterBouncedRecipients $false -ValidateEmailAddresses "VALIDATE_FILTER_REMOVE_INVALID")) # BulkSendEmailOptions |
# Bulk Send Emails
try {
$Result = Invoke-BulkSendEmails -BulkSendEmailOptions $BulkSendEmailOptions
} catch {
Write-Host ("Exception occured when calling Invoke-BulkSendEmails: {0}" -f ($_.ErrorDetails | ConvertFrom-Json))
Write-Host ("Response headers: {0}" -f ($_.Exception.Response.Headers | ConvertTo-Json))
}
Parameters
Name | Type | Description | Notes |
---|---|---|---|
BulkSendEmailOptions | BulkSendEmailOptions |
Return type
void (empty response body)
Authorization
HTTP request headers
- Content-Type: application/json
- Accept: Not defined
[Back to top] [Back to API list] [Back to Model list] [Back to ]