SubjectTerm (JavaMail API documentation)

This documentation differs from the official API. Jadeite adds extra features to the API including: variable font sizes, constructions examples, placeholders for classes and methods, and auto-generated “See Also” links. Additionally it is missing some items found in standard Javadoc documentation, including: generics type information, “Deprecated” tags and comments, “See Also” links, along with other minor differences. Please send any questions or feedback to bam@cs.cmu.edu.

Overview

Package

Class

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

javax.mail.search
class SubjectTerm

javax.mail.search.SearchTerm
  javax.mail.search.StringTerm
      javax.mail.search.SubjectTerm

All Implemented Interfaces:: Serializable

Most common way to construct:

String pattern = …;

SubjectTerm st = new SubjectTerm(pattern);

Based on 6 examples

public final class SubjectTerm
extends StringTerm

This class implements comparisons for the Message Subject header. The comparison is case-insensitive.

See Also (auto-generated):

Session

Folder

Message

Field Summary

Fields inherited from class javax.mail.search.StringTerm
`ignoreCase, pattern`

Constructor Summary
`SubjectTerm(String pattern)` Constructor.

Method Summary
`boolean`	`equals(Object obj)` 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 Detail

SubjectTerm

public SubjectTerm(String pattern)

Constructor.

Parameters:: pattern - the pattern to search for

Method Detail

equals

public boolean equals(Object obj)

Equality comparison.

Overrides:: equals in class StringTerm
Parameters:: obj

match

public boolean match(Message msg)

The match method.

Overrides:: match in class SearchTerm
Parameters:: msg - the pattern match is applied to this Message's subject header
Returns:: true if the pattern match succeeds, otherwise false