Skip to content

Interface: CreateDomainOptions

Options for creating a domain to use with MailSlurp. You must have ownership access to this domain in order to verify it. Domains will not function correctly until the domain has been verified. See for help. Domains can be either HTTP or SMTP type. The type of domain determines which inboxes can be used with it. SMTP inboxes use a mail server running while HTTP inboxes are handled by AWS SES.


interface CreateDomainOptions

Table of contents




Optional createdCatchAllInbox: boolean

Whether to create a catch all inbox for the domain. Any email sent to an address using your domain that cannot be matched to an existing inbox you created with the domain will be routed to the created catch all inbox. You can access emails using the regular methods on this inbox ID.

memberof CreateDomainOptions


Optional description: string

Optional description of the domain.

memberof CreateDomainOptions


domain: string

The top level domain you wish to use with MailSlurp. Do not specify subdomain just the top level. So covers all subdomains such as Don't include a protocol such as http://. Once added you must complete the verification steps by adding the returned records to your domain.

memberof CreateDomainOptions


Optional domainType: CreateDomainOptionsDomainTypeEnum

Type of domain. Dictates type of inbox that can be created with domain. HTTP means inboxes are processed using SES while SMTP inboxes use a custom SMTP mail server. SMTP does not support sending so use HTTP for sending emails.

memberof CreateDomainOptions