Java 2 Platform EE v1.3: Class BodyTerm - Java Platform, Enterprise Edition v1.3.1 API Specifications

Overview

Package

Class

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: INNER | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

javax.mail.search
Class BodyTerm

java.lang.Object
  |
  +--javax.mail.search.SearchTerm
        |
        +--javax.mail.search.StringTerm
              |
              +--javax.mail.search.BodyTerm

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.

Fields inherited from class javax.mail.search.StringTerm

ignoreCase, pattern

Constructor Summary

BodyTerm(java.lang.String pattern)
Constructor

Method Summary

boolean match(Message msg)
The match method.

Methods inherited from class javax.mail.search.StringTerm

getIgnoreCase, getPattern, match

Methods inherited from class java.lang.Object

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

Constructor Detail

BodyTerm

public BodyTerm(java.lang.String pattern)

Constructor

Parameters:: pattern - The String to search for

Method Detail

match

public boolean match(Message msg)

The match method.

Overrides:: 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