MailSearchResult class
Contains the result of a search
- Inheritance
-
- Object
- PagedMessageResult
- MailSearchResult
Constructors
-
MailSearchResult(MailSearch search, PagedMessageSequence pagedSequence, List<
MimeMessage> messages, FetchPreference fetchPreference) - Creates a new search result
- MailSearchResult.empty(MailSearch search)
- Creates a new empty search result
Properties
- fetchPreference → FetchPreference
-
The original fetch preference
finalinherited
- hashCode → int
-
The hash code for this object.
no setterinherited
- hasMoreResults → bool
-
Checks if the
messageSequence
has a next pageno setterinherited - isEmpty → bool
-
Checks if this result is empty
no setterinherited
- isNotEmpty → bool
-
Checks if this result is not empty
no setterinherited
- isUidBased → bool
-
Shortcut to find out if this search result is UID based
no setterinherited
- length → int
-
The number of all matching messages
no setterinherited
-
messages
→ List<
MimeMessage> -
The fetched messages, initially this contains only the first page
finalinherited
- pagedSequence → PagedMessageSequence
-
The message sequence containing all IDs or UIDs, may be null
for empty searches
finalinherited
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
- search → MailSearch
-
The original search
final
Methods
-
addMessage(
MimeMessage message) → void -
Adds the specified message to this search result.
inherited
-
getMessage(
int messageIndex, MailClient mailClient, {Mailbox? mailbox, FetchPreference fetchPreference = FetchPreference.envelope}) → Future< MimeMessage> -
Retrieves the message at the given index.
inherited
-
insertAll(
List< MimeMessage> page) → void -
Inserts the given
page
of messages to this resultinherited -
isAvailable(
int messageIndex) → bool -
Checks if the message for the given
messageIndex
is already loaded.inherited -
isPageRequestedFor(
int messageIndex) → bool -
Checks if the page for the given
messageIndex
is already requested.inherited -
messageIdAt(
int messageIndex) → int -
Retrieves the message ID at the specified
messageIndex
.inherited -
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
removeMessage(
MimeMessage message) → void -
Adds the specified message to this search result.
inherited
-
removeMessageSequence(
MessageSequence removeSequence) → List< MimeMessage> -
Removes the specified
removeSequence
from this result and returns all messages that have been loaded.inherited -
toString(
) → String -
A string representation of this object.
inherited
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited
-
operator [](
int messageIndex) → MimeMessage -
Retrieves the message for the given
messageIndex
.inherited