Module mailslurp::apis::domain_controller_api[][src]

Structs

AddDomainWildcardCatchAllParams

struct for passing parameters to the method add_domain_wildcard_catch_all

CreateDomainParams

struct for passing parameters to the method create_domain

DeleteDomainParams

struct for passing parameters to the method delete_domain

GetDomainParams

struct for passing parameters to the method get_domain

UpdateDomainParams

struct for passing parameters to the method update_domain

Enums

AddDomainWildcardCatchAllError

struct for typed errors of method add_domain_wildcard_catch_all

CreateDomainError

struct for typed errors of method create_domain

DeleteDomainError

struct for typed errors of method delete_domain

GetDomainError

struct for typed errors of method get_domain

GetDomainsError

struct for typed errors of method get_domains

UpdateDomainError

struct for typed errors of method update_domain

Functions

add_domain_wildcard_catch_all

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

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.

delete_domain

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

get_domain

Returns domain verification status and tokens for a given domain

get_domains

List all custom domains you have created

update_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.