javax.mail.search

Class FromStringTerm

Implemented Interfaces:
Serializable

public final class FromStringTerm
extends AddressStringTerm

This class implements string comparisons for the From Address header.

Note that this class differs from the FromTerm class in that this class does comparisons on address strings rather than Address objects. The string comparisons are case-insensitive.

Field Summary

Fields inherited from class javax.mail.search.StringTerm

ignoreCase, pattern

Constructor Summary

FromStringTerm(String pattern)
Constructor.

Method Summary

boolean
equals(Object other)
Equality comparison.
boolean
match(Message msg)
Check whether the address string specified in the constructor is a substring of the From address of this Message.

Methods inherited from class javax.mail.search.AddressStringTerm

equals, match

Methods inherited from class javax.mail.search.StringTerm

equals, getIgnoreCase, getPattern, hashCode, match

Methods inherited from class javax.mail.search.SearchTerm

match

Constructor Details

FromStringTerm

public FromStringTerm(String pattern)
Constructor.

Parameters:

Method Details

equals

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


match

public boolean match(Message msg)
Check whether the address string specified in the constructor is a substring of the From address of this Message.
Overrides:
match in interface SearchTerm

Parameters:
msg - The comparison is applied to this Message's From address.

Returns:
true if the match succeeds, otherwise false.