UserControllerApi
in package
UserControllerApi Class Doc Comment
Tags
Table of Contents
- contentTypes = ['createInboxRetentionPolicy' => ['application/json'], 'createInboxRetentionPolicyRun' => ['application/json'], 'createOrUpdateInboxRetentionPolicyForAccount' => ['application/json'], 'deleteInboxRetentionPolicy' => ['application/json'], 'deleteInboxRetentionPolicyForAccount' => ['application/json'], 'getEntityAutomations' => ['application/json'], 'getEntityEvents' => ['application/json'], 'getEntityFavorites' => ['application/json'], 'getInboxRetentionPolicy' => ['application/json'], 'getInboxRetentionPolicyForAccount' => ['application/json'], 'getInboxRetentionPolicyRun' => ['application/json'], 'getInboxRetentionPolicyRuns' => ['application/json'], 'getJsonPropertyAsString' => ['application/json'], 'getUserInfo' => ['application/json'], 'getUserStorageInsights' => ['application/json'], 'listInboxRetentionPolicies' => ['application/json'], 'updateInboxRetentionPolicy' => ['application/json']]
- $client : ClientInterface
- $config : Configuration
- $headerSelector : HeaderSelector
- $hostIndex : int
- __construct() : mixed
- createInboxRetentionPolicy() : InboxRetentionPolicyDto
- Operation createInboxRetentionPolicy
- createInboxRetentionPolicyAsync() : PromiseInterface
- Operation createInboxRetentionPolicyAsync
- createInboxRetentionPolicyAsyncWithHttpInfo() : PromiseInterface
- Operation createInboxRetentionPolicyAsyncWithHttpInfo
- createInboxRetentionPolicyRequest() : Request
- Create request for operation 'createInboxRetentionPolicy'
- createInboxRetentionPolicyRun() : InboxRetentionPolicyRunDto
- Operation createInboxRetentionPolicyRun
- createInboxRetentionPolicyRunAsync() : PromiseInterface
- Operation createInboxRetentionPolicyRunAsync
- createInboxRetentionPolicyRunAsyncWithHttpInfo() : PromiseInterface
- Operation createInboxRetentionPolicyRunAsyncWithHttpInfo
- createInboxRetentionPolicyRunRequest() : Request
- Create request for operation 'createInboxRetentionPolicyRun'
- createInboxRetentionPolicyRunWithHttpInfo() : array<string|int, mixed>
- Operation createInboxRetentionPolicyRunWithHttpInfo
- createInboxRetentionPolicyWithHttpInfo() : array<string|int, mixed>
- Operation createInboxRetentionPolicyWithHttpInfo
- createOrUpdateInboxRetentionPolicyForAccount() : InboxRetentionPolicyDto
- Operation createOrUpdateInboxRetentionPolicyForAccount
- createOrUpdateInboxRetentionPolicyForAccountAsync() : PromiseInterface
- Operation createOrUpdateInboxRetentionPolicyForAccountAsync
- createOrUpdateInboxRetentionPolicyForAccountAsyncWithHttpInfo() : PromiseInterface
- Operation createOrUpdateInboxRetentionPolicyForAccountAsyncWithHttpInfo
- createOrUpdateInboxRetentionPolicyForAccountRequest() : Request
- Create request for operation 'createOrUpdateInboxRetentionPolicyForAccount'
- createOrUpdateInboxRetentionPolicyForAccountWithHttpInfo() : array<string|int, mixed>
- Operation createOrUpdateInboxRetentionPolicyForAccountWithHttpInfo
- deleteInboxRetentionPolicy() : EmptyResponseDto
- Operation deleteInboxRetentionPolicy
- deleteInboxRetentionPolicyAsync() : PromiseInterface
- Operation deleteInboxRetentionPolicyAsync
- deleteInboxRetentionPolicyAsyncWithHttpInfo() : PromiseInterface
- Operation deleteInboxRetentionPolicyAsyncWithHttpInfo
- deleteInboxRetentionPolicyForAccount() : EmptyResponseDto
- Operation deleteInboxRetentionPolicyForAccount
- deleteInboxRetentionPolicyForAccountAsync() : PromiseInterface
- Operation deleteInboxRetentionPolicyForAccountAsync
- deleteInboxRetentionPolicyForAccountAsyncWithHttpInfo() : PromiseInterface
- Operation deleteInboxRetentionPolicyForAccountAsyncWithHttpInfo
- deleteInboxRetentionPolicyForAccountRequest() : Request
- Create request for operation 'deleteInboxRetentionPolicyForAccount'
- deleteInboxRetentionPolicyForAccountWithHttpInfo() : array<string|int, mixed>
- Operation deleteInboxRetentionPolicyForAccountWithHttpInfo
- deleteInboxRetentionPolicyRequest() : Request
- Create request for operation 'deleteInboxRetentionPolicy'
- deleteInboxRetentionPolicyWithHttpInfo() : array<string|int, mixed>
- Operation deleteInboxRetentionPolicyWithHttpInfo
- getConfig() : Configuration
- getEntityAutomations() : PageEntityAutomationItems
- Operation getEntityAutomations
- getEntityAutomationsAsync() : PromiseInterface
- Operation getEntityAutomationsAsync
- getEntityAutomationsAsyncWithHttpInfo() : PromiseInterface
- Operation getEntityAutomationsAsyncWithHttpInfo
- getEntityAutomationsRequest() : Request
- Create request for operation 'getEntityAutomations'
- getEntityAutomationsWithHttpInfo() : array<string|int, mixed>
- Operation getEntityAutomationsWithHttpInfo
- getEntityEvents() : PageEntityEventItems
- Operation getEntityEvents
- getEntityEventsAsync() : PromiseInterface
- Operation getEntityEventsAsync
- getEntityEventsAsyncWithHttpInfo() : PromiseInterface
- Operation getEntityEventsAsyncWithHttpInfo
- getEntityEventsRequest() : Request
- Create request for operation 'getEntityEvents'
- getEntityEventsWithHttpInfo() : array<string|int, mixed>
- Operation getEntityEventsWithHttpInfo
- getEntityFavorites() : PageEntityFavouriteItems
- Operation getEntityFavorites
- getEntityFavoritesAsync() : PromiseInterface
- Operation getEntityFavoritesAsync
- getEntityFavoritesAsyncWithHttpInfo() : PromiseInterface
- Operation getEntityFavoritesAsyncWithHttpInfo
- getEntityFavoritesRequest() : Request
- Create request for operation 'getEntityFavorites'
- getEntityFavoritesWithHttpInfo() : array<string|int, mixed>
- Operation getEntityFavoritesWithHttpInfo
- getHostIndex() : int
- Get the host index
- getInboxRetentionPolicy() : InboxRetentionPolicyDto
- Operation getInboxRetentionPolicy
- getInboxRetentionPolicyAsync() : PromiseInterface
- Operation getInboxRetentionPolicyAsync
- getInboxRetentionPolicyAsyncWithHttpInfo() : PromiseInterface
- Operation getInboxRetentionPolicyAsyncWithHttpInfo
- getInboxRetentionPolicyForAccount() : InboxRetentionPolicyOptionalDto
- Operation getInboxRetentionPolicyForAccount
- getInboxRetentionPolicyForAccountAsync() : PromiseInterface
- Operation getInboxRetentionPolicyForAccountAsync
- getInboxRetentionPolicyForAccountAsyncWithHttpInfo() : PromiseInterface
- Operation getInboxRetentionPolicyForAccountAsyncWithHttpInfo
- getInboxRetentionPolicyForAccountRequest() : Request
- Create request for operation 'getInboxRetentionPolicyForAccount'
- getInboxRetentionPolicyForAccountWithHttpInfo() : array<string|int, mixed>
- Operation getInboxRetentionPolicyForAccountWithHttpInfo
- getInboxRetentionPolicyRequest() : Request
- Create request for operation 'getInboxRetentionPolicy'
- getInboxRetentionPolicyRun() : InboxRetentionPolicyRunDto
- Operation getInboxRetentionPolicyRun
- getInboxRetentionPolicyRunAsync() : PromiseInterface
- Operation getInboxRetentionPolicyRunAsync
- getInboxRetentionPolicyRunAsyncWithHttpInfo() : PromiseInterface
- Operation getInboxRetentionPolicyRunAsyncWithHttpInfo
- getInboxRetentionPolicyRunRequest() : Request
- Create request for operation 'getInboxRetentionPolicyRun'
- getInboxRetentionPolicyRuns() : PageInboxRetentionPolicyRunProjection
- Operation getInboxRetentionPolicyRuns
- getInboxRetentionPolicyRunsAsync() : PromiseInterface
- Operation getInboxRetentionPolicyRunsAsync
- getInboxRetentionPolicyRunsAsyncWithHttpInfo() : PromiseInterface
- Operation getInboxRetentionPolicyRunsAsyncWithHttpInfo
- getInboxRetentionPolicyRunsRequest() : Request
- Create request for operation 'getInboxRetentionPolicyRuns'
- getInboxRetentionPolicyRunsWithHttpInfo() : array<string|int, mixed>
- Operation getInboxRetentionPolicyRunsWithHttpInfo
- getInboxRetentionPolicyRunWithHttpInfo() : array<string|int, mixed>
- Operation getInboxRetentionPolicyRunWithHttpInfo
- getInboxRetentionPolicyWithHttpInfo() : array<string|int, mixed>
- Operation getInboxRetentionPolicyWithHttpInfo
- getJsonPropertyAsString() : string
- Operation getJsonPropertyAsString
- getJsonPropertyAsStringAsync() : PromiseInterface
- Operation getJsonPropertyAsStringAsync
- getJsonPropertyAsStringAsyncWithHttpInfo() : PromiseInterface
- Operation getJsonPropertyAsStringAsyncWithHttpInfo
- getJsonPropertyAsStringRequest() : Request
- Create request for operation 'getJsonPropertyAsString'
- getJsonPropertyAsStringWithHttpInfo() : array<string|int, mixed>
- Operation getJsonPropertyAsStringWithHttpInfo
- getUserInfo() : UserInfoDto
- Operation getUserInfo
- getUserInfoAsync() : PromiseInterface
- Operation getUserInfoAsync
- getUserInfoAsyncWithHttpInfo() : PromiseInterface
- Operation getUserInfoAsyncWithHttpInfo
- getUserInfoRequest() : Request
- Create request for operation 'getUserInfo'
- getUserInfoWithHttpInfo() : array<string|int, mixed>
- Operation getUserInfoWithHttpInfo
- getUserStorageInsights() : UserStorageInsightsDto
- Operation getUserStorageInsights
- getUserStorageInsightsAsync() : PromiseInterface
- Operation getUserStorageInsightsAsync
- getUserStorageInsightsAsyncWithHttpInfo() : PromiseInterface
- Operation getUserStorageInsightsAsyncWithHttpInfo
- getUserStorageInsightsRequest() : Request
- Create request for operation 'getUserStorageInsights'
- getUserStorageInsightsWithHttpInfo() : array<string|int, mixed>
- Operation getUserStorageInsightsWithHttpInfo
- listInboxRetentionPolicies() : InboxRetentionPoliciesDto
- Operation listInboxRetentionPolicies
- listInboxRetentionPoliciesAsync() : PromiseInterface
- Operation listInboxRetentionPoliciesAsync
- listInboxRetentionPoliciesAsyncWithHttpInfo() : PromiseInterface
- Operation listInboxRetentionPoliciesAsyncWithHttpInfo
- listInboxRetentionPoliciesRequest() : Request
- Create request for operation 'listInboxRetentionPolicies'
- listInboxRetentionPoliciesWithHttpInfo() : array<string|int, mixed>
- Operation listInboxRetentionPoliciesWithHttpInfo
- setHostIndex() : void
- Set the host index
- updateInboxRetentionPolicy() : InboxRetentionPolicyDto
- Operation updateInboxRetentionPolicy
- updateInboxRetentionPolicyAsync() : PromiseInterface
- Operation updateInboxRetentionPolicyAsync
- updateInboxRetentionPolicyAsyncWithHttpInfo() : PromiseInterface
- Operation updateInboxRetentionPolicyAsyncWithHttpInfo
- updateInboxRetentionPolicyRequest() : Request
- Create request for operation 'updateInboxRetentionPolicy'
- updateInboxRetentionPolicyWithHttpInfo() : array<string|int, mixed>
- Operation updateInboxRetentionPolicyWithHttpInfo
- createHttpClientOption() : array<string|int, mixed>
- Create http client option
Constants
contentTypes
public
array<string|int, string>
contentTypes
= ['createInboxRetentionPolicy' => ['application/json'], 'createInboxRetentionPolicyRun' => ['application/json'], 'createOrUpdateInboxRetentionPolicyForAccount' => ['application/json'], 'deleteInboxRetentionPolicy' => ['application/json'], 'deleteInboxRetentionPolicyForAccount' => ['application/json'], 'getEntityAutomations' => ['application/json'], 'getEntityEvents' => ['application/json'], 'getEntityFavorites' => ['application/json'], 'getInboxRetentionPolicy' => ['application/json'], 'getInboxRetentionPolicyForAccount' => ['application/json'], 'getInboxRetentionPolicyRun' => ['application/json'], 'getInboxRetentionPolicyRuns' => ['application/json'], 'getJsonPropertyAsString' => ['application/json'], 'getUserInfo' => ['application/json'], 'getUserStorageInsights' => ['application/json'], 'listInboxRetentionPolicies' => ['application/json'], 'updateInboxRetentionPolicy' => ['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 —createInboxRetentionPolicy()
Operation createInboxRetentionPolicy
public
createInboxRetentionPolicy(CreateInboxRetentionPolicyOptions $create_inbox_retention_policy_options[, string $contentType = self::contentTypes['createInboxRetentionPolicy'][0] ]) : InboxRetentionPolicyDto
Parameters
- $create_inbox_retention_policy_options : CreateInboxRetentionPolicyOptions
-
create_inbox_retention_policy_options (required)
- $contentType : string = self::contentTypes['createInboxRetentionPolicy'][0]
-
The value for the Content-Type header. Check self::contentTypes['createInboxRetentionPolicy'] to see the possible values for this operation
Tags
Return values
InboxRetentionPolicyDto —createInboxRetentionPolicyAsync()
Operation createInboxRetentionPolicyAsync
public
createInboxRetentionPolicyAsync(CreateInboxRetentionPolicyOptions $create_inbox_retention_policy_options[, string $contentType = self::contentTypes['createInboxRetentionPolicy'][0] ]) : PromiseInterface
Parameters
- $create_inbox_retention_policy_options : CreateInboxRetentionPolicyOptions
-
(required)
- $contentType : string = self::contentTypes['createInboxRetentionPolicy'][0]
-
The value for the Content-Type header. Check self::contentTypes['createInboxRetentionPolicy'] to see the possible values for this operation
Tags
Return values
PromiseInterface —createInboxRetentionPolicyAsyncWithHttpInfo()
Operation createInboxRetentionPolicyAsyncWithHttpInfo
public
createInboxRetentionPolicyAsyncWithHttpInfo(CreateInboxRetentionPolicyOptions $create_inbox_retention_policy_options[, string $contentType = self::contentTypes['createInboxRetentionPolicy'][0] ]) : PromiseInterface
Parameters
- $create_inbox_retention_policy_options : CreateInboxRetentionPolicyOptions
-
(required)
- $contentType : string = self::contentTypes['createInboxRetentionPolicy'][0]
-
The value for the Content-Type header. Check self::contentTypes['createInboxRetentionPolicy'] to see the possible values for this operation
Tags
Return values
PromiseInterface —createInboxRetentionPolicyRequest()
Create request for operation 'createInboxRetentionPolicy'
public
createInboxRetentionPolicyRequest(CreateInboxRetentionPolicyOptions $create_inbox_retention_policy_options[, string $contentType = self::contentTypes['createInboxRetentionPolicy'][0] ]) : Request
Parameters
- $create_inbox_retention_policy_options : CreateInboxRetentionPolicyOptions
-
(required)
- $contentType : string = self::contentTypes['createInboxRetentionPolicy'][0]
-
The value for the Content-Type header. Check self::contentTypes['createInboxRetentionPolicy'] to see the possible values for this operation
Tags
Return values
Request —createInboxRetentionPolicyRun()
Operation createInboxRetentionPolicyRun
public
createInboxRetentionPolicyRun([string $contentType = self::contentTypes['createInboxRetentionPolicyRun'][0] ]) : InboxRetentionPolicyRunDto
Parameters
- $contentType : string = self::contentTypes['createInboxRetentionPolicyRun'][0]
-
The value for the Content-Type header. Check self::contentTypes['createInboxRetentionPolicyRun'] to see the possible values for this operation
Tags
Return values
InboxRetentionPolicyRunDto —createInboxRetentionPolicyRunAsync()
Operation createInboxRetentionPolicyRunAsync
public
createInboxRetentionPolicyRunAsync([string $contentType = self::contentTypes['createInboxRetentionPolicyRun'][0] ]) : PromiseInterface
Parameters
- $contentType : string = self::contentTypes['createInboxRetentionPolicyRun'][0]
-
The value for the Content-Type header. Check self::contentTypes['createInboxRetentionPolicyRun'] to see the possible values for this operation
Tags
Return values
PromiseInterface —createInboxRetentionPolicyRunAsyncWithHttpInfo()
Operation createInboxRetentionPolicyRunAsyncWithHttpInfo
public
createInboxRetentionPolicyRunAsyncWithHttpInfo([string $contentType = self::contentTypes['createInboxRetentionPolicyRun'][0] ]) : PromiseInterface
Parameters
- $contentType : string = self::contentTypes['createInboxRetentionPolicyRun'][0]
-
The value for the Content-Type header. Check self::contentTypes['createInboxRetentionPolicyRun'] to see the possible values for this operation
Tags
Return values
PromiseInterface —createInboxRetentionPolicyRunRequest()
Create request for operation 'createInboxRetentionPolicyRun'
public
createInboxRetentionPolicyRunRequest([string $contentType = self::contentTypes['createInboxRetentionPolicyRun'][0] ]) : Request
Parameters
- $contentType : string = self::contentTypes['createInboxRetentionPolicyRun'][0]
-
The value for the Content-Type header. Check self::contentTypes['createInboxRetentionPolicyRun'] to see the possible values for this operation
Tags
Return values
Request —createInboxRetentionPolicyRunWithHttpInfo()
Operation createInboxRetentionPolicyRunWithHttpInfo
public
createInboxRetentionPolicyRunWithHttpInfo([string $contentType = self::contentTypes['createInboxRetentionPolicyRun'][0] ]) : array<string|int, mixed>
Parameters
- $contentType : string = self::contentTypes['createInboxRetentionPolicyRun'][0]
-
The value for the Content-Type header. Check self::contentTypes['createInboxRetentionPolicyRun'] to see the possible values for this operation
Tags
Return values
array<string|int, mixed> —of \MailSlurp\Models\InboxRetentionPolicyRunDto, HTTP status code, HTTP response headers (array of strings)
createInboxRetentionPolicyWithHttpInfo()
Operation createInboxRetentionPolicyWithHttpInfo
public
createInboxRetentionPolicyWithHttpInfo(CreateInboxRetentionPolicyOptions $create_inbox_retention_policy_options[, string $contentType = self::contentTypes['createInboxRetentionPolicy'][0] ]) : array<string|int, mixed>
Parameters
- $create_inbox_retention_policy_options : CreateInboxRetentionPolicyOptions
-
(required)
- $contentType : string = self::contentTypes['createInboxRetentionPolicy'][0]
-
The value for the Content-Type header. Check self::contentTypes['createInboxRetentionPolicy'] to see the possible values for this operation
Tags
Return values
array<string|int, mixed> —of \MailSlurp\Models\InboxRetentionPolicyDto, HTTP status code, HTTP response headers (array of strings)
createOrUpdateInboxRetentionPolicyForAccount()
Operation createOrUpdateInboxRetentionPolicyForAccount
public
createOrUpdateInboxRetentionPolicyForAccount(CreateInboxRetentionPolicyForAccountOptions $create_inbox_retention_policy_for_account_options[, string $contentType = self::contentTypes['createOrUpdateInboxRetentionPolicyForAccount'][0] ]) : InboxRetentionPolicyDto
Parameters
- $create_inbox_retention_policy_for_account_options : CreateInboxRetentionPolicyForAccountOptions
-
create_inbox_retention_policy_for_account_options (required)
- $contentType : string = self::contentTypes['createOrUpdateInboxRetentionPolicyForAccount'][0]
-
The value for the Content-Type header. Check self::contentTypes['createOrUpdateInboxRetentionPolicyForAccount'] to see the possible values for this operation
Tags
Return values
InboxRetentionPolicyDto —createOrUpdateInboxRetentionPolicyForAccountAsync()
Operation createOrUpdateInboxRetentionPolicyForAccountAsync
public
createOrUpdateInboxRetentionPolicyForAccountAsync(CreateInboxRetentionPolicyForAccountOptions $create_inbox_retention_policy_for_account_options[, string $contentType = self::contentTypes['createOrUpdateInboxRetentionPolicyForAccount'][0] ]) : PromiseInterface
Parameters
- $create_inbox_retention_policy_for_account_options : CreateInboxRetentionPolicyForAccountOptions
-
(required)
- $contentType : string = self::contentTypes['createOrUpdateInboxRetentionPolicyForAccount'][0]
-
The value for the Content-Type header. Check self::contentTypes['createOrUpdateInboxRetentionPolicyForAccount'] to see the possible values for this operation
Tags
Return values
PromiseInterface —createOrUpdateInboxRetentionPolicyForAccountAsyncWithHttpInfo()
Operation createOrUpdateInboxRetentionPolicyForAccountAsyncWithHttpInfo
public
createOrUpdateInboxRetentionPolicyForAccountAsyncWithHttpInfo(CreateInboxRetentionPolicyForAccountOptions $create_inbox_retention_policy_for_account_options[, string $contentType = self::contentTypes['createOrUpdateInboxRetentionPolicyForAccount'][0] ]) : PromiseInterface
Parameters
- $create_inbox_retention_policy_for_account_options : CreateInboxRetentionPolicyForAccountOptions
-
(required)
- $contentType : string = self::contentTypes['createOrUpdateInboxRetentionPolicyForAccount'][0]
-
The value for the Content-Type header. Check self::contentTypes['createOrUpdateInboxRetentionPolicyForAccount'] to see the possible values for this operation
Tags
Return values
PromiseInterface —createOrUpdateInboxRetentionPolicyForAccountRequest()
Create request for operation 'createOrUpdateInboxRetentionPolicyForAccount'
public
createOrUpdateInboxRetentionPolicyForAccountRequest(CreateInboxRetentionPolicyForAccountOptions $create_inbox_retention_policy_for_account_options[, string $contentType = self::contentTypes['createOrUpdateInboxRetentionPolicyForAccount'][0] ]) : Request
Parameters
- $create_inbox_retention_policy_for_account_options : CreateInboxRetentionPolicyForAccountOptions
-
(required)
- $contentType : string = self::contentTypes['createOrUpdateInboxRetentionPolicyForAccount'][0]
-
The value for the Content-Type header. Check self::contentTypes['createOrUpdateInboxRetentionPolicyForAccount'] to see the possible values for this operation
Tags
Return values
Request —createOrUpdateInboxRetentionPolicyForAccountWithHttpInfo()
Operation createOrUpdateInboxRetentionPolicyForAccountWithHttpInfo
public
createOrUpdateInboxRetentionPolicyForAccountWithHttpInfo(CreateInboxRetentionPolicyForAccountOptions $create_inbox_retention_policy_for_account_options[, string $contentType = self::contentTypes['createOrUpdateInboxRetentionPolicyForAccount'][0] ]) : array<string|int, mixed>
Parameters
- $create_inbox_retention_policy_for_account_options : CreateInboxRetentionPolicyForAccountOptions
-
(required)
- $contentType : string = self::contentTypes['createOrUpdateInboxRetentionPolicyForAccount'][0]
-
The value for the Content-Type header. Check self::contentTypes['createOrUpdateInboxRetentionPolicyForAccount'] to see the possible values for this operation
Tags
Return values
array<string|int, mixed> —of \MailSlurp\Models\InboxRetentionPolicyDto, HTTP status code, HTTP response headers (array of strings)
deleteInboxRetentionPolicy()
Operation deleteInboxRetentionPolicy
public
deleteInboxRetentionPolicy(string $policy_id[, string $contentType = self::contentTypes['deleteInboxRetentionPolicy'][0] ]) : EmptyResponseDto
Parameters
- $policy_id : string
-
policy_id (required)
- $contentType : string = self::contentTypes['deleteInboxRetentionPolicy'][0]
-
The value for the Content-Type header. Check self::contentTypes['deleteInboxRetentionPolicy'] to see the possible values for this operation
Tags
Return values
EmptyResponseDto —deleteInboxRetentionPolicyAsync()
Operation deleteInboxRetentionPolicyAsync
public
deleteInboxRetentionPolicyAsync(string $policy_id[, string $contentType = self::contentTypes['deleteInboxRetentionPolicy'][0] ]) : PromiseInterface
Parameters
- $policy_id : string
-
(required)
- $contentType : string = self::contentTypes['deleteInboxRetentionPolicy'][0]
-
The value for the Content-Type header. Check self::contentTypes['deleteInboxRetentionPolicy'] to see the possible values for this operation
Tags
Return values
PromiseInterface —deleteInboxRetentionPolicyAsyncWithHttpInfo()
Operation deleteInboxRetentionPolicyAsyncWithHttpInfo
public
deleteInboxRetentionPolicyAsyncWithHttpInfo(string $policy_id[, string $contentType = self::contentTypes['deleteInboxRetentionPolicy'][0] ]) : PromiseInterface
Parameters
- $policy_id : string
-
(required)
- $contentType : string = self::contentTypes['deleteInboxRetentionPolicy'][0]
-
The value for the Content-Type header. Check self::contentTypes['deleteInboxRetentionPolicy'] to see the possible values for this operation
Tags
Return values
PromiseInterface —deleteInboxRetentionPolicyForAccount()
Operation deleteInboxRetentionPolicyForAccount
public
deleteInboxRetentionPolicyForAccount([string $contentType = self::contentTypes['deleteInboxRetentionPolicyForAccount'][0] ]) : EmptyResponseDto
Parameters
- $contentType : string = self::contentTypes['deleteInboxRetentionPolicyForAccount'][0]
-
The value for the Content-Type header. Check self::contentTypes['deleteInboxRetentionPolicyForAccount'] to see the possible values for this operation
Tags
Return values
EmptyResponseDto —deleteInboxRetentionPolicyForAccountAsync()
Operation deleteInboxRetentionPolicyForAccountAsync
public
deleteInboxRetentionPolicyForAccountAsync([string $contentType = self::contentTypes['deleteInboxRetentionPolicyForAccount'][0] ]) : PromiseInterface
Parameters
- $contentType : string = self::contentTypes['deleteInboxRetentionPolicyForAccount'][0]
-
The value for the Content-Type header. Check self::contentTypes['deleteInboxRetentionPolicyForAccount'] to see the possible values for this operation
Tags
Return values
PromiseInterface —deleteInboxRetentionPolicyForAccountAsyncWithHttpInfo()
Operation deleteInboxRetentionPolicyForAccountAsyncWithHttpInfo
public
deleteInboxRetentionPolicyForAccountAsyncWithHttpInfo([string $contentType = self::contentTypes['deleteInboxRetentionPolicyForAccount'][0] ]) : PromiseInterface
Parameters
- $contentType : string = self::contentTypes['deleteInboxRetentionPolicyForAccount'][0]
-
The value for the Content-Type header. Check self::contentTypes['deleteInboxRetentionPolicyForAccount'] to see the possible values for this operation
Tags
Return values
PromiseInterface —deleteInboxRetentionPolicyForAccountRequest()
Create request for operation 'deleteInboxRetentionPolicyForAccount'
public
deleteInboxRetentionPolicyForAccountRequest([string $contentType = self::contentTypes['deleteInboxRetentionPolicyForAccount'][0] ]) : Request
Parameters
- $contentType : string = self::contentTypes['deleteInboxRetentionPolicyForAccount'][0]
-
The value for the Content-Type header. Check self::contentTypes['deleteInboxRetentionPolicyForAccount'] to see the possible values for this operation
Tags
Return values
Request —deleteInboxRetentionPolicyForAccountWithHttpInfo()
Operation deleteInboxRetentionPolicyForAccountWithHttpInfo
public
deleteInboxRetentionPolicyForAccountWithHttpInfo([string $contentType = self::contentTypes['deleteInboxRetentionPolicyForAccount'][0] ]) : array<string|int, mixed>
Parameters
- $contentType : string = self::contentTypes['deleteInboxRetentionPolicyForAccount'][0]
-
The value for the Content-Type header. Check self::contentTypes['deleteInboxRetentionPolicyForAccount'] to see the possible values for this operation
Tags
Return values
array<string|int, mixed> —of \MailSlurp\Models\EmptyResponseDto, HTTP status code, HTTP response headers (array of strings)
deleteInboxRetentionPolicyRequest()
Create request for operation 'deleteInboxRetentionPolicy'
public
deleteInboxRetentionPolicyRequest(string $policy_id[, string $contentType = self::contentTypes['deleteInboxRetentionPolicy'][0] ]) : Request
Parameters
- $policy_id : string
-
(required)
- $contentType : string = self::contentTypes['deleteInboxRetentionPolicy'][0]
-
The value for the Content-Type header. Check self::contentTypes['deleteInboxRetentionPolicy'] to see the possible values for this operation
Tags
Return values
Request —deleteInboxRetentionPolicyWithHttpInfo()
Operation deleteInboxRetentionPolicyWithHttpInfo
public
deleteInboxRetentionPolicyWithHttpInfo(string $policy_id[, string $contentType = self::contentTypes['deleteInboxRetentionPolicy'][0] ]) : array<string|int, mixed>
Parameters
- $policy_id : string
-
(required)
- $contentType : string = self::contentTypes['deleteInboxRetentionPolicy'][0]
-
The value for the Content-Type header. Check self::contentTypes['deleteInboxRetentionPolicy'] to see the possible values for this operation
Tags
Return values
array<string|int, mixed> —of \MailSlurp\Models\EmptyResponseDto, HTTP status code, HTTP response headers (array of strings)
getConfig()
public
getConfig() : Configuration
Return values
Configuration —getEntityAutomations()
Operation getEntityAutomations
public
getEntityAutomations(int $page[, int $size = 20 ][, string $sort = 'DESC' ][, DateTime $since = null ][, DateTime $before = null ][, string $inbox_id = null ][, string $phone_id = null ][, string $filter = null ][, string $contentType = self::contentTypes['getEntityAutomations'][0] ]) : PageEntityAutomationItems
Parameters
- $page : int
-
Optional page index (optional, default to 0)
- $size : int = 20
-
Optional page size (optional, default to 20)
- $sort : string = 'DESC'
-
Optional createdAt sort direction ASC or DESC (optional, default to 'DESC')
- $since : DateTime = null
-
Filter by created at after the given timestamp (optional)
- $before : DateTime = null
-
Filter by created at before the given timestamp (optional)
- $inbox_id : string = null
-
Optional inbox ID (optional)
- $phone_id : string = null
-
Optional phone ID (optional)
- $filter : string = null
-
Optional automation type filter (optional)
- $contentType : string = self::contentTypes['getEntityAutomations'][0]
-
The value for the Content-Type header. Check self::contentTypes['getEntityAutomations'] to see the possible values for this operation
Tags
Return values
PageEntityAutomationItems —getEntityAutomationsAsync()
Operation getEntityAutomationsAsync
public
getEntityAutomationsAsync(int $page[, int $size = 20 ][, string $sort = 'DESC' ][, DateTime $since = null ][, DateTime $before = null ][, string $inbox_id = null ][, string $phone_id = null ][, string $filter = null ][, string $contentType = self::contentTypes['getEntityAutomations'][0] ]) : PromiseInterface
Parameters
- $page : int
-
Optional page index (optional, default to 0)
- $size : int = 20
-
Optional page size (optional, default to 20)
- $sort : string = 'DESC'
-
Optional createdAt sort direction ASC or DESC (optional, default to 'DESC')
- $since : DateTime = null
-
Filter by created at after the given timestamp (optional)
- $before : DateTime = null
-
Filter by created at before the given timestamp (optional)
- $inbox_id : string = null
-
Optional inbox ID (optional)
- $phone_id : string = null
-
Optional phone ID (optional)
- $filter : string = null
-
Optional automation type filter (optional)
- $contentType : string = self::contentTypes['getEntityAutomations'][0]
-
The value for the Content-Type header. Check self::contentTypes['getEntityAutomations'] to see the possible values for this operation
Tags
Return values
PromiseInterface —getEntityAutomationsAsyncWithHttpInfo()
Operation getEntityAutomationsAsyncWithHttpInfo
public
getEntityAutomationsAsyncWithHttpInfo(int $page[, int $size = 20 ][, string $sort = 'DESC' ][, DateTime $since = null ][, DateTime $before = null ][, string $inbox_id = null ][, string $phone_id = null ][, string $filter = null ][, string $contentType = self::contentTypes['getEntityAutomations'][0] ]) : PromiseInterface
Parameters
- $page : int
-
Optional page index (optional, default to 0)
- $size : int = 20
-
Optional page size (optional, default to 20)
- $sort : string = 'DESC'
-
Optional createdAt sort direction ASC or DESC (optional, default to 'DESC')
- $since : DateTime = null
-
Filter by created at after the given timestamp (optional)
- $before : DateTime = null
-
Filter by created at before the given timestamp (optional)
- $inbox_id : string = null
-
Optional inbox ID (optional)
- $phone_id : string = null
-
Optional phone ID (optional)
- $filter : string = null
-
Optional automation type filter (optional)
- $contentType : string = self::contentTypes['getEntityAutomations'][0]
-
The value for the Content-Type header. Check self::contentTypes['getEntityAutomations'] to see the possible values for this operation
Tags
Return values
PromiseInterface —getEntityAutomationsRequest()
Create request for operation 'getEntityAutomations'
public
getEntityAutomationsRequest(int $page[, int $size = 20 ][, string $sort = 'DESC' ][, DateTime $since = null ][, DateTime $before = null ][, string $inbox_id = null ][, string $phone_id = null ][, string $filter = null ][, string $contentType = self::contentTypes['getEntityAutomations'][0] ]) : Request
Parameters
- $page : int
-
Optional page index (optional, default to 0)
- $size : int = 20
-
Optional page size (optional, default to 20)
- $sort : string = 'DESC'
-
Optional createdAt sort direction ASC or DESC (optional, default to 'DESC')
- $since : DateTime = null
-
Filter by created at after the given timestamp (optional)
- $before : DateTime = null
-
Filter by created at before the given timestamp (optional)
- $inbox_id : string = null
-
Optional inbox ID (optional)
- $phone_id : string = null
-
Optional phone ID (optional)
- $filter : string = null
-
Optional automation type filter (optional)
- $contentType : string = self::contentTypes['getEntityAutomations'][0]
-
The value for the Content-Type header. Check self::contentTypes['getEntityAutomations'] to see the possible values for this operation
Tags
Return values
Request —getEntityAutomationsWithHttpInfo()
Operation getEntityAutomationsWithHttpInfo
public
getEntityAutomationsWithHttpInfo(int $page[, int $size = 20 ][, string $sort = 'DESC' ][, DateTime $since = null ][, DateTime $before = null ][, string $inbox_id = null ][, string $phone_id = null ][, string $filter = null ][, string $contentType = self::contentTypes['getEntityAutomations'][0] ]) : array<string|int, mixed>
Parameters
- $page : int
-
Optional page index (optional, default to 0)
- $size : int = 20
-
Optional page size (optional, default to 20)
- $sort : string = 'DESC'
-
Optional createdAt sort direction ASC or DESC (optional, default to 'DESC')
- $since : DateTime = null
-
Filter by created at after the given timestamp (optional)
- $before : DateTime = null
-
Filter by created at before the given timestamp (optional)
- $inbox_id : string = null
-
Optional inbox ID (optional)
- $phone_id : string = null
-
Optional phone ID (optional)
- $filter : string = null
-
Optional automation type filter (optional)
- $contentType : string = self::contentTypes['getEntityAutomations'][0]
-
The value for the Content-Type header. Check self::contentTypes['getEntityAutomations'] to see the possible values for this operation
Tags
Return values
array<string|int, mixed> —of \MailSlurp\Models\PageEntityAutomationItems, HTTP status code, HTTP response headers (array of strings)
getEntityEvents()
Operation getEntityEvents
public
getEntityEvents(int $page[, int $size = 20 ][, string $sort = 'DESC' ][, DateTime $since = null ][, DateTime $before = null ][, string $inbox_id = null ][, string $email_id = null ][, string $phone_id = null ][, string $sms_id = null ][, string $attachment_id = null ][, string $filter = null ][, string $contentType = self::contentTypes['getEntityEvents'][0] ]) : PageEntityEventItems
Parameters
- $page : int
-
Optional page index (optional, default to 0)
- $size : int = 20
-
Optional page size (optional, default to 20)
- $sort : string = 'DESC'
-
Optional createdAt sort direction ASC or DESC (optional, default to 'DESC')
- $since : DateTime = null
-
Filter by created at after the given timestamp (optional)
- $before : DateTime = null
-
Filter by created at before the given timestamp (optional)
- $inbox_id : string = null
-
Optional inbox ID (optional)
- $email_id : string = null
-
Optional email ID (optional)
- $phone_id : string = null
-
Optional phone ID (optional)
- $sms_id : string = null
-
Optional SMS ID (optional)
- $attachment_id : string = null
-
Optional attachment ID (optional)
- $filter : string = null
-
Optional type filter (optional)
- $contentType : string = self::contentTypes['getEntityEvents'][0]
-
The value for the Content-Type header. Check self::contentTypes['getEntityEvents'] to see the possible values for this operation
Tags
Return values
PageEntityEventItems —getEntityEventsAsync()
Operation getEntityEventsAsync
public
getEntityEventsAsync(int $page[, int $size = 20 ][, string $sort = 'DESC' ][, DateTime $since = null ][, DateTime $before = null ][, string $inbox_id = null ][, string $email_id = null ][, string $phone_id = null ][, string $sms_id = null ][, string $attachment_id = null ][, string $filter = null ][, string $contentType = self::contentTypes['getEntityEvents'][0] ]) : PromiseInterface
Parameters
- $page : int
-
Optional page index (optional, default to 0)
- $size : int = 20
-
Optional page size (optional, default to 20)
- $sort : string = 'DESC'
-
Optional createdAt sort direction ASC or DESC (optional, default to 'DESC')
- $since : DateTime = null
-
Filter by created at after the given timestamp (optional)
- $before : DateTime = null
-
Filter by created at before the given timestamp (optional)
- $inbox_id : string = null
-
Optional inbox ID (optional)
- $email_id : string = null
-
Optional email ID (optional)
- $phone_id : string = null
-
Optional phone ID (optional)
- $sms_id : string = null
-
Optional SMS ID (optional)
- $attachment_id : string = null
-
Optional attachment ID (optional)
- $filter : string = null
-
Optional type filter (optional)
- $contentType : string = self::contentTypes['getEntityEvents'][0]
-
The value for the Content-Type header. Check self::contentTypes['getEntityEvents'] to see the possible values for this operation
Tags
Return values
PromiseInterface —getEntityEventsAsyncWithHttpInfo()
Operation getEntityEventsAsyncWithHttpInfo
public
getEntityEventsAsyncWithHttpInfo(int $page[, int $size = 20 ][, string $sort = 'DESC' ][, DateTime $since = null ][, DateTime $before = null ][, string $inbox_id = null ][, string $email_id = null ][, string $phone_id = null ][, string $sms_id = null ][, string $attachment_id = null ][, string $filter = null ][, string $contentType = self::contentTypes['getEntityEvents'][0] ]) : PromiseInterface
Parameters
- $page : int
-
Optional page index (optional, default to 0)
- $size : int = 20
-
Optional page size (optional, default to 20)
- $sort : string = 'DESC'
-
Optional createdAt sort direction ASC or DESC (optional, default to 'DESC')
- $since : DateTime = null
-
Filter by created at after the given timestamp (optional)
- $before : DateTime = null
-
Filter by created at before the given timestamp (optional)
- $inbox_id : string = null
-
Optional inbox ID (optional)
- $email_id : string = null
-
Optional email ID (optional)
- $phone_id : string = null
-
Optional phone ID (optional)
- $sms_id : string = null
-
Optional SMS ID (optional)
- $attachment_id : string = null
-
Optional attachment ID (optional)
- $filter : string = null
-
Optional type filter (optional)
- $contentType : string = self::contentTypes['getEntityEvents'][0]
-
The value for the Content-Type header. Check self::contentTypes['getEntityEvents'] to see the possible values for this operation
Tags
Return values
PromiseInterface —getEntityEventsRequest()
Create request for operation 'getEntityEvents'
public
getEntityEventsRequest(int $page[, int $size = 20 ][, string $sort = 'DESC' ][, DateTime $since = null ][, DateTime $before = null ][, string $inbox_id = null ][, string $email_id = null ][, string $phone_id = null ][, string $sms_id = null ][, string $attachment_id = null ][, string $filter = null ][, string $contentType = self::contentTypes['getEntityEvents'][0] ]) : Request
Parameters
- $page : int
-
Optional page index (optional, default to 0)
- $size : int = 20
-
Optional page size (optional, default to 20)
- $sort : string = 'DESC'
-
Optional createdAt sort direction ASC or DESC (optional, default to 'DESC')
- $since : DateTime = null
-
Filter by created at after the given timestamp (optional)
- $before : DateTime = null
-
Filter by created at before the given timestamp (optional)
- $inbox_id : string = null
-
Optional inbox ID (optional)
- $email_id : string = null
-
Optional email ID (optional)
- $phone_id : string = null
-
Optional phone ID (optional)
- $sms_id : string = null
-
Optional SMS ID (optional)
- $attachment_id : string = null
-
Optional attachment ID (optional)
- $filter : string = null
-
Optional type filter (optional)
- $contentType : string = self::contentTypes['getEntityEvents'][0]
-
The value for the Content-Type header. Check self::contentTypes['getEntityEvents'] to see the possible values for this operation
Tags
Return values
Request —getEntityEventsWithHttpInfo()
Operation getEntityEventsWithHttpInfo
public
getEntityEventsWithHttpInfo(int $page[, int $size = 20 ][, string $sort = 'DESC' ][, DateTime $since = null ][, DateTime $before = null ][, string $inbox_id = null ][, string $email_id = null ][, string $phone_id = null ][, string $sms_id = null ][, string $attachment_id = null ][, string $filter = null ][, string $contentType = self::contentTypes['getEntityEvents'][0] ]) : array<string|int, mixed>
Parameters
- $page : int
-
Optional page index (optional, default to 0)
- $size : int = 20
-
Optional page size (optional, default to 20)
- $sort : string = 'DESC'
-
Optional createdAt sort direction ASC or DESC (optional, default to 'DESC')
- $since : DateTime = null
-
Filter by created at after the given timestamp (optional)
- $before : DateTime = null
-
Filter by created at before the given timestamp (optional)
- $inbox_id : string = null
-
Optional inbox ID (optional)
- $email_id : string = null
-
Optional email ID (optional)
- $phone_id : string = null
-
Optional phone ID (optional)
- $sms_id : string = null
-
Optional SMS ID (optional)
- $attachment_id : string = null
-
Optional attachment ID (optional)
- $filter : string = null
-
Optional type filter (optional)
- $contentType : string = self::contentTypes['getEntityEvents'][0]
-
The value for the Content-Type header. Check self::contentTypes['getEntityEvents'] to see the possible values for this operation
Tags
Return values
array<string|int, mixed> —of \MailSlurp\Models\PageEntityEventItems, HTTP status code, HTTP response headers (array of strings)
getEntityFavorites()
Operation getEntityFavorites
public
getEntityFavorites(int $page[, int $size = 20 ][, string $sort = 'DESC' ][, DateTime $since = null ][, DateTime $before = null ][, string $filter = null ][, string $contentType = self::contentTypes['getEntityFavorites'][0] ]) : PageEntityFavouriteItems
Parameters
- $page : int
-
Optional page index (optional, default to 0)
- $size : int = 20
-
Optional page size (optional, default to 20)
- $sort : string = 'DESC'
-
Optional createdAt sort direction ASC or DESC (optional, default to 'DESC')
- $since : DateTime = null
-
Filter by created at after the given timestamp (optional)
- $before : DateTime = null
-
Filter by created at before the given timestamp (optional)
- $filter : string = null
-
Optional type filter (optional)
- $contentType : string = self::contentTypes['getEntityFavorites'][0]
-
The value for the Content-Type header. Check self::contentTypes['getEntityFavorites'] to see the possible values for this operation
Tags
Return values
PageEntityFavouriteItems —getEntityFavoritesAsync()
Operation getEntityFavoritesAsync
public
getEntityFavoritesAsync(int $page[, int $size = 20 ][, string $sort = 'DESC' ][, DateTime $since = null ][, DateTime $before = null ][, string $filter = null ][, string $contentType = self::contentTypes['getEntityFavorites'][0] ]) : PromiseInterface
Parameters
- $page : int
-
Optional page index (optional, default to 0)
- $size : int = 20
-
Optional page size (optional, default to 20)
- $sort : string = 'DESC'
-
Optional createdAt sort direction ASC or DESC (optional, default to 'DESC')
- $since : DateTime = null
-
Filter by created at after the given timestamp (optional)
- $before : DateTime = null
-
Filter by created at before the given timestamp (optional)
- $filter : string = null
-
Optional type filter (optional)
- $contentType : string = self::contentTypes['getEntityFavorites'][0]
-
The value for the Content-Type header. Check self::contentTypes['getEntityFavorites'] to see the possible values for this operation
Tags
Return values
PromiseInterface —getEntityFavoritesAsyncWithHttpInfo()
Operation getEntityFavoritesAsyncWithHttpInfo
public
getEntityFavoritesAsyncWithHttpInfo(int $page[, int $size = 20 ][, string $sort = 'DESC' ][, DateTime $since = null ][, DateTime $before = null ][, string $filter = null ][, string $contentType = self::contentTypes['getEntityFavorites'][0] ]) : PromiseInterface
Parameters
- $page : int
-
Optional page index (optional, default to 0)
- $size : int = 20
-
Optional page size (optional, default to 20)
- $sort : string = 'DESC'
-
Optional createdAt sort direction ASC or DESC (optional, default to 'DESC')
- $since : DateTime = null
-
Filter by created at after the given timestamp (optional)
- $before : DateTime = null
-
Filter by created at before the given timestamp (optional)
- $filter : string = null
-
Optional type filter (optional)
- $contentType : string = self::contentTypes['getEntityFavorites'][0]
-
The value for the Content-Type header. Check self::contentTypes['getEntityFavorites'] to see the possible values for this operation
Tags
Return values
PromiseInterface —getEntityFavoritesRequest()
Create request for operation 'getEntityFavorites'
public
getEntityFavoritesRequest(int $page[, int $size = 20 ][, string $sort = 'DESC' ][, DateTime $since = null ][, DateTime $before = null ][, string $filter = null ][, string $contentType = self::contentTypes['getEntityFavorites'][0] ]) : Request
Parameters
- $page : int
-
Optional page index (optional, default to 0)
- $size : int = 20
-
Optional page size (optional, default to 20)
- $sort : string = 'DESC'
-
Optional createdAt sort direction ASC or DESC (optional, default to 'DESC')
- $since : DateTime = null
-
Filter by created at after the given timestamp (optional)
- $before : DateTime = null
-
Filter by created at before the given timestamp (optional)
- $filter : string = null
-
Optional type filter (optional)
- $contentType : string = self::contentTypes['getEntityFavorites'][0]
-
The value for the Content-Type header. Check self::contentTypes['getEntityFavorites'] to see the possible values for this operation
Tags
Return values
Request —getEntityFavoritesWithHttpInfo()
Operation getEntityFavoritesWithHttpInfo
public
getEntityFavoritesWithHttpInfo(int $page[, int $size = 20 ][, string $sort = 'DESC' ][, DateTime $since = null ][, DateTime $before = null ][, string $filter = null ][, string $contentType = self::contentTypes['getEntityFavorites'][0] ]) : array<string|int, mixed>
Parameters
- $page : int
-
Optional page index (optional, default to 0)
- $size : int = 20
-
Optional page size (optional, default to 20)
- $sort : string = 'DESC'
-
Optional createdAt sort direction ASC or DESC (optional, default to 'DESC')
- $since : DateTime = null
-
Filter by created at after the given timestamp (optional)
- $before : DateTime = null
-
Filter by created at before the given timestamp (optional)
- $filter : string = null
-
Optional type filter (optional)
- $contentType : string = self::contentTypes['getEntityFavorites'][0]
-
The value for the Content-Type header. Check self::contentTypes['getEntityFavorites'] to see the possible values for this operation
Tags
Return values
array<string|int, mixed> —of \MailSlurp\Models\PageEntityFavouriteItems, HTTP status code, HTTP response headers (array of strings)
getHostIndex()
Get the host index
public
getHostIndex() : int
Return values
int —Host index
getInboxRetentionPolicy()
Operation getInboxRetentionPolicy
public
getInboxRetentionPolicy(string $policy_id[, string $contentType = self::contentTypes['getInboxRetentionPolicy'][0] ]) : InboxRetentionPolicyDto
Parameters
- $policy_id : string
-
policy_id (required)
- $contentType : string = self::contentTypes['getInboxRetentionPolicy'][0]
-
The value for the Content-Type header. Check self::contentTypes['getInboxRetentionPolicy'] to see the possible values for this operation
Tags
Return values
InboxRetentionPolicyDto —getInboxRetentionPolicyAsync()
Operation getInboxRetentionPolicyAsync
public
getInboxRetentionPolicyAsync(string $policy_id[, string $contentType = self::contentTypes['getInboxRetentionPolicy'][0] ]) : PromiseInterface
Parameters
- $policy_id : string
-
(required)
- $contentType : string = self::contentTypes['getInboxRetentionPolicy'][0]
-
The value for the Content-Type header. Check self::contentTypes['getInboxRetentionPolicy'] to see the possible values for this operation
Tags
Return values
PromiseInterface —getInboxRetentionPolicyAsyncWithHttpInfo()
Operation getInboxRetentionPolicyAsyncWithHttpInfo
public
getInboxRetentionPolicyAsyncWithHttpInfo(string $policy_id[, string $contentType = self::contentTypes['getInboxRetentionPolicy'][0] ]) : PromiseInterface
Parameters
- $policy_id : string
-
(required)
- $contentType : string = self::contentTypes['getInboxRetentionPolicy'][0]
-
The value for the Content-Type header. Check self::contentTypes['getInboxRetentionPolicy'] to see the possible values for this operation
Tags
Return values
PromiseInterface —getInboxRetentionPolicyForAccount()
Operation getInboxRetentionPolicyForAccount
public
getInboxRetentionPolicyForAccount([string $contentType = self::contentTypes['getInboxRetentionPolicyForAccount'][0] ]) : InboxRetentionPolicyOptionalDto
Parameters
- $contentType : string = self::contentTypes['getInboxRetentionPolicyForAccount'][0]
-
The value for the Content-Type header. Check self::contentTypes['getInboxRetentionPolicyForAccount'] to see the possible values for this operation
Tags
Return values
InboxRetentionPolicyOptionalDto —getInboxRetentionPolicyForAccountAsync()
Operation getInboxRetentionPolicyForAccountAsync
public
getInboxRetentionPolicyForAccountAsync([string $contentType = self::contentTypes['getInboxRetentionPolicyForAccount'][0] ]) : PromiseInterface
Parameters
- $contentType : string = self::contentTypes['getInboxRetentionPolicyForAccount'][0]
-
The value for the Content-Type header. Check self::contentTypes['getInboxRetentionPolicyForAccount'] to see the possible values for this operation
Tags
Return values
PromiseInterface —getInboxRetentionPolicyForAccountAsyncWithHttpInfo()
Operation getInboxRetentionPolicyForAccountAsyncWithHttpInfo
public
getInboxRetentionPolicyForAccountAsyncWithHttpInfo([string $contentType = self::contentTypes['getInboxRetentionPolicyForAccount'][0] ]) : PromiseInterface
Parameters
- $contentType : string = self::contentTypes['getInboxRetentionPolicyForAccount'][0]
-
The value for the Content-Type header. Check self::contentTypes['getInboxRetentionPolicyForAccount'] to see the possible values for this operation
Tags
Return values
PromiseInterface —getInboxRetentionPolicyForAccountRequest()
Create request for operation 'getInboxRetentionPolicyForAccount'
public
getInboxRetentionPolicyForAccountRequest([string $contentType = self::contentTypes['getInboxRetentionPolicyForAccount'][0] ]) : Request
Parameters
- $contentType : string = self::contentTypes['getInboxRetentionPolicyForAccount'][0]
-
The value for the Content-Type header. Check self::contentTypes['getInboxRetentionPolicyForAccount'] to see the possible values for this operation
Tags
Return values
Request —getInboxRetentionPolicyForAccountWithHttpInfo()
Operation getInboxRetentionPolicyForAccountWithHttpInfo
public
getInboxRetentionPolicyForAccountWithHttpInfo([string $contentType = self::contentTypes['getInboxRetentionPolicyForAccount'][0] ]) : array<string|int, mixed>
Parameters
- $contentType : string = self::contentTypes['getInboxRetentionPolicyForAccount'][0]
-
The value for the Content-Type header. Check self::contentTypes['getInboxRetentionPolicyForAccount'] to see the possible values for this operation
Tags
Return values
array<string|int, mixed> —of \MailSlurp\Models\InboxRetentionPolicyOptionalDto, HTTP status code, HTTP response headers (array of strings)
getInboxRetentionPolicyRequest()
Create request for operation 'getInboxRetentionPolicy'
public
getInboxRetentionPolicyRequest(string $policy_id[, string $contentType = self::contentTypes['getInboxRetentionPolicy'][0] ]) : Request
Parameters
- $policy_id : string
-
(required)
- $contentType : string = self::contentTypes['getInboxRetentionPolicy'][0]
-
The value for the Content-Type header. Check self::contentTypes['getInboxRetentionPolicy'] to see the possible values for this operation
Tags
Return values
Request —getInboxRetentionPolicyRun()
Operation getInboxRetentionPolicyRun
public
getInboxRetentionPolicyRun(string $run_id[, string $contentType = self::contentTypes['getInboxRetentionPolicyRun'][0] ]) : InboxRetentionPolicyRunDto
Parameters
- $run_id : string
-
run_id (required)
- $contentType : string = self::contentTypes['getInboxRetentionPolicyRun'][0]
-
The value for the Content-Type header. Check self::contentTypes['getInboxRetentionPolicyRun'] to see the possible values for this operation
Tags
Return values
InboxRetentionPolicyRunDto —getInboxRetentionPolicyRunAsync()
Operation getInboxRetentionPolicyRunAsync
public
getInboxRetentionPolicyRunAsync(string $run_id[, string $contentType = self::contentTypes['getInboxRetentionPolicyRun'][0] ]) : PromiseInterface
Parameters
- $run_id : string
-
(required)
- $contentType : string = self::contentTypes['getInboxRetentionPolicyRun'][0]
-
The value for the Content-Type header. Check self::contentTypes['getInboxRetentionPolicyRun'] to see the possible values for this operation
Tags
Return values
PromiseInterface —getInboxRetentionPolicyRunAsyncWithHttpInfo()
Operation getInboxRetentionPolicyRunAsyncWithHttpInfo
public
getInboxRetentionPolicyRunAsyncWithHttpInfo(string $run_id[, string $contentType = self::contentTypes['getInboxRetentionPolicyRun'][0] ]) : PromiseInterface
Parameters
- $run_id : string
-
(required)
- $contentType : string = self::contentTypes['getInboxRetentionPolicyRun'][0]
-
The value for the Content-Type header. Check self::contentTypes['getInboxRetentionPolicyRun'] to see the possible values for this operation
Tags
Return values
PromiseInterface —getInboxRetentionPolicyRunRequest()
Create request for operation 'getInboxRetentionPolicyRun'
public
getInboxRetentionPolicyRunRequest(string $run_id[, string $contentType = self::contentTypes['getInboxRetentionPolicyRun'][0] ]) : Request
Parameters
- $run_id : string
-
(required)
- $contentType : string = self::contentTypes['getInboxRetentionPolicyRun'][0]
-
The value for the Content-Type header. Check self::contentTypes['getInboxRetentionPolicyRun'] to see the possible values for this operation
Tags
Return values
Request —getInboxRetentionPolicyRuns()
Operation getInboxRetentionPolicyRuns
public
getInboxRetentionPolicyRuns(int $page[, int $size = 20 ][, string $sort = 'DESC' ][, string $contentType = self::contentTypes['getInboxRetentionPolicyRuns'][0] ]) : PageInboxRetentionPolicyRunProjection
Parameters
- $page : int
-
Optional page index (optional, default to 0)
- $size : int = 20
-
Optional page size (optional, default to 20)
- $sort : string = 'DESC'
-
Optional createdAt sort direction ASC or DESC (optional, default to 'DESC')
- $contentType : string = self::contentTypes['getInboxRetentionPolicyRuns'][0]
-
The value for the Content-Type header. Check self::contentTypes['getInboxRetentionPolicyRuns'] to see the possible values for this operation
Tags
Return values
PageInboxRetentionPolicyRunProjection —getInboxRetentionPolicyRunsAsync()
Operation getInboxRetentionPolicyRunsAsync
public
getInboxRetentionPolicyRunsAsync(int $page[, int $size = 20 ][, string $sort = 'DESC' ][, string $contentType = self::contentTypes['getInboxRetentionPolicyRuns'][0] ]) : PromiseInterface
Parameters
- $page : int
-
Optional page index (optional, default to 0)
- $size : int = 20
-
Optional page size (optional, default to 20)
- $sort : string = 'DESC'
-
Optional createdAt sort direction ASC or DESC (optional, default to 'DESC')
- $contentType : string = self::contentTypes['getInboxRetentionPolicyRuns'][0]
-
The value for the Content-Type header. Check self::contentTypes['getInboxRetentionPolicyRuns'] to see the possible values for this operation
Tags
Return values
PromiseInterface —getInboxRetentionPolicyRunsAsyncWithHttpInfo()
Operation getInboxRetentionPolicyRunsAsyncWithHttpInfo
public
getInboxRetentionPolicyRunsAsyncWithHttpInfo(int $page[, int $size = 20 ][, string $sort = 'DESC' ][, string $contentType = self::contentTypes['getInboxRetentionPolicyRuns'][0] ]) : PromiseInterface
Parameters
- $page : int
-
Optional page index (optional, default to 0)
- $size : int = 20
-
Optional page size (optional, default to 20)
- $sort : string = 'DESC'
-
Optional createdAt sort direction ASC or DESC (optional, default to 'DESC')
- $contentType : string = self::contentTypes['getInboxRetentionPolicyRuns'][0]
-
The value for the Content-Type header. Check self::contentTypes['getInboxRetentionPolicyRuns'] to see the possible values for this operation
Tags
Return values
PromiseInterface —getInboxRetentionPolicyRunsRequest()
Create request for operation 'getInboxRetentionPolicyRuns'
public
getInboxRetentionPolicyRunsRequest(int $page[, int $size = 20 ][, string $sort = 'DESC' ][, string $contentType = self::contentTypes['getInboxRetentionPolicyRuns'][0] ]) : Request
Parameters
- $page : int
-
Optional page index (optional, default to 0)
- $size : int = 20
-
Optional page size (optional, default to 20)
- $sort : string = 'DESC'
-
Optional createdAt sort direction ASC or DESC (optional, default to 'DESC')
- $contentType : string = self::contentTypes['getInboxRetentionPolicyRuns'][0]
-
The value for the Content-Type header. Check self::contentTypes['getInboxRetentionPolicyRuns'] to see the possible values for this operation
Tags
Return values
Request —getInboxRetentionPolicyRunsWithHttpInfo()
Operation getInboxRetentionPolicyRunsWithHttpInfo
public
getInboxRetentionPolicyRunsWithHttpInfo(int $page[, int $size = 20 ][, string $sort = 'DESC' ][, string $contentType = self::contentTypes['getInboxRetentionPolicyRuns'][0] ]) : array<string|int, mixed>
Parameters
- $page : int
-
Optional page index (optional, default to 0)
- $size : int = 20
-
Optional page size (optional, default to 20)
- $sort : string = 'DESC'
-
Optional createdAt sort direction ASC or DESC (optional, default to 'DESC')
- $contentType : string = self::contentTypes['getInboxRetentionPolicyRuns'][0]
-
The value for the Content-Type header. Check self::contentTypes['getInboxRetentionPolicyRuns'] to see the possible values for this operation
Tags
Return values
array<string|int, mixed> —of \MailSlurp\Models\PageInboxRetentionPolicyRunProjection, HTTP status code, HTTP response headers (array of strings)
getInboxRetentionPolicyRunWithHttpInfo()
Operation getInboxRetentionPolicyRunWithHttpInfo
public
getInboxRetentionPolicyRunWithHttpInfo(string $run_id[, string $contentType = self::contentTypes['getInboxRetentionPolicyRun'][0] ]) : array<string|int, mixed>
Parameters
- $run_id : string
-
(required)
- $contentType : string = self::contentTypes['getInboxRetentionPolicyRun'][0]
-
The value for the Content-Type header. Check self::contentTypes['getInboxRetentionPolicyRun'] to see the possible values for this operation
Tags
Return values
array<string|int, mixed> —of \MailSlurp\Models\InboxRetentionPolicyRunDto, HTTP status code, HTTP response headers (array of strings)
getInboxRetentionPolicyWithHttpInfo()
Operation getInboxRetentionPolicyWithHttpInfo
public
getInboxRetentionPolicyWithHttpInfo(string $policy_id[, string $contentType = self::contentTypes['getInboxRetentionPolicy'][0] ]) : array<string|int, mixed>
Parameters
- $policy_id : string
-
(required)
- $contentType : string = self::contentTypes['getInboxRetentionPolicy'][0]
-
The value for the Content-Type header. Check self::contentTypes['getInboxRetentionPolicy'] to see the possible values for this operation
Tags
Return values
array<string|int, mixed> —of \MailSlurp\Models\InboxRetentionPolicyDto, HTTP status code, HTTP response headers (array of strings)
getJsonPropertyAsString()
Operation getJsonPropertyAsString
public
getJsonPropertyAsString(string $property, JsonNode $json_node[, string $contentType = self::contentTypes['getJsonPropertyAsString'][0] ]) : string
Parameters
- $property : string
-
JSON property name or dot separated path selector such as `a.b.c` (required)
- $json_node : JsonNode
-
json_node (required)
- $contentType : string = self::contentTypes['getJsonPropertyAsString'][0]
-
The value for the Content-Type header. Check self::contentTypes['getJsonPropertyAsString'] to see the possible values for this operation
Tags
Return values
string —getJsonPropertyAsStringAsync()
Operation getJsonPropertyAsStringAsync
public
getJsonPropertyAsStringAsync(string $property, JsonNode $json_node[, string $contentType = self::contentTypes['getJsonPropertyAsString'][0] ]) : PromiseInterface
Parameters
- $property : string
-
JSON property name or dot separated path selector such as `a.b.c` (required)
- $json_node : JsonNode
-
(required)
- $contentType : string = self::contentTypes['getJsonPropertyAsString'][0]
-
The value for the Content-Type header. Check self::contentTypes['getJsonPropertyAsString'] to see the possible values for this operation
Tags
Return values
PromiseInterface —getJsonPropertyAsStringAsyncWithHttpInfo()
Operation getJsonPropertyAsStringAsyncWithHttpInfo
public
getJsonPropertyAsStringAsyncWithHttpInfo(string $property, JsonNode $json_node[, string $contentType = self::contentTypes['getJsonPropertyAsString'][0] ]) : PromiseInterface
Parameters
- $property : string
-
JSON property name or dot separated path selector such as `a.b.c` (required)
- $json_node : JsonNode
-
(required)
- $contentType : string = self::contentTypes['getJsonPropertyAsString'][0]
-
The value for the Content-Type header. Check self::contentTypes['getJsonPropertyAsString'] to see the possible values for this operation
Tags
Return values
PromiseInterface —getJsonPropertyAsStringRequest()
Create request for operation 'getJsonPropertyAsString'
public
getJsonPropertyAsStringRequest(string $property, JsonNode $json_node[, string $contentType = self::contentTypes['getJsonPropertyAsString'][0] ]) : Request
Parameters
- $property : string
-
JSON property name or dot separated path selector such as `a.b.c` (required)
- $json_node : JsonNode
-
(required)
- $contentType : string = self::contentTypes['getJsonPropertyAsString'][0]
-
The value for the Content-Type header. Check self::contentTypes['getJsonPropertyAsString'] to see the possible values for this operation
Tags
Return values
Request —getJsonPropertyAsStringWithHttpInfo()
Operation getJsonPropertyAsStringWithHttpInfo
public
getJsonPropertyAsStringWithHttpInfo(string $property, JsonNode $json_node[, string $contentType = self::contentTypes['getJsonPropertyAsString'][0] ]) : array<string|int, mixed>
Parameters
- $property : string
-
JSON property name or dot separated path selector such as `a.b.c` (required)
- $json_node : JsonNode
-
(required)
- $contentType : string = self::contentTypes['getJsonPropertyAsString'][0]
-
The value for the Content-Type header. Check self::contentTypes['getJsonPropertyAsString'] to see the possible values for this operation
Tags
Return values
array<string|int, mixed> —of string, HTTP status code, HTTP response headers (array of strings)
getUserInfo()
Operation getUserInfo
public
getUserInfo([string $contentType = self::contentTypes['getUserInfo'][0] ]) : UserInfoDto
Parameters
- $contentType : string = self::contentTypes['getUserInfo'][0]
-
The value for the Content-Type header. Check self::contentTypes['getUserInfo'] to see the possible values for this operation
Tags
Return values
UserInfoDto —getUserInfoAsync()
Operation getUserInfoAsync
public
getUserInfoAsync([string $contentType = self::contentTypes['getUserInfo'][0] ]) : PromiseInterface
Parameters
- $contentType : string = self::contentTypes['getUserInfo'][0]
-
The value for the Content-Type header. Check self::contentTypes['getUserInfo'] to see the possible values for this operation
Tags
Return values
PromiseInterface —getUserInfoAsyncWithHttpInfo()
Operation getUserInfoAsyncWithHttpInfo
public
getUserInfoAsyncWithHttpInfo([string $contentType = self::contentTypes['getUserInfo'][0] ]) : PromiseInterface
Parameters
- $contentType : string = self::contentTypes['getUserInfo'][0]
-
The value for the Content-Type header. Check self::contentTypes['getUserInfo'] to see the possible values for this operation
Tags
Return values
PromiseInterface —getUserInfoRequest()
Create request for operation 'getUserInfo'
public
getUserInfoRequest([string $contentType = self::contentTypes['getUserInfo'][0] ]) : Request
Parameters
- $contentType : string = self::contentTypes['getUserInfo'][0]
-
The value for the Content-Type header. Check self::contentTypes['getUserInfo'] to see the possible values for this operation
Tags
Return values
Request —getUserInfoWithHttpInfo()
Operation getUserInfoWithHttpInfo
public
getUserInfoWithHttpInfo([string $contentType = self::contentTypes['getUserInfo'][0] ]) : array<string|int, mixed>
Parameters
- $contentType : string = self::contentTypes['getUserInfo'][0]
-
The value for the Content-Type header. Check self::contentTypes['getUserInfo'] to see the possible values for this operation
Tags
Return values
array<string|int, mixed> —of \MailSlurp\Models\UserInfoDto, HTTP status code, HTTP response headers (array of strings)
getUserStorageInsights()
Operation getUserStorageInsights
public
getUserStorageInsights([int $limit = 10 ][, string $contentType = self::contentTypes['getUserStorageInsights'][0] ]) : UserStorageInsightsDto
Parameters
- $limit : int = 10
-
Maximum number of inboxes and domains to return (optional, default to 10)
- $contentType : string = self::contentTypes['getUserStorageInsights'][0]
-
The value for the Content-Type header. Check self::contentTypes['getUserStorageInsights'] to see the possible values for this operation
Tags
Return values
UserStorageInsightsDto —getUserStorageInsightsAsync()
Operation getUserStorageInsightsAsync
public
getUserStorageInsightsAsync([int $limit = 10 ][, string $contentType = self::contentTypes['getUserStorageInsights'][0] ]) : PromiseInterface
Parameters
- $limit : int = 10
-
Maximum number of inboxes and domains to return (optional, default to 10)
- $contentType : string = self::contentTypes['getUserStorageInsights'][0]
-
The value for the Content-Type header. Check self::contentTypes['getUserStorageInsights'] to see the possible values for this operation
Tags
Return values
PromiseInterface —getUserStorageInsightsAsyncWithHttpInfo()
Operation getUserStorageInsightsAsyncWithHttpInfo
public
getUserStorageInsightsAsyncWithHttpInfo([int $limit = 10 ][, string $contentType = self::contentTypes['getUserStorageInsights'][0] ]) : PromiseInterface
Parameters
- $limit : int = 10
-
Maximum number of inboxes and domains to return (optional, default to 10)
- $contentType : string = self::contentTypes['getUserStorageInsights'][0]
-
The value for the Content-Type header. Check self::contentTypes['getUserStorageInsights'] to see the possible values for this operation
Tags
Return values
PromiseInterface —getUserStorageInsightsRequest()
Create request for operation 'getUserStorageInsights'
public
getUserStorageInsightsRequest([int $limit = 10 ][, string $contentType = self::contentTypes['getUserStorageInsights'][0] ]) : Request
Parameters
- $limit : int = 10
-
Maximum number of inboxes and domains to return (optional, default to 10)
- $contentType : string = self::contentTypes['getUserStorageInsights'][0]
-
The value for the Content-Type header. Check self::contentTypes['getUserStorageInsights'] to see the possible values for this operation
Tags
Return values
Request —getUserStorageInsightsWithHttpInfo()
Operation getUserStorageInsightsWithHttpInfo
public
getUserStorageInsightsWithHttpInfo([int $limit = 10 ][, string $contentType = self::contentTypes['getUserStorageInsights'][0] ]) : array<string|int, mixed>
Parameters
- $limit : int = 10
-
Maximum number of inboxes and domains to return (optional, default to 10)
- $contentType : string = self::contentTypes['getUserStorageInsights'][0]
-
The value for the Content-Type header. Check self::contentTypes['getUserStorageInsights'] to see the possible values for this operation
Tags
Return values
array<string|int, mixed> —of \MailSlurp\Models\UserStorageInsightsDto, HTTP status code, HTTP response headers (array of strings)
listInboxRetentionPolicies()
Operation listInboxRetentionPolicies
public
listInboxRetentionPolicies([string $contentType = self::contentTypes['listInboxRetentionPolicies'][0] ]) : InboxRetentionPoliciesDto
Parameters
- $contentType : string = self::contentTypes['listInboxRetentionPolicies'][0]
-
The value for the Content-Type header. Check self::contentTypes['listInboxRetentionPolicies'] to see the possible values for this operation
Tags
Return values
InboxRetentionPoliciesDto —listInboxRetentionPoliciesAsync()
Operation listInboxRetentionPoliciesAsync
public
listInboxRetentionPoliciesAsync([string $contentType = self::contentTypes['listInboxRetentionPolicies'][0] ]) : PromiseInterface
Parameters
- $contentType : string = self::contentTypes['listInboxRetentionPolicies'][0]
-
The value for the Content-Type header. Check self::contentTypes['listInboxRetentionPolicies'] to see the possible values for this operation
Tags
Return values
PromiseInterface —listInboxRetentionPoliciesAsyncWithHttpInfo()
Operation listInboxRetentionPoliciesAsyncWithHttpInfo
public
listInboxRetentionPoliciesAsyncWithHttpInfo([string $contentType = self::contentTypes['listInboxRetentionPolicies'][0] ]) : PromiseInterface
Parameters
- $contentType : string = self::contentTypes['listInboxRetentionPolicies'][0]
-
The value for the Content-Type header. Check self::contentTypes['listInboxRetentionPolicies'] to see the possible values for this operation
Tags
Return values
PromiseInterface —listInboxRetentionPoliciesRequest()
Create request for operation 'listInboxRetentionPolicies'
public
listInboxRetentionPoliciesRequest([string $contentType = self::contentTypes['listInboxRetentionPolicies'][0] ]) : Request
Parameters
- $contentType : string = self::contentTypes['listInboxRetentionPolicies'][0]
-
The value for the Content-Type header. Check self::contentTypes['listInboxRetentionPolicies'] to see the possible values for this operation
Tags
Return values
Request —listInboxRetentionPoliciesWithHttpInfo()
Operation listInboxRetentionPoliciesWithHttpInfo
public
listInboxRetentionPoliciesWithHttpInfo([string $contentType = self::contentTypes['listInboxRetentionPolicies'][0] ]) : array<string|int, mixed>
Parameters
- $contentType : string = self::contentTypes['listInboxRetentionPolicies'][0]
-
The value for the Content-Type header. Check self::contentTypes['listInboxRetentionPolicies'] to see the possible values for this operation
Tags
Return values
array<string|int, mixed> —of \MailSlurp\Models\InboxRetentionPoliciesDto, 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 —updateInboxRetentionPolicy()
Operation updateInboxRetentionPolicy
public
updateInboxRetentionPolicy(string $policy_id, UpdateInboxRetentionPolicyOptions $update_inbox_retention_policy_options[, string $contentType = self::contentTypes['updateInboxRetentionPolicy'][0] ]) : InboxRetentionPolicyDto
Parameters
- $policy_id : string
-
policy_id (required)
- $update_inbox_retention_policy_options : UpdateInboxRetentionPolicyOptions
-
update_inbox_retention_policy_options (required)
- $contentType : string = self::contentTypes['updateInboxRetentionPolicy'][0]
-
The value for the Content-Type header. Check self::contentTypes['updateInboxRetentionPolicy'] to see the possible values for this operation
Tags
Return values
InboxRetentionPolicyDto —updateInboxRetentionPolicyAsync()
Operation updateInboxRetentionPolicyAsync
public
updateInboxRetentionPolicyAsync(string $policy_id, UpdateInboxRetentionPolicyOptions $update_inbox_retention_policy_options[, string $contentType = self::contentTypes['updateInboxRetentionPolicy'][0] ]) : PromiseInterface
Parameters
- $policy_id : string
-
(required)
- $update_inbox_retention_policy_options : UpdateInboxRetentionPolicyOptions
-
(required)
- $contentType : string = self::contentTypes['updateInboxRetentionPolicy'][0]
-
The value for the Content-Type header. Check self::contentTypes['updateInboxRetentionPolicy'] to see the possible values for this operation
Tags
Return values
PromiseInterface —updateInboxRetentionPolicyAsyncWithHttpInfo()
Operation updateInboxRetentionPolicyAsyncWithHttpInfo
public
updateInboxRetentionPolicyAsyncWithHttpInfo(string $policy_id, UpdateInboxRetentionPolicyOptions $update_inbox_retention_policy_options[, string $contentType = self::contentTypes['updateInboxRetentionPolicy'][0] ]) : PromiseInterface
Parameters
- $policy_id : string
-
(required)
- $update_inbox_retention_policy_options : UpdateInboxRetentionPolicyOptions
-
(required)
- $contentType : string = self::contentTypes['updateInboxRetentionPolicy'][0]
-
The value for the Content-Type header. Check self::contentTypes['updateInboxRetentionPolicy'] to see the possible values for this operation
Tags
Return values
PromiseInterface —updateInboxRetentionPolicyRequest()
Create request for operation 'updateInboxRetentionPolicy'
public
updateInboxRetentionPolicyRequest(string $policy_id, UpdateInboxRetentionPolicyOptions $update_inbox_retention_policy_options[, string $contentType = self::contentTypes['updateInboxRetentionPolicy'][0] ]) : Request
Parameters
- $policy_id : string
-
(required)
- $update_inbox_retention_policy_options : UpdateInboxRetentionPolicyOptions
-
(required)
- $contentType : string = self::contentTypes['updateInboxRetentionPolicy'][0]
-
The value for the Content-Type header. Check self::contentTypes['updateInboxRetentionPolicy'] to see the possible values for this operation
Tags
Return values
Request —updateInboxRetentionPolicyWithHttpInfo()
Operation updateInboxRetentionPolicyWithHttpInfo
public
updateInboxRetentionPolicyWithHttpInfo(string $policy_id, UpdateInboxRetentionPolicyOptions $update_inbox_retention_policy_options[, string $contentType = self::contentTypes['updateInboxRetentionPolicy'][0] ]) : array<string|int, mixed>
Parameters
- $policy_id : string
-
(required)
- $update_inbox_retention_policy_options : UpdateInboxRetentionPolicyOptions
-
(required)
- $contentType : string = self::contentTypes['updateInboxRetentionPolicy'][0]
-
The value for the Content-Type header. Check self::contentTypes['updateInboxRetentionPolicy'] to see the possible values for this operation
Tags
Return values
array<string|int, mixed> —of \MailSlurp\Models\InboxRetentionPolicyDto, 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