Class DomainControllerApi

Hierarchy

Constructors

Properties

configuration: Configuration = ...

Methods

  • 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

    Returns 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

    Returns Promise<ApiResponse<DomainDto>>

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

    Parameters

    Returns Promise<string[]>

  • 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

    Returns Promise<DomainDto>