Class MailServerControllerApi

Hierarchy

BaseAPI
- MailServerControllerApi

Index

Constructors

Properties

Methods

describeMailServerDomain describeMailServerDomainRaw getDnsLookup getDnsLookupRaw getDnsLookups getDnsLookupsRaw getIpAddress getIpAddressRaw request verifyEmailAddress verifyEmailAddressRaw withMiddleware withPostMiddleware withPreMiddleware

Constructors

constructor

new MailServerControllerApi(configuration?: Configuration): MailServerControllerApi
Parameters
- configuration: Configuration = ...
Returns MailServerControllerApi

Inherited from BaseAPI.constructor

Properties

`Protected` configuration

configuration: Configuration = ...

Methods

describeMailServerDomain

describeMailServerDomain(requestParameters: DescribeMailServerDomainRequest, initOverrides?: RequestInit): Promise<DescribeMailServerDomainResult>
Get DNS Mail Server records for a domain
Parameters
- requestParameters: DescribeMailServerDomainRequest
- Optional initOverrides: RequestInit
Returns Promise<DescribeMailServerDomainResult>

describeMailServerDomainRaw

describeMailServerDomainRaw(requestParameters: DescribeMailServerDomainRequest, initOverrides?: RequestInit): Promise<ApiResponse<DescribeMailServerDomainResult>>
Get DNS Mail Server records for a domain
Parameters
- requestParameters: DescribeMailServerDomainRequest
- Optional initOverrides: RequestInit
Returns Promise<ApiResponse<DescribeMailServerDomainResult>>

getDnsLookup

getDnsLookup(requestParameters: GetDnsLookupRequest, initOverrides?: RequestInit): Promise<DNSLookupResults>
Lookup DNS records for a domain
Parameters
- requestParameters: GetDnsLookupRequest
- Optional initOverrides: RequestInit
Returns Promise<DNSLookupResults>

getDnsLookupRaw

getDnsLookupRaw(requestParameters: GetDnsLookupRequest, initOverrides?: RequestInit): Promise<ApiResponse<DNSLookupResults>>
Lookup DNS records for a domain
Parameters
- requestParameters: GetDnsLookupRequest
- Optional initOverrides: RequestInit
Returns Promise<ApiResponse<DNSLookupResults>>

getDnsLookups

getDnsLookups(requestParameters: GetDnsLookupsRequest, initOverrides?: RequestInit): Promise<DNSLookupResults>
Lookup DNS records for multiple domains
Parameters
- requestParameters: GetDnsLookupsRequest
- Optional initOverrides: RequestInit
Returns Promise<DNSLookupResults>

getDnsLookupsRaw

getDnsLookupsRaw(requestParameters: GetDnsLookupsRequest, initOverrides?: RequestInit): Promise<ApiResponse<DNSLookupResults>>
Lookup DNS records for multiple domains
Parameters
- requestParameters: GetDnsLookupsRequest
- Optional initOverrides: RequestInit
Returns Promise<ApiResponse<DNSLookupResults>>

getIpAddress

getIpAddress(requestParameters: GetIpAddressRequest, initOverrides?: RequestInit): Promise<IPAddressResult>
Get IP address for a domain
Parameters
- requestParameters: GetIpAddressRequest
- Optional initOverrides: RequestInit
Returns Promise<IPAddressResult>

getIpAddressRaw

getIpAddressRaw(requestParameters: GetIpAddressRequest, initOverrides?: RequestInit): Promise<ApiResponse<IPAddressResult>>
Get IP address for a domain
Parameters
- requestParameters: GetIpAddressRequest
- Optional initOverrides: RequestInit
Returns Promise<ApiResponse<IPAddressResult>>

`Protected` request

request(context: RequestOpts, initOverrides?: RequestInit): Promise<Response>
Parameters
- context: RequestOpts
- Optional initOverrides: RequestInit
Returns Promise<Response>

Inherited from BaseAPI.request

verifyEmailAddress

verifyEmailAddress(requestParameters: VerifyEmailAddressRequest, initOverrides?: RequestInit): 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
- requestParameters: VerifyEmailAddressRequest
- Optional initOverrides: RequestInit
Returns Promise<EmailVerificationResult>

verifyEmailAddressRaw

