MailSlurp JS

Globals / DomainControllerApi

Class: DomainControllerApi

DomainControllerApi - 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: DomainControllerApi

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

addDomainWildcardCatchAll

addDomainWildcardCatchAll(id: string, options?: any): Promise<DomainDto>

Defined in src/generated/api.ts:10456

Add a catch all inbox to a domain so that any emails sent to it that cannot be matched will be sent to the catch all inbox generated

summary Add catch all wild card inbox to domain

throws {RequiredError}

memberof DomainControllerApi

Parameters:

NameTypeDescription
idstringid
options?any-

Returns: Promise<DomainDto>


createDomain

createDomain(domainOptions: CreateDomainOptions, options?: any): Promise<DomainDto>

Defined in src/generated/api.ts:10470

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:

NameTypeDescription
domainOptionsCreateDomainOptionsdomainOptions
options?any-

Returns: Promise<DomainDto>


deleteDomain

deleteDomain(id: string, options?: any): Promise<string[]>

Defined in src/generated/api.ts:10485

Delete a domain. This will disable any existing inboxes that use this domain.

summary Delete a domain

throws {RequiredError}

memberof DomainControllerApi

Parameters:

NameTypeDescription
idstringid
options?any-

Returns: Promise<string[]>


getDomain

getDomain(id: string, options?: any): Promise<DomainDto>

Defined in src/generated/api.ts:10500

Returns domain verification status and tokens for a given domain

summary Get a domain

throws {RequiredError}

memberof DomainControllerApi

Parameters:

NameTypeDescription
idstringid
options?any-

Returns: Promise<DomainDto>


getDomains

getDomains(options?: any): Promise<DomainPreview[]>

Defined in src/generated/api.ts:10514

List all custom domains you have created

summary Get domains

throws {RequiredError}

memberof DomainControllerApi

Parameters:

NameType
options?any

Returns: Promise<DomainPreview[]>


updateDomain

updateDomain(id: string, updateDomainDto: UpdateDomainOptions, options?: any): Promise<DomainDto>

Defined in src/generated/api.ts:10530

Update values on a domain. Note you cannot change the domain name as it is immutable. Recreate the domain if you need to alter this.

summary Update a domain

throws {RequiredError}

memberof DomainControllerApi

Parameters:

NameTypeDescription
idstringid
updateDomainDtoUpdateDomainOptionsupdateDomainDto
options?any-

Returns: Promise<DomainDto>