CreateDomainOptions class

Constructors

CreateDomainOptions({required String domain, String? description, bool? createdCatchAllInbox, CreateDomainOptionsDomainTypeEnum? domainType})

Returns a new CreateDomainOptions instance.

Properties

createdCatchAllInbox ↔ bool?

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.

getter/setter pair

description ↔ String?

Optional description of the domain.

getter/setter pair

domain ↔ String

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

getter/setter pair

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.

getter/setter pair

hashCode → int

The hash code for this object.

no setter, override

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

Methods

noSuchMethod(Invocation invocation) → dynamic

Invoked when a nonexistent method or property is accessed.

inherited

toJson() → Map<String, dynamic>

toString() → String

A string representation of this object.

override

Operators

operator ==(Object other) → bool

The equality operator.

override

Static Methods

fromJson(dynamic value) → CreateDomainOptions?

Returns a new CreateDomainOptions instance and imports its values from value if it's a Map, null otherwise.

listFromJson(dynamic json, {bool growable = false}) → List<CreateDomainOptions>

mapFromJson(dynamic json) → Map<String, CreateDomainOptions>

mapListFromJson(dynamic json, {bool growable = false}) → Map<String, List<CreateDomainOptions>>

Constants

requiredKeys → const Set<String>

The list of required keys that must be present in a JSON.