MessageIDTerm (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 MessageIDTerm

javax.mail.search.SearchTerm
  javax.mail.search.StringTerm
      javax.mail.search.MessageIDTerm

All Implemented Interfaces:: Serializable

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.

Field Summary

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

Constructor Summary
`MessageIDTerm(String msgid)` 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

MessageIDTerm

public MessageIDTerm(String msgid)

Constructor.

Parameters:: msgid - the msgid 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 match is applied to this Message's Message-ID header
Returns:: true if the match succeeds, otherwise false