ReturnOption class
Return option definition for extended commands.
Constructors
-
ReturnOption(String name, {List<
String> ? parameters, bool isSingleParam = false}) - Creates a new return option
- ReturnOption.all()
- Returns all the message ids or UIDs that satisfies the search parameters.
- ReturnOption.children()
- Returns mailbox child information as flags "\HasChildren", "\HasNoChildren".
- ReturnOption.count()
- Returns the match count of the search request.
- ReturnOption.max()
- Return the maximum message id or UID that satisfies the search parameters.
- ReturnOption.min()
- Returns the minimum message id or UID satisfying the search parameters.
- ReturnOption.partial(String rangeSet)
- Defines a partial range of the found results.
- ReturnOption.specialUse()
- Creates a new return option
-
ReturnOption.status([List<
String> ? parameters]) - Returns given STATUS information of all matching mailbox names.
- ReturnOption.subscribed()
- Returns subscription state of all matching mailbox names.
Properties
- hashCode → int
-
The hash code for this object.
no setterinherited
- isSingleParam → bool
-
If set, the option allows only one parameter not enclosed by "()".
final
- name → String
-
The name of this option
final
-
parameters
→ List<
String> ? -
Optional list of return option parameters.
final
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
Methods
-
add(
String parameter) → void -
Adds the given
parameter -
addAll(
List< String> parameters) → void - Adds all parameters
-
hasParameter(
String parameter) → bool -
Checks of this return options has the specified
parameter -
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
toString(
) → String -
A string representation of this object.
override
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited