CreateInboxRulesetOptions class

Constructors

CreateInboxRulesetOptions({required CreateInboxRulesetOptionsScopeEnum scope, required CreateInboxRulesetOptionsActionEnum action, required String target})

Returns a new CreateInboxRulesetOptions instance.

Properties

action ↔ CreateInboxRulesetOptionsActionEnum

Action to be taken when the ruleset matches an email for the given scope. For example: BLOCK action with target * and scope SENDING_EMAILS blocks sending to all recipients. Note ALLOW takes precedent over BLOCK. FILTER_REMOVE is like block but will remove offending email addresses during a send or receive event instead of blocking the action.

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

scope ↔ CreateInboxRulesetOptionsScopeEnum

What type of emails actions to apply ruleset to. Either SENDING_EMAILS or RECEIVING_EMAILS will apply action and target to any sending or receiving of emails respectively.

getter/setter pair

target ↔ String

Target to match emails with. Can be a wild-card type pattern or a valid email address. For instance *@gmail.com matches all gmail addresses while [e-mail] matches one address exactly. The target is applied to every recipient field email address when SENDING_EMAILS is the scope and is applied to sender of email when RECEIVING_EMAILS.

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

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

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

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

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

Constants

requiredKeys → const Set<String>

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