CreateDomainOptions

Properties

NameTypeDescriptionNotes
CreatedCatchAllInboxBooleanWhether 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.[optional]
DescriptionStringOptional description of the domain.[optional]
DomainStringThe top level domain you wish to use with MailSlurp. Do not specify subdomain just the top level. So test.com covers all subdomains such as mail.test.com. Don’t include a protocol such as http://. Once added you must complete the verification steps by adding the returned records to your domain.[optional]
DomainTypeStringDomain type to create. HTTP or SMTP domain. HTTP domain uses MailSlurps SES MX records. SMTP uses a custom SMTP server MX record. SMTP domains can only be used with SMTP inboxes. SMTP inboxes are more reliable for public inbound emails while HTTP inboxes are more suitable for testing.[optional]

Examples

  • Prepare the resource
$CreateDomainOptions = Initialize-maislurp-client-powershellCreateDomainOptions  -CreatedCatchAllInbox null `
 -Description null `
 -Domain null `
 -DomainType null
  • Convert the resource to JSON
$CreateDomainOptions | ConvertTo-JSON

[Back to Model list] [Back to API list] [Back to ]