javax.mail.search
Class RecipientTerm


java.lang.Object

  |

  +--javax.mail.search.SearchTerm

        |

        +--javax.mail.search.AddressTerm

              |

              +--javax.mail.search.RecipientTerm


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
 Message.RecipientType getRecipientType()
          Return the type of recipient to match with.
 boolean match(Message msg)
          The match method.
 
Methods inherited from class javax.mail.search.AddressTerm
getAddress, match
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, 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 for
Method Detail

getRecipientType


public Message.RecipientType getRecipientType()
Return the type of recipient to match with.

match


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