javax.mail.search

Class BodyTerm

Implemented Interfaces:
Serializable

public final class BodyTerm
extends StringTerm

This class implements searches on Message Body. Body searches are done only for: (1) single-part messages whose primary-type is Text OR (2) multipart/mixed messages whose first body-part's primary-type is Text. In this case, the search is done on the first body-part.

Field Summary

Fields inherited from class javax.mail.search.StringTerm

ignoreCase, pattern

Constructor Summary

BodyTerm(String pattern)
Constructor

Method Summary

boolean
equals(Object other)
Equality comparison.
boolean
match(Message msg)
The match method.

Methods inherited from class javax.mail.search.StringTerm

equals, getIgnoreCase, getPattern, hashCode, match

Methods inherited from class javax.mail.search.SearchTerm

match

Constructor Details

BodyTerm

public BodyTerm(String pattern)
Constructor

Parameters:
pattern - The String to search for

Method Details

equals

public boolean equals(Object other)
Equality comparison.
Overrides:
equals in interface StringTerm


match

public boolean match(Message msg)
The match method.
Overrides:
match in interface SearchTerm

Parameters:
msg - The pattern search is applied on this Message's body

Returns:
true if the pattern is found; otherwise false