InboxDto class

Constructors

InboxDto({required String id, String? userId, required DateTime createdAt, String? name, String? domainId, String? description, required String emailAddress, String? expiresAt, required bool favourite, List<String>? tags = const [], InboxDtoInboxTypeEnum? inboxType, required bool readOnly, required bool virtualInbox})

Returns a new InboxDto instance.

Properties

createdAt ↔ DateTime

When the inbox was created. Time stamps are in ISO DateTime Format yyyy-MM-dd'T'HH:mm:ss.SSSXXX e.g. 2000-10-31T01:30:00.000-05:00.

getter/setter pair

description ↔ String?

Description of an inbox for labelling and searching purposes

getter/setter pair

domainId ↔ String?

ID of custom domain used by the inbox if any

getter/setter pair

emailAddress ↔ String

The inbox's email address. Inbox projections and previews may not include the email address. To view the email address fetch the inbox entity directly. Send an email to this address and the inbox will receive and store it for you. Note the email address in MailSlurp match characters exactly and are case sensitive so +123 additions are considered different addresses. To retrieve the email use the Inbox and Email Controller endpoints with the inbox ID.

getter/setter pair

expiresAt ↔ String?

Inbox expiration time. When, if ever, the inbox should expire and be deleted. If null then this inbox is permanent and the emails in it won't be deleted. This is the default behavior unless expiration date is set. If an expiration date is set and the time is reached MailSlurp will expire the inbox and move it to an expired inbox entity. You can still access the emails belonging to it but it can no longer send or receive email.

getter/setter pair

favourite ↔ bool

Is the inbox a favorite inbox. Make an inbox a favorite is typically done in the dashboard for quick access or filtering

getter/setter pair

hashCode → int

The hash code for this object.

no setter, override

id ↔ String

ID of the inbox. The ID is a UUID-V4 format string. Use the inboxId for calls to Inbox and Email Controller endpoints. See the emailAddress property for the email address or the inbox. To get emails in an inbox use the WaitFor and Inbox Controller methods waitForLatestEmail and getEmails methods respectively. Inboxes can be used with aliases to forward emails automatically.

getter/setter pair

inboxType ↔ InboxDtoInboxTypeEnum?

Type of inbox. HTTP inboxes are faster and better for most cases. SMTP inboxes are more suited for public facing inbound messages (but cannot send).

getter/setter pair

name ↔ String?

Name of the inbox and used as the sender name when sending emails .Displayed in the dashboard for easier search

getter/setter pair

readOnly ↔ bool

Is the inbox readOnly for the caller. Read only means can not be deleted or modified. This flag is present when using team accounts and shared inboxes.

getter/setter pair

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

tags ↔ List<String>?

Tags that inbox has been tagged with. Tags can be added to inboxes to group different inboxes within an account. You can also search for inboxes by tag in the dashboard UI.

getter/setter pair

userId ↔ String?

ID of user that inbox belongs to

getter/setter pair

virtualInbox ↔ bool

Virtual inbox can receive email but will not send emails to real recipients. Will save sent email record but never send an actual email. Perfect for testing mail server actions.

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

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

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

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

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

Constants

requiredKeys → const Set<String>

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