CreateAliasOptions class

Constructors

CreateAliasOptions({required String emailAddress, String? inboxId, String? name, required bool useThreads})
Returns a new CreateAliasOptions instance.

Properties

emailAddress String
Email address to be hidden behind alias. Emails sent to the alias email address will be forwarded to this address. If you want to enable replies set useThreads true and the reply-to for the email will allow outbound communication via a thread. Some email addresses may require verification if they are not added as a contact first.
getter/setter pair
hashCode int
The hash code for this object.
no setteroverride
inboxId String?
Optional inbox ID to attach to alias. Null by default means an a new inbox will be created for the alias. Use a custom inbox to control what email address the alias uses. To use custom email addresses create a domain and an inbox, the use the inbox ID with this call. Emails received by this inbox will be forwarded to the alias email address
getter/setter pair
name String?
Optional name for alias
getter/setter pair
runtimeType Type
A representation of the runtime type of the object.
no setterinherited
useThreads bool
Enable threads options. If true emails will be sent with a unique reply-to thread address. This means you can reply to the forwarded email and it will be sent to the recipients via your alias address. That way a thread conversation is preserved.
getter/setter pair

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) CreateAliasOptions?
Returns a new CreateAliasOptions instance and imports its values from value if it's a Map, null otherwise.
listFromJson(dynamic json, {bool growable = false}) List<CreateAliasOptions>?
mapFromJson(dynamic json) Map<String, CreateAliasOptions>
mapListFromJson(dynamic json, {bool growable = false}) Map<String, List<CreateAliasOptions>>

Constants

requiredKeys → const Set<String>
The list of required keys that must be present in a JSON.