RulesetControllerApi
in package
RulesetControllerApi Class Doc Comment
Tags
Table of Contents
- contentTypes = ['createNewRuleset' => ['application/json'], 'deleteRuleset' => ['application/json'], 'deleteRulesets' => ['application/json'], 'getRuleset' => ['application/json'], 'getRulesets' => ['application/json'], 'testInboxRulesetsForInbox' => ['application/json'], 'testNewRuleset' => ['application/json'], 'testRuleset' => ['application/json'], 'testRulesetReceiving' => ['application/json'], 'testRulesetSending' => ['application/json'], 'updateRuleset' => ['application/json']]
- $client : ClientInterface
- $config : Configuration
- $headerSelector : HeaderSelector
- $hostIndex : int
- __construct() : mixed
- createNewRuleset() : RulesetDto
- Operation createNewRuleset
- createNewRulesetAsync() : PromiseInterface
- Operation createNewRulesetAsync
- createNewRulesetAsyncWithHttpInfo() : PromiseInterface
- Operation createNewRulesetAsyncWithHttpInfo
- createNewRulesetRequest() : Request
- Create request for operation 'createNewRuleset'
- createNewRulesetWithHttpInfo() : array<string|int, mixed>
- Operation createNewRulesetWithHttpInfo
- deleteRuleset() : void
- Operation deleteRuleset
- deleteRulesetAsync() : PromiseInterface
- Operation deleteRulesetAsync
- deleteRulesetAsyncWithHttpInfo() : PromiseInterface
- Operation deleteRulesetAsyncWithHttpInfo
- deleteRulesetRequest() : Request
- Create request for operation 'deleteRuleset'
- deleteRulesets() : void
- Operation deleteRulesets
- deleteRulesetsAsync() : PromiseInterface
- Operation deleteRulesetsAsync
- deleteRulesetsAsyncWithHttpInfo() : PromiseInterface
- Operation deleteRulesetsAsyncWithHttpInfo
- deleteRulesetsRequest() : Request
- Create request for operation 'deleteRulesets'
- deleteRulesetsWithHttpInfo() : array<string|int, mixed>
- Operation deleteRulesetsWithHttpInfo
- deleteRulesetWithHttpInfo() : array<string|int, mixed>
- Operation deleteRulesetWithHttpInfo
- getConfig() : Configuration
- getHostIndex() : int
- Get the host index
- getRuleset() : RulesetDto
- Operation getRuleset
- getRulesetAsync() : PromiseInterface
- Operation getRulesetAsync
- getRulesetAsyncWithHttpInfo() : PromiseInterface
- Operation getRulesetAsyncWithHttpInfo
- getRulesetRequest() : Request
- Create request for operation 'getRuleset'
- getRulesets() : PageRulesetDto
- Operation getRulesets
- getRulesetsAsync() : PromiseInterface
- Operation getRulesetsAsync
- getRulesetsAsyncWithHttpInfo() : PromiseInterface
- Operation getRulesetsAsyncWithHttpInfo
- getRulesetsRequest() : Request
- Create request for operation 'getRulesets'
- getRulesetsWithHttpInfo() : array<string|int, mixed>
- Operation getRulesetsWithHttpInfo
- getRulesetWithHttpInfo() : array<string|int, mixed>
- Operation getRulesetWithHttpInfo
- setHostIndex() : void
- Set the host index
- 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
- testNewRuleset() : InboxRulesetTestResult
- Operation testNewRuleset
- testNewRulesetAsync() : PromiseInterface
- Operation testNewRulesetAsync
- testNewRulesetAsyncWithHttpInfo() : PromiseInterface
- Operation testNewRulesetAsyncWithHttpInfo
- testNewRulesetRequest() : Request
- Create request for operation 'testNewRuleset'
- testNewRulesetWithHttpInfo() : array<string|int, mixed>
- Operation testNewRulesetWithHttpInfo
- testRuleset() : InboxRulesetTestResult
- Operation testRuleset
- testRulesetAsync() : PromiseInterface
- Operation testRulesetAsync
- testRulesetAsyncWithHttpInfo() : PromiseInterface
- Operation testRulesetAsyncWithHttpInfo
- testRulesetReceiving() : TestRulesetReceivingResult
- Operation testRulesetReceiving
- testRulesetReceivingAsync() : PromiseInterface
- Operation testRulesetReceivingAsync
- testRulesetReceivingAsyncWithHttpInfo() : PromiseInterface
- Operation testRulesetReceivingAsyncWithHttpInfo
- testRulesetReceivingRequest() : Request
- Create request for operation 'testRulesetReceiving'
- testRulesetReceivingWithHttpInfo() : array<string|int, mixed>
- Operation testRulesetReceivingWithHttpInfo
- testRulesetRequest() : Request
- Create request for operation 'testRuleset'
- testRulesetSending() : TestRulesetSendingResult
- Operation testRulesetSending
- testRulesetSendingAsync() : PromiseInterface
- Operation testRulesetSendingAsync
- testRulesetSendingAsyncWithHttpInfo() : PromiseInterface
- Operation testRulesetSendingAsyncWithHttpInfo
- testRulesetSendingRequest() : Request
- Create request for operation 'testRulesetSending'
- testRulesetSendingWithHttpInfo() : array<string|int, mixed>
- Operation testRulesetSendingWithHttpInfo
- testRulesetWithHttpInfo() : array<string|int, mixed>
- Operation testRulesetWithHttpInfo
- updateRuleset() : RulesetDto
- Operation updateRuleset
- updateRulesetAsync() : PromiseInterface
- Operation updateRulesetAsync
- updateRulesetAsyncWithHttpInfo() : PromiseInterface
- Operation updateRulesetAsyncWithHttpInfo
- updateRulesetRequest() : Request
- Create request for operation 'updateRuleset'
- updateRulesetWithHttpInfo() : array<string|int, mixed>
- Operation updateRulesetWithHttpInfo
- createHttpClientOption() : array<string|int, mixed>
- Create http client option
Constants
contentTypes
public
array<string|int, string>
contentTypes
= ['createNewRuleset' => ['application/json'], 'deleteRuleset' => ['application/json'], 'deleteRulesets' => ['application/json'], 'getRuleset' => ['application/json'], 'getRulesets' => ['application/json'], 'testInboxRulesetsForInbox' => ['application/json'], 'testNewRuleset' => ['application/json'], 'testRuleset' => ['application/json'], 'testRulesetReceiving' => ['application/json'], 'testRulesetSending' => ['application/json'], 'updateRuleset' => ['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 —createNewRuleset()
Operation createNewRuleset
public
createNewRuleset(CreateRulesetOptions $create_ruleset_options[, string $inbox_id = null ][, string $phone_id = null ][, string $contentType = self::contentTypes['createNewRuleset'][0] ]) : RulesetDto
Create a ruleset
Parameters
- $create_ruleset_options : CreateRulesetOptions
-
create_ruleset_options (required)
- $inbox_id : string = null
-
Inbox id to attach ruleset to (optional)
- $phone_id : string = null
-
Phone id to attach ruleset to (optional)
- $contentType : string = self::contentTypes['createNewRuleset'][0]
-
The value for the Content-Type header. Check self::contentTypes['createNewRuleset'] to see the possible values for this operation
Tags
Return values
RulesetDto —createNewRulesetAsync()
Operation createNewRulesetAsync
public
createNewRulesetAsync(CreateRulesetOptions $create_ruleset_options[, string $inbox_id = null ][, string $phone_id = null ][, string $contentType = self::contentTypes['createNewRuleset'][0] ]) : PromiseInterface
Create a ruleset
Parameters
- $create_ruleset_options : CreateRulesetOptions
-
(required)
- $inbox_id : string = null
-
Inbox id to attach ruleset to (optional)
- $phone_id : string = null
-
Phone id to attach ruleset to (optional)
- $contentType : string = self::contentTypes['createNewRuleset'][0]
-
The value for the Content-Type header. Check self::contentTypes['createNewRuleset'] to see the possible values for this operation
Tags
Return values
PromiseInterface —createNewRulesetAsyncWithHttpInfo()
Operation createNewRulesetAsyncWithHttpInfo
public
createNewRulesetAsyncWithHttpInfo(CreateRulesetOptions $create_ruleset_options[, string $inbox_id = null ][, string $phone_id = null ][, string $contentType = self::contentTypes['createNewRuleset'][0] ]) : PromiseInterface
Create a ruleset
Parameters
- $create_ruleset_options : CreateRulesetOptions
-
(required)
- $inbox_id : string = null
-
Inbox id to attach ruleset to (optional)
- $phone_id : string = null
-
Phone id to attach ruleset to (optional)
- $contentType : string = self::contentTypes['createNewRuleset'][0]
-
The value for the Content-Type header. Check self::contentTypes['createNewRuleset'] to see the possible values for this operation
Tags
Return values
PromiseInterface —createNewRulesetRequest()
Create request for operation 'createNewRuleset'
public
createNewRulesetRequest(CreateRulesetOptions $create_ruleset_options[, string $inbox_id = null ][, string $phone_id = null ][, string $contentType = self::contentTypes['createNewRuleset'][0] ]) : Request
Parameters
- $create_ruleset_options : CreateRulesetOptions
-
(required)
- $inbox_id : string = null
-
Inbox id to attach ruleset to (optional)
- $phone_id : string = null
-
Phone id to attach ruleset to (optional)
- $contentType : string = self::contentTypes['createNewRuleset'][0]
-
The value for the Content-Type header. Check self::contentTypes['createNewRuleset'] to see the possible values for this operation
Tags
Return values
Request —createNewRulesetWithHttpInfo()
Operation createNewRulesetWithHttpInfo
public
createNewRulesetWithHttpInfo(CreateRulesetOptions $create_ruleset_options[, string $inbox_id = null ][, string $phone_id = null ][, string $contentType = self::contentTypes['createNewRuleset'][0] ]) : array<string|int, mixed>
Create a ruleset
Parameters
- $create_ruleset_options : CreateRulesetOptions
-
(required)
- $inbox_id : string = null
-
Inbox id to attach ruleset to (optional)
- $phone_id : string = null
-
Phone id to attach ruleset to (optional)
- $contentType : string = self::contentTypes['createNewRuleset'][0]
-
The value for the Content-Type header. Check self::contentTypes['createNewRuleset'] to see the possible values for this operation
Tags
Return values
array<string|int, mixed> —of \MailSlurp\Models\RulesetDto, HTTP status code, HTTP response headers (array of strings)
deleteRuleset()
Operation deleteRuleset
public
deleteRuleset(string $id[, string $contentType = self::contentTypes['deleteRuleset'][0] ]) : void
Delete a ruleset
Parameters
- $id : string
-
ID of ruleset (required)
- $contentType : string = self::contentTypes['deleteRuleset'][0]
-
The value for the Content-Type header. Check self::contentTypes['deleteRuleset'] to see the possible values for this operation
Tags
Return values
void —deleteRulesetAsync()
Operation deleteRulesetAsync
public
deleteRulesetAsync(string $id[, string $contentType = self::contentTypes['deleteRuleset'][0] ]) : PromiseInterface
Delete a ruleset
Parameters
- $id : string
-
ID of ruleset (required)
- $contentType : string = self::contentTypes['deleteRuleset'][0]
-
The value for the Content-Type header. Check self::contentTypes['deleteRuleset'] to see the possible values for this operation
Tags
Return values
PromiseInterface —deleteRulesetAsyncWithHttpInfo()
Operation deleteRulesetAsyncWithHttpInfo
public
deleteRulesetAsyncWithHttpInfo(string $id[, string $contentType = self::contentTypes['deleteRuleset'][0] ]) : PromiseInterface
Delete a ruleset
Parameters
- $id : string
-
ID of ruleset (required)
- $contentType : string = self::contentTypes['deleteRuleset'][0]
-
The value for the Content-Type header. Check self::contentTypes['deleteRuleset'] to see the possible values for this operation
Tags
Return values
PromiseInterface —deleteRulesetRequest()
Create request for operation 'deleteRuleset'
public
deleteRulesetRequest(string $id[, string $contentType = self::contentTypes['deleteRuleset'][0] ]) : Request
Parameters
- $id : string
-
ID of ruleset (required)
- $contentType : string = self::contentTypes['deleteRuleset'][0]
-
The value for the Content-Type header. Check self::contentTypes['deleteRuleset'] to see the possible values for this operation
Tags
Return values
Request —deleteRulesets()
Operation deleteRulesets
public
deleteRulesets([string $inbox_id = null ][, string $phone_id = null ][, string $contentType = self::contentTypes['deleteRulesets'][0] ]) : void
Delete rulesets
Parameters
- $inbox_id : string = null
-
Optional inbox id to attach ruleset to (optional)
- $phone_id : string = null
-
phone_id (optional)
- $contentType : string = self::contentTypes['deleteRulesets'][0]
-
The value for the Content-Type header. Check self::contentTypes['deleteRulesets'] to see the possible values for this operation
Tags
Return values
void —deleteRulesetsAsync()
Operation deleteRulesetsAsync
public
deleteRulesetsAsync([string $inbox_id = null ][, string $phone_id = null ][, string $contentType = self::contentTypes['deleteRulesets'][0] ]) : PromiseInterface
Delete rulesets
Parameters
- $inbox_id : string = null
-
Optional inbox id to attach ruleset to (optional)
- $phone_id : string = null
-
(optional)
- $contentType : string = self::contentTypes['deleteRulesets'][0]
-
The value for the Content-Type header. Check self::contentTypes['deleteRulesets'] to see the possible values for this operation
Tags
Return values
PromiseInterface —deleteRulesetsAsyncWithHttpInfo()
Operation deleteRulesetsAsyncWithHttpInfo
public
deleteRulesetsAsyncWithHttpInfo([string $inbox_id = null ][, string $phone_id = null ][, string $contentType = self::contentTypes['deleteRulesets'][0] ]) : PromiseInterface
Delete rulesets
Parameters
- $inbox_id : string = null
-
Optional inbox id to attach ruleset to (optional)
- $phone_id : string = null
-
(optional)
- $contentType : string = self::contentTypes['deleteRulesets'][0]
-
The value for the Content-Type header. Check self::contentTypes['deleteRulesets'] to see the possible values for this operation
Tags
Return values
PromiseInterface —deleteRulesetsRequest()
Create request for operation 'deleteRulesets'
public
deleteRulesetsRequest([string $inbox_id = null ][, string $phone_id = null ][, string $contentType = self::contentTypes['deleteRulesets'][0] ]) : Request
Parameters
- $inbox_id : string = null
-
Optional inbox id to attach ruleset to (optional)
- $phone_id : string = null
-
(optional)
- $contentType : string = self::contentTypes['deleteRulesets'][0]
-
The value for the Content-Type header. Check self::contentTypes['deleteRulesets'] to see the possible values for this operation
Tags
Return values
Request —deleteRulesetsWithHttpInfo()
Operation deleteRulesetsWithHttpInfo
public
deleteRulesetsWithHttpInfo([string $inbox_id = null ][, string $phone_id = null ][, string $contentType = self::contentTypes['deleteRulesets'][0] ]) : array<string|int, mixed>
Delete rulesets
Parameters
- $inbox_id : string = null
-
Optional inbox id to attach ruleset to (optional)
- $phone_id : string = null
-
(optional)
- $contentType : string = self::contentTypes['deleteRulesets'][0]
-
The value for the Content-Type header. Check self::contentTypes['deleteRulesets'] 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)
deleteRulesetWithHttpInfo()
Operation deleteRulesetWithHttpInfo
public
deleteRulesetWithHttpInfo(string $id[, string $contentType = self::contentTypes['deleteRuleset'][0] ]) : array<string|int, mixed>
Delete a ruleset
Parameters
- $id : string
-
ID of ruleset (required)
- $contentType : string = self::contentTypes['deleteRuleset'][0]
-
The value for the Content-Type header. Check self::contentTypes['deleteRuleset'] 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
getRuleset()
Operation getRuleset
public
getRuleset(string $id[, string $contentType = self::contentTypes['getRuleset'][0] ]) : RulesetDto
Get a ruleset
Parameters
- $id : string
-
ID of ruleset (required)
- $contentType : string = self::contentTypes['getRuleset'][0]
-
The value for the Content-Type header. Check self::contentTypes['getRuleset'] to see the possible values for this operation
Tags
Return values
RulesetDto —getRulesetAsync()
Operation getRulesetAsync
public
getRulesetAsync(string $id[, string $contentType = self::contentTypes['getRuleset'][0] ]) : PromiseInterface
Get a ruleset
Parameters
- $id : string
-
ID of ruleset (required)
- $contentType : string = self::contentTypes['getRuleset'][0]
-
The value for the Content-Type header. Check self::contentTypes['getRuleset'] to see the possible values for this operation
Tags
Return values
PromiseInterface —getRulesetAsyncWithHttpInfo()
Operation getRulesetAsyncWithHttpInfo
public
getRulesetAsyncWithHttpInfo(string $id[, string $contentType = self::contentTypes['getRuleset'][0] ]) : PromiseInterface
Get a ruleset
Parameters
- $id : string
-
ID of ruleset (required)
- $contentType : string = self::contentTypes['getRuleset'][0]
-
The value for the Content-Type header. Check self::contentTypes['getRuleset'] to see the possible values for this operation
Tags
Return values
PromiseInterface —getRulesetRequest()
Create request for operation 'getRuleset'
public
getRulesetRequest(string $id[, string $contentType = self::contentTypes['getRuleset'][0] ]) : Request
Parameters
- $id : string
-
ID of ruleset (required)
- $contentType : string = self::contentTypes['getRuleset'][0]
-
The value for the Content-Type header. Check self::contentTypes['getRuleset'] to see the possible values for this operation
Tags
Return values
Request —getRulesets()
Operation getRulesets
public
getRulesets([string $inbox_id = null ][, string $phone_id = null ], int $page[, int $size = 20 ][, string $sort = 'ASC' ][, string $search_filter = null ][, DateTime $since = null ][, DateTime $before = null ][, string $contentType = self::contentTypes['getRulesets'][0] ]) : PageRulesetDto
List rulesets block and allow lists
Parameters
- $inbox_id : string = null
-
Optional inbox id to get rulesets from (optional)
- $phone_id : string = null
-
Optional phone 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['getRulesets'][0]
-
The value for the Content-Type header. Check self::contentTypes['getRulesets'] to see the possible values for this operation
Tags
Return values
PageRulesetDto —getRulesetsAsync()
Operation getRulesetsAsync
public
getRulesetsAsync([string $inbox_id = null ][, string $phone_id = null ], int $page[, int $size = 20 ][, string $sort = 'ASC' ][, string $search_filter = null ][, DateTime $since = null ][, DateTime $before = null ][, string $contentType = self::contentTypes['getRulesets'][0] ]) : PromiseInterface
List rulesets block and allow lists
Parameters
- $inbox_id : string = null
-
Optional inbox id to get rulesets from (optional)
- $phone_id : string = null
-
Optional phone 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['getRulesets'][0]
-
The value for the Content-Type header. Check self::contentTypes['getRulesets'] to see the possible values for this operation
Tags
Return values
PromiseInterface —getRulesetsAsyncWithHttpInfo()
Operation getRulesetsAsyncWithHttpInfo
public
getRulesetsAsyncWithHttpInfo([string $inbox_id = null ][, string $phone_id = null ], int $page[, int $size = 20 ][, string $sort = 'ASC' ][, string $search_filter = null ][, DateTime $since = null ][, DateTime $before = null ][, string $contentType = self::contentTypes['getRulesets'][0] ]) : PromiseInterface
List rulesets block and allow lists
Parameters
- $inbox_id : string = null
-
Optional inbox id to get rulesets from (optional)
- $phone_id : string = null
-
Optional phone 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['getRulesets'][0]
-
The value for the Content-Type header. Check self::contentTypes['getRulesets'] to see the possible values for this operation
Tags
Return values
PromiseInterface —getRulesetsRequest()
Create request for operation 'getRulesets'
public
getRulesetsRequest([string $inbox_id = null ][, string $phone_id = null ], int $page[, int $size = 20 ][, string $sort = 'ASC' ][, string $search_filter = null ][, DateTime $since = null ][, DateTime $before = null ][, string $contentType = self::contentTypes['getRulesets'][0] ]) : Request
Parameters
- $inbox_id : string = null
-
Optional inbox id to get rulesets from (optional)
- $phone_id : string = null
-
Optional phone 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['getRulesets'][0]
-
The value for the Content-Type header. Check self::contentTypes['getRulesets'] to see the possible values for this operation
Tags
Return values
Request —getRulesetsWithHttpInfo()
Operation getRulesetsWithHttpInfo
public
getRulesetsWithHttpInfo([string $inbox_id = null ][, string $phone_id = null ], int $page[, int $size = 20 ][, string $sort = 'ASC' ][, string $search_filter = null ][, DateTime $since = null ][, DateTime $before = null ][, string $contentType = self::contentTypes['getRulesets'][0] ]) : array<string|int, mixed>
List rulesets block and allow lists
Parameters
- $inbox_id : string = null
-
Optional inbox id to get rulesets from (optional)
- $phone_id : string = null
-
Optional phone 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['getRulesets'][0]
-
The value for the Content-Type header. Check self::contentTypes['getRulesets'] to see the possible values for this operation
Tags
Return values
array<string|int, mixed> —of \MailSlurp\Models\PageRulesetDto, HTTP status code, HTTP response headers (array of strings)
getRulesetWithHttpInfo()
Operation getRulesetWithHttpInfo
public
getRulesetWithHttpInfo(string $id[, string $contentType = self::contentTypes['getRuleset'][0] ]) : array<string|int, mixed>
Get a ruleset
Parameters
- $id : string
-
ID of ruleset (required)
- $contentType : string = self::contentTypes['getRuleset'][0]
-
The value for the Content-Type header. Check self::contentTypes['getRuleset'] to see the possible values for this operation
Tags
Return values
array<string|int, mixed> —of \MailSlurp\Models\RulesetDto, 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 —testInboxRulesetsForInbox()
Operation testInboxRulesetsForInbox
public
testInboxRulesetsForInbox(string $inbox_id, RulesetTestOptions $ruleset_test_options[, string $contentType = self::contentTypes['testInboxRulesetsForInbox'][0] ]) : InboxRulesetTestResult
Test inbox rulesets for inbox
Parameters
- $inbox_id : string
-
ID of inbox (required)
- $ruleset_test_options : RulesetTestOptions
-
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, RulesetTestOptions $ruleset_test_options[, string $contentType = self::contentTypes['testInboxRulesetsForInbox'][0] ]) : PromiseInterface
Test inbox rulesets for inbox
Parameters
- $inbox_id : string
-
ID of inbox (required)
- $ruleset_test_options : RulesetTestOptions
-
(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, RulesetTestOptions $ruleset_test_options[, string $contentType = self::contentTypes['testInboxRulesetsForInbox'][0] ]) : PromiseInterface
Test inbox rulesets for inbox
Parameters
- $inbox_id : string
-
ID of inbox (required)
- $ruleset_test_options : RulesetTestOptions
-
(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, RulesetTestOptions $ruleset_test_options[, string $contentType = self::contentTypes['testInboxRulesetsForInbox'][0] ]) : Request
Parameters
- $inbox_id : string
-
ID of inbox (required)
- $ruleset_test_options : RulesetTestOptions
-
(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, RulesetTestOptions $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)
- $ruleset_test_options : RulesetTestOptions
-
(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)
testNewRuleset()
Operation testNewRuleset
public
testNewRuleset(TestNewInboxRulesetOptions $test_new_inbox_ruleset_options[, string $contentType = self::contentTypes['testNewRuleset'][0] ]) : InboxRulesetTestResult
Test new ruleset
Parameters
- $test_new_inbox_ruleset_options : TestNewInboxRulesetOptions
-
test_new_inbox_ruleset_options (required)
- $contentType : string = self::contentTypes['testNewRuleset'][0]
-
The value for the Content-Type header. Check self::contentTypes['testNewRuleset'] to see the possible values for this operation
Tags
Return values
InboxRulesetTestResult —testNewRulesetAsync()
Operation testNewRulesetAsync
public
testNewRulesetAsync(TestNewInboxRulesetOptions $test_new_inbox_ruleset_options[, string $contentType = self::contentTypes['testNewRuleset'][0] ]) : PromiseInterface
Test new ruleset
Parameters
- $test_new_inbox_ruleset_options : TestNewInboxRulesetOptions
-
(required)
- $contentType : string = self::contentTypes['testNewRuleset'][0]
-
The value for the Content-Type header. Check self::contentTypes['testNewRuleset'] to see the possible values for this operation
Tags
Return values
PromiseInterface —testNewRulesetAsyncWithHttpInfo()
Operation testNewRulesetAsyncWithHttpInfo
public
testNewRulesetAsyncWithHttpInfo(TestNewInboxRulesetOptions $test_new_inbox_ruleset_options[, string $contentType = self::contentTypes['testNewRuleset'][0] ]) : PromiseInterface
Test new ruleset
Parameters
- $test_new_inbox_ruleset_options : TestNewInboxRulesetOptions
-
(required)
- $contentType : string = self::contentTypes['testNewRuleset'][0]
-
The value for the Content-Type header. Check self::contentTypes['testNewRuleset'] to see the possible values for this operation
Tags
Return values
PromiseInterface —testNewRulesetRequest()
Create request for operation 'testNewRuleset'
public
testNewRulesetRequest(TestNewInboxRulesetOptions $test_new_inbox_ruleset_options[, string $contentType = self::contentTypes['testNewRuleset'][0] ]) : Request
Parameters
- $test_new_inbox_ruleset_options : TestNewInboxRulesetOptions
-
(required)
- $contentType : string = self::contentTypes['testNewRuleset'][0]
-
The value for the Content-Type header. Check self::contentTypes['testNewRuleset'] to see the possible values for this operation
Tags
Return values
Request —testNewRulesetWithHttpInfo()
Operation testNewRulesetWithHttpInfo
public
testNewRulesetWithHttpInfo(TestNewInboxRulesetOptions $test_new_inbox_ruleset_options[, string $contentType = self::contentTypes['testNewRuleset'][0] ]) : array<string|int, mixed>
Test new ruleset
Parameters
- $test_new_inbox_ruleset_options : TestNewInboxRulesetOptions
-
(required)
- $contentType : string = self::contentTypes['testNewRuleset'][0]
-
The value for the Content-Type header. Check self::contentTypes['testNewRuleset'] 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)
testRuleset()
Operation testRuleset
public
testRuleset(string $id, RulesetTestOptions $ruleset_test_options[, string $contentType = self::contentTypes['testRuleset'][0] ]) : InboxRulesetTestResult
Test a ruleset
Parameters
- $id : string
-
ID of ruleset (required)
- $ruleset_test_options : RulesetTestOptions
-
ruleset_test_options (required)
- $contentType : string = self::contentTypes['testRuleset'][0]
-
The value for the Content-Type header. Check self::contentTypes['testRuleset'] to see the possible values for this operation
Tags
Return values
InboxRulesetTestResult —testRulesetAsync()
Operation testRulesetAsync
public
testRulesetAsync(string $id, RulesetTestOptions $ruleset_test_options[, string $contentType = self::contentTypes['testRuleset'][0] ]) : PromiseInterface
Test a ruleset
Parameters
- $id : string
-
ID of ruleset (required)
- $ruleset_test_options : RulesetTestOptions
-
(required)
- $contentType : string = self::contentTypes['testRuleset'][0]
-
The value for the Content-Type header. Check self::contentTypes['testRuleset'] to see the possible values for this operation
Tags
Return values
PromiseInterface —testRulesetAsyncWithHttpInfo()
Operation testRulesetAsyncWithHttpInfo
public
testRulesetAsyncWithHttpInfo(string $id, RulesetTestOptions $ruleset_test_options[, string $contentType = self::contentTypes['testRuleset'][0] ]) : PromiseInterface
Test a ruleset
Parameters
- $id : string
-
ID of ruleset (required)
- $ruleset_test_options : RulesetTestOptions
-
(required)
- $contentType : string = self::contentTypes['testRuleset'][0]
-
The value for the Content-Type header. Check self::contentTypes['testRuleset'] to see the possible values for this operation
Tags
Return values
PromiseInterface —testRulesetReceiving()
Operation testRulesetReceiving
public
testRulesetReceiving(TestRulesetReceivingOptions $test_ruleset_receiving_options[, string $contentType = self::contentTypes['testRulesetReceiving'][0] ]) : TestRulesetReceivingResult
Test receiving with rulesets
Parameters
- $test_ruleset_receiving_options : TestRulesetReceivingOptions
-
test_ruleset_receiving_options (required)
- $contentType : string = self::contentTypes['testRulesetReceiving'][0]
-
The value for the Content-Type header. Check self::contentTypes['testRulesetReceiving'] to see the possible values for this operation
Tags
Return values
TestRulesetReceivingResult —testRulesetReceivingAsync()
Operation testRulesetReceivingAsync
public
testRulesetReceivingAsync(TestRulesetReceivingOptions $test_ruleset_receiving_options[, string $contentType = self::contentTypes['testRulesetReceiving'][0] ]) : PromiseInterface
Test receiving with rulesets
Parameters
- $test_ruleset_receiving_options : TestRulesetReceivingOptions
-
(required)
- $contentType : string = self::contentTypes['testRulesetReceiving'][0]
-
The value for the Content-Type header. Check self::contentTypes['testRulesetReceiving'] to see the possible values for this operation
Tags
Return values
PromiseInterface —testRulesetReceivingAsyncWithHttpInfo()
Operation testRulesetReceivingAsyncWithHttpInfo
public
testRulesetReceivingAsyncWithHttpInfo(TestRulesetReceivingOptions $test_ruleset_receiving_options[, string $contentType = self::contentTypes['testRulesetReceiving'][0] ]) : PromiseInterface
Test receiving with rulesets
Parameters
- $test_ruleset_receiving_options : TestRulesetReceivingOptions
-
(required)
- $contentType : string = self::contentTypes['testRulesetReceiving'][0]
-
The value for the Content-Type header. Check self::contentTypes['testRulesetReceiving'] to see the possible values for this operation
Tags
Return values
PromiseInterface —testRulesetReceivingRequest()
Create request for operation 'testRulesetReceiving'
public
testRulesetReceivingRequest(TestRulesetReceivingOptions $test_ruleset_receiving_options[, string $contentType = self::contentTypes['testRulesetReceiving'][0] ]) : Request
Parameters
- $test_ruleset_receiving_options : TestRulesetReceivingOptions
-
(required)
- $contentType : string = self::contentTypes['testRulesetReceiving'][0]
-
The value for the Content-Type header. Check self::contentTypes['testRulesetReceiving'] to see the possible values for this operation
Tags
Return values
Request —testRulesetReceivingWithHttpInfo()
Operation testRulesetReceivingWithHttpInfo
public
testRulesetReceivingWithHttpInfo(TestRulesetReceivingOptions $test_ruleset_receiving_options[, string $contentType = self::contentTypes['testRulesetReceiving'][0] ]) : array<string|int, mixed>
Test receiving with rulesets
Parameters
- $test_ruleset_receiving_options : TestRulesetReceivingOptions
-
(required)
- $contentType : string = self::contentTypes['testRulesetReceiving'][0]
-
The value for the Content-Type header. Check self::contentTypes['testRulesetReceiving'] to see the possible values for this operation
Tags
Return values
array<string|int, mixed> —of \MailSlurp\Models\TestRulesetReceivingResult, HTTP status code, HTTP response headers (array of strings)
testRulesetRequest()
Create request for operation 'testRuleset'
public
testRulesetRequest(string $id, RulesetTestOptions $ruleset_test_options[, string $contentType = self::contentTypes['testRuleset'][0] ]) : Request
Parameters
- $id : string
-
ID of ruleset (required)
- $ruleset_test_options : RulesetTestOptions
-
(required)
- $contentType : string = self::contentTypes['testRuleset'][0]
-
The value for the Content-Type header. Check self::contentTypes['testRuleset'] to see the possible values for this operation
Tags
Return values
Request —testRulesetSending()
Operation testRulesetSending
public
testRulesetSending(TestInboxRulesetSendingOptions $test_inbox_ruleset_sending_options[, string $contentType = self::contentTypes['testRulesetSending'][0] ]) : TestRulesetSendingResult
Test sending with rulesets
Parameters
- $test_inbox_ruleset_sending_options : TestInboxRulesetSendingOptions
-
test_inbox_ruleset_sending_options (required)
- $contentType : string = self::contentTypes['testRulesetSending'][0]
-
The value for the Content-Type header. Check self::contentTypes['testRulesetSending'] to see the possible values for this operation
Tags
Return values
TestRulesetSendingResult —testRulesetSendingAsync()
Operation testRulesetSendingAsync
public
testRulesetSendingAsync(TestInboxRulesetSendingOptions $test_inbox_ruleset_sending_options[, string $contentType = self::contentTypes['testRulesetSending'][0] ]) : PromiseInterface
Test sending with rulesets
Parameters
- $test_inbox_ruleset_sending_options : TestInboxRulesetSendingOptions
-
(required)
- $contentType : string = self::contentTypes['testRulesetSending'][0]
-
The value for the Content-Type header. Check self::contentTypes['testRulesetSending'] to see the possible values for this operation
Tags
Return values
PromiseInterface —testRulesetSendingAsyncWithHttpInfo()
Operation testRulesetSendingAsyncWithHttpInfo
public
testRulesetSendingAsyncWithHttpInfo(TestInboxRulesetSendingOptions $test_inbox_ruleset_sending_options[, string $contentType = self::contentTypes['testRulesetSending'][0] ]) : PromiseInterface
Test sending with rulesets
Parameters
- $test_inbox_ruleset_sending_options : TestInboxRulesetSendingOptions
-
(required)
- $contentType : string = self::contentTypes['testRulesetSending'][0]
-
The value for the Content-Type header. Check self::contentTypes['testRulesetSending'] to see the possible values for this operation
Tags
Return values
PromiseInterface —testRulesetSendingRequest()
Create request for operation 'testRulesetSending'
public
testRulesetSendingRequest(TestInboxRulesetSendingOptions $test_inbox_ruleset_sending_options[, string $contentType = self::contentTypes['testRulesetSending'][0] ]) : Request
Parameters
- $test_inbox_ruleset_sending_options : TestInboxRulesetSendingOptions
-
(required)
- $contentType : string = self::contentTypes['testRulesetSending'][0]
-
The value for the Content-Type header. Check self::contentTypes['testRulesetSending'] to see the possible values for this operation
Tags
Return values
Request —testRulesetSendingWithHttpInfo()
Operation testRulesetSendingWithHttpInfo
public
testRulesetSendingWithHttpInfo(TestInboxRulesetSendingOptions $test_inbox_ruleset_sending_options[, string $contentType = self::contentTypes['testRulesetSending'][0] ]) : array<string|int, mixed>
Test sending with rulesets
Parameters
- $test_inbox_ruleset_sending_options : TestInboxRulesetSendingOptions
-
(required)
- $contentType : string = self::contentTypes['testRulesetSending'][0]
-
The value for the Content-Type header. Check self::contentTypes['testRulesetSending'] to see the possible values for this operation
Tags
Return values
array<string|int, mixed> —of \MailSlurp\Models\TestRulesetSendingResult, HTTP status code, HTTP response headers (array of strings)
testRulesetWithHttpInfo()
Operation testRulesetWithHttpInfo
public
testRulesetWithHttpInfo(string $id, RulesetTestOptions $ruleset_test_options[, string $contentType = self::contentTypes['testRuleset'][0] ]) : array<string|int, mixed>
Test a ruleset
Parameters
- $id : string
-
ID of ruleset (required)
- $ruleset_test_options : RulesetTestOptions
-
(required)
- $contentType : string = self::contentTypes['testRuleset'][0]
-
The value for the Content-Type header. Check self::contentTypes['testRuleset'] 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)
updateRuleset()
Operation updateRuleset
public
updateRuleset(string $id, UpdateRulesetOptions $update_ruleset_options[, string $contentType = self::contentTypes['updateRuleset'][0] ]) : RulesetDto
Update a ruleset
Parameters
- $id : string
-
ID of ruleset (required)
- $update_ruleset_options : UpdateRulesetOptions
-
update_ruleset_options (required)
- $contentType : string = self::contentTypes['updateRuleset'][0]
-
The value for the Content-Type header. Check self::contentTypes['updateRuleset'] to see the possible values for this operation
Tags
Return values
RulesetDto —updateRulesetAsync()
Operation updateRulesetAsync
public
updateRulesetAsync(string $id, UpdateRulesetOptions $update_ruleset_options[, string $contentType = self::contentTypes['updateRuleset'][0] ]) : PromiseInterface
Update a ruleset
Parameters
- $id : string
-
ID of ruleset (required)
- $update_ruleset_options : UpdateRulesetOptions
-
(required)
- $contentType : string = self::contentTypes['updateRuleset'][0]
-
The value for the Content-Type header. Check self::contentTypes['updateRuleset'] to see the possible values for this operation
Tags
Return values
PromiseInterface —updateRulesetAsyncWithHttpInfo()
Operation updateRulesetAsyncWithHttpInfo
public
updateRulesetAsyncWithHttpInfo(string $id, UpdateRulesetOptions $update_ruleset_options[, string $contentType = self::contentTypes['updateRuleset'][0] ]) : PromiseInterface
Update a ruleset
Parameters
- $id : string
-
ID of ruleset (required)
- $update_ruleset_options : UpdateRulesetOptions
-
(required)
- $contentType : string = self::contentTypes['updateRuleset'][0]
-
The value for the Content-Type header. Check self::contentTypes['updateRuleset'] to see the possible values for this operation
Tags
Return values
PromiseInterface —updateRulesetRequest()
Create request for operation 'updateRuleset'
public
updateRulesetRequest(string $id, UpdateRulesetOptions $update_ruleset_options[, string $contentType = self::contentTypes['updateRuleset'][0] ]) : Request
Parameters
- $id : string
-
ID of ruleset (required)
- $update_ruleset_options : UpdateRulesetOptions
-
(required)
- $contentType : string = self::contentTypes['updateRuleset'][0]
-
The value for the Content-Type header. Check self::contentTypes['updateRuleset'] to see the possible values for this operation
Tags
Return values
Request —updateRulesetWithHttpInfo()
Operation updateRulesetWithHttpInfo
public
updateRulesetWithHttpInfo(string $id, UpdateRulesetOptions $update_ruleset_options[, string $contentType = self::contentTypes['updateRuleset'][0] ]) : array<string|int, mixed>
Update a ruleset
Parameters
- $id : string
-
ID of ruleset (required)
- $update_ruleset_options : UpdateRulesetOptions
-
(required)
- $contentType : string = self::contentTypes['updateRuleset'][0]
-
The value for the Content-Type header. Check self::contentTypes['updateRuleset'] to see the possible values for this operation
Tags
Return values
array<string|int, mixed> —of \MailSlurp\Models\RulesetDto, 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