Top Description Fields Constructors Methods
javax.mail.search

public final Class MessageIDTerm

extends StringTerm
Class Inheritance
Imports
javax.mail.Message
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.

Authors
Bill Shannon, John Mani

Field Summary

Modifier and TypeField and Description
private static final long
serialVersionUID

Hides javax.mail.search.StringTerm.serialVersionUID.

Inherited from javax.mail.search.StringTerm:
ignoreCasepattern

Constructor Summary

AccessConstructor and Description
public
MessageIDTerm(String
the msgid to search for
msgid)

Constructor.

Method Summary

Modifier and TypeMethod and Description
public boolean
equals(Object
the reference object with which to compare.
obj)

Overrides javax.mail.search.StringTerm.equals.

Equality comparison.
public boolean

Returns:

true if the match succeeds, otherwise false
match(Message
the match is applied to this Message's Message-ID header
msg)

Implements abstract javax.mail.search.SearchTerm.match.

The match method.
Inherited from javax.mail.search.StringTerm:
getIgnoreCasegetPatternhashCodematch

Field Detail

serialVersionUIDback to summary
private static final long serialVersionUID

Hides javax.mail.search.StringTerm.serialVersionUID.

Constructor Detail

MessageIDTermback to summary
public MessageIDTerm(String msgid)

Constructor.

Parameters
msgid:String

the msgid to search for

Method Detail

equalsback to summary
public boolean equals(Object obj)

Overrides javax.mail.search.StringTerm.equals.

Equality comparison.

Parameters
obj:Object

Doc from java.lang.Object.equals.

the reference object with which to compare.

Returns:boolean

Doc from java.lang.Object.equals.

true if this object is the same as the obj argument; false otherwise.

Annotations
@Override
matchback to summary
public boolean match(Message msg)

Implements abstract javax.mail.search.SearchTerm.match.

The match method.

Parameters
msg:Message

the match is applied to this Message's Message-ID header

Returns:boolean

true if the match succeeds, otherwise false

Annotations
@Override