RecipientTerm (GNU JavaMail API documentation)

java.lang.Object
- javax.mail.search.SearchTerm
- - javax.mail.search.AddressTerm
  - - javax.mail.search.RecipientTerm

All Implemented Interfaces:

java.io.Serializable
```
public final class RecipientTerm
extends AddressTerm
```
A comparison of recipient headers in a message.

Version:

1.4

Author:

Chris Burdess

See Also:

Serialized Form

Field Summary

Fields
Modifier and Type Field Description

protected Message.RecipientType type
The recipient type.
- Fields inherited from class javax.mail.search.AddressTerm
  address

Constructor Summary

Constructors
Constructor Description

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

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`boolean`	`equals(java.lang.Object other)`
`Message.RecipientType`	`getRecipientType()`	Returns the recipient type.
`int`	`hashCode()`
`boolean`	`match(Message msg)`	Returns true only if the recipient address in the given message matches the address specified in this term.

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

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

- 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
- Method Detail
  - getRecipientType
```
public Message.RecipientType getRecipientType()
```
    Returns the recipient type.
  - match
```
public boolean match(Message msg)
```
    Returns true only if the recipient address in the given message matches the address specified in this term.
    
    Specified by:
    
    match in class SearchTerm
  - equals
```
public boolean equals(java.lang.Object other)
```
    Overrides:
    
    equals in class AddressTerm
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class AddressTerm