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

javax.mail.search.SearchTerm
  javax.mail.search.AddressTerm
      javax.mail.search.RecipientTerm

All Implemented Interfaces:: Serializable

public final class RecipientTerm
extends AddressTerm

This class implements comparisons for the Recipient Address headers.

Field Summary
`protected Message.RecipientType`	`type` The recipient type.

Fields inherited from class javax.mail.search.AddressTerm
`address`

Constructor Summary
`RecipientTerm(Message.RecipientType type, Address address)` Constructor.

Method Summary
`boolean`	`equals(Object obj)` Equality comparison.
`Message.RecipientType`	`getRecipientType()` Return the type of recipient to match with.
`int`	`hashCode()` Compute a hashCode for this object.
`boolean`	`match(Message msg)` The match method.

Methods inherited from class javax.mail.search.AddressTerm
`equals, getAddress, hashCode, match`

Methods inherited from class javax.mail.search.SearchTerm
`match`

Field Detail

type

protected Message.RecipientType type

The recipient type.

Constructor Detail

RecipientTerm

public RecipientTerm(Message.RecipientType type,
                     Address address)

Constructor.

Parameters:: type - the recipient type; address - the address to match for

Method Detail

equals

public boolean equals(Object obj)

Equality comparison.

Overrides:: equals in class AddressTerm
Parameters:: obj

getRecipientType

public Message.RecipientType getRecipientType()

Return the type of recipient to match with.

hashCode

public int hashCode()

Compute a hashCode for this object.

Overrides:: hashCode in class AddressTerm

match

public boolean match(Message msg)

The match method.

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