MailSlurp JS / MailServerControllerApi

Class: MailServerControllerApi

MailServerControllerApi - object-oriented interface

export

Hierarchy

Table of contents

Constructors

Properties

Methods

Constructors

constructor

new MailServerControllerApi(configuration?, basePath?, fetch?)

Parameters

NameType
configuration?Configuration
basePathstring
fetchFetchAPI

Inherited from

BaseAPI.constructor

Defined in

src/generated/api.ts:59

Properties

basePath

Protected basePath: string

Inherited from

BaseAPI.basePath


configuration

Protected configuration: Configuration

Inherited from

BaseAPI.configuration

Defined in

src/generated/api.ts:57


fetch

Protected fetch: FetchAPI

Inherited from

BaseAPI.fetch

Methods

describeMailServerDomain

describeMailServerDomain(describeOptions, options?): Promise<DescribeMailServerDomainResult>

summary Get DNS Mail Server records for a domain

throws {RequiredError}

memberof MailServerControllerApi

Parameters

NameTypeDescription
describeOptionsDescribeDomainOptionsdescribeOptions
options?any-

Returns

Promise<DescribeMailServerDomainResult>

Defined in

src/generated/api.ts:25961


getDnsLookup

getDnsLookup(dnsLookupOptions, options?): Promise<DNSLookupResults>

summary Lookup DNS records for a domain

throws {RequiredError}

memberof MailServerControllerApi

Parameters

NameTypeDescription
dnsLookupOptionsDNSLookupOptionsdnsLookupOptions
options?any-

Returns

Promise<DNSLookupResults>

Defined in

src/generated/api.ts:25981


getIpAddress

getIpAddress(name, options?): Promise<IPAddressResult>

summary Get IP address for a domain

throws {RequiredError}

memberof MailServerControllerApi

Parameters

NameTypeDescription
namestringname
options?any-

Returns

Promise<IPAddressResult>

Defined in

src/generated/api.ts:25996


verifyEmailAddress

verifyEmailAddress(verifyOptions, options?): Promise<EmailVerificationResult>

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

throws {RequiredError}

memberof MailServerControllerApi

Parameters

NameTypeDescription
verifyOptionsVerifyEmailAddressOptionsverifyOptions
options?any-

Returns

Promise<EmailVerificationResult>

Defined in

src/generated/api.ts:26011