Hierarchy

Table of contents

Constructors

Properties

Methods

Constructors

constructor

new MailServerControllerApi(configuration?)

Parameters

NameType
configurationConfiguration

Inherited from

BaseAPI.constructor

Properties

configuration

Protected configuration: Configuration

Inherited from

BaseAPI.configuration

Methods

describeMailServerDomain

describeMailServerDomain(requestParameters, initOverrides?): Promise<DescribeMailServerDomainResult>

Get DNS Mail Server records for a domain

Parameters

NameType
requestParametersDescribeMailServerDomainRequest
initOverrides?RequestInit

Returns

Promise<DescribeMailServerDomainResult>


describeMailServerDomainRaw

describeMailServerDomainRaw(requestParameters, initOverrides?): Promise<ApiResponse<DescribeMailServerDomainResult»

Get DNS Mail Server records for a domain

Parameters

NameType
requestParametersDescribeMailServerDomainRequest
initOverrides?RequestInit

Returns

Promise<ApiResponse<DescribeMailServerDomainResult»


getDnsLookup

getDnsLookup(requestParameters, initOverrides?): Promise<DNSLookupResults>

Lookup DNS records for a domain

Parameters

NameType
requestParametersGetDnsLookupRequest
initOverrides?RequestInit

Returns

Promise<DNSLookupResults>


getDnsLookupRaw

getDnsLookupRaw(requestParameters, initOverrides?): Promise<ApiResponse<DNSLookupResults»

Lookup DNS records for a domain

Parameters

NameType
requestParametersGetDnsLookupRequest
initOverrides?RequestInit

Returns

Promise<ApiResponse<DNSLookupResults»


getIpAddress

getIpAddress(requestParameters, initOverrides?): Promise<IPAddressResult>

Get IP address for a domain

Parameters

NameType
requestParametersGetIpAddressRequest
initOverrides?RequestInit

Returns

Promise<IPAddressResult>


getIpAddressRaw

getIpAddressRaw(requestParameters, initOverrides?): Promise<ApiResponse<IPAddressResult»

Get IP address for a domain

Parameters

NameType
requestParametersGetIpAddressRequest
initOverrides?RequestInit

Returns

Promise<ApiResponse<IPAddressResult»


request

Protected request(context, initOverrides?): Promise<Response>

Parameters

NameType
contextRequestOpts
initOverrides?RequestInit

Returns

Promise<Response>

Inherited from

BaseAPI.request


verifyEmailAddress

verifyEmailAddress(requestParameters, initOverrides?): Promise<EmailVerificationResult>

Verify the existence of an email address at a given mail server.

Parameters

NameType
requestParametersVerifyEmailAddressRequest
initOverrides?RequestInit

Returns

Promise<EmailVerificationResult>


verifyEmailAddressRaw

verifyEmailAddressRaw(requestParameters, initOverrides?): Promise<ApiResponse<EmailVerificationResult»

Verify the existence of an email address at a given mail server.

Parameters

NameType
requestParametersVerifyEmailAddressRequest
initOverrides?RequestInit

Returns

Promise<ApiResponse<EmailVerificationResult»


withMiddleware

withMiddleware<T>(…middlewares): T

Type parameters

NameType
Textends BaseAPI<T>

Parameters

NameType
...middlewaresMiddleware[]

Returns

T

Inherited from

BaseAPI.withMiddleware


withPostMiddleware

withPostMiddleware<T>(…postMiddlewares): T

Type parameters

NameType
Textends BaseAPI<T>

Parameters

NameType
...postMiddlewares(context: ResponseContext) => Promise<void

Returns

T

Inherited from

BaseAPI.withPostMiddleware


withPreMiddleware

withPreMiddleware<T>(…preMiddlewares): T

Type parameters

NameType
Textends BaseAPI<T>

Parameters

NameType
...preMiddlewares(context: RequestContext) => Promise<void

Returns

T

Inherited from

BaseAPI.withPreMiddleware