Globals / MailServerControllerApi
# Class: MailServerControllerApi
MailServerControllerApi - object-oriented interface
export
# Hierarchy
-
↳ MailServerControllerApi
# Index
# Constructors
# Properties
# Methods
# Constructors
# constructor
+ new MailServerControllerApi(configuration?: Configuration, basePath?: string, fetch?: FetchAPI): MailServerControllerApi
Inherited from BaseAPI.constructor
Defined in src/generated/api.ts:57 (opens new window)
# Parameters:
| Name | Type | Default value |
|---|---|---|
configuration? | Configuration | - |
basePath | string | BASE_PATH |
fetch | FetchAPI | portableFetch |
Returns: MailServerControllerApi
# Properties
# basePath
• Protected basePath: string
Inherited from BaseAPI.basePath
Defined in src/generated/api.ts:61 (opens new window)
# configuration
• Protected configuration: Configuration
Inherited from BaseAPI.configuration
Defined in src/generated/api.ts:57 (opens new window)
# fetch
• Protected fetch: FetchAPI
Defined in src/generated/api.ts:62 (opens new window)
# Methods
# describeMailServerDomain
▸ describeMailServerDomain(describeOptions: DescribeDomainOptions, options?: any): Promise<DescribeMailServerDomainResult>
Defined in src/generated/api.ts:15159 (opens new window)
summary Get DNS Mail Server records for a domain
throws {RequiredError}
memberof MailServerControllerApi
# Parameters:
| Name | Type | Description |
|---|---|---|
describeOptions | DescribeDomainOptions | describeOptions |
options? | any | - |
Returns: Promise<DescribeMailServerDomainResult>
# getDnsLookup
▸ getDnsLookup(dnsLookupOptions: DNSLookupOptions, options?: any): Promise<DNSLookupResults>
Defined in src/generated/api.ts:15179 (opens new window)
summary Lookup DNS records for a domain
throws {RequiredError}
memberof MailServerControllerApi
# Parameters:
| Name | Type | Description |
|---|---|---|
dnsLookupOptions | DNSLookupOptions | dnsLookupOptions |
options? | any | - |
Returns: Promise<DNSLookupResults>
# getIpAddress
▸ getIpAddress(name: string, options?: any): Promise<IPAddressResult>
Defined in src/generated/api.ts:15194 (opens new window)
summary Get IP address for a domain
throws {RequiredError}
memberof MailServerControllerApi
# Parameters:
| Name | Type | Description |
|---|---|---|
name | string | name |
options? | any | - |
Returns: Promise<IPAddressResult>
# verifyEmailAddress
▸ verifyEmailAddress(verifyOptions: VerifyEmailAddressOptions, options?: any): Promise<EmailVerificationResult>
Defined in src/generated/api.ts:15209 (opens new window)
summary Verify the existence of an email address at a given mail server.
throws {RequiredError}
memberof MailServerControllerApi
# Parameters:
| Name | Type | Description |
|---|---|---|
verifyOptions | VerifyEmailAddressOptions | verifyOptions |
options? | any | - |
Returns: Promise<EmailVerificationResult>
