Java 2 Platform EE v1.3: Class MessageIDTerm - 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 MessageIDTerm

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

public final class MessageIDTerm
extends StringTerm

This term models the RFC822 "MessageId" - a message-id for Internet messages that is supposed to be unique per message. Clients can use this term to search a folder for a message given its MessageId.

The MessageId is represented as a String.

Fields inherited from class javax.mail.search.StringTerm

ignoreCase, pattern

Constructor Summary

MessageIDTerm(java.lang.String msgid)
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

MessageIDTerm

public MessageIDTerm(java.lang.String msgid)

Constructor.

Parameters:: msgid - the msgid to search for

Method Detail

match

public boolean match(Message msg)

The match method.

Overrides:: match in class SearchTerm

Parameters:: msg - the match is applied to this Message's Message-ID header
Returns:: true if the match succeeds, otherwise false