verifyEmailAddressRaw(requestParameters: VerifyEmailAddressRequest, initOverrides?: RequestInit): 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
- requestParameters: VerifyEmailAddressRequest
- Optional initOverrides: RequestInit
Returns Promise<ApiResponse<EmailVerificationResult>>

withMiddleware

withMiddleware<T>(this: T, ...middlewares: Middleware[]): T
Type Parameters
- T extends BaseAPI<T>
Parameters
- this: T
- Rest ...middlewares: Middleware[]
Returns T

Inherited from BaseAPI.withMiddleware

withPostMiddleware

withPostMiddleware<T>(this: T, ...postMiddlewares: ((context: ResponseContext) => Promise<void | Response>)[]): T
Type Parameters
- T extends BaseAPI<T>
Parameters
- this: T
- Rest ...postMiddlewares: ((context: ResponseContext) => Promise<void | Response>)[]
Returns T

Inherited from BaseAPI.withPostMiddleware

withPreMiddleware

withPreMiddleware<T>(this: T, ...preMiddlewares: ((context: RequestContext) => Promise<void | FetchParams>)[]): T
Type Parameters
- T extends BaseAPI<T>
Parameters
- this: T
- Rest ...preMiddlewares: ((context: RequestContext) => Promise<void | FetchParams>)[]
Returns T

Inherited from BaseAPI.withPreMiddleware

Class MailServerControllerApi

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

configuration: Configuration = ...

Returns MailServerControllerApi

Properties

Protected configuration

Methods

describeMailServerDomain

Parameters

requestParameters: DescribeMailServerDomainRequest

Optional initOverrides: RequestInit

Returns Promise<DescribeMailServerDomainResult>

describeMailServerDomainRaw

Parameters

requestParameters: DescribeMailServerDomainRequest

Optional initOverrides: RequestInit

Returns Promise<ApiResponse<DescribeMailServerDomainResult>>

getDnsLookup

Parameters

requestParameters: GetDnsLookupRequest

Optional initOverrides: RequestInit

Returns Promise<DNSLookupResults>

getDnsLookupRaw

Parameters

requestParameters: GetDnsLookupRequest

Optional initOverrides: RequestInit

Returns Promise<ApiResponse<DNSLookupResults>>

getDnsLookups

Parameters

requestParameters: GetDnsLookupsRequest

Optional initOverrides: RequestInit

Returns Promise<DNSLookupResults>

getDnsLookupsRaw

Parameters

requestParameters: GetDnsLookupsRequest

Optional initOverrides: RequestInit

Returns Promise<ApiResponse<DNSLookupResults>>

getIpAddress

Parameters

requestParameters: GetIpAddressRequest

Optional initOverrides: RequestInit

Returns Promise<IPAddressResult>

getIpAddressRaw

Parameters

requestParameters: GetIpAddressRequest

Optional initOverrides: RequestInit

Returns Promise<ApiResponse<IPAddressResult>>

Protected request

Parameters

context: RequestOpts

Optional initOverrides: RequestInit

Returns Promise<Response>

verifyEmailAddress

Parameters

requestParameters: VerifyEmailAddressRequest

Optional initOverrides: RequestInit

Returns Promise<EmailVerificationResult>

verifyEmailAddressRaw

Parameters

requestParameters: VerifyEmailAddressRequest

Optional initOverrides: RequestInit

Returns Promise<ApiResponse<EmailVerificationResult>>

withMiddleware

Type Parameters

T extends BaseAPI<T>

Parameters

this: T

Rest ...middlewares: Middleware[]

Returns T

withPostMiddleware

Type Parameters

T extends BaseAPI<T>

Parameters

`Protected` configuration

`Optional` initOverrides: RequestInit

`Optional` initOverrides: RequestInit

`Optional` initOverrides: RequestInit

`Optional` initOverrides: RequestInit

`Optional` initOverrides: RequestInit

`Optional` initOverrides: RequestInit

`Optional` initOverrides: RequestInit

`Optional` initOverrides: RequestInit

`Protected` request

`Optional` initOverrides: RequestInit

`Optional` initOverrides: RequestInit

`Optional` initOverrides: RequestInit

`Rest` ...middlewares: Middleware[]

`Rest` ...postMiddlewares: ((context: ResponseContext) => Promise<void | Response>)[]

`Rest` ...preMiddlewares: ((context: RequestContext) => Promise<void | FetchParams>)[]