SearchTerm

extends Object
implements Serializable

java.lang.Object
↳	com.google.code.javax.mail.search.SearchTerm

Known Direct Subclasses

AddressTerm, AndTerm, ComparisonTerm, FlagTerm, GmailSearchTerm, NotTerm, OrTerm, StringTerm

Known Indirect Subclasses

AddressStringTerm, BodyTerm, DateTerm, FromStringTerm, FromTerm, GmailLabelTerm, GmailMessageIDTerm, GmailRawSearchTerm, GmailThreadIDTerm, HeaderTerm, IntegerComparisonTerm, MessageIDTerm, MessageNumberTerm, ReceivedDateTerm, RecipientStringTerm, RecipientTerm, SentDateTerm, SizeTerm, SubjectTerm

AddressStringTerm	This abstract class implements string comparisons for Message addresses.
BodyTerm	This class implements searches on a message body.
DateTerm	This class implements comparisons for Dates
FromStringTerm	This class implements string comparisons for the From Address header.
FromTerm	This class implements comparisons for the From Address header.
GmailLabelTerm
GmailMessageIDTerm
GmailRawSearchTerm
GmailThreadIDTerm
HeaderTerm	This class implements comparisons for Message headers.
IntegerComparisonTerm	This class implements comparisons for integers.
MessageIDTerm	This term models the RFC822 "MessageId" - a message-id for Internet messages that is supposed to be unique per message.
MessageNumberTerm	This class implements comparisons for Message numbers.
ReceivedDateTerm	This class implements comparisons for the Message Received date
RecipientStringTerm	This class implements string comparisons for the Recipient Address headers.
RecipientTerm	This class implements comparisons for the Recipient Address headers.
SentDateTerm	This class implements comparisons for the Message SentDate.
SizeTerm	This class implements comparisons for Message sizes.
SubjectTerm	This class implements comparisons for the message Subject header.

Class Overview

Search criteria are expressed as a tree of search-terms, forming a parse-tree for the search expression.

Search-terms are represented by this class. This is an abstract class; subclasses implement specific match methods.

Search terms are serializable, which allows storing a search term between sessions. Warning: Serialized objects of this class may not be compatible with future JavaMail API releases. The current serialization support is appropriate for short term storage.

Warning: Search terms that include references to objects of type Message.RecipientType will not be deserialized correctly on JDK 1.1 systems. While these objects will be deserialized without throwing any exceptions, the resulting objects violate the type-safe enum contract of the Message.RecipientType class. Proper deserialization of these objects depends on support for the readReplace method, added in JDK 1.2.

Summary

Constants
long	serialVersionUID

Public Constructors
	SearchTerm()

Public Methods
abstract boolean	match(Message msg) This method applies a specific match criterion to the given message and returns the result.

[Expand]

Inherited Methods

From class java.lang.Object

Constants

private static final long serialVersionUID

Constant Value: -6652358452205992789 (0xa3ae133bc1b1c4ab)

Public Constructors

public SearchTerm ()

Public Methods

public abstract boolean match (Message msg)

This method applies a specific match criterion to the given message and returns the result.

Parameters

msg	The match criterion is applied on this message

Returns

true, it the match succeeds, false if the match fails

Classes

Exceptions