Module jakarta.mail

Package jakarta.mail.search

Class BodyTerm

java.lang.Object

jakarta.mail.search.SearchTerm

jakarta.mail.search.StringTerm

jakarta.mail.search.BodyTerm

All Implemented Interfaces:

Serializable

public final class BodyTerm
extends StringTerm

This class implements searches on a message body. All parts of the message that are of MIME type "text/*" are searched. The pattern is a simple string that must appear as a substring in the message body.

See Also:

• Serialized Form

Field Summary

Fields inherited from class jakarta.mail.search.StringTerm

ignoreCase, pattern

Constructor Summary

Constructors

Constructor	Description
BodyTerm(String pattern)	Constructor

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object obj)	Equality comparison.
boolean	match(Message msg)	The match method.

Methods inherited from class jakarta.mail.search.StringTerm

getIgnoreCase, getPattern, hashCode, match

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Constructor Details

BodyTerm

public BodyTerm(String pattern)

Constructor

Parameters:

pattern - The String to search for

Method Details

match

public boolean match(Message msg)

The match method.

Specified by:

match in class SearchTerm

Parameters:

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

Returns:

true if the pattern is found; otherwise false

equals

public boolean equals(Object obj)

Equality comparison.

Overrides:

equals in class StringTerm