DeliverabilityTestControllerApi
in package
DeliverabilityTestControllerApi Class Doc Comment
Tags
Table of Contents
- contentTypes = ['cancelDeliverabilitySimulationJob' => ['application/json'], 'createDeliverabilitySimulationJob' => ['application/json'], 'createDeliverabilityTest' => ['application/json'], 'deleteDeliverabilityTest' => ['application/json'], 'duplicateDeliverabilityTest' => ['application/json'], 'exportDeliverabilityTestReport' => ['application/json'], 'exportDeliverabilityTestResults' => ['application/json'], 'getDeliverabilityAnalyticsSeries' => ['application/json'], 'getDeliverabilityFailureHotspots' => ['application/json'], 'getDeliverabilitySimulationJob' => ['application/json'], 'getDeliverabilitySimulationJobEvents' => ['application/json'], 'getDeliverabilityTest' => ['application/json'], 'getDeliverabilityTestResults' => ['application/json'], 'getDeliverabilityTests' => ['application/json'], 'getLatestDeliverabilitySimulationJob' => ['application/json'], 'pauseDeliverabilitySimulationJob' => ['application/json'], 'pauseDeliverabilityTest' => ['application/json'], 'pollDeliverabilityTestStatus' => ['application/json'], 'resumeDeliverabilitySimulationJob' => ['application/json'], 'startDeliverabilityTest' => ['application/json'], 'stopDeliverabilityTest' => ['application/json'], 'updateDeliverabilityTest' => ['application/json']]
- $client : ClientInterface
- $config : Configuration
- $headerSelector : HeaderSelector
- $hostIndex : int
- __construct() : mixed
- cancelDeliverabilitySimulationJob() : DeliverabilitySimulationJobDto
- Operation cancelDeliverabilitySimulationJob
- cancelDeliverabilitySimulationJobAsync() : PromiseInterface
- Operation cancelDeliverabilitySimulationJobAsync
- cancelDeliverabilitySimulationJobAsyncWithHttpInfo() : PromiseInterface
- Operation cancelDeliverabilitySimulationJobAsyncWithHttpInfo
- cancelDeliverabilitySimulationJobRequest() : Request
- Create request for operation 'cancelDeliverabilitySimulationJob'
- cancelDeliverabilitySimulationJobWithHttpInfo() : array<string|int, mixed>
- Operation cancelDeliverabilitySimulationJobWithHttpInfo
- createDeliverabilitySimulationJob() : DeliverabilitySimulationJobDto
- Operation createDeliverabilitySimulationJob
- createDeliverabilitySimulationJobAsync() : PromiseInterface
- Operation createDeliverabilitySimulationJobAsync
- createDeliverabilitySimulationJobAsyncWithHttpInfo() : PromiseInterface
- Operation createDeliverabilitySimulationJobAsyncWithHttpInfo
- createDeliverabilitySimulationJobRequest() : Request
- Create request for operation 'createDeliverabilitySimulationJob'
- createDeliverabilitySimulationJobWithHttpInfo() : array<string|int, mixed>
- Operation createDeliverabilitySimulationJobWithHttpInfo
- createDeliverabilityTest() : DeliverabilityTestDto
- Operation createDeliverabilityTest
- createDeliverabilityTestAsync() : PromiseInterface
- Operation createDeliverabilityTestAsync
- createDeliverabilityTestAsyncWithHttpInfo() : PromiseInterface
- Operation createDeliverabilityTestAsyncWithHttpInfo
- createDeliverabilityTestRequest() : Request
- Create request for operation 'createDeliverabilityTest'
- createDeliverabilityTestWithHttpInfo() : array<string|int, mixed>
- Operation createDeliverabilityTestWithHttpInfo
- deleteDeliverabilityTest() : DeleteResult
- Operation deleteDeliverabilityTest
- deleteDeliverabilityTestAsync() : PromiseInterface
- Operation deleteDeliverabilityTestAsync
- deleteDeliverabilityTestAsyncWithHttpInfo() : PromiseInterface
- Operation deleteDeliverabilityTestAsyncWithHttpInfo
- deleteDeliverabilityTestRequest() : Request
- Create request for operation 'deleteDeliverabilityTest'
- deleteDeliverabilityTestWithHttpInfo() : array<string|int, mixed>
- Operation deleteDeliverabilityTestWithHttpInfo
- duplicateDeliverabilityTest() : DeliverabilityTestDto
- Operation duplicateDeliverabilityTest
- duplicateDeliverabilityTestAsync() : PromiseInterface
- Operation duplicateDeliverabilityTestAsync
- duplicateDeliverabilityTestAsyncWithHttpInfo() : PromiseInterface
- Operation duplicateDeliverabilityTestAsyncWithHttpInfo
- duplicateDeliverabilityTestRequest() : Request
- Create request for operation 'duplicateDeliverabilityTest'
- duplicateDeliverabilityTestWithHttpInfo() : array<string|int, mixed>
- Operation duplicateDeliverabilityTestWithHttpInfo
- exportDeliverabilityTestReport() : void
- Operation exportDeliverabilityTestReport
- exportDeliverabilityTestReportAsync() : PromiseInterface
- Operation exportDeliverabilityTestReportAsync
- exportDeliverabilityTestReportAsyncWithHttpInfo() : PromiseInterface
- Operation exportDeliverabilityTestReportAsyncWithHttpInfo
- exportDeliverabilityTestReportRequest() : Request
- Create request for operation 'exportDeliverabilityTestReport'
- exportDeliverabilityTestReportWithHttpInfo() : array<string|int, mixed>
- Operation exportDeliverabilityTestReportWithHttpInfo
- exportDeliverabilityTestResults() : void
- Operation exportDeliverabilityTestResults
- exportDeliverabilityTestResultsAsync() : PromiseInterface
- Operation exportDeliverabilityTestResultsAsync
- exportDeliverabilityTestResultsAsyncWithHttpInfo() : PromiseInterface
- Operation exportDeliverabilityTestResultsAsyncWithHttpInfo
- exportDeliverabilityTestResultsRequest() : Request
- Create request for operation 'exportDeliverabilityTestResults'
- exportDeliverabilityTestResultsWithHttpInfo() : array<string|int, mixed>
- Operation exportDeliverabilityTestResultsWithHttpInfo
- getConfig() : Configuration
- getDeliverabilityAnalyticsSeries() : DeliverabilityAnalyticsSeriesDto
- Operation getDeliverabilityAnalyticsSeries
- getDeliverabilityAnalyticsSeriesAsync() : PromiseInterface
- Operation getDeliverabilityAnalyticsSeriesAsync
- getDeliverabilityAnalyticsSeriesAsyncWithHttpInfo() : PromiseInterface
- Operation getDeliverabilityAnalyticsSeriesAsyncWithHttpInfo
- getDeliverabilityAnalyticsSeriesRequest() : Request
- Create request for operation 'getDeliverabilityAnalyticsSeries'
- getDeliverabilityAnalyticsSeriesWithHttpInfo() : array<string|int, mixed>
- Operation getDeliverabilityAnalyticsSeriesWithHttpInfo
- getDeliverabilityFailureHotspots() : DeliverabilityFailureHotspotsDto
- Operation getDeliverabilityFailureHotspots
- getDeliverabilityFailureHotspotsAsync() : PromiseInterface
- Operation getDeliverabilityFailureHotspotsAsync
- getDeliverabilityFailureHotspotsAsyncWithHttpInfo() : PromiseInterface
- Operation getDeliverabilityFailureHotspotsAsyncWithHttpInfo
- getDeliverabilityFailureHotspotsRequest() : Request
- Create request for operation 'getDeliverabilityFailureHotspots'
- getDeliverabilityFailureHotspotsWithHttpInfo() : array<string|int, mixed>
- Operation getDeliverabilityFailureHotspotsWithHttpInfo
- getDeliverabilitySimulationJob() : DeliverabilitySimulationJobDto
- Operation getDeliverabilitySimulationJob
- getDeliverabilitySimulationJobAsync() : PromiseInterface
- Operation getDeliverabilitySimulationJobAsync
- getDeliverabilitySimulationJobAsyncWithHttpInfo() : PromiseInterface
- Operation getDeliverabilitySimulationJobAsyncWithHttpInfo
- getDeliverabilitySimulationJobEvents() : DeliverabilitySimulationJobEventPageDto
- Operation getDeliverabilitySimulationJobEvents
- getDeliverabilitySimulationJobEventsAsync() : PromiseInterface
- Operation getDeliverabilitySimulationJobEventsAsync
- getDeliverabilitySimulationJobEventsAsyncWithHttpInfo() : PromiseInterface
- Operation getDeliverabilitySimulationJobEventsAsyncWithHttpInfo
- getDeliverabilitySimulationJobEventsRequest() : Request
- Create request for operation 'getDeliverabilitySimulationJobEvents'
- getDeliverabilitySimulationJobEventsWithHttpInfo() : array<string|int, mixed>
- Operation getDeliverabilitySimulationJobEventsWithHttpInfo
- getDeliverabilitySimulationJobRequest() : Request
- Create request for operation 'getDeliverabilitySimulationJob'
- getDeliverabilitySimulationJobWithHttpInfo() : array<string|int, mixed>
- Operation getDeliverabilitySimulationJobWithHttpInfo
- getDeliverabilityTest() : DeliverabilityTestDto
- Operation getDeliverabilityTest
- getDeliverabilityTestAsync() : PromiseInterface
- Operation getDeliverabilityTestAsync
- getDeliverabilityTestAsyncWithHttpInfo() : PromiseInterface
- Operation getDeliverabilityTestAsyncWithHttpInfo
- getDeliverabilityTestRequest() : Request
- Create request for operation 'getDeliverabilityTest'
- getDeliverabilityTestResults() : DeliverabilityEntityResultPageDto
- Operation getDeliverabilityTestResults
- getDeliverabilityTestResultsAsync() : PromiseInterface
- Operation getDeliverabilityTestResultsAsync
- getDeliverabilityTestResultsAsyncWithHttpInfo() : PromiseInterface
- Operation getDeliverabilityTestResultsAsyncWithHttpInfo
- getDeliverabilityTestResultsRequest() : Request
- Create request for operation 'getDeliverabilityTestResults'
- getDeliverabilityTestResultsWithHttpInfo() : array<string|int, mixed>
- Operation getDeliverabilityTestResultsWithHttpInfo
- getDeliverabilityTests() : DeliverabilityTestPageDto
- Operation getDeliverabilityTests
- getDeliverabilityTestsAsync() : PromiseInterface
- Operation getDeliverabilityTestsAsync
- getDeliverabilityTestsAsyncWithHttpInfo() : PromiseInterface
- Operation getDeliverabilityTestsAsyncWithHttpInfo
- getDeliverabilityTestsRequest() : Request
- Create request for operation 'getDeliverabilityTests'
- getDeliverabilityTestsWithHttpInfo() : array<string|int, mixed>
- Operation getDeliverabilityTestsWithHttpInfo
- getDeliverabilityTestWithHttpInfo() : array<string|int, mixed>
- Operation getDeliverabilityTestWithHttpInfo
- getHostIndex() : int
- Get the host index
- getLatestDeliverabilitySimulationJob() : DeliverabilitySimulationJobDto
- Operation getLatestDeliverabilitySimulationJob
- getLatestDeliverabilitySimulationJobAsync() : PromiseInterface
- Operation getLatestDeliverabilitySimulationJobAsync
- getLatestDeliverabilitySimulationJobAsyncWithHttpInfo() : PromiseInterface
- Operation getLatestDeliverabilitySimulationJobAsyncWithHttpInfo
- getLatestDeliverabilitySimulationJobRequest() : Request
- Create request for operation 'getLatestDeliverabilitySimulationJob'
- getLatestDeliverabilitySimulationJobWithHttpInfo() : array<string|int, mixed>
- Operation getLatestDeliverabilitySimulationJobWithHttpInfo
- pauseDeliverabilitySimulationJob() : DeliverabilitySimulationJobDto
- Operation pauseDeliverabilitySimulationJob
- pauseDeliverabilitySimulationJobAsync() : PromiseInterface
- Operation pauseDeliverabilitySimulationJobAsync
- pauseDeliverabilitySimulationJobAsyncWithHttpInfo() : PromiseInterface
- Operation pauseDeliverabilitySimulationJobAsyncWithHttpInfo
- pauseDeliverabilitySimulationJobRequest() : Request
- Create request for operation 'pauseDeliverabilitySimulationJob'
- pauseDeliverabilitySimulationJobWithHttpInfo() : array<string|int, mixed>
- Operation pauseDeliverabilitySimulationJobWithHttpInfo
- pauseDeliverabilityTest() : DeliverabilityTestDto
- Operation pauseDeliverabilityTest
- pauseDeliverabilityTestAsync() : PromiseInterface
- Operation pauseDeliverabilityTestAsync
- pauseDeliverabilityTestAsyncWithHttpInfo() : PromiseInterface
- Operation pauseDeliverabilityTestAsyncWithHttpInfo
- pauseDeliverabilityTestRequest() : Request
- Create request for operation 'pauseDeliverabilityTest'
- pauseDeliverabilityTestWithHttpInfo() : array<string|int, mixed>
- Operation pauseDeliverabilityTestWithHttpInfo
- pollDeliverabilityTestStatus() : DeliverabilityPollStatusResultDto
- Operation pollDeliverabilityTestStatus
- pollDeliverabilityTestStatusAsync() : PromiseInterface
- Operation pollDeliverabilityTestStatusAsync
- pollDeliverabilityTestStatusAsyncWithHttpInfo() : PromiseInterface
- Operation pollDeliverabilityTestStatusAsyncWithHttpInfo
- pollDeliverabilityTestStatusRequest() : Request
- Create request for operation 'pollDeliverabilityTestStatus'
- pollDeliverabilityTestStatusWithHttpInfo() : array<string|int, mixed>
- Operation pollDeliverabilityTestStatusWithHttpInfo
- resumeDeliverabilitySimulationJob() : DeliverabilitySimulationJobDto
- Operation resumeDeliverabilitySimulationJob
- resumeDeliverabilitySimulationJobAsync() : PromiseInterface
- Operation resumeDeliverabilitySimulationJobAsync
- resumeDeliverabilitySimulationJobAsyncWithHttpInfo() : PromiseInterface
- Operation resumeDeliverabilitySimulationJobAsyncWithHttpInfo
- resumeDeliverabilitySimulationJobRequest() : Request
- Create request for operation 'resumeDeliverabilitySimulationJob'
- resumeDeliverabilitySimulationJobWithHttpInfo() : array<string|int, mixed>
- Operation resumeDeliverabilitySimulationJobWithHttpInfo
- setHostIndex() : void
- Set the host index
- startDeliverabilityTest() : DeliverabilityTestDto
- Operation startDeliverabilityTest
- startDeliverabilityTestAsync() : PromiseInterface
- Operation startDeliverabilityTestAsync
- startDeliverabilityTestAsyncWithHttpInfo() : PromiseInterface
- Operation startDeliverabilityTestAsyncWithHttpInfo
- startDeliverabilityTestRequest() : Request
- Create request for operation 'startDeliverabilityTest'
- startDeliverabilityTestWithHttpInfo() : array<string|int, mixed>
- Operation startDeliverabilityTestWithHttpInfo
- stopDeliverabilityTest() : DeliverabilityTestDto
- Operation stopDeliverabilityTest
- stopDeliverabilityTestAsync() : PromiseInterface
- Operation stopDeliverabilityTestAsync
- stopDeliverabilityTestAsyncWithHttpInfo() : PromiseInterface
- Operation stopDeliverabilityTestAsyncWithHttpInfo
- stopDeliverabilityTestRequest() : Request
- Create request for operation 'stopDeliverabilityTest'
- stopDeliverabilityTestWithHttpInfo() : array<string|int, mixed>
- Operation stopDeliverabilityTestWithHttpInfo
- updateDeliverabilityTest() : DeliverabilityTestDto
- Operation updateDeliverabilityTest
- updateDeliverabilityTestAsync() : PromiseInterface
- Operation updateDeliverabilityTestAsync
- updateDeliverabilityTestAsyncWithHttpInfo() : PromiseInterface
- Operation updateDeliverabilityTestAsyncWithHttpInfo
- updateDeliverabilityTestRequest() : Request
- Create request for operation 'updateDeliverabilityTest'
- updateDeliverabilityTestWithHttpInfo() : array<string|int, mixed>
- Operation updateDeliverabilityTestWithHttpInfo
- createHttpClientOption() : array<string|int, mixed>
- Create http client option
Constants
contentTypes
public
array<string|int, string>
contentTypes
= ['cancelDeliverabilitySimulationJob' => ['application/json'], 'createDeliverabilitySimulationJob' => ['application/json'], 'createDeliverabilityTest' => ['application/json'], 'deleteDeliverabilityTest' => ['application/json'], 'duplicateDeliverabilityTest' => ['application/json'], 'exportDeliverabilityTestReport' => ['application/json'], 'exportDeliverabilityTestResults' => ['application/json'], 'getDeliverabilityAnalyticsSeries' => ['application/json'], 'getDeliverabilityFailureHotspots' => ['application/json'], 'getDeliverabilitySimulationJob' => ['application/json'], 'getDeliverabilitySimulationJobEvents' => ['application/json'], 'getDeliverabilityTest' => ['application/json'], 'getDeliverabilityTestResults' => ['application/json'], 'getDeliverabilityTests' => ['application/json'], 'getLatestDeliverabilitySimulationJob' => ['application/json'], 'pauseDeliverabilitySimulationJob' => ['application/json'], 'pauseDeliverabilityTest' => ['application/json'], 'pollDeliverabilityTestStatus' => ['application/json'], 'resumeDeliverabilitySimulationJob' => ['application/json'], 'startDeliverabilityTest' => ['application/json'], 'stopDeliverabilityTest' => ['application/json'], 'updateDeliverabilityTest' => ['application/json']]
Properties
$client
protected
ClientInterface
$client
$config
protected
Configuration
$config
$headerSelector
protected
HeaderSelector
$headerSelector
$hostIndex
protected
int
$hostIndex
Host index
Methods
__construct()
public
__construct([ClientInterface $client = null ][, Configuration $config = null ][, HeaderSelector $selector = null ], int $hostIndex) : mixed
Parameters
- $client : ClientInterface = null
- $config : Configuration = null
- $selector : HeaderSelector = null
- $hostIndex : int
-
(Optional) host index to select the list of hosts if defined in the OpenAPI spec
Return values
mixed —cancelDeliverabilitySimulationJob()
Operation cancelDeliverabilitySimulationJob
public
cancelDeliverabilitySimulationJob(string $test_id, string $job_id[, string $contentType = self::contentTypes['cancelDeliverabilitySimulationJob'][0] ]) : DeliverabilitySimulationJobDto
Cancel deliverability simulation job
Parameters
- $test_id : string
-
test_id (required)
- $job_id : string
-
job_id (required)
- $contentType : string = self::contentTypes['cancelDeliverabilitySimulationJob'][0]
-
The value for the Content-Type header. Check self::contentTypes['cancelDeliverabilitySimulationJob'] to see the possible values for this operation
Tags
Return values
DeliverabilitySimulationJobDto —cancelDeliverabilitySimulationJobAsync()
Operation cancelDeliverabilitySimulationJobAsync
public
cancelDeliverabilitySimulationJobAsync(string $test_id, string $job_id[, string $contentType = self::contentTypes['cancelDeliverabilitySimulationJob'][0] ]) : PromiseInterface
Cancel deliverability simulation job
Parameters
- $test_id : string
-
(required)
- $job_id : string
-
(required)
- $contentType : string = self::contentTypes['cancelDeliverabilitySimulationJob'][0]
-
The value for the Content-Type header. Check self::contentTypes['cancelDeliverabilitySimulationJob'] to see the possible values for this operation
Tags
Return values
PromiseInterface —cancelDeliverabilitySimulationJobAsyncWithHttpInfo()
Operation cancelDeliverabilitySimulationJobAsyncWithHttpInfo
public
cancelDeliverabilitySimulationJobAsyncWithHttpInfo(string $test_id, string $job_id[, string $contentType = self::contentTypes['cancelDeliverabilitySimulationJob'][0] ]) : PromiseInterface
Cancel deliverability simulation job
Parameters
- $test_id : string
-
(required)
- $job_id : string
-
(required)
- $contentType : string = self::contentTypes['cancelDeliverabilitySimulationJob'][0]
-
The value for the Content-Type header. Check self::contentTypes['cancelDeliverabilitySimulationJob'] to see the possible values for this operation
Tags
Return values
PromiseInterface —cancelDeliverabilitySimulationJobRequest()
Create request for operation 'cancelDeliverabilitySimulationJob'
public
cancelDeliverabilitySimulationJobRequest(string $test_id, string $job_id[, string $contentType = self::contentTypes['cancelDeliverabilitySimulationJob'][0] ]) : Request
Parameters
- $test_id : string
-
(required)
- $job_id : string
-
(required)
- $contentType : string = self::contentTypes['cancelDeliverabilitySimulationJob'][0]
-
The value for the Content-Type header. Check self::contentTypes['cancelDeliverabilitySimulationJob'] to see the possible values for this operation
Tags
Return values
Request —cancelDeliverabilitySimulationJobWithHttpInfo()
Operation cancelDeliverabilitySimulationJobWithHttpInfo
public
cancelDeliverabilitySimulationJobWithHttpInfo(string $test_id, string $job_id[, string $contentType = self::contentTypes['cancelDeliverabilitySimulationJob'][0] ]) : array<string|int, mixed>
Cancel deliverability simulation job
Parameters
- $test_id : string
-
(required)
- $job_id : string
-
(required)
- $contentType : string = self::contentTypes['cancelDeliverabilitySimulationJob'][0]
-
The value for the Content-Type header. Check self::contentTypes['cancelDeliverabilitySimulationJob'] to see the possible values for this operation
Tags
Return values
array<string|int, mixed> —of \MailSlurp\Models\DeliverabilitySimulationJobDto, HTTP status code, HTTP response headers (array of strings)
createDeliverabilitySimulationJob()
Operation createDeliverabilitySimulationJob
public
createDeliverabilitySimulationJob(string $test_id, CreateDeliverabilitySimulationJobOptions $create_deliverability_simulation_job_options[, string $contentType = self::contentTypes['createDeliverabilitySimulationJob'][0] ]) : DeliverabilitySimulationJobDto
Create deliverability simulation job
Parameters
- $test_id : string
-
test_id (required)
- $create_deliverability_simulation_job_options : CreateDeliverabilitySimulationJobOptions
-
create_deliverability_simulation_job_options (required)
- $contentType : string = self::contentTypes['createDeliverabilitySimulationJob'][0]
-
The value for the Content-Type header. Check self::contentTypes['createDeliverabilitySimulationJob'] to see the possible values for this operation
Tags
Return values
DeliverabilitySimulationJobDto —createDeliverabilitySimulationJobAsync()
Operation createDeliverabilitySimulationJobAsync
public
createDeliverabilitySimulationJobAsync(string $test_id, CreateDeliverabilitySimulationJobOptions $create_deliverability_simulation_job_options[, string $contentType = self::contentTypes['createDeliverabilitySimulationJob'][0] ]) : PromiseInterface
Create deliverability simulation job
Parameters
- $test_id : string
-
(required)
- $create_deliverability_simulation_job_options : CreateDeliverabilitySimulationJobOptions
-
(required)
- $contentType : string = self::contentTypes['createDeliverabilitySimulationJob'][0]
-
The value for the Content-Type header. Check self::contentTypes['createDeliverabilitySimulationJob'] to see the possible values for this operation
Tags
Return values
PromiseInterface —createDeliverabilitySimulationJobAsyncWithHttpInfo()
Operation createDeliverabilitySimulationJobAsyncWithHttpInfo
public
createDeliverabilitySimulationJobAsyncWithHttpInfo(string $test_id, CreateDeliverabilitySimulationJobOptions $create_deliverability_simulation_job_options[, string $contentType = self::contentTypes['createDeliverabilitySimulationJob'][0] ]) : PromiseInterface
Create deliverability simulation job
Parameters
- $test_id : string
-
(required)
- $create_deliverability_simulation_job_options : CreateDeliverabilitySimulationJobOptions
-
(required)
- $contentType : string = self::contentTypes['createDeliverabilitySimulationJob'][0]
-
The value for the Content-Type header. Check self::contentTypes['createDeliverabilitySimulationJob'] to see the possible values for this operation
Tags
Return values
PromiseInterface —createDeliverabilitySimulationJobRequest()
Create request for operation 'createDeliverabilitySimulationJob'
public
createDeliverabilitySimulationJobRequest(string $test_id, CreateDeliverabilitySimulationJobOptions $create_deliverability_simulation_job_options[, string $contentType = self::contentTypes['createDeliverabilitySimulationJob'][0] ]) : Request
Parameters
- $test_id : string
-
(required)
- $create_deliverability_simulation_job_options : CreateDeliverabilitySimulationJobOptions
-
(required)
- $contentType : string = self::contentTypes['createDeliverabilitySimulationJob'][0]
-
The value for the Content-Type header. Check self::contentTypes['createDeliverabilitySimulationJob'] to see the possible values for this operation
Tags
Return values
Request —createDeliverabilitySimulationJobWithHttpInfo()
Operation createDeliverabilitySimulationJobWithHttpInfo
public
createDeliverabilitySimulationJobWithHttpInfo(string $test_id, CreateDeliverabilitySimulationJobOptions $create_deliverability_simulation_job_options[, string $contentType = self::contentTypes['createDeliverabilitySimulationJob'][0] ]) : array<string|int, mixed>
Create deliverability simulation job
Parameters
- $test_id : string
-
(required)
- $create_deliverability_simulation_job_options : CreateDeliverabilitySimulationJobOptions
-
(required)
- $contentType : string = self::contentTypes['createDeliverabilitySimulationJob'][0]
-
The value for the Content-Type header. Check self::contentTypes['createDeliverabilitySimulationJob'] to see the possible values for this operation
Tags
Return values
array<string|int, mixed> —of \MailSlurp\Models\DeliverabilitySimulationJobDto, HTTP status code, HTTP response headers (array of strings)
createDeliverabilityTest()
Operation createDeliverabilityTest
public
createDeliverabilityTest(CreateDeliverabilityTestOptions $create_deliverability_test_options[, string $contentType = self::contentTypes['createDeliverabilityTest'][0] ]) : DeliverabilityTestDto
Create load test
Parameters
- $create_deliverability_test_options : CreateDeliverabilityTestOptions
-
create_deliverability_test_options (required)
- $contentType : string = self::contentTypes['createDeliverabilityTest'][0]
-
The value for the Content-Type header. Check self::contentTypes['createDeliverabilityTest'] to see the possible values for this operation
Tags
Return values
DeliverabilityTestDto —createDeliverabilityTestAsync()
Operation createDeliverabilityTestAsync
public
createDeliverabilityTestAsync(CreateDeliverabilityTestOptions $create_deliverability_test_options[, string $contentType = self::contentTypes['createDeliverabilityTest'][0] ]) : PromiseInterface
Create load test
Parameters
- $create_deliverability_test_options : CreateDeliverabilityTestOptions
-
(required)
- $contentType : string = self::contentTypes['createDeliverabilityTest'][0]
-
The value for the Content-Type header. Check self::contentTypes['createDeliverabilityTest'] to see the possible values for this operation
Tags
Return values
PromiseInterface —createDeliverabilityTestAsyncWithHttpInfo()
Operation createDeliverabilityTestAsyncWithHttpInfo
public
createDeliverabilityTestAsyncWithHttpInfo(CreateDeliverabilityTestOptions $create_deliverability_test_options[, string $contentType = self::contentTypes['createDeliverabilityTest'][0] ]) : PromiseInterface
Create load test
Parameters
- $create_deliverability_test_options : CreateDeliverabilityTestOptions
-
(required)
- $contentType : string = self::contentTypes['createDeliverabilityTest'][0]
-
The value for the Content-Type header. Check self::contentTypes['createDeliverabilityTest'] to see the possible values for this operation
Tags
Return values
PromiseInterface —createDeliverabilityTestRequest()
Create request for operation 'createDeliverabilityTest'
public
createDeliverabilityTestRequest(CreateDeliverabilityTestOptions $create_deliverability_test_options[, string $contentType = self::contentTypes['createDeliverabilityTest'][0] ]) : Request
Parameters
- $create_deliverability_test_options : CreateDeliverabilityTestOptions
-
(required)
- $contentType : string = self::contentTypes['createDeliverabilityTest'][0]
-
The value for the Content-Type header. Check self::contentTypes['createDeliverabilityTest'] to see the possible values for this operation
Tags
Return values
Request —createDeliverabilityTestWithHttpInfo()
Operation createDeliverabilityTestWithHttpInfo
public
createDeliverabilityTestWithHttpInfo(CreateDeliverabilityTestOptions $create_deliverability_test_options[, string $contentType = self::contentTypes['createDeliverabilityTest'][0] ]) : array<string|int, mixed>
Create load test
Parameters
- $create_deliverability_test_options : CreateDeliverabilityTestOptions
-
(required)
- $contentType : string = self::contentTypes['createDeliverabilityTest'][0]
-
The value for the Content-Type header. Check self::contentTypes['createDeliverabilityTest'] to see the possible values for this operation
Tags
Return values
array<string|int, mixed> —of \MailSlurp\Models\DeliverabilityTestDto, HTTP status code, HTTP response headers (array of strings)
deleteDeliverabilityTest()
Operation deleteDeliverabilityTest
public
deleteDeliverabilityTest(string $test_id[, string $contentType = self::contentTypes['deleteDeliverabilityTest'][0] ]) : DeleteResult
Delete load test
Parameters
- $test_id : string
-
test_id (required)
- $contentType : string = self::contentTypes['deleteDeliverabilityTest'][0]
-
The value for the Content-Type header. Check self::contentTypes['deleteDeliverabilityTest'] to see the possible values for this operation
Tags
Return values
DeleteResult —deleteDeliverabilityTestAsync()
Operation deleteDeliverabilityTestAsync
public
deleteDeliverabilityTestAsync(string $test_id[, string $contentType = self::contentTypes['deleteDeliverabilityTest'][0] ]) : PromiseInterface
Delete load test
Parameters
- $test_id : string
-
(required)
- $contentType : string = self::contentTypes['deleteDeliverabilityTest'][0]
-
The value for the Content-Type header. Check self::contentTypes['deleteDeliverabilityTest'] to see the possible values for this operation
Tags
Return values
PromiseInterface —deleteDeliverabilityTestAsyncWithHttpInfo()
Operation deleteDeliverabilityTestAsyncWithHttpInfo
public
deleteDeliverabilityTestAsyncWithHttpInfo(string $test_id[, string $contentType = self::contentTypes['deleteDeliverabilityTest'][0] ]) : PromiseInterface
Delete load test
Parameters
- $test_id : string
-
(required)
- $contentType : string = self::contentTypes['deleteDeliverabilityTest'][0]
-
The value for the Content-Type header. Check self::contentTypes['deleteDeliverabilityTest'] to see the possible values for this operation
Tags
Return values
PromiseInterface —deleteDeliverabilityTestRequest()
Create request for operation 'deleteDeliverabilityTest'
public
deleteDeliverabilityTestRequest(string $test_id[, string $contentType = self::contentTypes['deleteDeliverabilityTest'][0] ]) : Request
Parameters
- $test_id : string
-
(required)
- $contentType : string = self::contentTypes['deleteDeliverabilityTest'][0]
-
The value for the Content-Type header. Check self::contentTypes['deleteDeliverabilityTest'] to see the possible values for this operation
Tags
Return values
Request —deleteDeliverabilityTestWithHttpInfo()
Operation deleteDeliverabilityTestWithHttpInfo
public
deleteDeliverabilityTestWithHttpInfo(string $test_id[, string $contentType = self::contentTypes['deleteDeliverabilityTest'][0] ]) : array<string|int, mixed>
Delete load test
Parameters
- $test_id : string
-
(required)
- $contentType : string = self::contentTypes['deleteDeliverabilityTest'][0]
-
The value for the Content-Type header. Check self::contentTypes['deleteDeliverabilityTest'] to see the possible values for this operation
Tags
Return values
array<string|int, mixed> —of \MailSlurp\Models\DeleteResult, HTTP status code, HTTP response headers (array of strings)
duplicateDeliverabilityTest()
Operation duplicateDeliverabilityTest
public
duplicateDeliverabilityTest(string $test_id[, string $contentType = self::contentTypes['duplicateDeliverabilityTest'][0] ]) : DeliverabilityTestDto
Duplicate load test
Parameters
- $test_id : string
-
test_id (required)
- $contentType : string = self::contentTypes['duplicateDeliverabilityTest'][0]
-
The value for the Content-Type header. Check self::contentTypes['duplicateDeliverabilityTest'] to see the possible values for this operation
Tags
Return values
DeliverabilityTestDto —duplicateDeliverabilityTestAsync()
Operation duplicateDeliverabilityTestAsync
public
duplicateDeliverabilityTestAsync(string $test_id[, string $contentType = self::contentTypes['duplicateDeliverabilityTest'][0] ]) : PromiseInterface
Duplicate load test
Parameters
- $test_id : string
-
(required)
- $contentType : string = self::contentTypes['duplicateDeliverabilityTest'][0]
-
The value for the Content-Type header. Check self::contentTypes['duplicateDeliverabilityTest'] to see the possible values for this operation
Tags
Return values
PromiseInterface —duplicateDeliverabilityTestAsyncWithHttpInfo()
Operation duplicateDeliverabilityTestAsyncWithHttpInfo
public
duplicateDeliverabilityTestAsyncWithHttpInfo(string $test_id[, string $contentType = self::contentTypes['duplicateDeliverabilityTest'][0] ]) : PromiseInterface
Duplicate load test
Parameters
- $test_id : string
-
(required)
- $contentType : string = self::contentTypes['duplicateDeliverabilityTest'][0]
-
The value for the Content-Type header. Check self::contentTypes['duplicateDeliverabilityTest'] to see the possible values for this operation
Tags
Return values
PromiseInterface —duplicateDeliverabilityTestRequest()
Create request for operation 'duplicateDeliverabilityTest'
public
duplicateDeliverabilityTestRequest(string $test_id[, string $contentType = self::contentTypes['duplicateDeliverabilityTest'][0] ]) : Request
Parameters
- $test_id : string
-
(required)
- $contentType : string = self::contentTypes['duplicateDeliverabilityTest'][0]
-
The value for the Content-Type header. Check self::contentTypes['duplicateDeliverabilityTest'] to see the possible values for this operation
Tags
Return values
Request —duplicateDeliverabilityTestWithHttpInfo()
Operation duplicateDeliverabilityTestWithHttpInfo
public
duplicateDeliverabilityTestWithHttpInfo(string $test_id[, string $contentType = self::contentTypes['duplicateDeliverabilityTest'][0] ]) : array<string|int, mixed>
Duplicate load test
Parameters
- $test_id : string
-
(required)
- $contentType : string = self::contentTypes['duplicateDeliverabilityTest'][0]
-
The value for the Content-Type header. Check self::contentTypes['duplicateDeliverabilityTest'] to see the possible values for this operation
Tags
Return values
array<string|int, mixed> —of \MailSlurp\Models\DeliverabilityTestDto, HTTP status code, HTTP response headers (array of strings)
exportDeliverabilityTestReport()
Operation exportDeliverabilityTestReport
public
exportDeliverabilityTestReport(string $test_id[, string $contentType = self::contentTypes['exportDeliverabilityTestReport'][0] ]) : void
Export load-test report as PDF
Parameters
- $test_id : string
-
test_id (required)
- $contentType : string = self::contentTypes['exportDeliverabilityTestReport'][0]
-
The value for the Content-Type header. Check self::contentTypes['exportDeliverabilityTestReport'] to see the possible values for this operation
Tags
Return values
void —exportDeliverabilityTestReportAsync()
Operation exportDeliverabilityTestReportAsync
public
exportDeliverabilityTestReportAsync(string $test_id[, string $contentType = self::contentTypes['exportDeliverabilityTestReport'][0] ]) : PromiseInterface
Export load-test report as PDF
Parameters
- $test_id : string
-
(required)
- $contentType : string = self::contentTypes['exportDeliverabilityTestReport'][0]
-
The value for the Content-Type header. Check self::contentTypes['exportDeliverabilityTestReport'] to see the possible values for this operation
Tags
Return values
PromiseInterface —exportDeliverabilityTestReportAsyncWithHttpInfo()
Operation exportDeliverabilityTestReportAsyncWithHttpInfo
public
exportDeliverabilityTestReportAsyncWithHttpInfo(string $test_id[, string $contentType = self::contentTypes['exportDeliverabilityTestReport'][0] ]) : PromiseInterface
Export load-test report as PDF
Parameters
- $test_id : string
-
(required)
- $contentType : string = self::contentTypes['exportDeliverabilityTestReport'][0]
-
The value for the Content-Type header. Check self::contentTypes['exportDeliverabilityTestReport'] to see the possible values for this operation
Tags
Return values
PromiseInterface —exportDeliverabilityTestReportRequest()
Create request for operation 'exportDeliverabilityTestReport'
public
exportDeliverabilityTestReportRequest(string $test_id[, string $contentType = self::contentTypes['exportDeliverabilityTestReport'][0] ]) : Request
Parameters
- $test_id : string
-
(required)
- $contentType : string = self::contentTypes['exportDeliverabilityTestReport'][0]
-
The value for the Content-Type header. Check self::contentTypes['exportDeliverabilityTestReport'] to see the possible values for this operation
Tags
Return values
Request —exportDeliverabilityTestReportWithHttpInfo()
Operation exportDeliverabilityTestReportWithHttpInfo
public
exportDeliverabilityTestReportWithHttpInfo(string $test_id[, string $contentType = self::contentTypes['exportDeliverabilityTestReport'][0] ]) : array<string|int, mixed>
Export load-test report as PDF
Parameters
- $test_id : string
-
(required)
- $contentType : string = self::contentTypes['exportDeliverabilityTestReport'][0]
-
The value for the Content-Type header. Check self::contentTypes['exportDeliverabilityTestReport'] to see the possible values for this operation
Tags
Return values
array<string|int, mixed> —of null, HTTP status code, HTTP response headers (array of strings)
exportDeliverabilityTestResults()
Operation exportDeliverabilityTestResults
public
exportDeliverabilityTestResults(string $test_id[, bool $matched = null ][, string $contentType = self::contentTypes['exportDeliverabilityTestResults'][0] ]) : void
Export load-test entity results as CSV
Parameters
- $test_id : string
-
test_id (required)
- $matched : bool = null
-
matched (optional)
- $contentType : string = self::contentTypes['exportDeliverabilityTestResults'][0]
-
The value for the Content-Type header. Check self::contentTypes['exportDeliverabilityTestResults'] to see the possible values for this operation
Tags
Return values
void —exportDeliverabilityTestResultsAsync()
Operation exportDeliverabilityTestResultsAsync
public
exportDeliverabilityTestResultsAsync(string $test_id[, bool $matched = null ][, string $contentType = self::contentTypes['exportDeliverabilityTestResults'][0] ]) : PromiseInterface
Export load-test entity results as CSV
Parameters
- $test_id : string
-
(required)
- $matched : bool = null
-
(optional)
- $contentType : string = self::contentTypes['exportDeliverabilityTestResults'][0]
-
The value for the Content-Type header. Check self::contentTypes['exportDeliverabilityTestResults'] to see the possible values for this operation
Tags
Return values
PromiseInterface —exportDeliverabilityTestResultsAsyncWithHttpInfo()
Operation exportDeliverabilityTestResultsAsyncWithHttpInfo
public
exportDeliverabilityTestResultsAsyncWithHttpInfo(string $test_id[, bool $matched = null ][, string $contentType = self::contentTypes['exportDeliverabilityTestResults'][0] ]) : PromiseInterface
Export load-test entity results as CSV
Parameters
- $test_id : string
-
(required)
- $matched : bool = null
-
(optional)
- $contentType : string = self::contentTypes['exportDeliverabilityTestResults'][0]
-
The value for the Content-Type header. Check self::contentTypes['exportDeliverabilityTestResults'] to see the possible values for this operation
Tags
Return values
PromiseInterface —exportDeliverabilityTestResultsRequest()
Create request for operation 'exportDeliverabilityTestResults'
public
exportDeliverabilityTestResultsRequest(string $test_id[, bool $matched = null ][, string $contentType = self::contentTypes['exportDeliverabilityTestResults'][0] ]) : Request
Parameters
- $test_id : string
-
(required)
- $matched : bool = null
-
(optional)
- $contentType : string = self::contentTypes['exportDeliverabilityTestResults'][0]
-
The value for the Content-Type header. Check self::contentTypes['exportDeliverabilityTestResults'] to see the possible values for this operation
Tags
Return values
Request —exportDeliverabilityTestResultsWithHttpInfo()
Operation exportDeliverabilityTestResultsWithHttpInfo
public
exportDeliverabilityTestResultsWithHttpInfo(string $test_id[, bool $matched = null ][, string $contentType = self::contentTypes['exportDeliverabilityTestResults'][0] ]) : array<string|int, mixed>
Export load-test entity results as CSV
Parameters
- $test_id : string
-
(required)
- $matched : bool = null
-
(optional)
- $contentType : string = self::contentTypes['exportDeliverabilityTestResults'][0]
-
The value for the Content-Type header. Check self::contentTypes['exportDeliverabilityTestResults'] to see the possible values for this operation
Tags
Return values
array<string|int, mixed> —of null, HTTP status code, HTTP response headers (array of strings)
getConfig()
public
getConfig() : Configuration
Return values
Configuration —getDeliverabilityAnalyticsSeries()
Operation getDeliverabilityAnalyticsSeries
public
getDeliverabilityAnalyticsSeries([DateTime $since = null ][, DateTime $before = null ][, string $scope = null ][, string $bucket = 'DAY' ][, int $run_limit = null ][, string $contentType = self::contentTypes['getDeliverabilityAnalyticsSeries'][0] ]) : DeliverabilityAnalyticsSeriesDto
Get deliverability analytics time series
Parameters
- $since : DateTime = null
-
since (optional)
- $before : DateTime = null
-
before (optional)
- $scope : string = null
-
scope (optional)
- $bucket : string = 'DAY'
-
bucket (optional, default to 'DAY')
- $run_limit : int = null
-
run_limit (optional)
- $contentType : string = self::contentTypes['getDeliverabilityAnalyticsSeries'][0]
-
The value for the Content-Type header. Check self::contentTypes['getDeliverabilityAnalyticsSeries'] to see the possible values for this operation
Tags
Return values
DeliverabilityAnalyticsSeriesDto —getDeliverabilityAnalyticsSeriesAsync()
Operation getDeliverabilityAnalyticsSeriesAsync
public
getDeliverabilityAnalyticsSeriesAsync([DateTime $since = null ][, DateTime $before = null ][, string $scope = null ][, string $bucket = 'DAY' ][, int $run_limit = null ][, string $contentType = self::contentTypes['getDeliverabilityAnalyticsSeries'][0] ]) : PromiseInterface
Get deliverability analytics time series
Parameters
- $since : DateTime = null
-
(optional)
- $before : DateTime = null
-
(optional)
- $scope : string = null
-
(optional)
- $bucket : string = 'DAY'
-
(optional, default to 'DAY')
- $run_limit : int = null
-
(optional)
- $contentType : string = self::contentTypes['getDeliverabilityAnalyticsSeries'][0]
-
The value for the Content-Type header. Check self::contentTypes['getDeliverabilityAnalyticsSeries'] to see the possible values for this operation
Tags
Return values
PromiseInterface —getDeliverabilityAnalyticsSeriesAsyncWithHttpInfo()
Operation getDeliverabilityAnalyticsSeriesAsyncWithHttpInfo
public
getDeliverabilityAnalyticsSeriesAsyncWithHttpInfo([DateTime $since = null ][, DateTime $before = null ][, string $scope = null ][, string $bucket = 'DAY' ][, int $run_limit = null ][, string $contentType = self::contentTypes['getDeliverabilityAnalyticsSeries'][0] ]) : PromiseInterface
Get deliverability analytics time series
Parameters
- $since : DateTime = null
-
(optional)
- $before : DateTime = null
-
(optional)
- $scope : string = null
-
(optional)
- $bucket : string = 'DAY'
-
(optional, default to 'DAY')
- $run_limit : int = null
-
(optional)
- $contentType : string = self::contentTypes['getDeliverabilityAnalyticsSeries'][0]
-
The value for the Content-Type header. Check self::contentTypes['getDeliverabilityAnalyticsSeries'] to see the possible values for this operation
Tags
Return values
PromiseInterface —getDeliverabilityAnalyticsSeriesRequest()
Create request for operation 'getDeliverabilityAnalyticsSeries'
public
getDeliverabilityAnalyticsSeriesRequest([DateTime $since = null ][, DateTime $before = null ][, string $scope = null ][, string $bucket = 'DAY' ][, int $run_limit = null ][, string $contentType = self::contentTypes['getDeliverabilityAnalyticsSeries'][0] ]) : Request
Parameters
- $since : DateTime = null
-
(optional)
- $before : DateTime = null
-
(optional)
- $scope : string = null
-
(optional)
- $bucket : string = 'DAY'
-
(optional, default to 'DAY')
- $run_limit : int = null
-
(optional)
- $contentType : string = self::contentTypes['getDeliverabilityAnalyticsSeries'][0]
-
The value for the Content-Type header. Check self::contentTypes['getDeliverabilityAnalyticsSeries'] to see the possible values for this operation
Tags
Return values
Request —getDeliverabilityAnalyticsSeriesWithHttpInfo()
Operation getDeliverabilityAnalyticsSeriesWithHttpInfo
public
getDeliverabilityAnalyticsSeriesWithHttpInfo([DateTime $since = null ][, DateTime $before = null ][, string $scope = null ][, string $bucket = 'DAY' ][, int $run_limit = null ][, string $contentType = self::contentTypes['getDeliverabilityAnalyticsSeries'][0] ]) : array<string|int, mixed>
Get deliverability analytics time series
Parameters
- $since : DateTime = null
-
(optional)
- $before : DateTime = null
-
(optional)
- $scope : string = null
-
(optional)
- $bucket : string = 'DAY'
-
(optional, default to 'DAY')
- $run_limit : int = null
-
(optional)
- $contentType : string = self::contentTypes['getDeliverabilityAnalyticsSeries'][0]
-
The value for the Content-Type header. Check self::contentTypes['getDeliverabilityAnalyticsSeries'] to see the possible values for this operation
Tags
Return values
array<string|int, mixed> —of \MailSlurp\Models\DeliverabilityAnalyticsSeriesDto, HTTP status code, HTTP response headers (array of strings)
getDeliverabilityFailureHotspots()
Operation getDeliverabilityFailureHotspots
public
getDeliverabilityFailureHotspots([DateTime $since = null ][, DateTime $before = null ][, string $scope = null ][, int $limit = null ][, string $contentType = self::contentTypes['getDeliverabilityFailureHotspots'][0] ]) : DeliverabilityFailureHotspotsDto
Get deliverability failure hotspots
Parameters
- $since : DateTime = null
-
since (optional)
- $before : DateTime = null
-
before (optional)
- $scope : string = null
-
scope (optional)
- $limit : int = null
-
limit (optional)
- $contentType : string = self::contentTypes['getDeliverabilityFailureHotspots'][0]
-
The value for the Content-Type header. Check self::contentTypes['getDeliverabilityFailureHotspots'] to see the possible values for this operation
Tags
Return values
DeliverabilityFailureHotspotsDto —getDeliverabilityFailureHotspotsAsync()
Operation getDeliverabilityFailureHotspotsAsync
public
getDeliverabilityFailureHotspotsAsync([DateTime $since = null ][, DateTime $before = null ][, string $scope = null ][, int $limit = null ][, string $contentType = self::contentTypes['getDeliverabilityFailureHotspots'][0] ]) : PromiseInterface
Get deliverability failure hotspots
Parameters
- $since : DateTime = null
-
(optional)
- $before : DateTime = null
-
(optional)
- $scope : string = null
-
(optional)
- $limit : int = null
-
(optional)
- $contentType : string = self::contentTypes['getDeliverabilityFailureHotspots'][0]
-
The value for the Content-Type header. Check self::contentTypes['getDeliverabilityFailureHotspots'] to see the possible values for this operation
Tags
Return values
PromiseInterface —getDeliverabilityFailureHotspotsAsyncWithHttpInfo()
Operation getDeliverabilityFailureHotspotsAsyncWithHttpInfo
public
getDeliverabilityFailureHotspotsAsyncWithHttpInfo([DateTime $since = null ][, DateTime $before = null ][, string $scope = null ][, int $limit = null ][, string $contentType = self::contentTypes['getDeliverabilityFailureHotspots'][0] ]) : PromiseInterface
Get deliverability failure hotspots
Parameters
- $since : DateTime = null
-
(optional)
- $before : DateTime = null
-
(optional)
- $scope : string = null
-
(optional)
- $limit : int = null
-
(optional)
- $contentType : string = self::contentTypes['getDeliverabilityFailureHotspots'][0]
-
The value for the Content-Type header. Check self::contentTypes['getDeliverabilityFailureHotspots'] to see the possible values for this operation
Tags
Return values
PromiseInterface —getDeliverabilityFailureHotspotsRequest()
Create request for operation 'getDeliverabilityFailureHotspots'
public
getDeliverabilityFailureHotspotsRequest([DateTime $since = null ][, DateTime $before = null ][, string $scope = null ][, int $limit = null ][, string $contentType = self::contentTypes['getDeliverabilityFailureHotspots'][0] ]) : Request
Parameters
- $since : DateTime = null
-
(optional)
- $before : DateTime = null
-
(optional)
- $scope : string = null
-
(optional)
- $limit : int = null
-
(optional)
- $contentType : string = self::contentTypes['getDeliverabilityFailureHotspots'][0]
-
The value for the Content-Type header. Check self::contentTypes['getDeliverabilityFailureHotspots'] to see the possible values for this operation
Tags
Return values
Request —getDeliverabilityFailureHotspotsWithHttpInfo()
Operation getDeliverabilityFailureHotspotsWithHttpInfo
public
getDeliverabilityFailureHotspotsWithHttpInfo([DateTime $since = null ][, DateTime $before = null ][, string $scope = null ][, int $limit = null ][, string $contentType = self::contentTypes['getDeliverabilityFailureHotspots'][0] ]) : array<string|int, mixed>
Get deliverability failure hotspots
Parameters
- $since : DateTime = null
-
(optional)
- $before : DateTime = null
-
(optional)
- $scope : string = null
-
(optional)
- $limit : int = null
-
(optional)
- $contentType : string = self::contentTypes['getDeliverabilityFailureHotspots'][0]
-
The value for the Content-Type header. Check self::contentTypes['getDeliverabilityFailureHotspots'] to see the possible values for this operation
Tags
Return values
array<string|int, mixed> —of \MailSlurp\Models\DeliverabilityFailureHotspotsDto, HTTP status code, HTTP response headers (array of strings)
getDeliverabilitySimulationJob()
Operation getDeliverabilitySimulationJob
public
getDeliverabilitySimulationJob(string $test_id, string $job_id[, string $contentType = self::contentTypes['getDeliverabilitySimulationJob'][0] ]) : DeliverabilitySimulationJobDto
Get deliverability simulation job
Parameters
- $test_id : string
-
test_id (required)
- $job_id : string
-
job_id (required)
- $contentType : string = self::contentTypes['getDeliverabilitySimulationJob'][0]
-
The value for the Content-Type header. Check self::contentTypes['getDeliverabilitySimulationJob'] to see the possible values for this operation
Tags
Return values
DeliverabilitySimulationJobDto —getDeliverabilitySimulationJobAsync()
Operation getDeliverabilitySimulationJobAsync
public
getDeliverabilitySimulationJobAsync(string $test_id, string $job_id[, string $contentType = self::contentTypes['getDeliverabilitySimulationJob'][0] ]) : PromiseInterface
Get deliverability simulation job
Parameters
- $test_id : string
-
(required)
- $job_id : string
-
(required)
- $contentType : string = self::contentTypes['getDeliverabilitySimulationJob'][0]
-
The value for the Content-Type header. Check self::contentTypes['getDeliverabilitySimulationJob'] to see the possible values for this operation
Tags
Return values
PromiseInterface —getDeliverabilitySimulationJobAsyncWithHttpInfo()
Operation getDeliverabilitySimulationJobAsyncWithHttpInfo
public
getDeliverabilitySimulationJobAsyncWithHttpInfo(string $test_id, string $job_id[, string $contentType = self::contentTypes['getDeliverabilitySimulationJob'][0] ]) : PromiseInterface
Get deliverability simulation job
Parameters
- $test_id : string
-
(required)
- $job_id : string
-
(required)
- $contentType : string = self::contentTypes['getDeliverabilitySimulationJob'][0]
-
The value for the Content-Type header. Check self::contentTypes['getDeliverabilitySimulationJob'] to see the possible values for this operation
Tags
Return values
PromiseInterface —getDeliverabilitySimulationJobEvents()
Operation getDeliverabilitySimulationJobEvents
public
getDeliverabilitySimulationJobEvents(string $test_id, string $job_id, int $page[, int $size = 20 ][, string $sort = 'DESC' ][, string $contentType = self::contentTypes['getDeliverabilitySimulationJobEvents'][0] ]) : DeliverabilitySimulationJobEventPageDto
Get deliverability simulation job events
Parameters
- $test_id : string
-
test_id (required)
- $job_id : string
-
job_id (required)
- $page : int
-
page (optional, default to 0)
- $size : int = 20
-
size (optional, default to 20)
- $sort : string = 'DESC'
-
sort (optional, default to 'DESC')
- $contentType : string = self::contentTypes['getDeliverabilitySimulationJobEvents'][0]
-
The value for the Content-Type header. Check self::contentTypes['getDeliverabilitySimulationJobEvents'] to see the possible values for this operation
Tags
Return values
DeliverabilitySimulationJobEventPageDto —getDeliverabilitySimulationJobEventsAsync()
Operation getDeliverabilitySimulationJobEventsAsync
public
getDeliverabilitySimulationJobEventsAsync(string $test_id, string $job_id, int $page[, int $size = 20 ][, string $sort = 'DESC' ][, string $contentType = self::contentTypes['getDeliverabilitySimulationJobEvents'][0] ]) : PromiseInterface
Get deliverability simulation job events
Parameters
- $test_id : string
-
(required)
- $job_id : string
-
(required)
- $page : int
-
(optional, default to 0)
- $size : int = 20
-
(optional, default to 20)
- $sort : string = 'DESC'
-
(optional, default to 'DESC')
- $contentType : string = self::contentTypes['getDeliverabilitySimulationJobEvents'][0]
-
The value for the Content-Type header. Check self::contentTypes['getDeliverabilitySimulationJobEvents'] to see the possible values for this operation
Tags
Return values
PromiseInterface —getDeliverabilitySimulationJobEventsAsyncWithHttpInfo()
Operation getDeliverabilitySimulationJobEventsAsyncWithHttpInfo
public
getDeliverabilitySimulationJobEventsAsyncWithHttpInfo(string $test_id, string $job_id, int $page[, int $size = 20 ][, string $sort = 'DESC' ][, string $contentType = self::contentTypes['getDeliverabilitySimulationJobEvents'][0] ]) : PromiseInterface
Get deliverability simulation job events
Parameters
- $test_id : string
-
(required)
- $job_id : string
-
(required)
- $page : int
-
(optional, default to 0)
- $size : int = 20
-
(optional, default to 20)
- $sort : string = 'DESC'
-
(optional, default to 'DESC')
- $contentType : string = self::contentTypes['getDeliverabilitySimulationJobEvents'][0]
-
The value for the Content-Type header. Check self::contentTypes['getDeliverabilitySimulationJobEvents'] to see the possible values for this operation
Tags
Return values
PromiseInterface —getDeliverabilitySimulationJobEventsRequest()
Create request for operation 'getDeliverabilitySimulationJobEvents'
public
getDeliverabilitySimulationJobEventsRequest(string $test_id, string $job_id, int $page[, int $size = 20 ][, string $sort = 'DESC' ][, string $contentType = self::contentTypes['getDeliverabilitySimulationJobEvents'][0] ]) : Request
Parameters
- $test_id : string
-
(required)
- $job_id : string
-
(required)
- $page : int
-
(optional, default to 0)
- $size : int = 20
-
(optional, default to 20)
- $sort : string = 'DESC'
-
(optional, default to 'DESC')
- $contentType : string = self::contentTypes['getDeliverabilitySimulationJobEvents'][0]
-
The value for the Content-Type header. Check self::contentTypes['getDeliverabilitySimulationJobEvents'] to see the possible values for this operation
Tags
Return values
Request —getDeliverabilitySimulationJobEventsWithHttpInfo()
Operation getDeliverabilitySimulationJobEventsWithHttpInfo
public
getDeliverabilitySimulationJobEventsWithHttpInfo(string $test_id, string $job_id, int $page[, int $size = 20 ][, string $sort = 'DESC' ][, string $contentType = self::contentTypes['getDeliverabilitySimulationJobEvents'][0] ]) : array<string|int, mixed>
Get deliverability simulation job events
Parameters
- $test_id : string
-
(required)
- $job_id : string
-
(required)
- $page : int
-
(optional, default to 0)
- $size : int = 20
-
(optional, default to 20)
- $sort : string = 'DESC'
-
(optional, default to 'DESC')
- $contentType : string = self::contentTypes['getDeliverabilitySimulationJobEvents'][0]
-
The value for the Content-Type header. Check self::contentTypes['getDeliverabilitySimulationJobEvents'] to see the possible values for this operation
Tags
Return values
array<string|int, mixed> —of \MailSlurp\Models\DeliverabilitySimulationJobEventPageDto, HTTP status code, HTTP response headers (array of strings)
getDeliverabilitySimulationJobRequest()
Create request for operation 'getDeliverabilitySimulationJob'
public
getDeliverabilitySimulationJobRequest(string $test_id, string $job_id[, string $contentType = self::contentTypes['getDeliverabilitySimulationJob'][0] ]) : Request
Parameters
- $test_id : string
-
(required)
- $job_id : string
-
(required)
- $contentType : string = self::contentTypes['getDeliverabilitySimulationJob'][0]
-
The value for the Content-Type header. Check self::contentTypes['getDeliverabilitySimulationJob'] to see the possible values for this operation
Tags
Return values
Request —getDeliverabilitySimulationJobWithHttpInfo()
Operation getDeliverabilitySimulationJobWithHttpInfo
public
getDeliverabilitySimulationJobWithHttpInfo(string $test_id, string $job_id[, string $contentType = self::contentTypes['getDeliverabilitySimulationJob'][0] ]) : array<string|int, mixed>
Get deliverability simulation job
Parameters
- $test_id : string
-
(required)
- $job_id : string
-
(required)
- $contentType : string = self::contentTypes['getDeliverabilitySimulationJob'][0]
-
The value for the Content-Type header. Check self::contentTypes['getDeliverabilitySimulationJob'] to see the possible values for this operation
Tags
Return values
array<string|int, mixed> —of \MailSlurp\Models\DeliverabilitySimulationJobDto, HTTP status code, HTTP response headers (array of strings)
getDeliverabilityTest()
Operation getDeliverabilityTest
public
getDeliverabilityTest(string $test_id[, string $contentType = self::contentTypes['getDeliverabilityTest'][0] ]) : DeliverabilityTestDto
Get load test
Parameters
- $test_id : string
-
test_id (required)
- $contentType : string = self::contentTypes['getDeliverabilityTest'][0]
-
The value for the Content-Type header. Check self::contentTypes['getDeliverabilityTest'] to see the possible values for this operation
Tags
Return values
DeliverabilityTestDto —getDeliverabilityTestAsync()
Operation getDeliverabilityTestAsync
public
getDeliverabilityTestAsync(string $test_id[, string $contentType = self::contentTypes['getDeliverabilityTest'][0] ]) : PromiseInterface
Get load test
Parameters
- $test_id : string
-
(required)
- $contentType : string = self::contentTypes['getDeliverabilityTest'][0]
-
The value for the Content-Type header. Check self::contentTypes['getDeliverabilityTest'] to see the possible values for this operation
Tags
Return values
PromiseInterface —getDeliverabilityTestAsyncWithHttpInfo()
Operation getDeliverabilityTestAsyncWithHttpInfo
public
getDeliverabilityTestAsyncWithHttpInfo(string $test_id[, string $contentType = self::contentTypes['getDeliverabilityTest'][0] ]) : PromiseInterface
Get load test
Parameters
- $test_id : string
-
(required)
- $contentType : string = self::contentTypes['getDeliverabilityTest'][0]
-
The value for the Content-Type header. Check self::contentTypes['getDeliverabilityTest'] to see the possible values for this operation
Tags
Return values
PromiseInterface —getDeliverabilityTestRequest()
Create request for operation 'getDeliverabilityTest'
public
getDeliverabilityTestRequest(string $test_id[, string $contentType = self::contentTypes['getDeliverabilityTest'][0] ]) : Request
Parameters
- $test_id : string
-
(required)
- $contentType : string = self::contentTypes['getDeliverabilityTest'][0]
-
The value for the Content-Type header. Check self::contentTypes['getDeliverabilityTest'] to see the possible values for this operation
Tags
Return values
Request —getDeliverabilityTestResults()
Operation getDeliverabilityTestResults
public
getDeliverabilityTestResults(string $test_id[, bool $matched = null ], int $page[, int $size = 20 ][, string $sort = 'ASC' ][, string $contentType = self::contentTypes['getDeliverabilityTestResults'][0] ]) : DeliverabilityEntityResultPageDto
Get load-test entity results
Parameters
- $test_id : string
-
test_id (required)
- $matched : bool = null
-
matched (optional)
- $page : int
-
page (optional, default to 0)
- $size : int = 20
-
size (optional, default to 20)
- $sort : string = 'ASC'
-
sort (optional, default to 'ASC')
- $contentType : string = self::contentTypes['getDeliverabilityTestResults'][0]
-
The value for the Content-Type header. Check self::contentTypes['getDeliverabilityTestResults'] to see the possible values for this operation
Tags
Return values
DeliverabilityEntityResultPageDto —getDeliverabilityTestResultsAsync()
Operation getDeliverabilityTestResultsAsync
public
getDeliverabilityTestResultsAsync(string $test_id[, bool $matched = null ], int $page[, int $size = 20 ][, string $sort = 'ASC' ][, string $contentType = self::contentTypes['getDeliverabilityTestResults'][0] ]) : PromiseInterface
Get load-test entity results
Parameters
- $test_id : string
-
(required)
- $matched : bool = null
-
(optional)
- $page : int
-
(optional, default to 0)
- $size : int = 20
-
(optional, default to 20)
- $sort : string = 'ASC'
-
(optional, default to 'ASC')
- $contentType : string = self::contentTypes['getDeliverabilityTestResults'][0]
-
The value for the Content-Type header. Check self::contentTypes['getDeliverabilityTestResults'] to see the possible values for this operation
Tags
Return values
PromiseInterface —getDeliverabilityTestResultsAsyncWithHttpInfo()
Operation getDeliverabilityTestResultsAsyncWithHttpInfo
public
getDeliverabilityTestResultsAsyncWithHttpInfo(string $test_id[, bool $matched = null ], int $page[, int $size = 20 ][, string $sort = 'ASC' ][, string $contentType = self::contentTypes['getDeliverabilityTestResults'][0] ]) : PromiseInterface
Get load-test entity results
Parameters
- $test_id : string
-
(required)
- $matched : bool = null
-
(optional)
- $page : int
-
(optional, default to 0)
- $size : int = 20
-
(optional, default to 20)
- $sort : string = 'ASC'
-
(optional, default to 'ASC')
- $contentType : string = self::contentTypes['getDeliverabilityTestResults'][0]
-
The value for the Content-Type header. Check self::contentTypes['getDeliverabilityTestResults'] to see the possible values for this operation
Tags
Return values
PromiseInterface —getDeliverabilityTestResultsRequest()
Create request for operation 'getDeliverabilityTestResults'
public
getDeliverabilityTestResultsRequest(string $test_id[, bool $matched = null ], int $page[, int $size = 20 ][, string $sort = 'ASC' ][, string $contentType = self::contentTypes['getDeliverabilityTestResults'][0] ]) : Request
Parameters
- $test_id : string
-
(required)
- $matched : bool = null
-
(optional)
- $page : int
-
(optional, default to 0)
- $size : int = 20
-
(optional, default to 20)
- $sort : string = 'ASC'
-
(optional, default to 'ASC')
- $contentType : string = self::contentTypes['getDeliverabilityTestResults'][0]
-
The value for the Content-Type header. Check self::contentTypes['getDeliverabilityTestResults'] to see the possible values for this operation
Tags
Return values
Request —getDeliverabilityTestResultsWithHttpInfo()
Operation getDeliverabilityTestResultsWithHttpInfo
public
getDeliverabilityTestResultsWithHttpInfo(string $test_id[, bool $matched = null ], int $page[, int $size = 20 ][, string $sort = 'ASC' ][, string $contentType = self::contentTypes['getDeliverabilityTestResults'][0] ]) : array<string|int, mixed>
Get load-test entity results
Parameters
- $test_id : string
-
(required)
- $matched : bool = null
-
(optional)
- $page : int
-
(optional, default to 0)
- $size : int = 20
-
(optional, default to 20)
- $sort : string = 'ASC'
-
(optional, default to 'ASC')
- $contentType : string = self::contentTypes['getDeliverabilityTestResults'][0]
-
The value for the Content-Type header. Check self::contentTypes['getDeliverabilityTestResults'] to see the possible values for this operation
Tags
Return values
array<string|int, mixed> —of \MailSlurp\Models\DeliverabilityEntityResultPageDto, HTTP status code, HTTP response headers (array of strings)
getDeliverabilityTests()
Operation getDeliverabilityTests
public
getDeliverabilityTests(int $page[, int $size = 20 ][, string $sort = 'DESC' ][, string $contentType = self::contentTypes['getDeliverabilityTests'][0] ]) : DeliverabilityTestPageDto
List load tests
Parameters
- $page : int
-
Page index (optional, default to 0)
- $size : int = 20
-
Page size (optional, default to 20)
- $sort : string = 'DESC'
-
Sort direction (optional, default to 'DESC')
- $contentType : string = self::contentTypes['getDeliverabilityTests'][0]
-
The value for the Content-Type header. Check self::contentTypes['getDeliverabilityTests'] to see the possible values for this operation
Tags
Return values
DeliverabilityTestPageDto —getDeliverabilityTestsAsync()
Operation getDeliverabilityTestsAsync
public
getDeliverabilityTestsAsync(int $page[, int $size = 20 ][, string $sort = 'DESC' ][, string $contentType = self::contentTypes['getDeliverabilityTests'][0] ]) : PromiseInterface
List load tests
Parameters
- $page : int
-
Page index (optional, default to 0)
- $size : int = 20
-
Page size (optional, default to 20)
- $sort : string = 'DESC'
-
Sort direction (optional, default to 'DESC')
- $contentType : string = self::contentTypes['getDeliverabilityTests'][0]
-
The value for the Content-Type header. Check self::contentTypes['getDeliverabilityTests'] to see the possible values for this operation
Tags
Return values
PromiseInterface —getDeliverabilityTestsAsyncWithHttpInfo()
Operation getDeliverabilityTestsAsyncWithHttpInfo
public
getDeliverabilityTestsAsyncWithHttpInfo(int $page[, int $size = 20 ][, string $sort = 'DESC' ][, string $contentType = self::contentTypes['getDeliverabilityTests'][0] ]) : PromiseInterface
List load tests
Parameters
- $page : int
-
Page index (optional, default to 0)
- $size : int = 20
-
Page size (optional, default to 20)
- $sort : string = 'DESC'
-
Sort direction (optional, default to 'DESC')
- $contentType : string = self::contentTypes['getDeliverabilityTests'][0]
-
The value for the Content-Type header. Check self::contentTypes['getDeliverabilityTests'] to see the possible values for this operation
Tags
Return values
PromiseInterface —getDeliverabilityTestsRequest()
Create request for operation 'getDeliverabilityTests'
public
getDeliverabilityTestsRequest(int $page[, int $size = 20 ][, string $sort = 'DESC' ][, string $contentType = self::contentTypes['getDeliverabilityTests'][0] ]) : Request
Parameters
- $page : int
-
Page index (optional, default to 0)
- $size : int = 20
-
Page size (optional, default to 20)
- $sort : string = 'DESC'
-
Sort direction (optional, default to 'DESC')
- $contentType : string = self::contentTypes['getDeliverabilityTests'][0]
-
The value for the Content-Type header. Check self::contentTypes['getDeliverabilityTests'] to see the possible values for this operation
Tags
Return values
Request —getDeliverabilityTestsWithHttpInfo()
Operation getDeliverabilityTestsWithHttpInfo
public
getDeliverabilityTestsWithHttpInfo(int $page[, int $size = 20 ][, string $sort = 'DESC' ][, string $contentType = self::contentTypes['getDeliverabilityTests'][0] ]) : array<string|int, mixed>
List load tests
Parameters
- $page : int
-
Page index (optional, default to 0)
- $size : int = 20
-
Page size (optional, default to 20)
- $sort : string = 'DESC'
-
Sort direction (optional, default to 'DESC')
- $contentType : string = self::contentTypes['getDeliverabilityTests'][0]
-
The value for the Content-Type header. Check self::contentTypes['getDeliverabilityTests'] to see the possible values for this operation
Tags
Return values
array<string|int, mixed> —of \MailSlurp\Models\DeliverabilityTestPageDto, HTTP status code, HTTP response headers (array of strings)
getDeliverabilityTestWithHttpInfo()
Operation getDeliverabilityTestWithHttpInfo
public
getDeliverabilityTestWithHttpInfo(string $test_id[, string $contentType = self::contentTypes['getDeliverabilityTest'][0] ]) : array<string|int, mixed>
Get load test
Parameters
- $test_id : string
-
(required)
- $contentType : string = self::contentTypes['getDeliverabilityTest'][0]
-
The value for the Content-Type header. Check self::contentTypes['getDeliverabilityTest'] to see the possible values for this operation
Tags
Return values
array<string|int, mixed> —of \MailSlurp\Models\DeliverabilityTestDto, HTTP status code, HTTP response headers (array of strings)
getHostIndex()
Get the host index
public
getHostIndex() : int
Return values
int —Host index
getLatestDeliverabilitySimulationJob()
Operation getLatestDeliverabilitySimulationJob
public
getLatestDeliverabilitySimulationJob(string $test_id[, string $contentType = self::contentTypes['getLatestDeliverabilitySimulationJob'][0] ]) : DeliverabilitySimulationJobDto
Get latest deliverability simulation job
Parameters
- $test_id : string
-
test_id (required)
- $contentType : string = self::contentTypes['getLatestDeliverabilitySimulationJob'][0]
-
The value for the Content-Type header. Check self::contentTypes['getLatestDeliverabilitySimulationJob'] to see the possible values for this operation
Tags
Return values
DeliverabilitySimulationJobDto —getLatestDeliverabilitySimulationJobAsync()
Operation getLatestDeliverabilitySimulationJobAsync
public
getLatestDeliverabilitySimulationJobAsync(string $test_id[, string $contentType = self::contentTypes['getLatestDeliverabilitySimulationJob'][0] ]) : PromiseInterface
Get latest deliverability simulation job
Parameters
- $test_id : string
-
(required)
- $contentType : string = self::contentTypes['getLatestDeliverabilitySimulationJob'][0]
-
The value for the Content-Type header. Check self::contentTypes['getLatestDeliverabilitySimulationJob'] to see the possible values for this operation
Tags
Return values
PromiseInterface —getLatestDeliverabilitySimulationJobAsyncWithHttpInfo()
Operation getLatestDeliverabilitySimulationJobAsyncWithHttpInfo
public
getLatestDeliverabilitySimulationJobAsyncWithHttpInfo(string $test_id[, string $contentType = self::contentTypes['getLatestDeliverabilitySimulationJob'][0] ]) : PromiseInterface
Get latest deliverability simulation job
Parameters
- $test_id : string
-
(required)
- $contentType : string = self::contentTypes['getLatestDeliverabilitySimulationJob'][0]
-
The value for the Content-Type header. Check self::contentTypes['getLatestDeliverabilitySimulationJob'] to see the possible values for this operation
Tags
Return values
PromiseInterface —getLatestDeliverabilitySimulationJobRequest()
Create request for operation 'getLatestDeliverabilitySimulationJob'
public
getLatestDeliverabilitySimulationJobRequest(string $test_id[, string $contentType = self::contentTypes['getLatestDeliverabilitySimulationJob'][0] ]) : Request
Parameters
- $test_id : string
-
(required)
- $contentType : string = self::contentTypes['getLatestDeliverabilitySimulationJob'][0]
-
The value for the Content-Type header. Check self::contentTypes['getLatestDeliverabilitySimulationJob'] to see the possible values for this operation
Tags
Return values
Request —getLatestDeliverabilitySimulationJobWithHttpInfo()
Operation getLatestDeliverabilitySimulationJobWithHttpInfo
public
getLatestDeliverabilitySimulationJobWithHttpInfo(string $test_id[, string $contentType = self::contentTypes['getLatestDeliverabilitySimulationJob'][0] ]) : array<string|int, mixed>
Get latest deliverability simulation job
Parameters
- $test_id : string
-
(required)
- $contentType : string = self::contentTypes['getLatestDeliverabilitySimulationJob'][0]
-
The value for the Content-Type header. Check self::contentTypes['getLatestDeliverabilitySimulationJob'] to see the possible values for this operation
Tags
Return values
array<string|int, mixed> —of \MailSlurp\Models\DeliverabilitySimulationJobDto, HTTP status code, HTTP response headers (array of strings)
pauseDeliverabilitySimulationJob()
Operation pauseDeliverabilitySimulationJob
public
pauseDeliverabilitySimulationJob(string $test_id, string $job_id[, string $contentType = self::contentTypes['pauseDeliverabilitySimulationJob'][0] ]) : DeliverabilitySimulationJobDto
Pause deliverability simulation job
Parameters
- $test_id : string
-
test_id (required)
- $job_id : string
-
job_id (required)
- $contentType : string = self::contentTypes['pauseDeliverabilitySimulationJob'][0]
-
The value for the Content-Type header. Check self::contentTypes['pauseDeliverabilitySimulationJob'] to see the possible values for this operation
Tags
Return values
DeliverabilitySimulationJobDto —pauseDeliverabilitySimulationJobAsync()
Operation pauseDeliverabilitySimulationJobAsync
public
pauseDeliverabilitySimulationJobAsync(string $test_id, string $job_id[, string $contentType = self::contentTypes['pauseDeliverabilitySimulationJob'][0] ]) : PromiseInterface
Pause deliverability simulation job
Parameters
- $test_id : string
-
(required)
- $job_id : string
-
(required)
- $contentType : string = self::contentTypes['pauseDeliverabilitySimulationJob'][0]
-
The value for the Content-Type header. Check self::contentTypes['pauseDeliverabilitySimulationJob'] to see the possible values for this operation
Tags
Return values
PromiseInterface —pauseDeliverabilitySimulationJobAsyncWithHttpInfo()
Operation pauseDeliverabilitySimulationJobAsyncWithHttpInfo
public
pauseDeliverabilitySimulationJobAsyncWithHttpInfo(string $test_id, string $job_id[, string $contentType = self::contentTypes['pauseDeliverabilitySimulationJob'][0] ]) : PromiseInterface
Pause deliverability simulation job
Parameters
- $test_id : string
-
(required)
- $job_id : string
-
(required)
- $contentType : string = self::contentTypes['pauseDeliverabilitySimulationJob'][0]
-
The value for the Content-Type header. Check self::contentTypes['pauseDeliverabilitySimulationJob'] to see the possible values for this operation
Tags
Return values
PromiseInterface —pauseDeliverabilitySimulationJobRequest()
Create request for operation 'pauseDeliverabilitySimulationJob'
public
pauseDeliverabilitySimulationJobRequest(string $test_id, string $job_id[, string $contentType = self::contentTypes['pauseDeliverabilitySimulationJob'][0] ]) : Request
Parameters
- $test_id : string
-
(required)
- $job_id : string
-
(required)
- $contentType : string = self::contentTypes['pauseDeliverabilitySimulationJob'][0]
-
The value for the Content-Type header. Check self::contentTypes['pauseDeliverabilitySimulationJob'] to see the possible values for this operation
Tags
Return values
Request —pauseDeliverabilitySimulationJobWithHttpInfo()
Operation pauseDeliverabilitySimulationJobWithHttpInfo
public
pauseDeliverabilitySimulationJobWithHttpInfo(string $test_id, string $job_id[, string $contentType = self::contentTypes['pauseDeliverabilitySimulationJob'][0] ]) : array<string|int, mixed>
Pause deliverability simulation job
Parameters
- $test_id : string
-
(required)
- $job_id : string
-
(required)
- $contentType : string = self::contentTypes['pauseDeliverabilitySimulationJob'][0]
-
The value for the Content-Type header. Check self::contentTypes['pauseDeliverabilitySimulationJob'] to see the possible values for this operation
Tags
Return values
array<string|int, mixed> —of \MailSlurp\Models\DeliverabilitySimulationJobDto, HTTP status code, HTTP response headers (array of strings)
pauseDeliverabilityTest()
Operation pauseDeliverabilityTest
public
pauseDeliverabilityTest(string $test_id[, string $contentType = self::contentTypes['pauseDeliverabilityTest'][0] ]) : DeliverabilityTestDto
Pause load test
Parameters
- $test_id : string
-
test_id (required)
- $contentType : string = self::contentTypes['pauseDeliverabilityTest'][0]
-
The value for the Content-Type header. Check self::contentTypes['pauseDeliverabilityTest'] to see the possible values for this operation
Tags
Return values
DeliverabilityTestDto —pauseDeliverabilityTestAsync()
Operation pauseDeliverabilityTestAsync
public
pauseDeliverabilityTestAsync(string $test_id[, string $contentType = self::contentTypes['pauseDeliverabilityTest'][0] ]) : PromiseInterface
Pause load test
Parameters
- $test_id : string
-
(required)
- $contentType : string = self::contentTypes['pauseDeliverabilityTest'][0]
-
The value for the Content-Type header. Check self::contentTypes['pauseDeliverabilityTest'] to see the possible values for this operation
Tags
Return values
PromiseInterface —pauseDeliverabilityTestAsyncWithHttpInfo()
Operation pauseDeliverabilityTestAsyncWithHttpInfo
public
pauseDeliverabilityTestAsyncWithHttpInfo(string $test_id[, string $contentType = self::contentTypes['pauseDeliverabilityTest'][0] ]) : PromiseInterface
Pause load test
Parameters
- $test_id : string
-
(required)
- $contentType : string = self::contentTypes['pauseDeliverabilityTest'][0]
-
The value for the Content-Type header. Check self::contentTypes['pauseDeliverabilityTest'] to see the possible values for this operation
Tags
Return values
PromiseInterface —pauseDeliverabilityTestRequest()
Create request for operation 'pauseDeliverabilityTest'
public
pauseDeliverabilityTestRequest(string $test_id[, string $contentType = self::contentTypes['pauseDeliverabilityTest'][0] ]) : Request
Parameters
- $test_id : string
-
(required)
- $contentType : string = self::contentTypes['pauseDeliverabilityTest'][0]
-
The value for the Content-Type header. Check self::contentTypes['pauseDeliverabilityTest'] to see the possible values for this operation
Tags
Return values
Request —pauseDeliverabilityTestWithHttpInfo()
Operation pauseDeliverabilityTestWithHttpInfo
public
pauseDeliverabilityTestWithHttpInfo(string $test_id[, string $contentType = self::contentTypes['pauseDeliverabilityTest'][0] ]) : array<string|int, mixed>
Pause load test
Parameters
- $test_id : string
-
(required)
- $contentType : string = self::contentTypes['pauseDeliverabilityTest'][0]
-
The value for the Content-Type header. Check self::contentTypes['pauseDeliverabilityTest'] to see the possible values for this operation
Tags
Return values
array<string|int, mixed> —of \MailSlurp\Models\DeliverabilityTestDto, HTTP status code, HTTP response headers (array of strings)
pollDeliverabilityTestStatus()
Operation pollDeliverabilityTestStatus
public
pollDeliverabilityTestStatus(string $test_id[, string $contentType = self::contentTypes['pollDeliverabilityTestStatus'][0] ]) : DeliverabilityPollStatusResultDto
Poll load-test status
Parameters
- $test_id : string
-
test_id (required)
- $contentType : string = self::contentTypes['pollDeliverabilityTestStatus'][0]
-
The value for the Content-Type header. Check self::contentTypes['pollDeliverabilityTestStatus'] to see the possible values for this operation
Tags
Return values
DeliverabilityPollStatusResultDto —pollDeliverabilityTestStatusAsync()
Operation pollDeliverabilityTestStatusAsync
public
pollDeliverabilityTestStatusAsync(string $test_id[, string $contentType = self::contentTypes['pollDeliverabilityTestStatus'][0] ]) : PromiseInterface
Poll load-test status
Parameters
- $test_id : string
-
(required)
- $contentType : string = self::contentTypes['pollDeliverabilityTestStatus'][0]
-
The value for the Content-Type header. Check self::contentTypes['pollDeliverabilityTestStatus'] to see the possible values for this operation
Tags
Return values
PromiseInterface —pollDeliverabilityTestStatusAsyncWithHttpInfo()
Operation pollDeliverabilityTestStatusAsyncWithHttpInfo
public
pollDeliverabilityTestStatusAsyncWithHttpInfo(string $test_id[, string $contentType = self::contentTypes['pollDeliverabilityTestStatus'][0] ]) : PromiseInterface
Poll load-test status
Parameters
- $test_id : string
-
(required)
- $contentType : string = self::contentTypes['pollDeliverabilityTestStatus'][0]
-
The value for the Content-Type header. Check self::contentTypes['pollDeliverabilityTestStatus'] to see the possible values for this operation
Tags
Return values
PromiseInterface —pollDeliverabilityTestStatusRequest()
Create request for operation 'pollDeliverabilityTestStatus'
public
pollDeliverabilityTestStatusRequest(string $test_id[, string $contentType = self::contentTypes['pollDeliverabilityTestStatus'][0] ]) : Request
Parameters
- $test_id : string
-
(required)
- $contentType : string = self::contentTypes['pollDeliverabilityTestStatus'][0]
-
The value for the Content-Type header. Check self::contentTypes['pollDeliverabilityTestStatus'] to see the possible values for this operation
Tags
Return values
Request —pollDeliverabilityTestStatusWithHttpInfo()
Operation pollDeliverabilityTestStatusWithHttpInfo
public
pollDeliverabilityTestStatusWithHttpInfo(string $test_id[, string $contentType = self::contentTypes['pollDeliverabilityTestStatus'][0] ]) : array<string|int, mixed>
Poll load-test status
Parameters
- $test_id : string
-
(required)
- $contentType : string = self::contentTypes['pollDeliverabilityTestStatus'][0]
-
The value for the Content-Type header. Check self::contentTypes['pollDeliverabilityTestStatus'] to see the possible values for this operation
Tags
Return values
array<string|int, mixed> —of \MailSlurp\Models\DeliverabilityPollStatusResultDto, HTTP status code, HTTP response headers (array of strings)
resumeDeliverabilitySimulationJob()
Operation resumeDeliverabilitySimulationJob
public
resumeDeliverabilitySimulationJob(string $test_id, string $job_id[, string $contentType = self::contentTypes['resumeDeliverabilitySimulationJob'][0] ]) : DeliverabilitySimulationJobDto
Resume deliverability simulation job
Parameters
- $test_id : string
-
test_id (required)
- $job_id : string
-
job_id (required)
- $contentType : string = self::contentTypes['resumeDeliverabilitySimulationJob'][0]
-
The value for the Content-Type header. Check self::contentTypes['resumeDeliverabilitySimulationJob'] to see the possible values for this operation
Tags
Return values
DeliverabilitySimulationJobDto —resumeDeliverabilitySimulationJobAsync()
Operation resumeDeliverabilitySimulationJobAsync
public
resumeDeliverabilitySimulationJobAsync(string $test_id, string $job_id[, string $contentType = self::contentTypes['resumeDeliverabilitySimulationJob'][0] ]) : PromiseInterface
Resume deliverability simulation job
Parameters
- $test_id : string
-
(required)
- $job_id : string
-
(required)
- $contentType : string = self::contentTypes['resumeDeliverabilitySimulationJob'][0]
-
The value for the Content-Type header. Check self::contentTypes['resumeDeliverabilitySimulationJob'] to see the possible values for this operation
Tags
Return values
PromiseInterface —resumeDeliverabilitySimulationJobAsyncWithHttpInfo()
Operation resumeDeliverabilitySimulationJobAsyncWithHttpInfo
public
resumeDeliverabilitySimulationJobAsyncWithHttpInfo(string $test_id, string $job_id[, string $contentType = self::contentTypes['resumeDeliverabilitySimulationJob'][0] ]) : PromiseInterface
Resume deliverability simulation job
Parameters
- $test_id : string
-
(required)
- $job_id : string
-
(required)
- $contentType : string = self::contentTypes['resumeDeliverabilitySimulationJob'][0]
-
The value for the Content-Type header. Check self::contentTypes['resumeDeliverabilitySimulationJob'] to see the possible values for this operation
Tags
Return values
PromiseInterface —resumeDeliverabilitySimulationJobRequest()
Create request for operation 'resumeDeliverabilitySimulationJob'
public
resumeDeliverabilitySimulationJobRequest(string $test_id, string $job_id[, string $contentType = self::contentTypes['resumeDeliverabilitySimulationJob'][0] ]) : Request
Parameters
- $test_id : string
-
(required)
- $job_id : string
-
(required)
- $contentType : string = self::contentTypes['resumeDeliverabilitySimulationJob'][0]
-
The value for the Content-Type header. Check self::contentTypes['resumeDeliverabilitySimulationJob'] to see the possible values for this operation
Tags
Return values
Request —resumeDeliverabilitySimulationJobWithHttpInfo()
Operation resumeDeliverabilitySimulationJobWithHttpInfo
public
resumeDeliverabilitySimulationJobWithHttpInfo(string $test_id, string $job_id[, string $contentType = self::contentTypes['resumeDeliverabilitySimulationJob'][0] ]) : array<string|int, mixed>
Resume deliverability simulation job
Parameters
- $test_id : string
-
(required)
- $job_id : string
-
(required)
- $contentType : string = self::contentTypes['resumeDeliverabilitySimulationJob'][0]
-
The value for the Content-Type header. Check self::contentTypes['resumeDeliverabilitySimulationJob'] to see the possible values for this operation
Tags
Return values
array<string|int, mixed> —of \MailSlurp\Models\DeliverabilitySimulationJobDto, HTTP status code, HTTP response headers (array of strings)
setHostIndex()
Set the host index
public
setHostIndex(int $hostIndex) : void
Parameters
- $hostIndex : int
-
Host index (required)
Return values
void —startDeliverabilityTest()
Operation startDeliverabilityTest
public
startDeliverabilityTest(string $test_id[, string $contentType = self::contentTypes['startDeliverabilityTest'][0] ]) : DeliverabilityTestDto
Start or resume load test
Parameters
- $test_id : string
-
test_id (required)
- $contentType : string = self::contentTypes['startDeliverabilityTest'][0]
-
The value for the Content-Type header. Check self::contentTypes['startDeliverabilityTest'] to see the possible values for this operation
Tags
Return values
DeliverabilityTestDto —startDeliverabilityTestAsync()
Operation startDeliverabilityTestAsync
public
startDeliverabilityTestAsync(string $test_id[, string $contentType = self::contentTypes['startDeliverabilityTest'][0] ]) : PromiseInterface
Start or resume load test
Parameters
- $test_id : string
-
(required)
- $contentType : string = self::contentTypes['startDeliverabilityTest'][0]
-
The value for the Content-Type header. Check self::contentTypes['startDeliverabilityTest'] to see the possible values for this operation
Tags
Return values
PromiseInterface —startDeliverabilityTestAsyncWithHttpInfo()
Operation startDeliverabilityTestAsyncWithHttpInfo
public
startDeliverabilityTestAsyncWithHttpInfo(string $test_id[, string $contentType = self::contentTypes['startDeliverabilityTest'][0] ]) : PromiseInterface
Start or resume load test
Parameters
- $test_id : string
-
(required)
- $contentType : string = self::contentTypes['startDeliverabilityTest'][0]
-
The value for the Content-Type header. Check self::contentTypes['startDeliverabilityTest'] to see the possible values for this operation
Tags
Return values
PromiseInterface —startDeliverabilityTestRequest()
Create request for operation 'startDeliverabilityTest'
public
startDeliverabilityTestRequest(string $test_id[, string $contentType = self::contentTypes['startDeliverabilityTest'][0] ]) : Request
Parameters
- $test_id : string
-
(required)
- $contentType : string = self::contentTypes['startDeliverabilityTest'][0]
-
The value for the Content-Type header. Check self::contentTypes['startDeliverabilityTest'] to see the possible values for this operation
Tags
Return values
Request —startDeliverabilityTestWithHttpInfo()
Operation startDeliverabilityTestWithHttpInfo
public
startDeliverabilityTestWithHttpInfo(string $test_id[, string $contentType = self::contentTypes['startDeliverabilityTest'][0] ]) : array<string|int, mixed>
Start or resume load test
Parameters
- $test_id : string
-
(required)
- $contentType : string = self::contentTypes['startDeliverabilityTest'][0]
-
The value for the Content-Type header. Check self::contentTypes['startDeliverabilityTest'] to see the possible values for this operation
Tags
Return values
array<string|int, mixed> —of \MailSlurp\Models\DeliverabilityTestDto, HTTP status code, HTTP response headers (array of strings)
stopDeliverabilityTest()
Operation stopDeliverabilityTest
public
stopDeliverabilityTest(string $test_id[, string $contentType = self::contentTypes['stopDeliverabilityTest'][0] ]) : DeliverabilityTestDto
Stop load test
Parameters
- $test_id : string
-
test_id (required)
- $contentType : string = self::contentTypes['stopDeliverabilityTest'][0]
-
The value for the Content-Type header. Check self::contentTypes['stopDeliverabilityTest'] to see the possible values for this operation
Tags
Return values
DeliverabilityTestDto —stopDeliverabilityTestAsync()
Operation stopDeliverabilityTestAsync
public
stopDeliverabilityTestAsync(string $test_id[, string $contentType = self::contentTypes['stopDeliverabilityTest'][0] ]) : PromiseInterface
Stop load test
Parameters
- $test_id : string
-
(required)
- $contentType : string = self::contentTypes['stopDeliverabilityTest'][0]
-
The value for the Content-Type header. Check self::contentTypes['stopDeliverabilityTest'] to see the possible values for this operation
Tags
Return values
PromiseInterface —stopDeliverabilityTestAsyncWithHttpInfo()
Operation stopDeliverabilityTestAsyncWithHttpInfo
public
stopDeliverabilityTestAsyncWithHttpInfo(string $test_id[, string $contentType = self::contentTypes['stopDeliverabilityTest'][0] ]) : PromiseInterface
Stop load test
Parameters
- $test_id : string
-
(required)
- $contentType : string = self::contentTypes['stopDeliverabilityTest'][0]
-
The value for the Content-Type header. Check self::contentTypes['stopDeliverabilityTest'] to see the possible values for this operation
Tags
Return values
PromiseInterface —stopDeliverabilityTestRequest()
Create request for operation 'stopDeliverabilityTest'
public
stopDeliverabilityTestRequest(string $test_id[, string $contentType = self::contentTypes['stopDeliverabilityTest'][0] ]) : Request
Parameters
- $test_id : string
-
(required)
- $contentType : string = self::contentTypes['stopDeliverabilityTest'][0]
-
The value for the Content-Type header. Check self::contentTypes['stopDeliverabilityTest'] to see the possible values for this operation
Tags
Return values
Request —stopDeliverabilityTestWithHttpInfo()
Operation stopDeliverabilityTestWithHttpInfo
public
stopDeliverabilityTestWithHttpInfo(string $test_id[, string $contentType = self::contentTypes['stopDeliverabilityTest'][0] ]) : array<string|int, mixed>
Stop load test
Parameters
- $test_id : string
-
(required)
- $contentType : string = self::contentTypes['stopDeliverabilityTest'][0]
-
The value for the Content-Type header. Check self::contentTypes['stopDeliverabilityTest'] to see the possible values for this operation
Tags
Return values
array<string|int, mixed> —of \MailSlurp\Models\DeliverabilityTestDto, HTTP status code, HTTP response headers (array of strings)
updateDeliverabilityTest()
Operation updateDeliverabilityTest
public
updateDeliverabilityTest(string $test_id, UpdateDeliverabilityTestOptions $update_deliverability_test_options[, string $contentType = self::contentTypes['updateDeliverabilityTest'][0] ]) : DeliverabilityTestDto
Update load test
Parameters
- $test_id : string
-
test_id (required)
- $update_deliverability_test_options : UpdateDeliverabilityTestOptions
-
update_deliverability_test_options (required)
- $contentType : string = self::contentTypes['updateDeliverabilityTest'][0]
-
The value for the Content-Type header. Check self::contentTypes['updateDeliverabilityTest'] to see the possible values for this operation
Tags
Return values
DeliverabilityTestDto —updateDeliverabilityTestAsync()
Operation updateDeliverabilityTestAsync
public
updateDeliverabilityTestAsync(string $test_id, UpdateDeliverabilityTestOptions $update_deliverability_test_options[, string $contentType = self::contentTypes['updateDeliverabilityTest'][0] ]) : PromiseInterface
Update load test
Parameters
- $test_id : string
-
(required)
- $update_deliverability_test_options : UpdateDeliverabilityTestOptions
-
(required)
- $contentType : string = self::contentTypes['updateDeliverabilityTest'][0]
-
The value for the Content-Type header. Check self::contentTypes['updateDeliverabilityTest'] to see the possible values for this operation
Tags
Return values
PromiseInterface —updateDeliverabilityTestAsyncWithHttpInfo()
Operation updateDeliverabilityTestAsyncWithHttpInfo
public
updateDeliverabilityTestAsyncWithHttpInfo(string $test_id, UpdateDeliverabilityTestOptions $update_deliverability_test_options[, string $contentType = self::contentTypes['updateDeliverabilityTest'][0] ]) : PromiseInterface
Update load test
Parameters
- $test_id : string
-
(required)
- $update_deliverability_test_options : UpdateDeliverabilityTestOptions
-
(required)
- $contentType : string = self::contentTypes['updateDeliverabilityTest'][0]
-
The value for the Content-Type header. Check self::contentTypes['updateDeliverabilityTest'] to see the possible values for this operation
Tags
Return values
PromiseInterface —updateDeliverabilityTestRequest()
Create request for operation 'updateDeliverabilityTest'
public
updateDeliverabilityTestRequest(string $test_id, UpdateDeliverabilityTestOptions $update_deliverability_test_options[, string $contentType = self::contentTypes['updateDeliverabilityTest'][0] ]) : Request
Parameters
- $test_id : string
-
(required)
- $update_deliverability_test_options : UpdateDeliverabilityTestOptions
-
(required)
- $contentType : string = self::contentTypes['updateDeliverabilityTest'][0]
-
The value for the Content-Type header. Check self::contentTypes['updateDeliverabilityTest'] to see the possible values for this operation
Tags
Return values
Request —updateDeliverabilityTestWithHttpInfo()
Operation updateDeliverabilityTestWithHttpInfo
public
updateDeliverabilityTestWithHttpInfo(string $test_id, UpdateDeliverabilityTestOptions $update_deliverability_test_options[, string $contentType = self::contentTypes['updateDeliverabilityTest'][0] ]) : array<string|int, mixed>
Update load test
Parameters
- $test_id : string
-
(required)
- $update_deliverability_test_options : UpdateDeliverabilityTestOptions
-
(required)
- $contentType : string = self::contentTypes['updateDeliverabilityTest'][0]
-
The value for the Content-Type header. Check self::contentTypes['updateDeliverabilityTest'] to see the possible values for this operation
Tags
Return values
array<string|int, mixed> —of \MailSlurp\Models\DeliverabilityTestDto, HTTP status code, HTTP response headers (array of strings)
createHttpClientOption()
Create http client option
protected
createHttpClientOption() : array<string|int, mixed>
Tags
Return values
array<string|int, mixed> —of http client options