Module jakarta.mail

Class RecipientStringTerm

  • All Implemented Interfaces:

    public final class RecipientStringTerm
    extends AddressStringTerm
    This class implements string comparisons for the Recipient Address headers.

    Note that this class differs from the RecipientTerm class in that this class does comparisons on address strings rather than Address objects. The string comparisons are case-insensitive.

    See Also:
    Serialized Form
    • Constructor Detail

      • RecipientStringTerm

        public RecipientStringTerm​(Message.RecipientType type,
                                   java.lang.String pattern)
        type - the recipient type
        pattern - the address pattern to be compared.
    • Method Detail

      • getRecipientType

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

        public boolean match​(Message msg)
        Check whether the address specified in the constructor is a substring of the recipient address of this Message.
        Specified by:
        match in class SearchTerm
        msg - The comparison is applied to this Message's recipient address.
        true if the match succeeds, otherwise false.
      • equals

        public boolean equals​(java.lang.Object obj)
        Equality comparison.
        equals in class AddressStringTerm
      • hashCode

        public int hashCode()
        Compute a hashCode for this object.
        hashCode in class StringTerm