Skip to content

Class: DomainControllerApi

Hierarchy

Table of contents

Constructors

Properties

Methods

Constructors

constructor

new DomainControllerApi(configuration?)

Parameters

Name Type
configuration Configuration

Inherited from

BaseAPI.constructor

Properties

configuration

Protected configuration: Configuration

Inherited from

BaseAPI.configuration

Methods

addDomainWildcardCatchAll

addDomainWildcardCatchAll(requestParameters, initOverrides?): Promise<DomainDto>

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 Add catch all wild card inbox to domain

Parameters

Name Type
requestParameters AddDomainWildcardCatchAllRequest
initOverrides? RequestInit

Returns

Promise<DomainDto>


addDomainWildcardCatchAllRaw

addDomainWildcardCatchAllRaw(requestParameters, initOverrides?): Promise<ApiResponse<DomainDto>>

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 Add catch all wild card inbox to domain

Parameters

Name Type
requestParameters AddDomainWildcardCatchAllRequest
initOverrides? RequestInit

Returns

Promise<ApiResponse<DomainDto>>


createDomain

createDomain(requestParameters, initOverrides?): Promise<DomainDto>

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. Create Domain

Parameters

Name Type
requestParameters CreateDomainRequest
initOverrides? RequestInit

Returns

Promise<DomainDto>


createDomainRaw

createDomainRaw(requestParameters, initOverrides?): Promise<ApiResponse<DomainDto>>

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. Create Domain

Parameters

Name Type
requestParameters CreateDomainRequest
initOverrides? RequestInit

Returns

Promise<ApiResponse<DomainDto>>


deleteDomain

deleteDomain(requestParameters, initOverrides?): Promise<string[]>

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

Parameters

Name Type
requestParameters DeleteDomainRequest
initOverrides? RequestInit

Returns

Promise<string[]>


deleteDomainRaw

deleteDomainRaw(requestParameters, initOverrides?): Promise<ApiResponse<string[]>>

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

Parameters

Name Type
requestParameters DeleteDomainRequest
initOverrides? RequestInit

Returns

Promise<ApiResponse<string[]>>


getDomain

getDomain(requestParameters, initOverrides?): Promise<DomainDto>

Returns domain verification status and tokens for a given domain Get a domain

Parameters

Name Type
requestParameters GetDomainRequest
initOverrides? RequestInit

Returns

Promise<DomainDto>


getDomainRaw

getDomainRaw(requestParameters, initOverrides?): Promise<ApiResponse<DomainDto>>

Returns domain verification status and tokens for a given domain Get a domain

Parameters

Name Type
requestParameters GetDomainRequest
initOverrides? RequestInit

Returns

Promise<ApiResponse<DomainDto>>


getDomains

getDomains(initOverrides?): Promise<DomainPreview[]>

List all custom domains you have created Get domains

Parameters

Name Type
initOverrides? RequestInit

Returns

Promise<DomainPreview[]>


getDomainsRaw

getDomainsRaw(initOverrides?): Promise<ApiResponse<DomainPreview[]>>

List all custom domains you have created Get domains

Parameters

Name Type
initOverrides? RequestInit

Returns

Promise<ApiResponse<DomainPreview[]>>


request

Protected request(context, initOverrides?): Promise<Response>

Parameters

Name Type
context RequestOpts
initOverrides? RequestInit

Returns

Promise<Response>

Inherited from

BaseAPI.request


updateDomain

updateDomain(requestParameters, initOverrides?): Promise<DomainDto>

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. Update a domain

Parameters

Name Type
requestParameters UpdateDomainRequest
initOverrides? RequestInit

Returns

Promise<DomainDto>


updateDomainRaw

updateDomainRaw(requestParameters, initOverrides?): Promise<ApiResponse<DomainDto>>

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. Update a domain

Parameters

Name Type
requestParameters UpdateDomainRequest
initOverrides? RequestInit

Returns

Promise<ApiResponse<DomainDto>>


withMiddleware

withMiddleware<T>(this, ...middlewares): T

Type parameters

Name Type
T extends BaseAPI<T>

Parameters

Name Type
this T
...middlewares Middleware[]

Returns

T

Inherited from

BaseAPI.withMiddleware


withPostMiddleware

withPostMiddleware<T>(this, ...postMiddlewares): T

Type parameters

Name Type
T extends BaseAPI<T>

Parameters

Name Type
this T
...postMiddlewares (context: ResponseContext) => Promise<void

Returns

T

Inherited from

BaseAPI.withPostMiddleware


withPreMiddleware

withPreMiddleware<T>(this, ...preMiddlewares): T

Type parameters

Name Type
T extends BaseAPI<T>

Parameters

Name Type
this T
...preMiddlewares (context: RequestContext) => Promise<void

Returns

T

Inherited from

BaseAPI.withPreMiddleware