ApiInboxPlacementTestControllerApi
in package
ApiInboxPlacementTestControllerApi Class Doc Comment
Tags
Table of Contents
- contentTypes = ['confirmInboxPlacementTestSent' => ['application/json'], 'createInboxPlacementTest' => ['application/json'], 'exportInboxPlacementSeedList' => ['application/json'], 'exportInboxPlacementTestResults' => ['application/json'], 'getInboxPlacementAnalyticsBreakdown' => ['application/json'], 'getInboxPlacementAnalyticsSeries' => ['application/json'], 'getInboxPlacementPublicShare' => ['application/json'], 'getInboxPlacementPublicShareAnalysis' => ['application/json'], 'getInboxPlacementTest' => ['application/json'], 'getInboxPlacementTestAnalysis' => ['application/json'], 'getInboxPlacementTestResults' => ['application/json'], 'getInboxPlacementTests' => ['application/json'], 'prepareInboxPlacementTest' => ['application/json']]
- $client : ClientInterface
- $config : Configuration
- $headerSelector : HeaderSelector
- $hostIndex : int
- __construct() : mixed
- confirmInboxPlacementTestSent() : InboxPlacementTestRunDto
- Operation confirmInboxPlacementTestSent
- confirmInboxPlacementTestSentAsync() : PromiseInterface
- Operation confirmInboxPlacementTestSentAsync
- confirmInboxPlacementTestSentAsyncWithHttpInfo() : PromiseInterface
- Operation confirmInboxPlacementTestSentAsyncWithHttpInfo
- confirmInboxPlacementTestSentRequest() : Request
- Create request for operation 'confirmInboxPlacementTestSent'
- confirmInboxPlacementTestSentWithHttpInfo() : array<string|int, mixed>
- Operation confirmInboxPlacementTestSentWithHttpInfo
- createInboxPlacementTest() : InboxPlacementTestRunDto
- Operation createInboxPlacementTest
- createInboxPlacementTestAsync() : PromiseInterface
- Operation createInboxPlacementTestAsync
- createInboxPlacementTestAsyncWithHttpInfo() : PromiseInterface
- Operation createInboxPlacementTestAsyncWithHttpInfo
- createInboxPlacementTestRequest() : Request
- Create request for operation 'createInboxPlacementTest'
- createInboxPlacementTestWithHttpInfo() : array<string|int, mixed>
- Operation createInboxPlacementTestWithHttpInfo
- exportInboxPlacementSeedList() : void
- Operation exportInboxPlacementSeedList
- exportInboxPlacementSeedListAsync() : PromiseInterface
- Operation exportInboxPlacementSeedListAsync
- exportInboxPlacementSeedListAsyncWithHttpInfo() : PromiseInterface
- Operation exportInboxPlacementSeedListAsyncWithHttpInfo
- exportInboxPlacementSeedListRequest() : Request
- Create request for operation 'exportInboxPlacementSeedList'
- exportInboxPlacementSeedListWithHttpInfo() : array<string|int, mixed>
- Operation exportInboxPlacementSeedListWithHttpInfo
- exportInboxPlacementTestResults() : void
- Operation exportInboxPlacementTestResults
- exportInboxPlacementTestResultsAsync() : PromiseInterface
- Operation exportInboxPlacementTestResultsAsync
- exportInboxPlacementTestResultsAsyncWithHttpInfo() : PromiseInterface
- Operation exportInboxPlacementTestResultsAsyncWithHttpInfo
- exportInboxPlacementTestResultsRequest() : Request
- Create request for operation 'exportInboxPlacementTestResults'
- exportInboxPlacementTestResultsWithHttpInfo() : array<string|int, mixed>
- Operation exportInboxPlacementTestResultsWithHttpInfo
- getConfig() : Configuration
- getHostIndex() : int
- Get the host index
- getInboxPlacementAnalyticsBreakdown() : InboxPlacementAnalyticsBreakdownDto
- Operation getInboxPlacementAnalyticsBreakdown
- getInboxPlacementAnalyticsBreakdownAsync() : PromiseInterface
- Operation getInboxPlacementAnalyticsBreakdownAsync
- getInboxPlacementAnalyticsBreakdownAsyncWithHttpInfo() : PromiseInterface
- Operation getInboxPlacementAnalyticsBreakdownAsyncWithHttpInfo
- getInboxPlacementAnalyticsBreakdownRequest() : Request
- Create request for operation 'getInboxPlacementAnalyticsBreakdown'
- getInboxPlacementAnalyticsBreakdownWithHttpInfo() : array<string|int, mixed>
- Operation getInboxPlacementAnalyticsBreakdownWithHttpInfo
- getInboxPlacementAnalyticsSeries() : InboxPlacementAnalyticsSeriesDto
- Operation getInboxPlacementAnalyticsSeries
- getInboxPlacementAnalyticsSeriesAsync() : PromiseInterface
- Operation getInboxPlacementAnalyticsSeriesAsync
- getInboxPlacementAnalyticsSeriesAsyncWithHttpInfo() : PromiseInterface
- Operation getInboxPlacementAnalyticsSeriesAsyncWithHttpInfo
- getInboxPlacementAnalyticsSeriesRequest() : Request
- Create request for operation 'getInboxPlacementAnalyticsSeries'
- getInboxPlacementAnalyticsSeriesWithHttpInfo() : array<string|int, mixed>
- Operation getInboxPlacementAnalyticsSeriesWithHttpInfo
- getInboxPlacementPublicShare() : InboxPlacementPublicShareDto
- Operation getInboxPlacementPublicShare
- getInboxPlacementPublicShareAnalysis() : InboxPlacementAnalysisBundleDto
- Operation getInboxPlacementPublicShareAnalysis
- getInboxPlacementPublicShareAnalysisAsync() : PromiseInterface
- Operation getInboxPlacementPublicShareAnalysisAsync
- getInboxPlacementPublicShareAnalysisAsyncWithHttpInfo() : PromiseInterface
- Operation getInboxPlacementPublicShareAnalysisAsyncWithHttpInfo
- getInboxPlacementPublicShareAnalysisRequest() : Request
- Create request for operation 'getInboxPlacementPublicShareAnalysis'
- getInboxPlacementPublicShareAnalysisWithHttpInfo() : array<string|int, mixed>
- Operation getInboxPlacementPublicShareAnalysisWithHttpInfo
- getInboxPlacementPublicShareAsync() : PromiseInterface
- Operation getInboxPlacementPublicShareAsync
- getInboxPlacementPublicShareAsyncWithHttpInfo() : PromiseInterface
- Operation getInboxPlacementPublicShareAsyncWithHttpInfo
- getInboxPlacementPublicShareRequest() : Request
- Create request for operation 'getInboxPlacementPublicShare'
- getInboxPlacementPublicShareWithHttpInfo() : array<string|int, mixed>
- Operation getInboxPlacementPublicShareWithHttpInfo
- getInboxPlacementTest() : InboxPlacementTestRunDto
- Operation getInboxPlacementTest
- getInboxPlacementTestAnalysis() : InboxPlacementAnalysisBundleDto
- Operation getInboxPlacementTestAnalysis
- getInboxPlacementTestAnalysisAsync() : PromiseInterface
- Operation getInboxPlacementTestAnalysisAsync
- getInboxPlacementTestAnalysisAsyncWithHttpInfo() : PromiseInterface
- Operation getInboxPlacementTestAnalysisAsyncWithHttpInfo
- getInboxPlacementTestAnalysisRequest() : Request
- Create request for operation 'getInboxPlacementTestAnalysis'
- getInboxPlacementTestAnalysisWithHttpInfo() : array<string|int, mixed>
- Operation getInboxPlacementTestAnalysisWithHttpInfo
- getInboxPlacementTestAsync() : PromiseInterface
- Operation getInboxPlacementTestAsync
- getInboxPlacementTestAsyncWithHttpInfo() : PromiseInterface
- Operation getInboxPlacementTestAsyncWithHttpInfo
- getInboxPlacementTestRequest() : Request
- Create request for operation 'getInboxPlacementTest'
- getInboxPlacementTestResults() : InboxPlacementTestResultsDto
- Operation getInboxPlacementTestResults
- getInboxPlacementTestResultsAsync() : PromiseInterface
- Operation getInboxPlacementTestResultsAsync
- getInboxPlacementTestResultsAsyncWithHttpInfo() : PromiseInterface
- Operation getInboxPlacementTestResultsAsyncWithHttpInfo
- getInboxPlacementTestResultsRequest() : Request
- Create request for operation 'getInboxPlacementTestResults'
- getInboxPlacementTestResultsWithHttpInfo() : array<string|int, mixed>
- Operation getInboxPlacementTestResultsWithHttpInfo
- getInboxPlacementTests() : array<string|int, InboxPlacementTestRunDto>
- Operation getInboxPlacementTests
- getInboxPlacementTestsAsync() : PromiseInterface
- Operation getInboxPlacementTestsAsync
- getInboxPlacementTestsAsyncWithHttpInfo() : PromiseInterface
- Operation getInboxPlacementTestsAsyncWithHttpInfo
- getInboxPlacementTestsRequest() : Request
- Create request for operation 'getInboxPlacementTests'
- getInboxPlacementTestsWithHttpInfo() : array<string|int, mixed>
- Operation getInboxPlacementTestsWithHttpInfo
- getInboxPlacementTestWithHttpInfo() : array<string|int, mixed>
- Operation getInboxPlacementTestWithHttpInfo
- prepareInboxPlacementTest() : InboxPlacementTestRunDto
- Operation prepareInboxPlacementTest
- prepareInboxPlacementTestAsync() : PromiseInterface
- Operation prepareInboxPlacementTestAsync
- prepareInboxPlacementTestAsyncWithHttpInfo() : PromiseInterface
- Operation prepareInboxPlacementTestAsyncWithHttpInfo
- prepareInboxPlacementTestRequest() : Request
- Create request for operation 'prepareInboxPlacementTest'
- prepareInboxPlacementTestWithHttpInfo() : array<string|int, mixed>
- Operation prepareInboxPlacementTestWithHttpInfo
- setHostIndex() : void
- Set the host index
- createHttpClientOption() : array<string|int, mixed>
- Create http client option
Constants
contentTypes
public
array<string|int, string>
contentTypes
= ['confirmInboxPlacementTestSent' => ['application/json'], 'createInboxPlacementTest' => ['application/json'], 'exportInboxPlacementSeedList' => ['application/json'], 'exportInboxPlacementTestResults' => ['application/json'], 'getInboxPlacementAnalyticsBreakdown' => ['application/json'], 'getInboxPlacementAnalyticsSeries' => ['application/json'], 'getInboxPlacementPublicShare' => ['application/json'], 'getInboxPlacementPublicShareAnalysis' => ['application/json'], 'getInboxPlacementTest' => ['application/json'], 'getInboxPlacementTestAnalysis' => ['application/json'], 'getInboxPlacementTestResults' => ['application/json'], 'getInboxPlacementTests' => ['application/json'], 'prepareInboxPlacementTest' => ['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 —confirmInboxPlacementTestSent()
Operation confirmInboxPlacementTestSent
public
confirmInboxPlacementTestSent(string $id[, string $contentType = self::contentTypes['confirmInboxPlacementTestSent'][0] ]) : InboxPlacementTestRunDto
Confirm an inbox placement test email has been sent
Parameters
- $id : string
-
id (required)
- $contentType : string = self::contentTypes['confirmInboxPlacementTestSent'][0]
-
The value for the Content-Type header. Check self::contentTypes['confirmInboxPlacementTestSent'] to see the possible values for this operation
Tags
Return values
InboxPlacementTestRunDto —confirmInboxPlacementTestSentAsync()
Operation confirmInboxPlacementTestSentAsync
public
confirmInboxPlacementTestSentAsync(string $id[, string $contentType = self::contentTypes['confirmInboxPlacementTestSent'][0] ]) : PromiseInterface
Confirm an inbox placement test email has been sent
Parameters
- $id : string
-
(required)
- $contentType : string = self::contentTypes['confirmInboxPlacementTestSent'][0]
-
The value for the Content-Type header. Check self::contentTypes['confirmInboxPlacementTestSent'] to see the possible values for this operation
Tags
Return values
PromiseInterface —confirmInboxPlacementTestSentAsyncWithHttpInfo()
Operation confirmInboxPlacementTestSentAsyncWithHttpInfo
public
confirmInboxPlacementTestSentAsyncWithHttpInfo(string $id[, string $contentType = self::contentTypes['confirmInboxPlacementTestSent'][0] ]) : PromiseInterface
Confirm an inbox placement test email has been sent
Parameters
- $id : string
-
(required)
- $contentType : string = self::contentTypes['confirmInboxPlacementTestSent'][0]
-
The value for the Content-Type header. Check self::contentTypes['confirmInboxPlacementTestSent'] to see the possible values for this operation
Tags
Return values
PromiseInterface —confirmInboxPlacementTestSentRequest()
Create request for operation 'confirmInboxPlacementTestSent'
public
confirmInboxPlacementTestSentRequest(string $id[, string $contentType = self::contentTypes['confirmInboxPlacementTestSent'][0] ]) : Request
Parameters
- $id : string
-
(required)
- $contentType : string = self::contentTypes['confirmInboxPlacementTestSent'][0]
-
The value for the Content-Type header. Check self::contentTypes['confirmInboxPlacementTestSent'] to see the possible values for this operation
Tags
Return values
Request —confirmInboxPlacementTestSentWithHttpInfo()
Operation confirmInboxPlacementTestSentWithHttpInfo
public
confirmInboxPlacementTestSentWithHttpInfo(string $id[, string $contentType = self::contentTypes['confirmInboxPlacementTestSent'][0] ]) : array<string|int, mixed>
Confirm an inbox placement test email has been sent
Parameters
- $id : string
-
(required)
- $contentType : string = self::contentTypes['confirmInboxPlacementTestSent'][0]
-
The value for the Content-Type header. Check self::contentTypes['confirmInboxPlacementTestSent'] to see the possible values for this operation
Tags
Return values
array<string|int, mixed> —of \MailSlurp\Models\InboxPlacementTestRunDto, HTTP status code, HTTP response headers (array of strings)
createInboxPlacementTest()
Operation createInboxPlacementTest
public
createInboxPlacementTest(CreateInboxPlacementTestOptions $create_inbox_placement_test_options[, string $contentType = self::contentTypes['createInboxPlacementTest'][0] ]) : InboxPlacementTestRunDto
Create a new direct-send inbox placement test
Parameters
- $create_inbox_placement_test_options : CreateInboxPlacementTestOptions
-
create_inbox_placement_test_options (required)
- $contentType : string = self::contentTypes['createInboxPlacementTest'][0]
-
The value for the Content-Type header. Check self::contentTypes['createInboxPlacementTest'] to see the possible values for this operation
Tags
Return values
InboxPlacementTestRunDto —createInboxPlacementTestAsync()
Operation createInboxPlacementTestAsync
public
createInboxPlacementTestAsync(CreateInboxPlacementTestOptions $create_inbox_placement_test_options[, string $contentType = self::contentTypes['createInboxPlacementTest'][0] ]) : PromiseInterface
Create a new direct-send inbox placement test
Parameters
- $create_inbox_placement_test_options : CreateInboxPlacementTestOptions
-
(required)
- $contentType : string = self::contentTypes['createInboxPlacementTest'][0]
-
The value for the Content-Type header. Check self::contentTypes['createInboxPlacementTest'] to see the possible values for this operation
Tags
Return values
PromiseInterface —createInboxPlacementTestAsyncWithHttpInfo()
Operation createInboxPlacementTestAsyncWithHttpInfo
public
createInboxPlacementTestAsyncWithHttpInfo(CreateInboxPlacementTestOptions $create_inbox_placement_test_options[, string $contentType = self::contentTypes['createInboxPlacementTest'][0] ]) : PromiseInterface
Create a new direct-send inbox placement test
Parameters
- $create_inbox_placement_test_options : CreateInboxPlacementTestOptions
-
(required)
- $contentType : string = self::contentTypes['createInboxPlacementTest'][0]
-
The value for the Content-Type header. Check self::contentTypes['createInboxPlacementTest'] to see the possible values for this operation
Tags
Return values
PromiseInterface —createInboxPlacementTestRequest()
Create request for operation 'createInboxPlacementTest'
public
createInboxPlacementTestRequest(CreateInboxPlacementTestOptions $create_inbox_placement_test_options[, string $contentType = self::contentTypes['createInboxPlacementTest'][0] ]) : Request
Parameters
- $create_inbox_placement_test_options : CreateInboxPlacementTestOptions
-
(required)
- $contentType : string = self::contentTypes['createInboxPlacementTest'][0]
-
The value for the Content-Type header. Check self::contentTypes['createInboxPlacementTest'] to see the possible values for this operation
Tags
Return values
Request —createInboxPlacementTestWithHttpInfo()
Operation createInboxPlacementTestWithHttpInfo
public
createInboxPlacementTestWithHttpInfo(CreateInboxPlacementTestOptions $create_inbox_placement_test_options[, string $contentType = self::contentTypes['createInboxPlacementTest'][0] ]) : array<string|int, mixed>
Create a new direct-send inbox placement test
Parameters
- $create_inbox_placement_test_options : CreateInboxPlacementTestOptions
-
(required)
- $contentType : string = self::contentTypes['createInboxPlacementTest'][0]
-
The value for the Content-Type header. Check self::contentTypes['createInboxPlacementTest'] to see the possible values for this operation
Tags
Return values
array<string|int, mixed> —of \MailSlurp\Models\InboxPlacementTestRunDto, HTTP status code, HTTP response headers (array of strings)
exportInboxPlacementSeedList()
Operation exportInboxPlacementSeedList
public
exportInboxPlacementSeedList(string $id[, string $provider = 'GENERIC' ][, string $contentType = self::contentTypes['exportInboxPlacementSeedList'][0] ]) : void
Download inbox placement seed addresses as an email-platform CSV
Parameters
- $id : string
-
id (required)
- $provider : string = 'GENERIC'
-
provider (optional, default to 'GENERIC')
- $contentType : string = self::contentTypes['exportInboxPlacementSeedList'][0]
-
The value for the Content-Type header. Check self::contentTypes['exportInboxPlacementSeedList'] to see the possible values for this operation
Tags
Return values
void —exportInboxPlacementSeedListAsync()
Operation exportInboxPlacementSeedListAsync
public
exportInboxPlacementSeedListAsync(string $id[, string $provider = 'GENERIC' ][, string $contentType = self::contentTypes['exportInboxPlacementSeedList'][0] ]) : PromiseInterface
Download inbox placement seed addresses as an email-platform CSV
Parameters
- $id : string
-
(required)
- $provider : string = 'GENERIC'
-
(optional, default to 'GENERIC')
- $contentType : string = self::contentTypes['exportInboxPlacementSeedList'][0]
-
The value for the Content-Type header. Check self::contentTypes['exportInboxPlacementSeedList'] to see the possible values for this operation
Tags
Return values
PromiseInterface —exportInboxPlacementSeedListAsyncWithHttpInfo()
Operation exportInboxPlacementSeedListAsyncWithHttpInfo
public
exportInboxPlacementSeedListAsyncWithHttpInfo(string $id[, string $provider = 'GENERIC' ][, string $contentType = self::contentTypes['exportInboxPlacementSeedList'][0] ]) : PromiseInterface
Download inbox placement seed addresses as an email-platform CSV
Parameters
- $id : string
-
(required)
- $provider : string = 'GENERIC'
-
(optional, default to 'GENERIC')
- $contentType : string = self::contentTypes['exportInboxPlacementSeedList'][0]
-
The value for the Content-Type header. Check self::contentTypes['exportInboxPlacementSeedList'] to see the possible values for this operation
Tags
Return values
PromiseInterface —exportInboxPlacementSeedListRequest()
Create request for operation 'exportInboxPlacementSeedList'
public
exportInboxPlacementSeedListRequest(string $id[, string $provider = 'GENERIC' ][, string $contentType = self::contentTypes['exportInboxPlacementSeedList'][0] ]) : Request
Parameters
- $id : string
-
(required)
- $provider : string = 'GENERIC'
-
(optional, default to 'GENERIC')
- $contentType : string = self::contentTypes['exportInboxPlacementSeedList'][0]
-
The value for the Content-Type header. Check self::contentTypes['exportInboxPlacementSeedList'] to see the possible values for this operation
Tags
Return values
Request —exportInboxPlacementSeedListWithHttpInfo()
Operation exportInboxPlacementSeedListWithHttpInfo
public
exportInboxPlacementSeedListWithHttpInfo(string $id[, string $provider = 'GENERIC' ][, string $contentType = self::contentTypes['exportInboxPlacementSeedList'][0] ]) : array<string|int, mixed>
Download inbox placement seed addresses as an email-platform CSV
Parameters
- $id : string
-
(required)
- $provider : string = 'GENERIC'
-
(optional, default to 'GENERIC')
- $contentType : string = self::contentTypes['exportInboxPlacementSeedList'][0]
-
The value for the Content-Type header. Check self::contentTypes['exportInboxPlacementSeedList'] 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)
exportInboxPlacementTestResults()
Operation exportInboxPlacementTestResults
public
exportInboxPlacementTestResults(string $id[, string $contentType = self::contentTypes['exportInboxPlacementTestResults'][0] ]) : void
Export inbox placement test results as CSV
Parameters
- $id : string
-
id (required)
- $contentType : string = self::contentTypes['exportInboxPlacementTestResults'][0]
-
The value for the Content-Type header. Check self::contentTypes['exportInboxPlacementTestResults'] to see the possible values for this operation
Tags
Return values
void —exportInboxPlacementTestResultsAsync()
Operation exportInboxPlacementTestResultsAsync
public
exportInboxPlacementTestResultsAsync(string $id[, string $contentType = self::contentTypes['exportInboxPlacementTestResults'][0] ]) : PromiseInterface
Export inbox placement test results as CSV
Parameters
- $id : string
-
(required)
- $contentType : string = self::contentTypes['exportInboxPlacementTestResults'][0]
-
The value for the Content-Type header. Check self::contentTypes['exportInboxPlacementTestResults'] to see the possible values for this operation
Tags
Return values
PromiseInterface —exportInboxPlacementTestResultsAsyncWithHttpInfo()
Operation exportInboxPlacementTestResultsAsyncWithHttpInfo
public
exportInboxPlacementTestResultsAsyncWithHttpInfo(string $id[, string $contentType = self::contentTypes['exportInboxPlacementTestResults'][0] ]) : PromiseInterface
Export inbox placement test results as CSV
Parameters
- $id : string
-
(required)
- $contentType : string = self::contentTypes['exportInboxPlacementTestResults'][0]
-
The value for the Content-Type header. Check self::contentTypes['exportInboxPlacementTestResults'] to see the possible values for this operation
Tags
Return values
PromiseInterface —exportInboxPlacementTestResultsRequest()
Create request for operation 'exportInboxPlacementTestResults'
public
exportInboxPlacementTestResultsRequest(string $id[, string $contentType = self::contentTypes['exportInboxPlacementTestResults'][0] ]) : Request
Parameters
- $id : string
-
(required)
- $contentType : string = self::contentTypes['exportInboxPlacementTestResults'][0]
-
The value for the Content-Type header. Check self::contentTypes['exportInboxPlacementTestResults'] to see the possible values for this operation
Tags
Return values
Request —exportInboxPlacementTestResultsWithHttpInfo()
Operation exportInboxPlacementTestResultsWithHttpInfo
public
exportInboxPlacementTestResultsWithHttpInfo(string $id[, string $contentType = self::contentTypes['exportInboxPlacementTestResults'][0] ]) : array<string|int, mixed>
Export inbox placement test results as CSV
Parameters
- $id : string
-
(required)
- $contentType : string = self::contentTypes['exportInboxPlacementTestResults'][0]
-
The value for the Content-Type header. Check self::contentTypes['exportInboxPlacementTestResults'] 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 —getHostIndex()
Get the host index
public
getHostIndex() : int
Return values
int —Host index
getInboxPlacementAnalyticsBreakdown()
Operation getInboxPlacementAnalyticsBreakdown
public
getInboxPlacementAnalyticsBreakdown([DateTime $since = null ][, DateTime $before = null ][, string $sender_domain = null ][, string $from_email = null ][, int $limit = null ][, string $contentType = self::contentTypes['getInboxPlacementAnalyticsBreakdown'][0] ]) : InboxPlacementAnalyticsBreakdownDto
Get inbox placement analytics breakdowns
Parameters
- $since : DateTime = null
-
since (optional)
- $before : DateTime = null
-
before (optional)
- $sender_domain : string = null
-
sender_domain (optional)
- $from_email : string = null
-
from_email (optional)
- $limit : int = null
-
limit (optional)
- $contentType : string = self::contentTypes['getInboxPlacementAnalyticsBreakdown'][0]
-
The value for the Content-Type header. Check self::contentTypes['getInboxPlacementAnalyticsBreakdown'] to see the possible values for this operation
Tags
Return values
InboxPlacementAnalyticsBreakdownDto —getInboxPlacementAnalyticsBreakdownAsync()
Operation getInboxPlacementAnalyticsBreakdownAsync
public
getInboxPlacementAnalyticsBreakdownAsync([DateTime $since = null ][, DateTime $before = null ][, string $sender_domain = null ][, string $from_email = null ][, int $limit = null ][, string $contentType = self::contentTypes['getInboxPlacementAnalyticsBreakdown'][0] ]) : PromiseInterface
Get inbox placement analytics breakdowns
Parameters
- $since : DateTime = null
-
(optional)
- $before : DateTime = null
-
(optional)
- $sender_domain : string = null
-
(optional)
- $from_email : string = null
-
(optional)
- $limit : int = null
-
(optional)
- $contentType : string = self::contentTypes['getInboxPlacementAnalyticsBreakdown'][0]
-
The value for the Content-Type header. Check self::contentTypes['getInboxPlacementAnalyticsBreakdown'] to see the possible values for this operation
Tags
Return values
PromiseInterface —getInboxPlacementAnalyticsBreakdownAsyncWithHttpInfo()
Operation getInboxPlacementAnalyticsBreakdownAsyncWithHttpInfo
public
getInboxPlacementAnalyticsBreakdownAsyncWithHttpInfo([DateTime $since = null ][, DateTime $before = null ][, string $sender_domain = null ][, string $from_email = null ][, int $limit = null ][, string $contentType = self::contentTypes['getInboxPlacementAnalyticsBreakdown'][0] ]) : PromiseInterface
Get inbox placement analytics breakdowns
Parameters
- $since : DateTime = null
-
(optional)
- $before : DateTime = null
-
(optional)
- $sender_domain : string = null
-
(optional)
- $from_email : string = null
-
(optional)
- $limit : int = null
-
(optional)
- $contentType : string = self::contentTypes['getInboxPlacementAnalyticsBreakdown'][0]
-
The value for the Content-Type header. Check self::contentTypes['getInboxPlacementAnalyticsBreakdown'] to see the possible values for this operation
Tags
Return values
PromiseInterface —getInboxPlacementAnalyticsBreakdownRequest()
Create request for operation 'getInboxPlacementAnalyticsBreakdown'
public
getInboxPlacementAnalyticsBreakdownRequest([DateTime $since = null ][, DateTime $before = null ][, string $sender_domain = null ][, string $from_email = null ][, int $limit = null ][, string $contentType = self::contentTypes['getInboxPlacementAnalyticsBreakdown'][0] ]) : Request
Parameters
- $since : DateTime = null
-
(optional)
- $before : DateTime = null
-
(optional)
- $sender_domain : string = null
-
(optional)
- $from_email : string = null
-
(optional)
- $limit : int = null
-
(optional)
- $contentType : string = self::contentTypes['getInboxPlacementAnalyticsBreakdown'][0]
-
The value for the Content-Type header. Check self::contentTypes['getInboxPlacementAnalyticsBreakdown'] to see the possible values for this operation
Tags
Return values
Request —getInboxPlacementAnalyticsBreakdownWithHttpInfo()
Operation getInboxPlacementAnalyticsBreakdownWithHttpInfo
public
getInboxPlacementAnalyticsBreakdownWithHttpInfo([DateTime $since = null ][, DateTime $before = null ][, string $sender_domain = null ][, string $from_email = null ][, int $limit = null ][, string $contentType = self::contentTypes['getInboxPlacementAnalyticsBreakdown'][0] ]) : array<string|int, mixed>
Get inbox placement analytics breakdowns
Parameters
- $since : DateTime = null
-
(optional)
- $before : DateTime = null
-
(optional)
- $sender_domain : string = null
-
(optional)
- $from_email : string = null
-
(optional)
- $limit : int = null
-
(optional)
- $contentType : string = self::contentTypes['getInboxPlacementAnalyticsBreakdown'][0]
-
The value for the Content-Type header. Check self::contentTypes['getInboxPlacementAnalyticsBreakdown'] to see the possible values for this operation
Tags
Return values
array<string|int, mixed> —of \MailSlurp\Models\InboxPlacementAnalyticsBreakdownDto, HTTP status code, HTTP response headers (array of strings)
getInboxPlacementAnalyticsSeries()
Operation getInboxPlacementAnalyticsSeries
public
getInboxPlacementAnalyticsSeries([DateTime $since = null ][, DateTime $before = null ][, string $bucket = 'DAY' ][, string $group_by = 'NONE' ][, string $sender_domain = null ][, string $from_email = null ][, int $run_limit = null ][, int $group_limit = null ][, string $contentType = self::contentTypes['getInboxPlacementAnalyticsSeries'][0] ]) : InboxPlacementAnalyticsSeriesDto
Get inbox placement analytics time series
Parameters
- $since : DateTime = null
-
since (optional)
- $before : DateTime = null
-
before (optional)
- $bucket : string = 'DAY'
-
bucket (optional, default to 'DAY')
- $group_by : string = 'NONE'
-
group_by (optional, default to 'NONE')
- $sender_domain : string = null
-
sender_domain (optional)
- $from_email : string = null
-
from_email (optional)
- $run_limit : int = null
-
run_limit (optional)
- $group_limit : int = null
-
group_limit (optional)
- $contentType : string = self::contentTypes['getInboxPlacementAnalyticsSeries'][0]
-
The value for the Content-Type header. Check self::contentTypes['getInboxPlacementAnalyticsSeries'] to see the possible values for this operation
Tags
Return values
InboxPlacementAnalyticsSeriesDto —getInboxPlacementAnalyticsSeriesAsync()
Operation getInboxPlacementAnalyticsSeriesAsync
public
getInboxPlacementAnalyticsSeriesAsync([DateTime $since = null ][, DateTime $before = null ][, string $bucket = 'DAY' ][, string $group_by = 'NONE' ][, string $sender_domain = null ][, string $from_email = null ][, int $run_limit = null ][, int $group_limit = null ][, string $contentType = self::contentTypes['getInboxPlacementAnalyticsSeries'][0] ]) : PromiseInterface
Get inbox placement analytics time series
Parameters
- $since : DateTime = null
-
(optional)
- $before : DateTime = null
-
(optional)
- $bucket : string = 'DAY'
-
(optional, default to 'DAY')
- $group_by : string = 'NONE'
-
(optional, default to 'NONE')
- $sender_domain : string = null
-
(optional)
- $from_email : string = null
-
(optional)
- $run_limit : int = null
-
(optional)
- $group_limit : int = null
-
(optional)
- $contentType : string = self::contentTypes['getInboxPlacementAnalyticsSeries'][0]
-
The value for the Content-Type header. Check self::contentTypes['getInboxPlacementAnalyticsSeries'] to see the possible values for this operation
Tags
Return values
PromiseInterface —getInboxPlacementAnalyticsSeriesAsyncWithHttpInfo()
Operation getInboxPlacementAnalyticsSeriesAsyncWithHttpInfo
public
getInboxPlacementAnalyticsSeriesAsyncWithHttpInfo([DateTime $since = null ][, DateTime $before = null ][, string $bucket = 'DAY' ][, string $group_by = 'NONE' ][, string $sender_domain = null ][, string $from_email = null ][, int $run_limit = null ][, int $group_limit = null ][, string $contentType = self::contentTypes['getInboxPlacementAnalyticsSeries'][0] ]) : PromiseInterface
Get inbox placement analytics time series
Parameters
- $since : DateTime = null
-
(optional)
- $before : DateTime = null
-
(optional)
- $bucket : string = 'DAY'
-
(optional, default to 'DAY')
- $group_by : string = 'NONE'
-
(optional, default to 'NONE')
- $sender_domain : string = null
-
(optional)
- $from_email : string = null
-
(optional)
- $run_limit : int = null
-
(optional)
- $group_limit : int = null
-
(optional)
- $contentType : string = self::contentTypes['getInboxPlacementAnalyticsSeries'][0]
-
The value for the Content-Type header. Check self::contentTypes['getInboxPlacementAnalyticsSeries'] to see the possible values for this operation
Tags
Return values
PromiseInterface —getInboxPlacementAnalyticsSeriesRequest()
Create request for operation 'getInboxPlacementAnalyticsSeries'
public
getInboxPlacementAnalyticsSeriesRequest([DateTime $since = null ][, DateTime $before = null ][, string $bucket = 'DAY' ][, string $group_by = 'NONE' ][, string $sender_domain = null ][, string $from_email = null ][, int $run_limit = null ][, int $group_limit = null ][, string $contentType = self::contentTypes['getInboxPlacementAnalyticsSeries'][0] ]) : Request
Parameters
- $since : DateTime = null
-
(optional)
- $before : DateTime = null
-
(optional)
- $bucket : string = 'DAY'
-
(optional, default to 'DAY')
- $group_by : string = 'NONE'
-
(optional, default to 'NONE')
- $sender_domain : string = null
-
(optional)
- $from_email : string = null
-
(optional)
- $run_limit : int = null
-
(optional)
- $group_limit : int = null
-
(optional)
- $contentType : string = self::contentTypes['getInboxPlacementAnalyticsSeries'][0]
-
The value for the Content-Type header. Check self::contentTypes['getInboxPlacementAnalyticsSeries'] to see the possible values for this operation
Tags
Return values
Request —getInboxPlacementAnalyticsSeriesWithHttpInfo()
Operation getInboxPlacementAnalyticsSeriesWithHttpInfo
public
getInboxPlacementAnalyticsSeriesWithHttpInfo([DateTime $since = null ][, DateTime $before = null ][, string $bucket = 'DAY' ][, string $group_by = 'NONE' ][, string $sender_domain = null ][, string $from_email = null ][, int $run_limit = null ][, int $group_limit = null ][, string $contentType = self::contentTypes['getInboxPlacementAnalyticsSeries'][0] ]) : array<string|int, mixed>
Get inbox placement analytics time series
Parameters
- $since : DateTime = null
-
(optional)
- $before : DateTime = null
-
(optional)
- $bucket : string = 'DAY'
-
(optional, default to 'DAY')
- $group_by : string = 'NONE'
-
(optional, default to 'NONE')
- $sender_domain : string = null
-
(optional)
- $from_email : string = null
-
(optional)
- $run_limit : int = null
-
(optional)
- $group_limit : int = null
-
(optional)
- $contentType : string = self::contentTypes['getInboxPlacementAnalyticsSeries'][0]
-
The value for the Content-Type header. Check self::contentTypes['getInboxPlacementAnalyticsSeries'] to see the possible values for this operation
Tags
Return values
array<string|int, mixed> —of \MailSlurp\Models\InboxPlacementAnalyticsSeriesDto, HTTP status code, HTTP response headers (array of strings)
getInboxPlacementPublicShare()
Operation getInboxPlacementPublicShare
public
getInboxPlacementPublicShare(string $share_token[, string $contentType = self::contentTypes['getInboxPlacementPublicShare'][0] ]) : InboxPlacementPublicShareDto
Get a public inbox placement share
Parameters
- $share_token : string
-
share_token (required)
- $contentType : string = self::contentTypes['getInboxPlacementPublicShare'][0]
-
The value for the Content-Type header. Check self::contentTypes['getInboxPlacementPublicShare'] to see the possible values for this operation
Tags
Return values
InboxPlacementPublicShareDto —getInboxPlacementPublicShareAnalysis()
Operation getInboxPlacementPublicShareAnalysis
public
getInboxPlacementPublicShareAnalysis(string $share_token[, string $contentType = self::contentTypes['getInboxPlacementPublicShareAnalysis'][0] ]) : InboxPlacementAnalysisBundleDto
Get public inbox placement share analysis
Parameters
- $share_token : string
-
share_token (required)
- $contentType : string = self::contentTypes['getInboxPlacementPublicShareAnalysis'][0]
-
The value for the Content-Type header. Check self::contentTypes['getInboxPlacementPublicShareAnalysis'] to see the possible values for this operation
Tags
Return values
InboxPlacementAnalysisBundleDto —getInboxPlacementPublicShareAnalysisAsync()
Operation getInboxPlacementPublicShareAnalysisAsync
public
getInboxPlacementPublicShareAnalysisAsync(string $share_token[, string $contentType = self::contentTypes['getInboxPlacementPublicShareAnalysis'][0] ]) : PromiseInterface
Get public inbox placement share analysis
Parameters
- $share_token : string
-
(required)
- $contentType : string = self::contentTypes['getInboxPlacementPublicShareAnalysis'][0]
-
The value for the Content-Type header. Check self::contentTypes['getInboxPlacementPublicShareAnalysis'] to see the possible values for this operation
Tags
Return values
PromiseInterface —getInboxPlacementPublicShareAnalysisAsyncWithHttpInfo()
Operation getInboxPlacementPublicShareAnalysisAsyncWithHttpInfo
public
getInboxPlacementPublicShareAnalysisAsyncWithHttpInfo(string $share_token[, string $contentType = self::contentTypes['getInboxPlacementPublicShareAnalysis'][0] ]) : PromiseInterface
Get public inbox placement share analysis
Parameters
- $share_token : string
-
(required)
- $contentType : string = self::contentTypes['getInboxPlacementPublicShareAnalysis'][0]
-
The value for the Content-Type header. Check self::contentTypes['getInboxPlacementPublicShareAnalysis'] to see the possible values for this operation
Tags
Return values
PromiseInterface —getInboxPlacementPublicShareAnalysisRequest()
Create request for operation 'getInboxPlacementPublicShareAnalysis'
public
getInboxPlacementPublicShareAnalysisRequest(string $share_token[, string $contentType = self::contentTypes['getInboxPlacementPublicShareAnalysis'][0] ]) : Request
Parameters
- $share_token : string
-
(required)
- $contentType : string = self::contentTypes['getInboxPlacementPublicShareAnalysis'][0]
-
The value for the Content-Type header. Check self::contentTypes['getInboxPlacementPublicShareAnalysis'] to see the possible values for this operation
Tags
Return values
Request —getInboxPlacementPublicShareAnalysisWithHttpInfo()
Operation getInboxPlacementPublicShareAnalysisWithHttpInfo
public
getInboxPlacementPublicShareAnalysisWithHttpInfo(string $share_token[, string $contentType = self::contentTypes['getInboxPlacementPublicShareAnalysis'][0] ]) : array<string|int, mixed>
Get public inbox placement share analysis
Parameters
- $share_token : string
-
(required)
- $contentType : string = self::contentTypes['getInboxPlacementPublicShareAnalysis'][0]
-
The value for the Content-Type header. Check self::contentTypes['getInboxPlacementPublicShareAnalysis'] to see the possible values for this operation
Tags
Return values
array<string|int, mixed> —of \MailSlurp\Models\InboxPlacementAnalysisBundleDto, HTTP status code, HTTP response headers (array of strings)
getInboxPlacementPublicShareAsync()
Operation getInboxPlacementPublicShareAsync
public
getInboxPlacementPublicShareAsync(string $share_token[, string $contentType = self::contentTypes['getInboxPlacementPublicShare'][0] ]) : PromiseInterface
Get a public inbox placement share
Parameters
- $share_token : string
-
(required)
- $contentType : string = self::contentTypes['getInboxPlacementPublicShare'][0]
-
The value for the Content-Type header. Check self::contentTypes['getInboxPlacementPublicShare'] to see the possible values for this operation
Tags
Return values
PromiseInterface —getInboxPlacementPublicShareAsyncWithHttpInfo()
Operation getInboxPlacementPublicShareAsyncWithHttpInfo
public
getInboxPlacementPublicShareAsyncWithHttpInfo(string $share_token[, string $contentType = self::contentTypes['getInboxPlacementPublicShare'][0] ]) : PromiseInterface
Get a public inbox placement share
Parameters
- $share_token : string
-
(required)
- $contentType : string = self::contentTypes['getInboxPlacementPublicShare'][0]
-
The value for the Content-Type header. Check self::contentTypes['getInboxPlacementPublicShare'] to see the possible values for this operation
Tags
Return values
PromiseInterface —getInboxPlacementPublicShareRequest()
Create request for operation 'getInboxPlacementPublicShare'
public
getInboxPlacementPublicShareRequest(string $share_token[, string $contentType = self::contentTypes['getInboxPlacementPublicShare'][0] ]) : Request
Parameters
- $share_token : string
-
(required)
- $contentType : string = self::contentTypes['getInboxPlacementPublicShare'][0]
-
The value for the Content-Type header. Check self::contentTypes['getInboxPlacementPublicShare'] to see the possible values for this operation
Tags
Return values
Request —getInboxPlacementPublicShareWithHttpInfo()
Operation getInboxPlacementPublicShareWithHttpInfo
public
getInboxPlacementPublicShareWithHttpInfo(string $share_token[, string $contentType = self::contentTypes['getInboxPlacementPublicShare'][0] ]) : array<string|int, mixed>
Get a public inbox placement share
Parameters
- $share_token : string
-
(required)
- $contentType : string = self::contentTypes['getInboxPlacementPublicShare'][0]
-
The value for the Content-Type header. Check self::contentTypes['getInboxPlacementPublicShare'] to see the possible values for this operation
Tags
Return values
array<string|int, mixed> —of \MailSlurp\Models\InboxPlacementPublicShareDto, HTTP status code, HTTP response headers (array of strings)
getInboxPlacementTest()
Operation getInboxPlacementTest
public
getInboxPlacementTest(string $id[, string $contentType = self::contentTypes['getInboxPlacementTest'][0] ]) : InboxPlacementTestRunDto
Get inbox placement test run
Parameters
- $id : string
-
id (required)
- $contentType : string = self::contentTypes['getInboxPlacementTest'][0]
-
The value for the Content-Type header. Check self::contentTypes['getInboxPlacementTest'] to see the possible values for this operation
Tags
Return values
InboxPlacementTestRunDto —getInboxPlacementTestAnalysis()
Operation getInboxPlacementTestAnalysis
public
getInboxPlacementTestAnalysis(string $id[, string $contentType = self::contentTypes['getInboxPlacementTestAnalysis'][0] ]) : InboxPlacementAnalysisBundleDto
Get inbox placement run analysis
Parameters
- $id : string
-
id (required)
- $contentType : string = self::contentTypes['getInboxPlacementTestAnalysis'][0]
-
The value for the Content-Type header. Check self::contentTypes['getInboxPlacementTestAnalysis'] to see the possible values for this operation
Tags
Return values
InboxPlacementAnalysisBundleDto —getInboxPlacementTestAnalysisAsync()
Operation getInboxPlacementTestAnalysisAsync
public
getInboxPlacementTestAnalysisAsync(string $id[, string $contentType = self::contentTypes['getInboxPlacementTestAnalysis'][0] ]) : PromiseInterface
Get inbox placement run analysis
Parameters
- $id : string
-
(required)
- $contentType : string = self::contentTypes['getInboxPlacementTestAnalysis'][0]
-
The value for the Content-Type header. Check self::contentTypes['getInboxPlacementTestAnalysis'] to see the possible values for this operation
Tags
Return values
PromiseInterface —getInboxPlacementTestAnalysisAsyncWithHttpInfo()
Operation getInboxPlacementTestAnalysisAsyncWithHttpInfo
public
getInboxPlacementTestAnalysisAsyncWithHttpInfo(string $id[, string $contentType = self::contentTypes['getInboxPlacementTestAnalysis'][0] ]) : PromiseInterface
Get inbox placement run analysis
Parameters
- $id : string
-
(required)
- $contentType : string = self::contentTypes['getInboxPlacementTestAnalysis'][0]
-
The value for the Content-Type header. Check self::contentTypes['getInboxPlacementTestAnalysis'] to see the possible values for this operation
Tags
Return values
PromiseInterface —getInboxPlacementTestAnalysisRequest()
Create request for operation 'getInboxPlacementTestAnalysis'
public
getInboxPlacementTestAnalysisRequest(string $id[, string $contentType = self::contentTypes['getInboxPlacementTestAnalysis'][0] ]) : Request
Parameters
- $id : string
-
(required)
- $contentType : string = self::contentTypes['getInboxPlacementTestAnalysis'][0]
-
The value for the Content-Type header. Check self::contentTypes['getInboxPlacementTestAnalysis'] to see the possible values for this operation
Tags
Return values
Request —getInboxPlacementTestAnalysisWithHttpInfo()
Operation getInboxPlacementTestAnalysisWithHttpInfo
public
getInboxPlacementTestAnalysisWithHttpInfo(string $id[, string $contentType = self::contentTypes['getInboxPlacementTestAnalysis'][0] ]) : array<string|int, mixed>
Get inbox placement run analysis
Parameters
- $id : string
-
(required)
- $contentType : string = self::contentTypes['getInboxPlacementTestAnalysis'][0]
-
The value for the Content-Type header. Check self::contentTypes['getInboxPlacementTestAnalysis'] to see the possible values for this operation
Tags
Return values
array<string|int, mixed> —of \MailSlurp\Models\InboxPlacementAnalysisBundleDto, HTTP status code, HTTP response headers (array of strings)
getInboxPlacementTestAsync()
Operation getInboxPlacementTestAsync
public
getInboxPlacementTestAsync(string $id[, string $contentType = self::contentTypes['getInboxPlacementTest'][0] ]) : PromiseInterface
Get inbox placement test run
Parameters
- $id : string
-
(required)
- $contentType : string = self::contentTypes['getInboxPlacementTest'][0]
-
The value for the Content-Type header. Check self::contentTypes['getInboxPlacementTest'] to see the possible values for this operation
Tags
Return values
PromiseInterface —getInboxPlacementTestAsyncWithHttpInfo()
Operation getInboxPlacementTestAsyncWithHttpInfo
public
getInboxPlacementTestAsyncWithHttpInfo(string $id[, string $contentType = self::contentTypes['getInboxPlacementTest'][0] ]) : PromiseInterface
Get inbox placement test run
Parameters
- $id : string
-
(required)
- $contentType : string = self::contentTypes['getInboxPlacementTest'][0]
-
The value for the Content-Type header. Check self::contentTypes['getInboxPlacementTest'] to see the possible values for this operation
Tags
Return values
PromiseInterface —getInboxPlacementTestRequest()
Create request for operation 'getInboxPlacementTest'
public
getInboxPlacementTestRequest(string $id[, string $contentType = self::contentTypes['getInboxPlacementTest'][0] ]) : Request
Parameters
- $id : string
-
(required)
- $contentType : string = self::contentTypes['getInboxPlacementTest'][0]
-
The value for the Content-Type header. Check self::contentTypes['getInboxPlacementTest'] to see the possible values for this operation
Tags
Return values
Request —getInboxPlacementTestResults()
Operation getInboxPlacementTestResults
public
getInboxPlacementTestResults(string $id[, string $contentType = self::contentTypes['getInboxPlacementTestResults'][0] ]) : InboxPlacementTestResultsDto
Get inbox placement test results
Parameters
- $id : string
-
id (required)
- $contentType : string = self::contentTypes['getInboxPlacementTestResults'][0]
-
The value for the Content-Type header. Check self::contentTypes['getInboxPlacementTestResults'] to see the possible values for this operation
Tags
Return values
InboxPlacementTestResultsDto —getInboxPlacementTestResultsAsync()
Operation getInboxPlacementTestResultsAsync
public
getInboxPlacementTestResultsAsync(string $id[, string $contentType = self::contentTypes['getInboxPlacementTestResults'][0] ]) : PromiseInterface
Get inbox placement test results
Parameters
- $id : string
-
(required)
- $contentType : string = self::contentTypes['getInboxPlacementTestResults'][0]
-
The value for the Content-Type header. Check self::contentTypes['getInboxPlacementTestResults'] to see the possible values for this operation
Tags
Return values
PromiseInterface —getInboxPlacementTestResultsAsyncWithHttpInfo()
Operation getInboxPlacementTestResultsAsyncWithHttpInfo
public
getInboxPlacementTestResultsAsyncWithHttpInfo(string $id[, string $contentType = self::contentTypes['getInboxPlacementTestResults'][0] ]) : PromiseInterface
Get inbox placement test results
Parameters
- $id : string
-
(required)
- $contentType : string = self::contentTypes['getInboxPlacementTestResults'][0]
-
The value for the Content-Type header. Check self::contentTypes['getInboxPlacementTestResults'] to see the possible values for this operation
Tags
Return values
PromiseInterface —getInboxPlacementTestResultsRequest()
Create request for operation 'getInboxPlacementTestResults'
public
getInboxPlacementTestResultsRequest(string $id[, string $contentType = self::contentTypes['getInboxPlacementTestResults'][0] ]) : Request
Parameters
- $id : string
-
(required)
- $contentType : string = self::contentTypes['getInboxPlacementTestResults'][0]
-
The value for the Content-Type header. Check self::contentTypes['getInboxPlacementTestResults'] to see the possible values for this operation
Tags
Return values
Request —getInboxPlacementTestResultsWithHttpInfo()
Operation getInboxPlacementTestResultsWithHttpInfo
public
getInboxPlacementTestResultsWithHttpInfo(string $id[, string $contentType = self::contentTypes['getInboxPlacementTestResults'][0] ]) : array<string|int, mixed>
Get inbox placement test results
Parameters
- $id : string
-
(required)
- $contentType : string = self::contentTypes['getInboxPlacementTestResults'][0]
-
The value for the Content-Type header. Check self::contentTypes['getInboxPlacementTestResults'] to see the possible values for this operation
Tags
Return values
array<string|int, mixed> —of \MailSlurp\Models\InboxPlacementTestResultsDto, HTTP status code, HTTP response headers (array of strings)
getInboxPlacementTests()
Operation getInboxPlacementTests
public
getInboxPlacementTests([int $limit = 50 ][, string $contentType = self::contentTypes['getInboxPlacementTests'][0] ]) : array<string|int, InboxPlacementTestRunDto>
List inbox placement test runs
Parameters
- $limit : int = 50
-
limit (optional, default to 50)
- $contentType : string = self::contentTypes['getInboxPlacementTests'][0]
-
The value for the Content-Type header. Check self::contentTypes['getInboxPlacementTests'] to see the possible values for this operation
Tags
Return values
array<string|int, InboxPlacementTestRunDto> —getInboxPlacementTestsAsync()
Operation getInboxPlacementTestsAsync
public
getInboxPlacementTestsAsync([int $limit = 50 ][, string $contentType = self::contentTypes['getInboxPlacementTests'][0] ]) : PromiseInterface
List inbox placement test runs
Parameters
- $limit : int = 50
-
(optional, default to 50)
- $contentType : string = self::contentTypes['getInboxPlacementTests'][0]
-
The value for the Content-Type header. Check self::contentTypes['getInboxPlacementTests'] to see the possible values for this operation
Tags
Return values
PromiseInterface —getInboxPlacementTestsAsyncWithHttpInfo()
Operation getInboxPlacementTestsAsyncWithHttpInfo
public
getInboxPlacementTestsAsyncWithHttpInfo([int $limit = 50 ][, string $contentType = self::contentTypes['getInboxPlacementTests'][0] ]) : PromiseInterface
List inbox placement test runs
Parameters
- $limit : int = 50
-
(optional, default to 50)
- $contentType : string = self::contentTypes['getInboxPlacementTests'][0]
-
The value for the Content-Type header. Check self::contentTypes['getInboxPlacementTests'] to see the possible values for this operation
Tags
Return values
PromiseInterface —getInboxPlacementTestsRequest()
Create request for operation 'getInboxPlacementTests'
public
getInboxPlacementTestsRequest([int $limit = 50 ][, string $contentType = self::contentTypes['getInboxPlacementTests'][0] ]) : Request
Parameters
- $limit : int = 50
-
(optional, default to 50)
- $contentType : string = self::contentTypes['getInboxPlacementTests'][0]
-
The value for the Content-Type header. Check self::contentTypes['getInboxPlacementTests'] to see the possible values for this operation
Tags
Return values
Request —getInboxPlacementTestsWithHttpInfo()
Operation getInboxPlacementTestsWithHttpInfo
public
getInboxPlacementTestsWithHttpInfo([int $limit = 50 ][, string $contentType = self::contentTypes['getInboxPlacementTests'][0] ]) : array<string|int, mixed>
List inbox placement test runs
Parameters
- $limit : int = 50
-
(optional, default to 50)
- $contentType : string = self::contentTypes['getInboxPlacementTests'][0]
-
The value for the Content-Type header. Check self::contentTypes['getInboxPlacementTests'] to see the possible values for this operation
Tags
Return values
array<string|int, mixed> —of \MailSlurp\Models\InboxPlacementTestRunDto[], HTTP status code, HTTP response headers (array of strings)
getInboxPlacementTestWithHttpInfo()
Operation getInboxPlacementTestWithHttpInfo
public
getInboxPlacementTestWithHttpInfo(string $id[, string $contentType = self::contentTypes['getInboxPlacementTest'][0] ]) : array<string|int, mixed>
Get inbox placement test run
Parameters
- $id : string
-
(required)
- $contentType : string = self::contentTypes['getInboxPlacementTest'][0]
-
The value for the Content-Type header. Check self::contentTypes['getInboxPlacementTest'] to see the possible values for this operation
Tags
Return values
array<string|int, mixed> —of \MailSlurp\Models\InboxPlacementTestRunDto, HTTP status code, HTTP response headers (array of strings)
prepareInboxPlacementTest()
Operation prepareInboxPlacementTest
public
prepareInboxPlacementTest(CreateInboxPlacementTestOptions $create_inbox_placement_test_options[, string $contentType = self::contentTypes['prepareInboxPlacementTest'][0] ]) : InboxPlacementTestRunDto
Prepare a direct-send inbox placement test without consuming allowance
Parameters
- $create_inbox_placement_test_options : CreateInboxPlacementTestOptions
-
create_inbox_placement_test_options (required)
- $contentType : string = self::contentTypes['prepareInboxPlacementTest'][0]
-
The value for the Content-Type header. Check self::contentTypes['prepareInboxPlacementTest'] to see the possible values for this operation
Tags
Return values
InboxPlacementTestRunDto —prepareInboxPlacementTestAsync()
Operation prepareInboxPlacementTestAsync
public
prepareInboxPlacementTestAsync(CreateInboxPlacementTestOptions $create_inbox_placement_test_options[, string $contentType = self::contentTypes['prepareInboxPlacementTest'][0] ]) : PromiseInterface
Prepare a direct-send inbox placement test without consuming allowance
Parameters
- $create_inbox_placement_test_options : CreateInboxPlacementTestOptions
-
(required)
- $contentType : string = self::contentTypes['prepareInboxPlacementTest'][0]
-
The value for the Content-Type header. Check self::contentTypes['prepareInboxPlacementTest'] to see the possible values for this operation
Tags
Return values
PromiseInterface —prepareInboxPlacementTestAsyncWithHttpInfo()
Operation prepareInboxPlacementTestAsyncWithHttpInfo
public
prepareInboxPlacementTestAsyncWithHttpInfo(CreateInboxPlacementTestOptions $create_inbox_placement_test_options[, string $contentType = self::contentTypes['prepareInboxPlacementTest'][0] ]) : PromiseInterface
Prepare a direct-send inbox placement test without consuming allowance
Parameters
- $create_inbox_placement_test_options : CreateInboxPlacementTestOptions
-
(required)
- $contentType : string = self::contentTypes['prepareInboxPlacementTest'][0]
-
The value for the Content-Type header. Check self::contentTypes['prepareInboxPlacementTest'] to see the possible values for this operation
Tags
Return values
PromiseInterface —prepareInboxPlacementTestRequest()
Create request for operation 'prepareInboxPlacementTest'
public
prepareInboxPlacementTestRequest(CreateInboxPlacementTestOptions $create_inbox_placement_test_options[, string $contentType = self::contentTypes['prepareInboxPlacementTest'][0] ]) : Request
Parameters
- $create_inbox_placement_test_options : CreateInboxPlacementTestOptions
-
(required)
- $contentType : string = self::contentTypes['prepareInboxPlacementTest'][0]
-
The value for the Content-Type header. Check self::contentTypes['prepareInboxPlacementTest'] to see the possible values for this operation
Tags
Return values
Request —prepareInboxPlacementTestWithHttpInfo()
Operation prepareInboxPlacementTestWithHttpInfo
public
prepareInboxPlacementTestWithHttpInfo(CreateInboxPlacementTestOptions $create_inbox_placement_test_options[, string $contentType = self::contentTypes['prepareInboxPlacementTest'][0] ]) : array<string|int, mixed>
Prepare a direct-send inbox placement test without consuming allowance
Parameters
- $create_inbox_placement_test_options : CreateInboxPlacementTestOptions
-
(required)
- $contentType : string = self::contentTypes['prepareInboxPlacementTest'][0]
-
The value for the Content-Type header. Check self::contentTypes['prepareInboxPlacementTest'] to see the possible values for this operation
Tags
Return values
array<string|int, mixed> —of \MailSlurp\Models\InboxPlacementTestRunDto, 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 —createHttpClientOption()
Create http client option
protected
createHttpClientOption() : array<string|int, mixed>
Tags
Return values
array<string|int, mixed> —of http client options