Globals / DomainControllerApi
# Class: DomainControllerApi
DomainControllerApi - object-oriented interface
export
# Hierarchy
-
↳ DomainControllerApi
# Index
# Constructors
# Properties
# Methods
# Constructors
# constructor
+ new DomainControllerApi(configuration?: Configuration, basePath?: string, fetch?: FetchAPI): DomainControllerApi
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: DomainControllerApi
# 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
# createDomain
▸ createDomain(domainOptions: CreateDomainOptions, options?: any): Promise<DomainDto>
Defined in src/generated/api.ts:8028 (opens new window)
Link a domain that you own with MailSlurp so you can create email addresses using it. Endpoint returns DNS records used for validation. You must add these verification records to your host provider's DNS setup to verify the domain.
summary Create Domain
throws {RequiredError}
memberof DomainControllerApi
# Parameters:
| Name | Type | Description |
|---|---|---|
domainOptions | CreateDomainOptions | domainOptions |
options? | any | - |
Returns: Promise<DomainDto>
# deleteDomain
▸ deleteDomain(id: string, options?: any): Promise<string[]>
Defined in src/generated/api.ts:8043 (opens new window)
Delete a domain. This will disable any existing inboxes that use this domain.
summary Delete a domain
throws {RequiredError}
memberof DomainControllerApi
# Parameters:
| Name | Type | Description |
|---|---|---|
id | string | id |
options? | any | - |
Returns: Promise<string[]>
# getDomain
▸ getDomain(id: string, options?: any): Promise<DomainDto>
Defined in src/generated/api.ts:8058 (opens new window)
Returns domain verification status and tokens for a given domain
summary Get a domain
throws {RequiredError}
memberof DomainControllerApi
# Parameters:
| Name | Type | Description |
|---|---|---|
id | string | id |
options? | any | - |
Returns: Promise<DomainDto>
# getDomains
▸ getDomains(options?: any): Promise<DomainPreview[]>
Defined in src/generated/api.ts:8072 (opens new window)
List all custom domains you have created
summary Get domains
throws {RequiredError}
memberof DomainControllerApi
# Parameters:
| Name | Type |
|---|---|
options? | any |
Returns: Promise<DomainPreview[]>
