EmailPreview class

Constructors

EmailPreview({required String id, String? domainId, String? subject, List<String>? to = const [], String? from, List<String>? bcc = const [], List<String>? cc = const [], required DateTime createdAt, required bool read, List<String>? attachments = const []})

Returns a new EmailPreview instance.

Properties

attachments ↔ List<String>?

List of IDs of attachments found in the email. Use these IDs with the Inbox and Email Controllers to download attachments and attachment meta data such as filesize, name, extension.

getter/setter pair

bcc ↔ List<String>?

List of BCC recipients email addresses that the email was addressed to. See recipients object for names.

getter/setter pair

cc ↔ List<String>?

List of CC recipients email addresses that the email was addressed to. See recipients object for names.

getter/setter pair

createdAt ↔ DateTime

When was the email received by MailSlurp

getter/setter pair

domainId ↔ String?

ID of the domain that received the email

getter/setter pair

from ↔ String?

Who the email was sent from. An email address - see fromName for the sender name.

getter/setter pair

hashCode → int

The hash code for this object.

no setter, override

id ↔ String

ID of the email entity

getter/setter pair

read ↔ bool

Read flag. Has the email ever been viewed in the dashboard or fetched via the API with a hydrated body? If so the email is marked as read. Paginated results do not affect read status. Read status is different to email opened event as it depends on your own account accessing the email. Email opened is determined by tracking pixels sent to other uses if enable during sending. You can listened for both email read and email opened events using webhooks.

getter/setter pair

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

subject ↔ String?

The subject line of the email message as specified by SMTP subject header

getter/setter pair

to ↔ List<String>?

List of To recipient email addresses that the email was addressed to. See recipients object for names.

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) → EmailPreview?

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

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

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

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

Constants

requiredKeys → const Set<String>

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