MailSlurp JS

Globals / MailServerControllerApi

Class: MailServerControllerApi

MailServerControllerApi - object-oriented interface

export

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Inherited from BaseAPI.constructor

Defined in src/generated/api.ts:57

Parameters:

NameTypeDefault value
configuration?Configuration-
basePathstringBASE_PATH
fetchFetchAPIportableFetch

Returns: MailServerControllerApi

Properties

basePath

Protected basePath: string

Inherited from BaseAPI.basePath

Defined in src/generated/api.ts:61


configuration

Protected configuration: Configuration

Inherited from BaseAPI.configuration

Defined in src/generated/api.ts:57


fetch

Protected fetch: FetchAPI

Inherited from BaseAPI.fetch

Defined in src/generated/api.ts:62

Methods

describeMailServerDomain

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

Defined in src/generated/api.ts:24305

summary Get DNS Mail Server records for a domain

throws {RequiredError}

memberof MailServerControllerApi

Parameters:

NameTypeDescription
describeOptionsDescribeDomainOptionsdescribeOptions
options?any-

Returns: Promise<DescribeMailServerDomainResult>


getDnsLookup

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

Defined in src/generated/api.ts:24325

summary Lookup DNS records for a domain

throws {RequiredError}

memberof MailServerControllerApi

Parameters:

NameTypeDescription
dnsLookupOptionsDNSLookupOptionsdnsLookupOptions
options?any-

Returns: Promise<DNSLookupResults>


getIpAddress

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

Defined in src/generated/api.ts:24340

summary Get IP address for a domain

throws {RequiredError}

memberof MailServerControllerApi

Parameters:

NameTypeDescription
namestringname
options?any-

Returns: Promise<IPAddressResult>


verifyEmailAddress

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

Defined in src/generated/api.ts:24355

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>