MailSearch class

Abstracts a typical mail search

Constructors

MailSearch(String query, SearchQueryType queryType, {SearchMessageType? messageType, DateTime? since, DateTime? before, DateTime? sentSince, DateTime? sentBefore, int pageSize = 20, FetchPreference fetchPreference = FetchPreference.envelope})
Creates a new search for query in the fields defined by queryType.
const

Properties

before → DateTime?
Until which internal date a message matches
final
fetchPreference → FetchPreference
The fetch preference for loading the search results
final
hashCode → int
The hash code for this object.
no setterinherited
messageType → SearchMessageType?
Which message types should be used for this query - defaults to any.
final
pageSize → int
The number of messages that are loaded initially
final
query → String
The query text
final
queryType → SearchQueryType
Which message fields should be used for this query.
final
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
sentBefore → DateTime?
Until which internal sent date a message matches
final
sentSince → DateTime?
From which internal sent date a message matches
final
since → DateTime?
From which internal date onward a message matches
final

Methods

copyWith({String? query, SearchQueryType? queryType, SearchMessageType? messageType, DateTime? before, DateTime? since, DateTime? sentBefore, DateTime? sentSince, int? pageSize}) → MailSearch
Copies this search with the specified different parameters.
matches(MimeMessage message) → bool
Checks a new incoming message if it matches this query
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
toString() → String
A string representation of this object.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited