Skip to content

Class: MailServerControllerApi

Hierarchy

  • BaseAPI

    MailServerControllerApi

Table of contents

Constructors

Properties

Methods

Constructors

constructor

new MailServerControllerApi(configuration?)

Parameters

Name Type
configuration Configuration

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

Name Type
requestParameters DescribeMailServerDomainRequest
initOverrides? RequestInit

Returns

Promise<DescribeMailServerDomainResult>


describeMailServerDomainRaw

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

Get DNS Mail Server records for a domain

Parameters

Name Type
requestParameters DescribeMailServerDomainRequest
initOverrides? RequestInit

Returns

Promise<ApiResponse<DescribeMailServerDomainResult>>


getDnsLookup

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

Lookup DNS records for a domain

Parameters

Name Type
requestParameters GetDnsLookupRequest
initOverrides? RequestInit

Returns

Promise<DNSLookupResults>


getDnsLookupRaw

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

Lookup DNS records for a domain

Parameters

Name Type
requestParameters GetDnsLookupRequest
initOverrides? RequestInit

Returns

Promise<ApiResponse<DNSLookupResults>>


getIpAddress

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

Get IP address for a domain

Parameters

Name Type
requestParameters GetIpAddressRequest
initOverrides? RequestInit

Returns

Promise<IPAddressResult>


getIpAddressRaw

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

Get IP address for a domain

Parameters

Name Type
requestParameters GetIpAddressRequest
initOverrides? RequestInit

Returns

Promise<ApiResponse<IPAddressResult>>


request

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

Parameters

Name Type
context RequestOpts
initOverrides? RequestInit

Returns

Promise<Response>

Inherited from

BaseAPI.request


verifyEmailAddress

verifyEmailAddress(requestParameters, initOverrides?): Promise<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

Name Type
requestParameters VerifyEmailAddressRequest
initOverrides? RequestInit

Returns

Promise<EmailVerificationResult>


verifyEmailAddressRaw

verifyEmailAddressRaw(requestParameters, initOverrides?): Promise<ApiResponse<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

Name Type
requestParameters VerifyEmailAddressRequest
initOverrides? RequestInit

Returns

Promise<ApiResponse<EmailVerificationResult>>


withMiddleware

withMiddleware<T>(this, ...middlewares): T

Type parameters

Name Type
T extends BaseAPI<T>

Parameters

Name Type
this T
...middlewares Middleware[]

Returns

T

Inherited from

BaseAPI.withMiddleware


withPostMiddleware

withPostMiddleware<T>(this, ...postMiddlewares): T

Type parameters

Name Type
T extends BaseAPI<T>

Parameters

Name Type
this T
...postMiddlewares (context: ResponseContext) => Promise<void

Returns

T

Inherited from

BaseAPI.withPostMiddleware


withPreMiddleware

withPreMiddleware<T>(this, ...preMiddlewares): T

Type parameters

Name Type
T extends BaseAPI<T>

Parameters

Name Type
this T
...preMiddlewares (context: RequestContext) => Promise<void

Returns

T

Inherited from

BaseAPI.withPreMiddleware