javax.mail.search
Class BodyTerm

java.lang.Object
  extended by javax.mail.search.SearchTerm
      extended by javax.mail.search.StringTerm
          extended by javax.mail.search.BodyTerm
All Implemented Interfaces:
java.io.Serializable

public final class BodyTerm
extends StringTerm

A textual search of the message content. Body searches are done only on:

  1. single-part messages whose primary-type is text OR
  2. multipart/mixed messages whose first body part's primary-type is text.

See Also:
Serialized Form

Field Summary
 
Fields inherited from class javax.mail.search.StringTerm
ignoreCase, pattern
 
Constructor Summary
BodyTerm(java.lang.String pattern)
          Constructor.
 
Method Summary
 boolean equals(java.lang.Object other)
           
 boolean match(Message msg)
          Returns true only if the search text was found in the message body.
 
Methods inherited from class javax.mail.search.StringTerm
getIgnoreCase, getPattern, hashCode, match
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

BodyTerm

public BodyTerm(java.lang.String pattern)
Constructor.

Parameters:
pattern - the text to search for
Method Detail

match

public boolean match(Message msg)
Returns true only if the search text was found in the message body.

Specified by:
match in class SearchTerm

equals

public boolean equals(java.lang.Object other)
Overrides:
equals in class StringTerm