DomainControllerApi
in package
DomainControllerApi Class Doc Comment
Tags
Table of Contents
- contentTypes = ['addDomainWildcardCatchAll' => ['application/json'], 'createDomain' => ['application/json'], 'deleteDomain' => ['application/json'], 'getAvailableDomains' => ['application/json'], 'getDomain' => ['application/json'], 'getDomainIssues' => ['application/json'], 'getDomainWildcardCatchAllInbox' => ['application/json'], 'getDomains' => ['application/json'], 'getMailSlurpDomains' => ['application/json'], 'updateDomain' => ['application/json']]
- $client : ClientInterface
- $config : Configuration
- $headerSelector : HeaderSelector
- $hostIndex : int
- __construct() : mixed
- addDomainWildcardCatchAll() : DomainDto
- Operation addDomainWildcardCatchAll
- addDomainWildcardCatchAllAsync() : PromiseInterface
- Operation addDomainWildcardCatchAllAsync
- addDomainWildcardCatchAllAsyncWithHttpInfo() : PromiseInterface
- Operation addDomainWildcardCatchAllAsyncWithHttpInfo
- addDomainWildcardCatchAllRequest() : Request
- Create request for operation 'addDomainWildcardCatchAll'
- addDomainWildcardCatchAllWithHttpInfo() : array<string|int, mixed>
- Operation addDomainWildcardCatchAllWithHttpInfo
- createDomain() : DomainDto
- Operation createDomain
- createDomainAsync() : PromiseInterface
- Operation createDomainAsync
- createDomainAsyncWithHttpInfo() : PromiseInterface
- Operation createDomainAsyncWithHttpInfo
- createDomainRequest() : Request
- Create request for operation 'createDomain'
- createDomainWithHttpInfo() : array<string|int, mixed>
- Operation createDomainWithHttpInfo
- deleteDomain() : array<string|int, string>
- Operation deleteDomain
- deleteDomainAsync() : PromiseInterface
- Operation deleteDomainAsync
- deleteDomainAsyncWithHttpInfo() : PromiseInterface
- Operation deleteDomainAsyncWithHttpInfo
- deleteDomainRequest() : Request
- Create request for operation 'deleteDomain'
- deleteDomainWithHttpInfo() : array<string|int, mixed>
- Operation deleteDomainWithHttpInfo
- getAvailableDomains() : DomainGroupsDto
- Operation getAvailableDomains
- getAvailableDomainsAsync() : PromiseInterface
- Operation getAvailableDomainsAsync
- getAvailableDomainsAsyncWithHttpInfo() : PromiseInterface
- Operation getAvailableDomainsAsyncWithHttpInfo
- getAvailableDomainsRequest() : Request
- Create request for operation 'getAvailableDomains'
- getAvailableDomainsWithHttpInfo() : array<string|int, mixed>
- Operation getAvailableDomainsWithHttpInfo
- getConfig() : Configuration
- getDomain() : DomainDto
- Operation getDomain
- getDomainAsync() : PromiseInterface
- Operation getDomainAsync
- getDomainAsyncWithHttpInfo() : PromiseInterface
- Operation getDomainAsyncWithHttpInfo
- getDomainIssues() : DomainIssuesDto
- Operation getDomainIssues
- getDomainIssuesAsync() : PromiseInterface
- Operation getDomainIssuesAsync
- getDomainIssuesAsyncWithHttpInfo() : PromiseInterface
- Operation getDomainIssuesAsyncWithHttpInfo
- getDomainIssuesRequest() : Request
- Create request for operation 'getDomainIssues'
- getDomainIssuesWithHttpInfo() : array<string|int, mixed>
- Operation getDomainIssuesWithHttpInfo
- getDomainRequest() : Request
- Create request for operation 'getDomain'
- getDomains() : array<string|int, DomainPreview>
- Operation getDomains
- getDomainsAsync() : PromiseInterface
- Operation getDomainsAsync
- getDomainsAsyncWithHttpInfo() : PromiseInterface
- Operation getDomainsAsyncWithHttpInfo
- getDomainsRequest() : Request
- Create request for operation 'getDomains'
- getDomainsWithHttpInfo() : array<string|int, mixed>
- Operation getDomainsWithHttpInfo
- getDomainWildcardCatchAllInbox() : InboxDto
- Operation getDomainWildcardCatchAllInbox
- getDomainWildcardCatchAllInboxAsync() : PromiseInterface
- Operation getDomainWildcardCatchAllInboxAsync
- getDomainWildcardCatchAllInboxAsyncWithHttpInfo() : PromiseInterface
- Operation getDomainWildcardCatchAllInboxAsyncWithHttpInfo
- getDomainWildcardCatchAllInboxRequest() : Request
- Create request for operation 'getDomainWildcardCatchAllInbox'
- getDomainWildcardCatchAllInboxWithHttpInfo() : array<string|int, mixed>
- Operation getDomainWildcardCatchAllInboxWithHttpInfo
- getDomainWithHttpInfo() : array<string|int, mixed>
- Operation getDomainWithHttpInfo
- getHostIndex() : int
- Get the host index
- getMailSlurpDomains() : DomainGroupsDto
- Operation getMailSlurpDomains
- getMailSlurpDomainsAsync() : PromiseInterface
- Operation getMailSlurpDomainsAsync
- getMailSlurpDomainsAsyncWithHttpInfo() : PromiseInterface
- Operation getMailSlurpDomainsAsyncWithHttpInfo
- getMailSlurpDomainsRequest() : Request
- Create request for operation 'getMailSlurpDomains'
- getMailSlurpDomainsWithHttpInfo() : array<string|int, mixed>
- Operation getMailSlurpDomainsWithHttpInfo
- setHostIndex() : void
- Set the host index
- updateDomain() : DomainDto
- Operation updateDomain
- updateDomainAsync() : PromiseInterface
- Operation updateDomainAsync
- updateDomainAsyncWithHttpInfo() : PromiseInterface
- Operation updateDomainAsyncWithHttpInfo
- updateDomainRequest() : Request
- Create request for operation 'updateDomain'
- updateDomainWithHttpInfo() : array<string|int, mixed>
- Operation updateDomainWithHttpInfo
- createHttpClientOption() : array<string|int, mixed>
- Create http client option
Constants
contentTypes
public
array<string|int, string>
contentTypes
= ['addDomainWildcardCatchAll' => ['application/json'], 'createDomain' => ['application/json'], 'deleteDomain' => ['application/json'], 'getAvailableDomains' => ['application/json'], 'getDomain' => ['application/json'], 'getDomainIssues' => ['application/json'], 'getDomainWildcardCatchAllInbox' => ['application/json'], 'getDomains' => ['application/json'], 'getMailSlurpDomains' => ['application/json'], 'updateDomain' => ['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 —addDomainWildcardCatchAll()
Operation addDomainWildcardCatchAll
public
addDomainWildcardCatchAll(string $id[, string $contentType = self::contentTypes['addDomainWildcardCatchAll'][0] ]) : DomainDto
Add catch all wild card inbox to domain
Parameters
- $id : string
-
id (required)
- $contentType : string = self::contentTypes['addDomainWildcardCatchAll'][0]
-
The value for the Content-Type header. Check self::contentTypes['addDomainWildcardCatchAll'] to see the possible values for this operation
Tags
Return values
DomainDto —addDomainWildcardCatchAllAsync()
Operation addDomainWildcardCatchAllAsync
public
addDomainWildcardCatchAllAsync(string $id[, string $contentType = self::contentTypes['addDomainWildcardCatchAll'][0] ]) : PromiseInterface
Add catch all wild card inbox to domain
Parameters
- $id : string
-
(required)
- $contentType : string = self::contentTypes['addDomainWildcardCatchAll'][0]
-
The value for the Content-Type header. Check self::contentTypes['addDomainWildcardCatchAll'] to see the possible values for this operation
Tags
Return values
PromiseInterface —addDomainWildcardCatchAllAsyncWithHttpInfo()
Operation addDomainWildcardCatchAllAsyncWithHttpInfo
public
addDomainWildcardCatchAllAsyncWithHttpInfo(string $id[, string $contentType = self::contentTypes['addDomainWildcardCatchAll'][0] ]) : PromiseInterface
Add catch all wild card inbox to domain
Parameters
- $id : string
-
(required)
- $contentType : string = self::contentTypes['addDomainWildcardCatchAll'][0]
-
The value for the Content-Type header. Check self::contentTypes['addDomainWildcardCatchAll'] to see the possible values for this operation
Tags
Return values
PromiseInterface —addDomainWildcardCatchAllRequest()
Create request for operation 'addDomainWildcardCatchAll'
public
addDomainWildcardCatchAllRequest(string $id[, string $contentType = self::contentTypes['addDomainWildcardCatchAll'][0] ]) : Request
Parameters
- $id : string
-
(required)
- $contentType : string = self::contentTypes['addDomainWildcardCatchAll'][0]
-
The value for the Content-Type header. Check self::contentTypes['addDomainWildcardCatchAll'] to see the possible values for this operation
Tags
Return values
Request —addDomainWildcardCatchAllWithHttpInfo()
Operation addDomainWildcardCatchAllWithHttpInfo
public
addDomainWildcardCatchAllWithHttpInfo(string $id[, string $contentType = self::contentTypes['addDomainWildcardCatchAll'][0] ]) : array<string|int, mixed>
Add catch all wild card inbox to domain
Parameters
- $id : string
-
(required)
- $contentType : string = self::contentTypes['addDomainWildcardCatchAll'][0]
-
The value for the Content-Type header. Check self::contentTypes['addDomainWildcardCatchAll'] to see the possible values for this operation
Tags
Return values
array<string|int, mixed> —of \MailSlurp\Models\DomainDto, HTTP status code, HTTP response headers (array of strings)
createDomain()
Operation createDomain
public
createDomain(CreateDomainOptions $create_domain_options[, string $contentType = self::contentTypes['createDomain'][0] ]) : DomainDto
Create Domain
Parameters
- $create_domain_options : CreateDomainOptions
-
create_domain_options (required)
- $contentType : string = self::contentTypes['createDomain'][0]
-
The value for the Content-Type header. Check self::contentTypes['createDomain'] to see the possible values for this operation
Tags
Return values
DomainDto —createDomainAsync()
Operation createDomainAsync
public
createDomainAsync(CreateDomainOptions $create_domain_options[, string $contentType = self::contentTypes['createDomain'][0] ]) : PromiseInterface
Create Domain
Parameters
- $create_domain_options : CreateDomainOptions
-
(required)
- $contentType : string = self::contentTypes['createDomain'][0]
-
The value for the Content-Type header. Check self::contentTypes['createDomain'] to see the possible values for this operation
Tags
Return values
PromiseInterface —createDomainAsyncWithHttpInfo()
Operation createDomainAsyncWithHttpInfo
public
createDomainAsyncWithHttpInfo(CreateDomainOptions $create_domain_options[, string $contentType = self::contentTypes['createDomain'][0] ]) : PromiseInterface
Create Domain
Parameters
- $create_domain_options : CreateDomainOptions
-
(required)
- $contentType : string = self::contentTypes['createDomain'][0]
-
The value for the Content-Type header. Check self::contentTypes['createDomain'] to see the possible values for this operation
Tags
Return values
PromiseInterface —createDomainRequest()
Create request for operation 'createDomain'
public
createDomainRequest(CreateDomainOptions $create_domain_options[, string $contentType = self::contentTypes['createDomain'][0] ]) : Request
Parameters
- $create_domain_options : CreateDomainOptions
-
(required)
- $contentType : string = self::contentTypes['createDomain'][0]
-
The value for the Content-Type header. Check self::contentTypes['createDomain'] to see the possible values for this operation
Tags
Return values
Request —createDomainWithHttpInfo()
Operation createDomainWithHttpInfo
public
createDomainWithHttpInfo(CreateDomainOptions $create_domain_options[, string $contentType = self::contentTypes['createDomain'][0] ]) : array<string|int, mixed>
Create Domain
Parameters
- $create_domain_options : CreateDomainOptions
-
(required)
- $contentType : string = self::contentTypes['createDomain'][0]
-
The value for the Content-Type header. Check self::contentTypes['createDomain'] to see the possible values for this operation
Tags
Return values
array<string|int, mixed> —of \MailSlurp\Models\DomainDto, HTTP status code, HTTP response headers (array of strings)
deleteDomain()
Operation deleteDomain
public
deleteDomain(string $id[, string $contentType = self::contentTypes['deleteDomain'][0] ]) : array<string|int, string>
Delete a domain
Parameters
- $id : string
-
id (required)
- $contentType : string = self::contentTypes['deleteDomain'][0]
-
The value for the Content-Type header. Check self::contentTypes['deleteDomain'] to see the possible values for this operation
Tags
Return values
array<string|int, string> —deleteDomainAsync()
Operation deleteDomainAsync
public
deleteDomainAsync(string $id[, string $contentType = self::contentTypes['deleteDomain'][0] ]) : PromiseInterface
Delete a domain
Parameters
- $id : string
-
(required)
- $contentType : string = self::contentTypes['deleteDomain'][0]
-
The value for the Content-Type header. Check self::contentTypes['deleteDomain'] to see the possible values for this operation
Tags
Return values
PromiseInterface —deleteDomainAsyncWithHttpInfo()
Operation deleteDomainAsyncWithHttpInfo
public
deleteDomainAsyncWithHttpInfo(string $id[, string $contentType = self::contentTypes['deleteDomain'][0] ]) : PromiseInterface
Delete a domain
Parameters
- $id : string
-
(required)
- $contentType : string = self::contentTypes['deleteDomain'][0]
-
The value for the Content-Type header. Check self::contentTypes['deleteDomain'] to see the possible values for this operation
Tags
Return values
PromiseInterface —deleteDomainRequest()
Create request for operation 'deleteDomain'
public
deleteDomainRequest(string $id[, string $contentType = self::contentTypes['deleteDomain'][0] ]) : Request
Parameters
- $id : string
-
(required)
- $contentType : string = self::contentTypes['deleteDomain'][0]
-
The value for the Content-Type header. Check self::contentTypes['deleteDomain'] to see the possible values for this operation
Tags
Return values
Request —deleteDomainWithHttpInfo()
Operation deleteDomainWithHttpInfo
public
deleteDomainWithHttpInfo(string $id[, string $contentType = self::contentTypes['deleteDomain'][0] ]) : array<string|int, mixed>
Delete a domain
Parameters
- $id : string
-
(required)
- $contentType : string = self::contentTypes['deleteDomain'][0]
-
The value for the Content-Type header. Check self::contentTypes['deleteDomain'] 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)
getAvailableDomains()
Operation getAvailableDomains
public
getAvailableDomains([string $inbox_type = null ][, string $contentType = self::contentTypes['getAvailableDomains'][0] ]) : DomainGroupsDto
Get all usable domains
Parameters
- $inbox_type : string = null
-
inbox_type (optional)
- $contentType : string = self::contentTypes['getAvailableDomains'][0]
-
The value for the Content-Type header. Check self::contentTypes['getAvailableDomains'] to see the possible values for this operation
Tags
Return values
DomainGroupsDto —getAvailableDomainsAsync()
Operation getAvailableDomainsAsync
public
getAvailableDomainsAsync([string $inbox_type = null ][, string $contentType = self::contentTypes['getAvailableDomains'][0] ]) : PromiseInterface
Get all usable domains
Parameters
- $inbox_type : string = null
-
(optional)
- $contentType : string = self::contentTypes['getAvailableDomains'][0]
-
The value for the Content-Type header. Check self::contentTypes['getAvailableDomains'] to see the possible values for this operation
Tags
Return values
PromiseInterface —getAvailableDomainsAsyncWithHttpInfo()
Operation getAvailableDomainsAsyncWithHttpInfo
public
getAvailableDomainsAsyncWithHttpInfo([string $inbox_type = null ][, string $contentType = self::contentTypes['getAvailableDomains'][0] ]) : PromiseInterface
Get all usable domains
Parameters
- $inbox_type : string = null
-
(optional)
- $contentType : string = self::contentTypes['getAvailableDomains'][0]
-
The value for the Content-Type header. Check self::contentTypes['getAvailableDomains'] to see the possible values for this operation
Tags
Return values
PromiseInterface —getAvailableDomainsRequest()
Create request for operation 'getAvailableDomains'
public
getAvailableDomainsRequest([string $inbox_type = null ][, string $contentType = self::contentTypes['getAvailableDomains'][0] ]) : Request
Parameters
- $inbox_type : string = null
-
(optional)
- $contentType : string = self::contentTypes['getAvailableDomains'][0]
-
The value for the Content-Type header. Check self::contentTypes['getAvailableDomains'] to see the possible values for this operation
Tags
Return values
Request —getAvailableDomainsWithHttpInfo()
Operation getAvailableDomainsWithHttpInfo
public
getAvailableDomainsWithHttpInfo([string $inbox_type = null ][, string $contentType = self::contentTypes['getAvailableDomains'][0] ]) : array<string|int, mixed>
Get all usable domains
Parameters
- $inbox_type : string = null
-
(optional)
- $contentType : string = self::contentTypes['getAvailableDomains'][0]
-
The value for the Content-Type header. Check self::contentTypes['getAvailableDomains'] to see the possible values for this operation
Tags
Return values
array<string|int, mixed> —of \MailSlurp\Models\DomainGroupsDto, HTTP status code, HTTP response headers (array of strings)
getConfig()
public
getConfig() : Configuration
Return values
Configuration —getDomain()
Operation getDomain
public
getDomain(string $id[, bool $check_for_errors = null ][, string $contentType = self::contentTypes['getDomain'][0] ]) : DomainDto
Get a domain
Parameters
- $id : string
-
id (required)
- $check_for_errors : bool = null
-
check_for_errors (optional)
- $contentType : string = self::contentTypes['getDomain'][0]
-
The value for the Content-Type header. Check self::contentTypes['getDomain'] to see the possible values for this operation
Tags
Return values
DomainDto —getDomainAsync()
Operation getDomainAsync
public
getDomainAsync(string $id[, bool $check_for_errors = null ][, string $contentType = self::contentTypes['getDomain'][0] ]) : PromiseInterface
Get a domain
Parameters
- $id : string
-
(required)
- $check_for_errors : bool = null
-
(optional)
- $contentType : string = self::contentTypes['getDomain'][0]
-
The value for the Content-Type header. Check self::contentTypes['getDomain'] to see the possible values for this operation
Tags
Return values
PromiseInterface —getDomainAsyncWithHttpInfo()
Operation getDomainAsyncWithHttpInfo
public
getDomainAsyncWithHttpInfo(string $id[, bool $check_for_errors = null ][, string $contentType = self::contentTypes['getDomain'][0] ]) : PromiseInterface
Get a domain
Parameters
- $id : string
-
(required)
- $check_for_errors : bool = null
-
(optional)
- $contentType : string = self::contentTypes['getDomain'][0]
-
The value for the Content-Type header. Check self::contentTypes['getDomain'] to see the possible values for this operation
Tags
Return values
PromiseInterface —getDomainIssues()
Operation getDomainIssues
public
getDomainIssues([string $contentType = self::contentTypes['getDomainIssues'][0] ]) : DomainIssuesDto
Get domain issues
Parameters
- $contentType : string = self::contentTypes['getDomainIssues'][0]
-
The value for the Content-Type header. Check self::contentTypes['getDomainIssues'] to see the possible values for this operation
Tags
Return values
DomainIssuesDto —getDomainIssuesAsync()
Operation getDomainIssuesAsync
public
getDomainIssuesAsync([string $contentType = self::contentTypes['getDomainIssues'][0] ]) : PromiseInterface
Get domain issues
Parameters
- $contentType : string = self::contentTypes['getDomainIssues'][0]
-
The value for the Content-Type header. Check self::contentTypes['getDomainIssues'] to see the possible values for this operation
Tags
Return values
PromiseInterface —getDomainIssuesAsyncWithHttpInfo()
Operation getDomainIssuesAsyncWithHttpInfo
public
getDomainIssuesAsyncWithHttpInfo([string $contentType = self::contentTypes['getDomainIssues'][0] ]) : PromiseInterface
Get domain issues
Parameters
- $contentType : string = self::contentTypes['getDomainIssues'][0]
-
The value for the Content-Type header. Check self::contentTypes['getDomainIssues'] to see the possible values for this operation
Tags
Return values
PromiseInterface —getDomainIssuesRequest()
Create request for operation 'getDomainIssues'
public
getDomainIssuesRequest([string $contentType = self::contentTypes['getDomainIssues'][0] ]) : Request
Parameters
- $contentType : string = self::contentTypes['getDomainIssues'][0]
-
The value for the Content-Type header. Check self::contentTypes['getDomainIssues'] to see the possible values for this operation
Tags
Return values
Request —getDomainIssuesWithHttpInfo()
Operation getDomainIssuesWithHttpInfo
public
getDomainIssuesWithHttpInfo([string $contentType = self::contentTypes['getDomainIssues'][0] ]) : array<string|int, mixed>
Get domain issues
Parameters
- $contentType : string = self::contentTypes['getDomainIssues'][0]
-
The value for the Content-Type header. Check self::contentTypes['getDomainIssues'] to see the possible values for this operation
Tags
Return values
array<string|int, mixed> —of \MailSlurp\Models\DomainIssuesDto, HTTP status code, HTTP response headers (array of strings)
getDomainRequest()
Create request for operation 'getDomain'
public
getDomainRequest(string $id[, bool $check_for_errors = null ][, string $contentType = self::contentTypes['getDomain'][0] ]) : Request
Parameters
- $id : string
-
(required)
- $check_for_errors : bool = null
-
(optional)
- $contentType : string = self::contentTypes['getDomain'][0]
-
The value for the Content-Type header. Check self::contentTypes['getDomain'] to see the possible values for this operation
Tags
Return values
Request —getDomains()
Operation getDomains
public
getDomains([string $contentType = self::contentTypes['getDomains'][0] ]) : array<string|int, DomainPreview>
Get domains
Parameters
- $contentType : string = self::contentTypes['getDomains'][0]
-
The value for the Content-Type header. Check self::contentTypes['getDomains'] to see the possible values for this operation
Tags
Return values
array<string|int, DomainPreview> —getDomainsAsync()
Operation getDomainsAsync
public
getDomainsAsync([string $contentType = self::contentTypes['getDomains'][0] ]) : PromiseInterface
Get domains
Parameters
- $contentType : string = self::contentTypes['getDomains'][0]
-
The value for the Content-Type header. Check self::contentTypes['getDomains'] to see the possible values for this operation
Tags
Return values
PromiseInterface —getDomainsAsyncWithHttpInfo()
Operation getDomainsAsyncWithHttpInfo
public
getDomainsAsyncWithHttpInfo([string $contentType = self::contentTypes['getDomains'][0] ]) : PromiseInterface
Get domains
Parameters
- $contentType : string = self::contentTypes['getDomains'][0]
-
The value for the Content-Type header. Check self::contentTypes['getDomains'] to see the possible values for this operation
Tags
Return values
PromiseInterface —getDomainsRequest()
Create request for operation 'getDomains'
public
getDomainsRequest([string $contentType = self::contentTypes['getDomains'][0] ]) : Request
Parameters
- $contentType : string = self::contentTypes['getDomains'][0]
-
The value for the Content-Type header. Check self::contentTypes['getDomains'] to see the possible values for this operation
Tags
Return values
Request —getDomainsWithHttpInfo()
Operation getDomainsWithHttpInfo
public
getDomainsWithHttpInfo([string $contentType = self::contentTypes['getDomains'][0] ]) : array<string|int, mixed>
Get domains
Parameters
- $contentType : string = self::contentTypes['getDomains'][0]
-
The value for the Content-Type header. Check self::contentTypes['getDomains'] to see the possible values for this operation
Tags
Return values
array<string|int, mixed> —of \MailSlurp\Models\DomainPreview[], HTTP status code, HTTP response headers (array of strings)
getDomainWildcardCatchAllInbox()
Operation getDomainWildcardCatchAllInbox
public
getDomainWildcardCatchAllInbox(string $id[, string $contentType = self::contentTypes['getDomainWildcardCatchAllInbox'][0] ]) : InboxDto
Get catch all wild card inbox for domain
Parameters
- $id : string
-
id (required)
- $contentType : string = self::contentTypes['getDomainWildcardCatchAllInbox'][0]
-
The value for the Content-Type header. Check self::contentTypes['getDomainWildcardCatchAllInbox'] to see the possible values for this operation
Tags
Return values
InboxDto —getDomainWildcardCatchAllInboxAsync()
Operation getDomainWildcardCatchAllInboxAsync
public
getDomainWildcardCatchAllInboxAsync(string $id[, string $contentType = self::contentTypes['getDomainWildcardCatchAllInbox'][0] ]) : PromiseInterface
Get catch all wild card inbox for domain
Parameters
- $id : string
-
(required)
- $contentType : string = self::contentTypes['getDomainWildcardCatchAllInbox'][0]
-
The value for the Content-Type header. Check self::contentTypes['getDomainWildcardCatchAllInbox'] to see the possible values for this operation
Tags
Return values
PromiseInterface —getDomainWildcardCatchAllInboxAsyncWithHttpInfo()
Operation getDomainWildcardCatchAllInboxAsyncWithHttpInfo
public
getDomainWildcardCatchAllInboxAsyncWithHttpInfo(string $id[, string $contentType = self::contentTypes['getDomainWildcardCatchAllInbox'][0] ]) : PromiseInterface
Get catch all wild card inbox for domain
Parameters
- $id : string
-
(required)
- $contentType : string = self::contentTypes['getDomainWildcardCatchAllInbox'][0]
-
The value for the Content-Type header. Check self::contentTypes['getDomainWildcardCatchAllInbox'] to see the possible values for this operation
Tags
Return values
PromiseInterface —getDomainWildcardCatchAllInboxRequest()
Create request for operation 'getDomainWildcardCatchAllInbox'
public
getDomainWildcardCatchAllInboxRequest(string $id[, string $contentType = self::contentTypes['getDomainWildcardCatchAllInbox'][0] ]) : Request
Parameters
- $id : string
-
(required)
- $contentType : string = self::contentTypes['getDomainWildcardCatchAllInbox'][0]
-
The value for the Content-Type header. Check self::contentTypes['getDomainWildcardCatchAllInbox'] to see the possible values for this operation
Tags
Return values
Request —getDomainWildcardCatchAllInboxWithHttpInfo()
Operation getDomainWildcardCatchAllInboxWithHttpInfo
public
getDomainWildcardCatchAllInboxWithHttpInfo(string $id[, string $contentType = self::contentTypes['getDomainWildcardCatchAllInbox'][0] ]) : array<string|int, mixed>
Get catch all wild card inbox for domain
Parameters
- $id : string
-
(required)
- $contentType : string = self::contentTypes['getDomainWildcardCatchAllInbox'][0]
-
The value for the Content-Type header. Check self::contentTypes['getDomainWildcardCatchAllInbox'] to see the possible values for this operation
Tags
Return values
array<string|int, mixed> —of \MailSlurp\Models\InboxDto, HTTP status code, HTTP response headers (array of strings)
getDomainWithHttpInfo()
Operation getDomainWithHttpInfo
public
getDomainWithHttpInfo(string $id[, bool $check_for_errors = null ][, string $contentType = self::contentTypes['getDomain'][0] ]) : array<string|int, mixed>
Get a domain
Parameters
- $id : string
-
(required)
- $check_for_errors : bool = null
-
(optional)
- $contentType : string = self::contentTypes['getDomain'][0]
-
The value for the Content-Type header. Check self::contentTypes['getDomain'] to see the possible values for this operation
Tags
Return values
array<string|int, mixed> —of \MailSlurp\Models\DomainDto, HTTP status code, HTTP response headers (array of strings)
getHostIndex()
Get the host index
public
getHostIndex() : int
Return values
int —Host index
getMailSlurpDomains()
Operation getMailSlurpDomains
public
getMailSlurpDomains([string $inbox_type = null ][, string $contentType = self::contentTypes['getMailSlurpDomains'][0] ]) : DomainGroupsDto
Get MailSlurp domains
Parameters
- $inbox_type : string = null
-
inbox_type (optional)
- $contentType : string = self::contentTypes['getMailSlurpDomains'][0]
-
The value for the Content-Type header. Check self::contentTypes['getMailSlurpDomains'] to see the possible values for this operation
Tags
Return values
DomainGroupsDto —getMailSlurpDomainsAsync()
Operation getMailSlurpDomainsAsync
public
getMailSlurpDomainsAsync([string $inbox_type = null ][, string $contentType = self::contentTypes['getMailSlurpDomains'][0] ]) : PromiseInterface
Get MailSlurp domains
Parameters
- $inbox_type : string = null
-
(optional)
- $contentType : string = self::contentTypes['getMailSlurpDomains'][0]
-
The value for the Content-Type header. Check self::contentTypes['getMailSlurpDomains'] to see the possible values for this operation
Tags
Return values
PromiseInterface —getMailSlurpDomainsAsyncWithHttpInfo()
Operation getMailSlurpDomainsAsyncWithHttpInfo
public
getMailSlurpDomainsAsyncWithHttpInfo([string $inbox_type = null ][, string $contentType = self::contentTypes['getMailSlurpDomains'][0] ]) : PromiseInterface
Get MailSlurp domains
Parameters
- $inbox_type : string = null
-
(optional)
- $contentType : string = self::contentTypes['getMailSlurpDomains'][0]
-
The value for the Content-Type header. Check self::contentTypes['getMailSlurpDomains'] to see the possible values for this operation
Tags
Return values
PromiseInterface —getMailSlurpDomainsRequest()
Create request for operation 'getMailSlurpDomains'
public
getMailSlurpDomainsRequest([string $inbox_type = null ][, string $contentType = self::contentTypes['getMailSlurpDomains'][0] ]) : Request
Parameters
- $inbox_type : string = null
-
(optional)
- $contentType : string = self::contentTypes['getMailSlurpDomains'][0]
-
The value for the Content-Type header. Check self::contentTypes['getMailSlurpDomains'] to see the possible values for this operation
Tags
Return values
Request —getMailSlurpDomainsWithHttpInfo()
Operation getMailSlurpDomainsWithHttpInfo
public
getMailSlurpDomainsWithHttpInfo([string $inbox_type = null ][, string $contentType = self::contentTypes['getMailSlurpDomains'][0] ]) : array<string|int, mixed>
Get MailSlurp domains
Parameters
- $inbox_type : string = null
-
(optional)
- $contentType : string = self::contentTypes['getMailSlurpDomains'][0]
-
The value for the Content-Type header. Check self::contentTypes['getMailSlurpDomains'] to see the possible values for this operation
Tags
Return values
array<string|int, mixed> —of \MailSlurp\Models\DomainGroupsDto, 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 —updateDomain()
Operation updateDomain
public
updateDomain(string $id, UpdateDomainOptions $update_domain_options[, string $contentType = self::contentTypes['updateDomain'][0] ]) : DomainDto
Update a domain
Parameters
- $id : string
-
id (required)
- $update_domain_options : UpdateDomainOptions
-
update_domain_options (required)
- $contentType : string = self::contentTypes['updateDomain'][0]
-
The value for the Content-Type header. Check self::contentTypes['updateDomain'] to see the possible values for this operation
Tags
Return values
DomainDto —updateDomainAsync()
Operation updateDomainAsync
public
updateDomainAsync(string $id, UpdateDomainOptions $update_domain_options[, string $contentType = self::contentTypes['updateDomain'][0] ]) : PromiseInterface
Update a domain
Parameters
- $id : string
-
(required)
- $update_domain_options : UpdateDomainOptions
-
(required)
- $contentType : string = self::contentTypes['updateDomain'][0]
-
The value for the Content-Type header. Check self::contentTypes['updateDomain'] to see the possible values for this operation
Tags
Return values
PromiseInterface —updateDomainAsyncWithHttpInfo()
Operation updateDomainAsyncWithHttpInfo
public
updateDomainAsyncWithHttpInfo(string $id, UpdateDomainOptions $update_domain_options[, string $contentType = self::contentTypes['updateDomain'][0] ]) : PromiseInterface
Update a domain
Parameters
- $id : string
-
(required)
- $update_domain_options : UpdateDomainOptions
-
(required)
- $contentType : string = self::contentTypes['updateDomain'][0]
-
The value for the Content-Type header. Check self::contentTypes['updateDomain'] to see the possible values for this operation
Tags
Return values
PromiseInterface —updateDomainRequest()
Create request for operation 'updateDomain'
public
updateDomainRequest(string $id, UpdateDomainOptions $update_domain_options[, string $contentType = self::contentTypes['updateDomain'][0] ]) : Request
Parameters
- $id : string
-
(required)
- $update_domain_options : UpdateDomainOptions
-
(required)
- $contentType : string = self::contentTypes['updateDomain'][0]
-
The value for the Content-Type header. Check self::contentTypes['updateDomain'] to see the possible values for this operation
Tags
Return values
Request —updateDomainWithHttpInfo()
Operation updateDomainWithHttpInfo
public
updateDomainWithHttpInfo(string $id, UpdateDomainOptions $update_domain_options[, string $contentType = self::contentTypes['updateDomain'][0] ]) : array<string|int, mixed>
Update a domain
Parameters
- $id : string
-
(required)
- $update_domain_options : UpdateDomainOptions
-
(required)
- $contentType : string = self::contentTypes['updateDomain'][0]
-
The value for the Content-Type header. Check self::contentTypes['updateDomain'] to see the possible values for this operation
Tags
Return values
array<string|int, mixed> —of \MailSlurp\Models\DomainDto, 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