InboxRulesetControllerApi
in package
InboxRulesetControllerApi Class Doc Comment
Tags
Table of Contents
- contentTypes = ['createNewInboxRuleset' => ['application/json'], 'deleteInboxRuleset' => ['application/json'], 'deleteInboxRulesets' => ['application/json'], 'getInboxRuleset' => ['application/json'], 'getInboxRulesets' => ['application/json'], 'testInboxRuleset' => ['application/json'], 'testInboxRulesetReceiving' => ['application/json'], 'testInboxRulesetSending' => ['application/json'], 'testInboxRulesetsForInbox' => ['application/json'], 'testNewInboxRuleset' => ['application/json']]
- $client : ClientInterface
- $config : Configuration
- $headerSelector : HeaderSelector
- $hostIndex : int
- __construct() : mixed
- createNewInboxRuleset() : InboxRulesetDto
- Operation createNewInboxRuleset
- createNewInboxRulesetAsync() : PromiseInterface
- Operation createNewInboxRulesetAsync
- createNewInboxRulesetAsyncWithHttpInfo() : PromiseInterface
- Operation createNewInboxRulesetAsyncWithHttpInfo
- createNewInboxRulesetRequest() : Request
- Create request for operation 'createNewInboxRuleset'
- createNewInboxRulesetWithHttpInfo() : array<string|int, mixed>
- Operation createNewInboxRulesetWithHttpInfo
- deleteInboxRuleset() : void
- Operation deleteInboxRuleset
- deleteInboxRulesetAsync() : PromiseInterface
- Operation deleteInboxRulesetAsync
- deleteInboxRulesetAsyncWithHttpInfo() : PromiseInterface
- Operation deleteInboxRulesetAsyncWithHttpInfo
- deleteInboxRulesetRequest() : Request
- Create request for operation 'deleteInboxRuleset'
- deleteInboxRulesets() : void
- Operation deleteInboxRulesets
- deleteInboxRulesetsAsync() : PromiseInterface
- Operation deleteInboxRulesetsAsync
- deleteInboxRulesetsAsyncWithHttpInfo() : PromiseInterface
- Operation deleteInboxRulesetsAsyncWithHttpInfo
- deleteInboxRulesetsRequest() : Request
- Create request for operation 'deleteInboxRulesets'
- deleteInboxRulesetsWithHttpInfo() : array<string|int, mixed>
- Operation deleteInboxRulesetsWithHttpInfo
- deleteInboxRulesetWithHttpInfo() : array<string|int, mixed>
- Operation deleteInboxRulesetWithHttpInfo
- getConfig() : Configuration
- getHostIndex() : int
- Get the host index
- getInboxRuleset() : InboxRulesetDto
- Operation getInboxRuleset
- getInboxRulesetAsync() : PromiseInterface
- Operation getInboxRulesetAsync
- getInboxRulesetAsyncWithHttpInfo() : PromiseInterface
- Operation getInboxRulesetAsyncWithHttpInfo
- getInboxRulesetRequest() : Request
- Create request for operation 'getInboxRuleset'
- getInboxRulesets() : PageInboxRulesetDto
- Operation getInboxRulesets
- getInboxRulesetsAsync() : PromiseInterface
- Operation getInboxRulesetsAsync
- getInboxRulesetsAsyncWithHttpInfo() : PromiseInterface
- Operation getInboxRulesetsAsyncWithHttpInfo
- getInboxRulesetsRequest() : Request
- Create request for operation 'getInboxRulesets'
- getInboxRulesetsWithHttpInfo() : array<string|int, mixed>
- Operation getInboxRulesetsWithHttpInfo
- getInboxRulesetWithHttpInfo() : array<string|int, mixed>
- Operation getInboxRulesetWithHttpInfo
- setHostIndex() : void
- Set the host index
- testInboxRuleset() : InboxRulesetTestResult
- Operation testInboxRuleset
- testInboxRulesetAsync() : PromiseInterface
- Operation testInboxRulesetAsync
- testInboxRulesetAsyncWithHttpInfo() : PromiseInterface
- Operation testInboxRulesetAsyncWithHttpInfo
- testInboxRulesetReceiving() : TestInboxRulesetReceivingResult
- Operation testInboxRulesetReceiving
- testInboxRulesetReceivingAsync() : PromiseInterface
- Operation testInboxRulesetReceivingAsync
- testInboxRulesetReceivingAsyncWithHttpInfo() : PromiseInterface
- Operation testInboxRulesetReceivingAsyncWithHttpInfo
- testInboxRulesetReceivingRequest() : Request
- Create request for operation 'testInboxRulesetReceiving'
- testInboxRulesetReceivingWithHttpInfo() : array<string|int, mixed>
- Operation testInboxRulesetReceivingWithHttpInfo
- testInboxRulesetRequest() : Request
- Create request for operation 'testInboxRuleset'
- testInboxRulesetSending() : TestInboxRulesetSendingResult
- Operation testInboxRulesetSending
- testInboxRulesetSendingAsync() : PromiseInterface
- Operation testInboxRulesetSendingAsync
- testInboxRulesetSendingAsyncWithHttpInfo() : PromiseInterface
- Operation testInboxRulesetSendingAsyncWithHttpInfo
- testInboxRulesetSendingRequest() : Request
- Create request for operation 'testInboxRulesetSending'
- testInboxRulesetSendingWithHttpInfo() : array<string|int, mixed>
- Operation testInboxRulesetSendingWithHttpInfo
- testInboxRulesetsForInbox() : InboxRulesetTestResult
- Operation testInboxRulesetsForInbox
- testInboxRulesetsForInboxAsync() : PromiseInterface
- Operation testInboxRulesetsForInboxAsync
- testInboxRulesetsForInboxAsyncWithHttpInfo() : PromiseInterface
- Operation testInboxRulesetsForInboxAsyncWithHttpInfo
- testInboxRulesetsForInboxRequest() : Request
- Create request for operation 'testInboxRulesetsForInbox'
- testInboxRulesetsForInboxWithHttpInfo() : array<string|int, mixed>
- Operation testInboxRulesetsForInboxWithHttpInfo
- testInboxRulesetWithHttpInfo() : array<string|int, mixed>
- Operation testInboxRulesetWithHttpInfo
- testNewInboxRuleset() : InboxRulesetTestResult
- Operation testNewInboxRuleset
- testNewInboxRulesetAsync() : PromiseInterface
- Operation testNewInboxRulesetAsync
- testNewInboxRulesetAsyncWithHttpInfo() : PromiseInterface
- Operation testNewInboxRulesetAsyncWithHttpInfo
- testNewInboxRulesetRequest() : Request
- Create request for operation 'testNewInboxRuleset'
- testNewInboxRulesetWithHttpInfo() : array<string|int, mixed>
- Operation testNewInboxRulesetWithHttpInfo
- createHttpClientOption() : array<string|int, mixed>
- Create http client option
Constants
contentTypes
public
array<string|int, string>
contentTypes
= ['createNewInboxRuleset' => ['application/json'], 'deleteInboxRuleset' => ['application/json'], 'deleteInboxRulesets' => ['application/json'], 'getInboxRuleset' => ['application/json'], 'getInboxRulesets' => ['application/json'], 'testInboxRuleset' => ['application/json'], 'testInboxRulesetReceiving' => ['application/json'], 'testInboxRulesetSending' => ['application/json'], 'testInboxRulesetsForInbox' => ['application/json'], 'testNewInboxRuleset' => ['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 —createNewInboxRuleset()
Operation createNewInboxRuleset
public
createNewInboxRuleset(CreateInboxRulesetOptions $create_inbox_ruleset_options[, string $inbox_id = null ][, string $contentType = self::contentTypes['createNewInboxRuleset'][0] ]) : InboxRulesetDto
Create an inbox ruleset
Parameters
- $create_inbox_ruleset_options : CreateInboxRulesetOptions
-
create_inbox_ruleset_options (required)
- $inbox_id : string = null
-
Inbox id to attach ruleset to (optional)
- $contentType : string = self::contentTypes['createNewInboxRuleset'][0]
-
The value for the Content-Type header. Check self::contentTypes['createNewInboxRuleset'] to see the possible values for this operation
Tags
Return values
InboxRulesetDto —createNewInboxRulesetAsync()
Operation createNewInboxRulesetAsync
public
createNewInboxRulesetAsync(CreateInboxRulesetOptions $create_inbox_ruleset_options[, string $inbox_id = null ][, string $contentType = self::contentTypes['createNewInboxRuleset'][0] ]) : PromiseInterface
Create an inbox ruleset
Parameters
- $create_inbox_ruleset_options : CreateInboxRulesetOptions
-
(required)
- $inbox_id : string = null
-
Inbox id to attach ruleset to (optional)
- $contentType : string = self::contentTypes['createNewInboxRuleset'][0]
-
The value for the Content-Type header. Check self::contentTypes['createNewInboxRuleset'] to see the possible values for this operation
Tags
Return values
PromiseInterface —createNewInboxRulesetAsyncWithHttpInfo()
Operation createNewInboxRulesetAsyncWithHttpInfo
public
createNewInboxRulesetAsyncWithHttpInfo(CreateInboxRulesetOptions $create_inbox_ruleset_options[, string $inbox_id = null ][, string $contentType = self::contentTypes['createNewInboxRuleset'][0] ]) : PromiseInterface
Create an inbox ruleset
Parameters
- $create_inbox_ruleset_options : CreateInboxRulesetOptions
-
(required)
- $inbox_id : string = null
-
Inbox id to attach ruleset to (optional)
- $contentType : string = self::contentTypes['createNewInboxRuleset'][0]
-
The value for the Content-Type header. Check self::contentTypes['createNewInboxRuleset'] to see the possible values for this operation
Tags
Return values
PromiseInterface —createNewInboxRulesetRequest()
Create request for operation 'createNewInboxRuleset'
public
createNewInboxRulesetRequest(CreateInboxRulesetOptions $create_inbox_ruleset_options[, string $inbox_id = null ][, string $contentType = self::contentTypes['createNewInboxRuleset'][0] ]) : Request
Parameters
- $create_inbox_ruleset_options : CreateInboxRulesetOptions
-
(required)
- $inbox_id : string = null
-
Inbox id to attach ruleset to (optional)
- $contentType : string = self::contentTypes['createNewInboxRuleset'][0]
-
The value for the Content-Type header. Check self::contentTypes['createNewInboxRuleset'] to see the possible values for this operation
Tags
Return values
Request —createNewInboxRulesetWithHttpInfo()
Operation createNewInboxRulesetWithHttpInfo
public
createNewInboxRulesetWithHttpInfo(CreateInboxRulesetOptions $create_inbox_ruleset_options[, string $inbox_id = null ][, string $contentType = self::contentTypes['createNewInboxRuleset'][0] ]) : array<string|int, mixed>
Create an inbox ruleset
Parameters
- $create_inbox_ruleset_options : CreateInboxRulesetOptions
-
(required)
- $inbox_id : string = null
-
Inbox id to attach ruleset to (optional)
- $contentType : string = self::contentTypes['createNewInboxRuleset'][0]
-
The value for the Content-Type header. Check self::contentTypes['createNewInboxRuleset'] to see the possible values for this operation
Tags
Return values
array<string|int, mixed> —of \MailSlurp\Models\InboxRulesetDto, HTTP status code, HTTP response headers (array of strings)
deleteInboxRuleset()
Operation deleteInboxRuleset
public
deleteInboxRuleset(string $id[, string $contentType = self::contentTypes['deleteInboxRuleset'][0] ]) : void
Delete an inbox ruleset
Parameters
- $id : string
-
ID of inbox ruleset (required)
- $contentType : string = self::contentTypes['deleteInboxRuleset'][0]
-
The value for the Content-Type header. Check self::contentTypes['deleteInboxRuleset'] to see the possible values for this operation
Tags
Return values
void —deleteInboxRulesetAsync()
Operation deleteInboxRulesetAsync
public
deleteInboxRulesetAsync(string $id[, string $contentType = self::contentTypes['deleteInboxRuleset'][0] ]) : PromiseInterface
Delete an inbox ruleset
Parameters
- $id : string
-
ID of inbox ruleset (required)
- $contentType : string = self::contentTypes['deleteInboxRuleset'][0]
-
The value for the Content-Type header. Check self::contentTypes['deleteInboxRuleset'] to see the possible values for this operation
Tags
Return values
PromiseInterface —deleteInboxRulesetAsyncWithHttpInfo()
Operation deleteInboxRulesetAsyncWithHttpInfo
public
deleteInboxRulesetAsyncWithHttpInfo(string $id[, string $contentType = self::contentTypes['deleteInboxRuleset'][0] ]) : PromiseInterface
Delete an inbox ruleset
Parameters
- $id : string
-
ID of inbox ruleset (required)
- $contentType : string = self::contentTypes['deleteInboxRuleset'][0]
-
The value for the Content-Type header. Check self::contentTypes['deleteInboxRuleset'] to see the possible values for this operation
Tags
Return values
PromiseInterface —deleteInboxRulesetRequest()
Create request for operation 'deleteInboxRuleset'
public
deleteInboxRulesetRequest(string $id[, string $contentType = self::contentTypes['deleteInboxRuleset'][0] ]) : Request
Parameters
- $id : string
-
ID of inbox ruleset (required)
- $contentType : string = self::contentTypes['deleteInboxRuleset'][0]
-
The value for the Content-Type header. Check self::contentTypes['deleteInboxRuleset'] to see the possible values for this operation
Tags
Return values
Request —deleteInboxRulesets()
Operation deleteInboxRulesets
public
deleteInboxRulesets([string $inbox_id = null ][, string $contentType = self::contentTypes['deleteInboxRulesets'][0] ]) : void
Delete inbox rulesets
Parameters
- $inbox_id : string = null
-
Optional inbox id to attach ruleset to (optional)
- $contentType : string = self::contentTypes['deleteInboxRulesets'][0]
-
The value for the Content-Type header. Check self::contentTypes['deleteInboxRulesets'] to see the possible values for this operation
Tags
Return values
void —deleteInboxRulesetsAsync()
Operation deleteInboxRulesetsAsync
public
deleteInboxRulesetsAsync([string $inbox_id = null ][, string $contentType = self::contentTypes['deleteInboxRulesets'][0] ]) : PromiseInterface
Delete inbox rulesets
Parameters
- $inbox_id : string = null
-
Optional inbox id to attach ruleset to (optional)
- $contentType : string = self::contentTypes['deleteInboxRulesets'][0]
-
The value for the Content-Type header. Check self::contentTypes['deleteInboxRulesets'] to see the possible values for this operation
Tags
Return values
PromiseInterface —deleteInboxRulesetsAsyncWithHttpInfo()
Operation deleteInboxRulesetsAsyncWithHttpInfo
public
deleteInboxRulesetsAsyncWithHttpInfo([string $inbox_id = null ][, string $contentType = self::contentTypes['deleteInboxRulesets'][0] ]) : PromiseInterface
Delete inbox rulesets
Parameters
- $inbox_id : string = null
-
Optional inbox id to attach ruleset to (optional)
- $contentType : string = self::contentTypes['deleteInboxRulesets'][0]
-
The value for the Content-Type header. Check self::contentTypes['deleteInboxRulesets'] to see the possible values for this operation
Tags
Return values
PromiseInterface —deleteInboxRulesetsRequest()
Create request for operation 'deleteInboxRulesets'
public
deleteInboxRulesetsRequest([string $inbox_id = null ][, string $contentType = self::contentTypes['deleteInboxRulesets'][0] ]) : Request
Parameters
- $inbox_id : string = null
-
Optional inbox id to attach ruleset to (optional)
- $contentType : string = self::contentTypes['deleteInboxRulesets'][0]
-
The value for the Content-Type header. Check self::contentTypes['deleteInboxRulesets'] to see the possible values for this operation
Tags
Return values
Request —deleteInboxRulesetsWithHttpInfo()
Operation deleteInboxRulesetsWithHttpInfo
public
deleteInboxRulesetsWithHttpInfo([string $inbox_id = null ][, string $contentType = self::contentTypes['deleteInboxRulesets'][0] ]) : array<string|int, mixed>
Delete inbox rulesets
Parameters
- $inbox_id : string = null
-
Optional inbox id to attach ruleset to (optional)
- $contentType : string = self::contentTypes['deleteInboxRulesets'][0]
-
The value for the Content-Type header. Check self::contentTypes['deleteInboxRulesets'] 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)
deleteInboxRulesetWithHttpInfo()
Operation deleteInboxRulesetWithHttpInfo
public
deleteInboxRulesetWithHttpInfo(string $id[, string $contentType = self::contentTypes['deleteInboxRuleset'][0] ]) : array<string|int, mixed>
Delete an inbox ruleset
Parameters
- $id : string
-
ID of inbox ruleset (required)
- $contentType : string = self::contentTypes['deleteInboxRuleset'][0]
-
The value for the Content-Type header. Check self::contentTypes['deleteInboxRuleset'] 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
getInboxRuleset()
Operation getInboxRuleset
public
getInboxRuleset(string $id[, string $contentType = self::contentTypes['getInboxRuleset'][0] ]) : InboxRulesetDto
Get an inbox ruleset
Parameters
- $id : string
-
ID of inbox ruleset (required)
- $contentType : string = self::contentTypes['getInboxRuleset'][0]
-
The value for the Content-Type header. Check self::contentTypes['getInboxRuleset'] to see the possible values for this operation
Tags
Return values
InboxRulesetDto —getInboxRulesetAsync()
Operation getInboxRulesetAsync
public
getInboxRulesetAsync(string $id[, string $contentType = self::contentTypes['getInboxRuleset'][0] ]) : PromiseInterface
Get an inbox ruleset
Parameters
- $id : string
-
ID of inbox ruleset (required)
- $contentType : string = self::contentTypes['getInboxRuleset'][0]
-
The value for the Content-Type header. Check self::contentTypes['getInboxRuleset'] to see the possible values for this operation
Tags
Return values
PromiseInterface —getInboxRulesetAsyncWithHttpInfo()
Operation getInboxRulesetAsyncWithHttpInfo
public
getInboxRulesetAsyncWithHttpInfo(string $id[, string $contentType = self::contentTypes['getInboxRuleset'][0] ]) : PromiseInterface
Get an inbox ruleset
Parameters
- $id : string
-
ID of inbox ruleset (required)
- $contentType : string = self::contentTypes['getInboxRuleset'][0]
-
The value for the Content-Type header. Check self::contentTypes['getInboxRuleset'] to see the possible values for this operation
Tags
Return values
PromiseInterface —getInboxRulesetRequest()
Create request for operation 'getInboxRuleset'
public
getInboxRulesetRequest(string $id[, string $contentType = self::contentTypes['getInboxRuleset'][0] ]) : Request
Parameters
- $id : string
-
ID of inbox ruleset (required)
- $contentType : string = self::contentTypes['getInboxRuleset'][0]
-
The value for the Content-Type header. Check self::contentTypes['getInboxRuleset'] to see the possible values for this operation
Tags
Return values
Request —getInboxRulesets()
Operation getInboxRulesets
public
getInboxRulesets([string $inbox_id = null ], int $page[, int $size = 20 ][, string $sort = 'ASC' ][, string $search_filter = null ][, DateTime $since = null ][, DateTime $before = null ][, string $contentType = self::contentTypes['getInboxRulesets'][0] ]) : PageInboxRulesetDto
List inbox rulesets
Parameters
- $inbox_id : string = null
-
Optional inbox id to get rulesets from (optional)
- $page : int
-
Optional page index in inbox ruleset list pagination (optional, default to 0)
- $size : int = 20
-
Optional page size in inbox ruleset list pagination (optional, default to 20)
- $sort : string = 'ASC'
-
Optional createdAt sort direction ASC or DESC (optional, default to 'ASC')
- $search_filter : string = null
-
Optional search filter (optional)
- $since : DateTime = null
-
Filter by created at after the given timestamp (optional)
- $before : DateTime = null
-
Filter by created at before the given timestamp (optional)
- $contentType : string = self::contentTypes['getInboxRulesets'][0]
-
The value for the Content-Type header. Check self::contentTypes['getInboxRulesets'] to see the possible values for this operation
Tags
Return values
PageInboxRulesetDto —getInboxRulesetsAsync()
Operation getInboxRulesetsAsync
public
getInboxRulesetsAsync([string $inbox_id = null ], int $page[, int $size = 20 ][, string $sort = 'ASC' ][, string $search_filter = null ][, DateTime $since = null ][, DateTime $before = null ][, string $contentType = self::contentTypes['getInboxRulesets'][0] ]) : PromiseInterface
List inbox rulesets
Parameters
- $inbox_id : string = null
-
Optional inbox id to get rulesets from (optional)
- $page : int
-
Optional page index in inbox ruleset list pagination (optional, default to 0)
- $size : int = 20
-
Optional page size in inbox ruleset list pagination (optional, default to 20)
- $sort : string = 'ASC'
-
Optional createdAt sort direction ASC or DESC (optional, default to 'ASC')
- $search_filter : string = null
-
Optional search filter (optional)
- $since : DateTime = null
-
Filter by created at after the given timestamp (optional)
- $before : DateTime = null
-
Filter by created at before the given timestamp (optional)
- $contentType : string = self::contentTypes['getInboxRulesets'][0]
-
The value for the Content-Type header. Check self::contentTypes['getInboxRulesets'] to see the possible values for this operation
Tags
Return values
PromiseInterface —getInboxRulesetsAsyncWithHttpInfo()
Operation getInboxRulesetsAsyncWithHttpInfo
public
getInboxRulesetsAsyncWithHttpInfo([string $inbox_id = null ], int $page[, int $size = 20 ][, string $sort = 'ASC' ][, string $search_filter = null ][, DateTime $since = null ][, DateTime $before = null ][, string $contentType = self::contentTypes['getInboxRulesets'][0] ]) : PromiseInterface
List inbox rulesets
Parameters
- $inbox_id : string = null
-
Optional inbox id to get rulesets from (optional)
- $page : int
-
Optional page index in inbox ruleset list pagination (optional, default to 0)
- $size : int = 20
-
Optional page size in inbox ruleset list pagination (optional, default to 20)
- $sort : string = 'ASC'
-
Optional createdAt sort direction ASC or DESC (optional, default to 'ASC')
- $search_filter : string = null
-
Optional search filter (optional)
- $since : DateTime = null
-
Filter by created at after the given timestamp (optional)
- $before : DateTime = null
-
Filter by created at before the given timestamp (optional)
- $contentType : string = self::contentTypes['getInboxRulesets'][0]
-
The value for the Content-Type header. Check self::contentTypes['getInboxRulesets'] to see the possible values for this operation
Tags
Return values
PromiseInterface —getInboxRulesetsRequest()
Create request for operation 'getInboxRulesets'
public
getInboxRulesetsRequest([string $inbox_id = null ], int $page[, int $size = 20 ][, string $sort = 'ASC' ][, string $search_filter = null ][, DateTime $since = null ][, DateTime $before = null ][, string $contentType = self::contentTypes['getInboxRulesets'][0] ]) : Request
Parameters
- $inbox_id : string = null
-
Optional inbox id to get rulesets from (optional)
- $page : int
-
Optional page index in inbox ruleset list pagination (optional, default to 0)
- $size : int = 20
-
Optional page size in inbox ruleset list pagination (optional, default to 20)
- $sort : string = 'ASC'
-
Optional createdAt sort direction ASC or DESC (optional, default to 'ASC')
- $search_filter : string = null
-
Optional search filter (optional)
- $since : DateTime = null
-
Filter by created at after the given timestamp (optional)
- $before : DateTime = null
-
Filter by created at before the given timestamp (optional)
- $contentType : string = self::contentTypes['getInboxRulesets'][0]
-
The value for the Content-Type header. Check self::contentTypes['getInboxRulesets'] to see the possible values for this operation
Tags
Return values
Request —getInboxRulesetsWithHttpInfo()
Operation getInboxRulesetsWithHttpInfo
public
getInboxRulesetsWithHttpInfo([string $inbox_id = null ], int $page[, int $size = 20 ][, string $sort = 'ASC' ][, string $search_filter = null ][, DateTime $since = null ][, DateTime $before = null ][, string $contentType = self::contentTypes['getInboxRulesets'][0] ]) : array<string|int, mixed>
List inbox rulesets
Parameters
- $inbox_id : string = null
-
Optional inbox id to get rulesets from (optional)
- $page : int
-
Optional page index in inbox ruleset list pagination (optional, default to 0)
- $size : int = 20
-
Optional page size in inbox ruleset list pagination (optional, default to 20)
- $sort : string = 'ASC'
-
Optional createdAt sort direction ASC or DESC (optional, default to 'ASC')
- $search_filter : string = null
-
Optional search filter (optional)
- $since : DateTime = null
-
Filter by created at after the given timestamp (optional)
- $before : DateTime = null
-
Filter by created at before the given timestamp (optional)
- $contentType : string = self::contentTypes['getInboxRulesets'][0]
-
The value for the Content-Type header. Check self::contentTypes['getInboxRulesets'] to see the possible values for this operation
Tags
Return values
array<string|int, mixed> —of \MailSlurp\Models\PageInboxRulesetDto, HTTP status code, HTTP response headers (array of strings)
getInboxRulesetWithHttpInfo()
Operation getInboxRulesetWithHttpInfo
public
getInboxRulesetWithHttpInfo(string $id[, string $contentType = self::contentTypes['getInboxRuleset'][0] ]) : array<string|int, mixed>
Get an inbox ruleset
Parameters
- $id : string
-
ID of inbox ruleset (required)
- $contentType : string = self::contentTypes['getInboxRuleset'][0]
-
The value for the Content-Type header. Check self::contentTypes['getInboxRuleset'] to see the possible values for this operation
Tags
Return values
array<string|int, mixed> —of \MailSlurp\Models\InboxRulesetDto, 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 —testInboxRuleset()
Operation testInboxRuleset
public
testInboxRuleset(string $id, InboxRulesetTestOptions $inbox_ruleset_test_options[, string $contentType = self::contentTypes['testInboxRuleset'][0] ]) : InboxRulesetTestResult
Test an inbox ruleset
Parameters
- $id : string
-
ID of inbox ruleset (required)
- $inbox_ruleset_test_options : InboxRulesetTestOptions
-
inbox_ruleset_test_options (required)
- $contentType : string = self::contentTypes['testInboxRuleset'][0]
-
The value for the Content-Type header. Check self::contentTypes['testInboxRuleset'] to see the possible values for this operation
Tags
Return values
InboxRulesetTestResult —testInboxRulesetAsync()
Operation testInboxRulesetAsync
public
testInboxRulesetAsync(string $id, InboxRulesetTestOptions $inbox_ruleset_test_options[, string $contentType = self::contentTypes['testInboxRuleset'][0] ]) : PromiseInterface
Test an inbox ruleset
Parameters
- $id : string
-
ID of inbox ruleset (required)
- $inbox_ruleset_test_options : InboxRulesetTestOptions
-
(required)
- $contentType : string = self::contentTypes['testInboxRuleset'][0]
-
The value for the Content-Type header. Check self::contentTypes['testInboxRuleset'] to see the possible values for this operation
Tags
Return values
PromiseInterface —testInboxRulesetAsyncWithHttpInfo()
Operation testInboxRulesetAsyncWithHttpInfo
public
testInboxRulesetAsyncWithHttpInfo(string $id, InboxRulesetTestOptions $inbox_ruleset_test_options[, string $contentType = self::contentTypes['testInboxRuleset'][0] ]) : PromiseInterface
Test an inbox ruleset
Parameters
- $id : string
-
ID of inbox ruleset (required)
- $inbox_ruleset_test_options : InboxRulesetTestOptions
-
(required)
- $contentType : string = self::contentTypes['testInboxRuleset'][0]
-
The value for the Content-Type header. Check self::contentTypes['testInboxRuleset'] to see the possible values for this operation
Tags
Return values
PromiseInterface —testInboxRulesetReceiving()
Operation testInboxRulesetReceiving
public
testInboxRulesetReceiving(TestInboxRulesetReceivingOptions $test_inbox_ruleset_receiving_options[, string $contentType = self::contentTypes['testInboxRulesetReceiving'][0] ]) : TestInboxRulesetReceivingResult
Test receiving with inbox rulesets
Parameters
- $test_inbox_ruleset_receiving_options : TestInboxRulesetReceivingOptions
-
test_inbox_ruleset_receiving_options (required)
- $contentType : string = self::contentTypes['testInboxRulesetReceiving'][0]
-
The value for the Content-Type header. Check self::contentTypes['testInboxRulesetReceiving'] to see the possible values for this operation
Tags
Return values
TestInboxRulesetReceivingResult —testInboxRulesetReceivingAsync()
Operation testInboxRulesetReceivingAsync
public
testInboxRulesetReceivingAsync(TestInboxRulesetReceivingOptions $test_inbox_ruleset_receiving_options[, string $contentType = self::contentTypes['testInboxRulesetReceiving'][0] ]) : PromiseInterface
Test receiving with inbox rulesets
Parameters
- $test_inbox_ruleset_receiving_options : TestInboxRulesetReceivingOptions
-
(required)
- $contentType : string = self::contentTypes['testInboxRulesetReceiving'][0]
-
The value for the Content-Type header. Check self::contentTypes['testInboxRulesetReceiving'] to see the possible values for this operation
Tags
Return values
PromiseInterface —testInboxRulesetReceivingAsyncWithHttpInfo()
Operation testInboxRulesetReceivingAsyncWithHttpInfo
public
testInboxRulesetReceivingAsyncWithHttpInfo(TestInboxRulesetReceivingOptions $test_inbox_ruleset_receiving_options[, string $contentType = self::contentTypes['testInboxRulesetReceiving'][0] ]) : PromiseInterface
Test receiving with inbox rulesets
Parameters
- $test_inbox_ruleset_receiving_options : TestInboxRulesetReceivingOptions
-
(required)
- $contentType : string = self::contentTypes['testInboxRulesetReceiving'][0]
-
The value for the Content-Type header. Check self::contentTypes['testInboxRulesetReceiving'] to see the possible values for this operation
Tags
Return values
PromiseInterface —testInboxRulesetReceivingRequest()
Create request for operation 'testInboxRulesetReceiving'
public
testInboxRulesetReceivingRequest(TestInboxRulesetReceivingOptions $test_inbox_ruleset_receiving_options[, string $contentType = self::contentTypes['testInboxRulesetReceiving'][0] ]) : Request
Parameters
- $test_inbox_ruleset_receiving_options : TestInboxRulesetReceivingOptions
-
(required)
- $contentType : string = self::contentTypes['testInboxRulesetReceiving'][0]
-
The value for the Content-Type header. Check self::contentTypes['testInboxRulesetReceiving'] to see the possible values for this operation
Tags
Return values
Request —testInboxRulesetReceivingWithHttpInfo()
Operation testInboxRulesetReceivingWithHttpInfo
public
testInboxRulesetReceivingWithHttpInfo(TestInboxRulesetReceivingOptions $test_inbox_ruleset_receiving_options[, string $contentType = self::contentTypes['testInboxRulesetReceiving'][0] ]) : array<string|int, mixed>
Test receiving with inbox rulesets
Parameters
- $test_inbox_ruleset_receiving_options : TestInboxRulesetReceivingOptions
-
(required)
- $contentType : string = self::contentTypes['testInboxRulesetReceiving'][0]
-
The value for the Content-Type header. Check self::contentTypes['testInboxRulesetReceiving'] to see the possible values for this operation
Tags
Return values
array<string|int, mixed> —of \MailSlurp\Models\TestInboxRulesetReceivingResult, HTTP status code, HTTP response headers (array of strings)
testInboxRulesetRequest()
Create request for operation 'testInboxRuleset'
public
testInboxRulesetRequest(string $id, InboxRulesetTestOptions $inbox_ruleset_test_options[, string $contentType = self::contentTypes['testInboxRuleset'][0] ]) : Request
Parameters
- $id : string
-
ID of inbox ruleset (required)
- $inbox_ruleset_test_options : InboxRulesetTestOptions
-
(required)
- $contentType : string = self::contentTypes['testInboxRuleset'][0]
-
The value for the Content-Type header. Check self::contentTypes['testInboxRuleset'] to see the possible values for this operation
Tags
Return values
Request —testInboxRulesetSending()
Operation testInboxRulesetSending
public
testInboxRulesetSending(TestInboxRulesetSendingOptions $test_inbox_ruleset_sending_options[, string $contentType = self::contentTypes['testInboxRulesetSending'][0] ]) : TestInboxRulesetSendingResult
Test sending with inbox rulesets
Parameters
- $test_inbox_ruleset_sending_options : TestInboxRulesetSendingOptions
-
test_inbox_ruleset_sending_options (required)
- $contentType : string = self::contentTypes['testInboxRulesetSending'][0]
-
The value for the Content-Type header. Check self::contentTypes['testInboxRulesetSending'] to see the possible values for this operation
Tags
Return values
TestInboxRulesetSendingResult —testInboxRulesetSendingAsync()
Operation testInboxRulesetSendingAsync
public
testInboxRulesetSendingAsync(TestInboxRulesetSendingOptions $test_inbox_ruleset_sending_options[, string $contentType = self::contentTypes['testInboxRulesetSending'][0] ]) : PromiseInterface
Test sending with inbox rulesets
Parameters
- $test_inbox_ruleset_sending_options : TestInboxRulesetSendingOptions
-
(required)
- $contentType : string = self::contentTypes['testInboxRulesetSending'][0]
-
The value for the Content-Type header. Check self::contentTypes['testInboxRulesetSending'] to see the possible values for this operation
Tags
Return values
PromiseInterface —testInboxRulesetSendingAsyncWithHttpInfo()
Operation testInboxRulesetSendingAsyncWithHttpInfo
public
testInboxRulesetSendingAsyncWithHttpInfo(TestInboxRulesetSendingOptions $test_inbox_ruleset_sending_options[, string $contentType = self::contentTypes['testInboxRulesetSending'][0] ]) : PromiseInterface
Test sending with inbox rulesets
Parameters
- $test_inbox_ruleset_sending_options : TestInboxRulesetSendingOptions
-
(required)
- $contentType : string = self::contentTypes['testInboxRulesetSending'][0]
-
The value for the Content-Type header. Check self::contentTypes['testInboxRulesetSending'] to see the possible values for this operation
Tags
Return values
PromiseInterface —testInboxRulesetSendingRequest()
Create request for operation 'testInboxRulesetSending'
public
testInboxRulesetSendingRequest(TestInboxRulesetSendingOptions $test_inbox_ruleset_sending_options[, string $contentType = self::contentTypes['testInboxRulesetSending'][0] ]) : Request
Parameters
- $test_inbox_ruleset_sending_options : TestInboxRulesetSendingOptions
-
(required)
- $contentType : string = self::contentTypes['testInboxRulesetSending'][0]
-
The value for the Content-Type header. Check self::contentTypes['testInboxRulesetSending'] to see the possible values for this operation
Tags
Return values
Request —testInboxRulesetSendingWithHttpInfo()
Operation testInboxRulesetSendingWithHttpInfo
public
testInboxRulesetSendingWithHttpInfo(TestInboxRulesetSendingOptions $test_inbox_ruleset_sending_options[, string $contentType = self::contentTypes['testInboxRulesetSending'][0] ]) : array<string|int, mixed>
Test sending with inbox rulesets
Parameters
- $test_inbox_ruleset_sending_options : TestInboxRulesetSendingOptions
-
(required)
- $contentType : string = self::contentTypes['testInboxRulesetSending'][0]
-
The value for the Content-Type header. Check self::contentTypes['testInboxRulesetSending'] to see the possible values for this operation
Tags
Return values
array<string|int, mixed> —of \MailSlurp\Models\TestInboxRulesetSendingResult, HTTP status code, HTTP response headers (array of strings)
testInboxRulesetsForInbox()
Operation testInboxRulesetsForInbox
public
testInboxRulesetsForInbox(string $inbox_id, InboxRulesetTestOptions $inbox_ruleset_test_options[, string $contentType = self::contentTypes['testInboxRulesetsForInbox'][0] ]) : InboxRulesetTestResult
Test inbox rulesets for inbox
Parameters
- $inbox_id : string
-
ID of inbox (required)
- $inbox_ruleset_test_options : InboxRulesetTestOptions
-
inbox_ruleset_test_options (required)
- $contentType : string = self::contentTypes['testInboxRulesetsForInbox'][0]
-
The value for the Content-Type header. Check self::contentTypes['testInboxRulesetsForInbox'] to see the possible values for this operation
Tags
Return values
InboxRulesetTestResult —testInboxRulesetsForInboxAsync()
Operation testInboxRulesetsForInboxAsync
public
testInboxRulesetsForInboxAsync(string $inbox_id, InboxRulesetTestOptions $inbox_ruleset_test_options[, string $contentType = self::contentTypes['testInboxRulesetsForInbox'][0] ]) : PromiseInterface
Test inbox rulesets for inbox
Parameters
- $inbox_id : string
-
ID of inbox (required)
- $inbox_ruleset_test_options : InboxRulesetTestOptions
-
(required)
- $contentType : string = self::contentTypes['testInboxRulesetsForInbox'][0]
-
The value for the Content-Type header. Check self::contentTypes['testInboxRulesetsForInbox'] to see the possible values for this operation
Tags
Return values
PromiseInterface —testInboxRulesetsForInboxAsyncWithHttpInfo()
Operation testInboxRulesetsForInboxAsyncWithHttpInfo
public
testInboxRulesetsForInboxAsyncWithHttpInfo(string $inbox_id, InboxRulesetTestOptions $inbox_ruleset_test_options[, string $contentType = self::contentTypes['testInboxRulesetsForInbox'][0] ]) : PromiseInterface
Test inbox rulesets for inbox
Parameters
- $inbox_id : string
-
ID of inbox (required)
- $inbox_ruleset_test_options : InboxRulesetTestOptions
-
(required)
- $contentType : string = self::contentTypes['testInboxRulesetsForInbox'][0]
-
The value for the Content-Type header. Check self::contentTypes['testInboxRulesetsForInbox'] to see the possible values for this operation
Tags
Return values
PromiseInterface —testInboxRulesetsForInboxRequest()
Create request for operation 'testInboxRulesetsForInbox'
public
testInboxRulesetsForInboxRequest(string $inbox_id, InboxRulesetTestOptions $inbox_ruleset_test_options[, string $contentType = self::contentTypes['testInboxRulesetsForInbox'][0] ]) : Request
Parameters
- $inbox_id : string
-
ID of inbox (required)
- $inbox_ruleset_test_options : InboxRulesetTestOptions
-
(required)
- $contentType : string = self::contentTypes['testInboxRulesetsForInbox'][0]
-
The value for the Content-Type header. Check self::contentTypes['testInboxRulesetsForInbox'] to see the possible values for this operation
Tags
Return values
Request —testInboxRulesetsForInboxWithHttpInfo()
Operation testInboxRulesetsForInboxWithHttpInfo
public
testInboxRulesetsForInboxWithHttpInfo(string $inbox_id, InboxRulesetTestOptions $inbox_ruleset_test_options[, string $contentType = self::contentTypes['testInboxRulesetsForInbox'][0] ]) : array<string|int, mixed>
Test inbox rulesets for inbox
Parameters
- $inbox_id : string
-
ID of inbox (required)
- $inbox_ruleset_test_options : InboxRulesetTestOptions
-
(required)
- $contentType : string = self::contentTypes['testInboxRulesetsForInbox'][0]
-
The value for the Content-Type header. Check self::contentTypes['testInboxRulesetsForInbox'] to see the possible values for this operation
Tags
Return values
array<string|int, mixed> —of \MailSlurp\Models\InboxRulesetTestResult, HTTP status code, HTTP response headers (array of strings)
testInboxRulesetWithHttpInfo()
Operation testInboxRulesetWithHttpInfo
public
testInboxRulesetWithHttpInfo(string $id, InboxRulesetTestOptions $inbox_ruleset_test_options[, string $contentType = self::contentTypes['testInboxRuleset'][0] ]) : array<string|int, mixed>
Test an inbox ruleset
Parameters
- $id : string
-
ID of inbox ruleset (required)
- $inbox_ruleset_test_options : InboxRulesetTestOptions
-
(required)
- $contentType : string = self::contentTypes['testInboxRuleset'][0]
-
The value for the Content-Type header. Check self::contentTypes['testInboxRuleset'] to see the possible values for this operation
Tags
Return values
array<string|int, mixed> —of \MailSlurp\Models\InboxRulesetTestResult, HTTP status code, HTTP response headers (array of strings)
testNewInboxRuleset()
Operation testNewInboxRuleset
public
testNewInboxRuleset(TestNewInboxRulesetOptions $test_new_inbox_ruleset_options[, string $contentType = self::contentTypes['testNewInboxRuleset'][0] ]) : InboxRulesetTestResult
Test new inbox ruleset
Parameters
- $test_new_inbox_ruleset_options : TestNewInboxRulesetOptions
-
test_new_inbox_ruleset_options (required)
- $contentType : string = self::contentTypes['testNewInboxRuleset'][0]
-
The value for the Content-Type header. Check self::contentTypes['testNewInboxRuleset'] to see the possible values for this operation
Tags
Return values
InboxRulesetTestResult —testNewInboxRulesetAsync()
Operation testNewInboxRulesetAsync
public
testNewInboxRulesetAsync(TestNewInboxRulesetOptions $test_new_inbox_ruleset_options[, string $contentType = self::contentTypes['testNewInboxRuleset'][0] ]) : PromiseInterface
Test new inbox ruleset
Parameters
- $test_new_inbox_ruleset_options : TestNewInboxRulesetOptions
-
(required)
- $contentType : string = self::contentTypes['testNewInboxRuleset'][0]
-
The value for the Content-Type header. Check self::contentTypes['testNewInboxRuleset'] to see the possible values for this operation
Tags
Return values
PromiseInterface —testNewInboxRulesetAsyncWithHttpInfo()
Operation testNewInboxRulesetAsyncWithHttpInfo
public
testNewInboxRulesetAsyncWithHttpInfo(TestNewInboxRulesetOptions $test_new_inbox_ruleset_options[, string $contentType = self::contentTypes['testNewInboxRuleset'][0] ]) : PromiseInterface
Test new inbox ruleset
Parameters
- $test_new_inbox_ruleset_options : TestNewInboxRulesetOptions
-
(required)
- $contentType : string = self::contentTypes['testNewInboxRuleset'][0]
-
The value for the Content-Type header. Check self::contentTypes['testNewInboxRuleset'] to see the possible values for this operation
Tags
Return values
PromiseInterface —testNewInboxRulesetRequest()
Create request for operation 'testNewInboxRuleset'
public
testNewInboxRulesetRequest(TestNewInboxRulesetOptions $test_new_inbox_ruleset_options[, string $contentType = self::contentTypes['testNewInboxRuleset'][0] ]) : Request
Parameters
- $test_new_inbox_ruleset_options : TestNewInboxRulesetOptions
-
(required)
- $contentType : string = self::contentTypes['testNewInboxRuleset'][0]
-
The value for the Content-Type header. Check self::contentTypes['testNewInboxRuleset'] to see the possible values for this operation
Tags
Return values
Request —testNewInboxRulesetWithHttpInfo()
Operation testNewInboxRulesetWithHttpInfo
public
testNewInboxRulesetWithHttpInfo(TestNewInboxRulesetOptions $test_new_inbox_ruleset_options[, string $contentType = self::contentTypes['testNewInboxRuleset'][0] ]) : array<string|int, mixed>
Test new inbox ruleset
Parameters
- $test_new_inbox_ruleset_options : TestNewInboxRulesetOptions
-
(required)
- $contentType : string = self::contentTypes['testNewInboxRuleset'][0]
-
The value for the Content-Type header. Check self::contentTypes['testNewInboxRuleset'] to see the possible values for this operation
Tags
Return values
array<string|int, mixed> —of \MailSlurp\Models\InboxRulesetTestResult, 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