Module jakarta.mail

Package jakarta.mail.search

Class MessageIDTerm

java.lang.Object

jakarta.mail.search.SearchTerm

jakarta.mail.search.StringTerm

jakarta.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.

See Also:

• Serialized Form

Field Summary

Fields inherited from class jakarta.mail.search.StringTerm

ignoreCase, pattern

Constructor Summary

Constructors

Constructor	Description
MessageIDTerm(String msgid)	Constructor.

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object obj)	Equality comparison.
boolean	match(Message msg)	The match method.

Methods inherited from class jakarta.mail.search.StringTerm

getIgnoreCase, getPattern, hashCode, match

Methods inherited from class java.lang.Object

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

Constructor Details

MessageIDTerm

public MessageIDTerm(String msgid)

Constructor.

Parameters:

msgid - the msgid to search for

Method Details

match

public boolean match(Message msg)

The match method.

Specified by:

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

equals

public boolean equals(Object obj)

Equality comparison.

Overrides:

equals in class StringTerm