MailServerControllerApi
in package
MailServerControllerApi Class Doc Comment
Tags
Table of Contents
- contentTypes = ['describeMailServerDomain' => ['application/json'], 'getDnsLookup' => ['application/json'], 'getDnsLookups' => ['application/json'], 'getIpAddress' => ['application/json'], 'verifyEmailAddress' => ['application/json']]
- $client : ClientInterface
- $config : Configuration
- $headerSelector : HeaderSelector
- $hostIndex : int
- __construct() : mixed
- describeMailServerDomain() : DescribeMailServerDomainResult
- Operation describeMailServerDomain
- describeMailServerDomainAsync() : PromiseInterface
- Operation describeMailServerDomainAsync
- describeMailServerDomainAsyncWithHttpInfo() : PromiseInterface
- Operation describeMailServerDomainAsyncWithHttpInfo
- describeMailServerDomainRequest() : Request
- Create request for operation 'describeMailServerDomain'
- describeMailServerDomainWithHttpInfo() : array<string|int, mixed>
- Operation describeMailServerDomainWithHttpInfo
- getConfig() : Configuration
- getDnsLookup() : DNSLookupResults
- Operation getDnsLookup
- getDnsLookupAsync() : PromiseInterface
- Operation getDnsLookupAsync
- getDnsLookupAsyncWithHttpInfo() : PromiseInterface
- Operation getDnsLookupAsyncWithHttpInfo
- getDnsLookupRequest() : Request
- Create request for operation 'getDnsLookup'
- getDnsLookups() : DNSLookupResults
- Operation getDnsLookups
- getDnsLookupsAsync() : PromiseInterface
- Operation getDnsLookupsAsync
- getDnsLookupsAsyncWithHttpInfo() : PromiseInterface
- Operation getDnsLookupsAsyncWithHttpInfo
- getDnsLookupsRequest() : Request
- Create request for operation 'getDnsLookups'
- getDnsLookupsWithHttpInfo() : array<string|int, mixed>
- Operation getDnsLookupsWithHttpInfo
- getDnsLookupWithHttpInfo() : array<string|int, mixed>
- Operation getDnsLookupWithHttpInfo
- getHostIndex() : int
- Get the host index
- getIpAddress() : IPAddressResult
- Operation getIpAddress
- getIpAddressAsync() : PromiseInterface
- Operation getIpAddressAsync
- getIpAddressAsyncWithHttpInfo() : PromiseInterface
- Operation getIpAddressAsyncWithHttpInfo
- getIpAddressRequest() : Request
- Create request for operation 'getIpAddress'
- getIpAddressWithHttpInfo() : array<string|int, mixed>
- Operation getIpAddressWithHttpInfo
- setHostIndex() : void
- Set the host index
- verifyEmailAddress() : EmailVerificationResult
- Operation verifyEmailAddress
- verifyEmailAddressAsync() : PromiseInterface
- Operation verifyEmailAddressAsync
- verifyEmailAddressAsyncWithHttpInfo() : PromiseInterface
- Operation verifyEmailAddressAsyncWithHttpInfo
- verifyEmailAddressRequest() : Request
- Create request for operation 'verifyEmailAddress'
- verifyEmailAddressWithHttpInfo() : array<string|int, mixed>
- Operation verifyEmailAddressWithHttpInfo
- createHttpClientOption() : array<string|int, mixed>
- Create http client option
Constants
contentTypes
public
array<string|int, string>
contentTypes
= ['describeMailServerDomain' => ['application/json'], 'getDnsLookup' => ['application/json'], 'getDnsLookups' => ['application/json'], 'getIpAddress' => ['application/json'], 'verifyEmailAddress' => ['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 —describeMailServerDomain()
Operation describeMailServerDomain
public
describeMailServerDomain(DescribeDomainOptions $describe_domain_options[, string $contentType = self::contentTypes['describeMailServerDomain'][0] ]) : DescribeMailServerDomainResult
Get DNS Mail Server records for a domain
Parameters
- $describe_domain_options : DescribeDomainOptions
-
describe_domain_options (required)
- $contentType : string = self::contentTypes['describeMailServerDomain'][0]
-
The value for the Content-Type header. Check self::contentTypes['describeMailServerDomain'] to see the possible values for this operation
Tags
Return values
DescribeMailServerDomainResult —describeMailServerDomainAsync()
Operation describeMailServerDomainAsync
public
describeMailServerDomainAsync(DescribeDomainOptions $describe_domain_options[, string $contentType = self::contentTypes['describeMailServerDomain'][0] ]) : PromiseInterface
Get DNS Mail Server records for a domain
Parameters
- $describe_domain_options : DescribeDomainOptions
-
(required)
- $contentType : string = self::contentTypes['describeMailServerDomain'][0]
-
The value for the Content-Type header. Check self::contentTypes['describeMailServerDomain'] to see the possible values for this operation
Tags
Return values
PromiseInterface —describeMailServerDomainAsyncWithHttpInfo()
Operation describeMailServerDomainAsyncWithHttpInfo
public
describeMailServerDomainAsyncWithHttpInfo(DescribeDomainOptions $describe_domain_options[, string $contentType = self::contentTypes['describeMailServerDomain'][0] ]) : PromiseInterface
Get DNS Mail Server records for a domain
Parameters
- $describe_domain_options : DescribeDomainOptions
-
(required)
- $contentType : string = self::contentTypes['describeMailServerDomain'][0]
-
The value for the Content-Type header. Check self::contentTypes['describeMailServerDomain'] to see the possible values for this operation
Tags
Return values
PromiseInterface —describeMailServerDomainRequest()
Create request for operation 'describeMailServerDomain'
public
describeMailServerDomainRequest(DescribeDomainOptions $describe_domain_options[, string $contentType = self::contentTypes['describeMailServerDomain'][0] ]) : Request
Parameters
- $describe_domain_options : DescribeDomainOptions
-
(required)
- $contentType : string = self::contentTypes['describeMailServerDomain'][0]
-
The value for the Content-Type header. Check self::contentTypes['describeMailServerDomain'] to see the possible values for this operation
Tags
Return values
Request —describeMailServerDomainWithHttpInfo()
Operation describeMailServerDomainWithHttpInfo
public
describeMailServerDomainWithHttpInfo(DescribeDomainOptions $describe_domain_options[, string $contentType = self::contentTypes['describeMailServerDomain'][0] ]) : array<string|int, mixed>
Get DNS Mail Server records for a domain
Parameters
- $describe_domain_options : DescribeDomainOptions
-
(required)
- $contentType : string = self::contentTypes['describeMailServerDomain'][0]
-
The value for the Content-Type header. Check self::contentTypes['describeMailServerDomain'] to see the possible values for this operation
Tags
Return values
array<string|int, mixed> —of \MailSlurp\Models\DescribeMailServerDomainResult, HTTP status code, HTTP response headers (array of strings)
getConfig()
public
getConfig() : Configuration
Return values
Configuration —getDnsLookup()
Operation getDnsLookup
public
getDnsLookup(DNSLookupOptions $dns_lookup_options[, string $contentType = self::contentTypes['getDnsLookup'][0] ]) : DNSLookupResults
Lookup DNS records for a domain
Parameters
- $dns_lookup_options : DNSLookupOptions
-
dns_lookup_options (required)
- $contentType : string = self::contentTypes['getDnsLookup'][0]
-
The value for the Content-Type header. Check self::contentTypes['getDnsLookup'] to see the possible values for this operation
Tags
Return values
DNSLookupResults —getDnsLookupAsync()
Operation getDnsLookupAsync
public
getDnsLookupAsync(DNSLookupOptions $dns_lookup_options[, string $contentType = self::contentTypes['getDnsLookup'][0] ]) : PromiseInterface
Lookup DNS records for a domain
Parameters
- $dns_lookup_options : DNSLookupOptions
-
(required)
- $contentType : string = self::contentTypes['getDnsLookup'][0]
-
The value for the Content-Type header. Check self::contentTypes['getDnsLookup'] to see the possible values for this operation
Tags
Return values
PromiseInterface —getDnsLookupAsyncWithHttpInfo()
Operation getDnsLookupAsyncWithHttpInfo
public
getDnsLookupAsyncWithHttpInfo(DNSLookupOptions $dns_lookup_options[, string $contentType = self::contentTypes['getDnsLookup'][0] ]) : PromiseInterface
Lookup DNS records for a domain
Parameters
- $dns_lookup_options : DNSLookupOptions
-
(required)
- $contentType : string = self::contentTypes['getDnsLookup'][0]
-
The value for the Content-Type header. Check self::contentTypes['getDnsLookup'] to see the possible values for this operation
Tags
Return values
PromiseInterface —getDnsLookupRequest()
Create request for operation 'getDnsLookup'
public
getDnsLookupRequest(DNSLookupOptions $dns_lookup_options[, string $contentType = self::contentTypes['getDnsLookup'][0] ]) : Request
Parameters
- $dns_lookup_options : DNSLookupOptions
-
(required)
- $contentType : string = self::contentTypes['getDnsLookup'][0]
-
The value for the Content-Type header. Check self::contentTypes['getDnsLookup'] to see the possible values for this operation
Tags
Return values
Request —getDnsLookups()
Operation getDnsLookups
public
getDnsLookups(DNSLookupsOptions $dns_lookups_options[, string $contentType = self::contentTypes['getDnsLookups'][0] ]) : DNSLookupResults
Lookup DNS records for multiple domains
Parameters
- $dns_lookups_options : DNSLookupsOptions
-
dns_lookups_options (required)
- $contentType : string = self::contentTypes['getDnsLookups'][0]
-
The value for the Content-Type header. Check self::contentTypes['getDnsLookups'] to see the possible values for this operation
Tags
Return values
DNSLookupResults —getDnsLookupsAsync()
Operation getDnsLookupsAsync
public
getDnsLookupsAsync(DNSLookupsOptions $dns_lookups_options[, string $contentType = self::contentTypes['getDnsLookups'][0] ]) : PromiseInterface
Lookup DNS records for multiple domains
Parameters
- $dns_lookups_options : DNSLookupsOptions
-
(required)
- $contentType : string = self::contentTypes['getDnsLookups'][0]
-
The value for the Content-Type header. Check self::contentTypes['getDnsLookups'] to see the possible values for this operation
Tags
Return values
PromiseInterface —getDnsLookupsAsyncWithHttpInfo()
Operation getDnsLookupsAsyncWithHttpInfo
public
getDnsLookupsAsyncWithHttpInfo(DNSLookupsOptions $dns_lookups_options[, string $contentType = self::contentTypes['getDnsLookups'][0] ]) : PromiseInterface
Lookup DNS records for multiple domains
Parameters
- $dns_lookups_options : DNSLookupsOptions
-
(required)
- $contentType : string = self::contentTypes['getDnsLookups'][0]
-
The value for the Content-Type header. Check self::contentTypes['getDnsLookups'] to see the possible values for this operation
Tags
Return values
PromiseInterface —getDnsLookupsRequest()
Create request for operation 'getDnsLookups'
public
getDnsLookupsRequest(DNSLookupsOptions $dns_lookups_options[, string $contentType = self::contentTypes['getDnsLookups'][0] ]) : Request
Parameters
- $dns_lookups_options : DNSLookupsOptions
-
(required)
- $contentType : string = self::contentTypes['getDnsLookups'][0]
-
The value for the Content-Type header. Check self::contentTypes['getDnsLookups'] to see the possible values for this operation
Tags
Return values
Request —getDnsLookupsWithHttpInfo()
Operation getDnsLookupsWithHttpInfo
public
getDnsLookupsWithHttpInfo(DNSLookupsOptions $dns_lookups_options[, string $contentType = self::contentTypes['getDnsLookups'][0] ]) : array<string|int, mixed>
Lookup DNS records for multiple domains
Parameters
- $dns_lookups_options : DNSLookupsOptions
-
(required)
- $contentType : string = self::contentTypes['getDnsLookups'][0]
-
The value for the Content-Type header. Check self::contentTypes['getDnsLookups'] to see the possible values for this operation
Tags
Return values
array<string|int, mixed> —of \MailSlurp\Models\DNSLookupResults, HTTP status code, HTTP response headers (array of strings)
getDnsLookupWithHttpInfo()
Operation getDnsLookupWithHttpInfo
public
getDnsLookupWithHttpInfo(DNSLookupOptions $dns_lookup_options[, string $contentType = self::contentTypes['getDnsLookup'][0] ]) : array<string|int, mixed>
Lookup DNS records for a domain
Parameters
- $dns_lookup_options : DNSLookupOptions
-
(required)
- $contentType : string = self::contentTypes['getDnsLookup'][0]
-
The value for the Content-Type header. Check self::contentTypes['getDnsLookup'] to see the possible values for this operation
Tags
Return values
array<string|int, mixed> —of \MailSlurp\Models\DNSLookupResults, HTTP status code, HTTP response headers (array of strings)
getHostIndex()
Get the host index
public
getHostIndex() : int
Return values
int —Host index
getIpAddress()
Operation getIpAddress
public
getIpAddress(string $name[, string $contentType = self::contentTypes['getIpAddress'][0] ]) : IPAddressResult
Get IP address for a domain
Parameters
- $name : string
-
name (required)
- $contentType : string = self::contentTypes['getIpAddress'][0]
-
The value for the Content-Type header. Check self::contentTypes['getIpAddress'] to see the possible values for this operation
Tags
Return values
IPAddressResult —getIpAddressAsync()
Operation getIpAddressAsync
public
getIpAddressAsync(string $name[, string $contentType = self::contentTypes['getIpAddress'][0] ]) : PromiseInterface
Get IP address for a domain
Parameters
- $name : string
-
(required)
- $contentType : string = self::contentTypes['getIpAddress'][0]
-
The value for the Content-Type header. Check self::contentTypes['getIpAddress'] to see the possible values for this operation
Tags
Return values
PromiseInterface —getIpAddressAsyncWithHttpInfo()
Operation getIpAddressAsyncWithHttpInfo
public
getIpAddressAsyncWithHttpInfo(string $name[, string $contentType = self::contentTypes['getIpAddress'][0] ]) : PromiseInterface
Get IP address for a domain
Parameters
- $name : string
-
(required)
- $contentType : string = self::contentTypes['getIpAddress'][0]
-
The value for the Content-Type header. Check self::contentTypes['getIpAddress'] to see the possible values for this operation
Tags
Return values
PromiseInterface —getIpAddressRequest()
Create request for operation 'getIpAddress'
public
getIpAddressRequest(string $name[, string $contentType = self::contentTypes['getIpAddress'][0] ]) : Request
Parameters
- $name : string
-
(required)
- $contentType : string = self::contentTypes['getIpAddress'][0]
-
The value for the Content-Type header. Check self::contentTypes['getIpAddress'] to see the possible values for this operation
Tags
Return values
Request —getIpAddressWithHttpInfo()
Operation getIpAddressWithHttpInfo
public
getIpAddressWithHttpInfo(string $name[, string $contentType = self::contentTypes['getIpAddress'][0] ]) : array<string|int, mixed>
Get IP address for a domain
Parameters
- $name : string
-
(required)
- $contentType : string = self::contentTypes['getIpAddress'][0]
-
The value for the Content-Type header. Check self::contentTypes['getIpAddress'] to see the possible values for this operation
Tags
Return values
array<string|int, mixed> —of \MailSlurp\Models\IPAddressResult, 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 —verifyEmailAddress()
Operation verifyEmailAddress
public
verifyEmailAddress(VerifyEmailAddressOptions $verify_email_address_options[, string $contentType = self::contentTypes['verifyEmailAddress'][0] ]) : EmailVerificationResult
Deprecated. Use the EmailVerificationController methods for more accurate and reliable functionality. Verify the existence of an email address at a given mail server.
Parameters
- $verify_email_address_options : VerifyEmailAddressOptions
-
verify_email_address_options (required)
- $contentType : string = self::contentTypes['verifyEmailAddress'][0]
-
The value for the Content-Type header. Check self::contentTypes['verifyEmailAddress'] to see the possible values for this operation
Tags
Return values
EmailVerificationResult —verifyEmailAddressAsync()
Operation verifyEmailAddressAsync
public
verifyEmailAddressAsync(VerifyEmailAddressOptions $verify_email_address_options[, string $contentType = self::contentTypes['verifyEmailAddress'][0] ]) : PromiseInterface
Deprecated. Use the EmailVerificationController methods for more accurate and reliable functionality. Verify the existence of an email address at a given mail server.
Parameters
- $verify_email_address_options : VerifyEmailAddressOptions
-
(required)
- $contentType : string = self::contentTypes['verifyEmailAddress'][0]
-
The value for the Content-Type header. Check self::contentTypes['verifyEmailAddress'] to see the possible values for this operation
Tags
Return values
PromiseInterface —verifyEmailAddressAsyncWithHttpInfo()
Operation verifyEmailAddressAsyncWithHttpInfo
public
verifyEmailAddressAsyncWithHttpInfo(VerifyEmailAddressOptions $verify_email_address_options[, string $contentType = self::contentTypes['verifyEmailAddress'][0] ]) : PromiseInterface
Deprecated. Use the EmailVerificationController methods for more accurate and reliable functionality. Verify the existence of an email address at a given mail server.
Parameters
- $verify_email_address_options : VerifyEmailAddressOptions
-
(required)
- $contentType : string = self::contentTypes['verifyEmailAddress'][0]
-
The value for the Content-Type header. Check self::contentTypes['verifyEmailAddress'] to see the possible values for this operation
Tags
Return values
PromiseInterface —verifyEmailAddressRequest()
Create request for operation 'verifyEmailAddress'
public
verifyEmailAddressRequest(VerifyEmailAddressOptions $verify_email_address_options[, string $contentType = self::contentTypes['verifyEmailAddress'][0] ]) : Request
Parameters
- $verify_email_address_options : VerifyEmailAddressOptions
-
(required)
- $contentType : string = self::contentTypes['verifyEmailAddress'][0]
-
The value for the Content-Type header. Check self::contentTypes['verifyEmailAddress'] to see the possible values for this operation
Tags
Return values
Request —verifyEmailAddressWithHttpInfo()
Operation verifyEmailAddressWithHttpInfo
public
verifyEmailAddressWithHttpInfo(VerifyEmailAddressOptions $verify_email_address_options[, string $contentType = self::contentTypes['verifyEmailAddress'][0] ]) : array<string|int, mixed>
Deprecated. Use the EmailVerificationController methods for more accurate and reliable functionality. Verify the existence of an email address at a given mail server.
Parameters
- $verify_email_address_options : VerifyEmailAddressOptions
-
(required)
- $contentType : string = self::contentTypes['verifyEmailAddress'][0]
-
The value for the Content-Type header. Check self::contentTypes['verifyEmailAddress'] to see the possible values for this operation
Tags
Return values
array<string|int, mixed> —of \MailSlurp\Models\EmailVerificationResult, 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