Constructor Detail

• DomainControllerApi

  DomainControllerApi(String xApiKey, String basePath)

Method Detail

• getBaseUrl

   final String getBaseUrl()

• addDomainWildcardCatchAll

   final DomainDto addDomainWildcardCatchAll(UUID id)

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

• addDomainWildcardCatchAllRequestConfig

   final RequestConfig addDomainWildcardCatchAllRequestConfig(UUID id)

  To obtain the request config of the operation addDomainWildcardCatchAll

• createDomain

   final DomainDto createDomain(CreateDomainOptions createDomainOptions)

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

• createDomainRequestConfig

   final RequestConfig createDomainRequestConfig(CreateDomainOptions createDomainOptions)

  To obtain the request config of the operation createDomain

• deleteDomain

   final List<String> deleteDomain(UUID id)

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

• deleteDomainRequestConfig

   final RequestConfig deleteDomainRequestConfig(UUID id)

  To obtain the request config of the operation deleteDomain

• getDomain

   final DomainDto getDomain(UUID id)

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

• getDomainRequestConfig

   final RequestConfig getDomainRequestConfig(UUID id)

  To obtain the request config of the operation getDomain

• getDomains

   final List<DomainPreview> getDomains()

  Get domains List all custom domains you have created

• getDomainsRequestConfig

   final RequestConfig getDomainsRequestConfig()

  To obtain the request config of the operation getDomains

• updateDomain

   final DomainDto updateDomain(UUID id, UpdateDomainOptions updateDomainOptions)

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

• updateDomainRequestConfig

   final RequestConfig updateDomainRequestConfig(UUID id, UpdateDomainOptions updateDomainOptions)

  To obtain the request config of the operation updateDomain