HeaderTerm (Jakarta Mail API documentation)

java.lang.Object
- jakarta.mail.search.SearchTerm
- - jakarta.mail.search.StringTerm
  - - jakarta.mail.search.HeaderTerm

All Implemented Interfaces:

java.io.Serializable
```
public final class HeaderTerm
extends StringTerm
```
This class implements comparisons for Message headers. The comparison is case-insensitive.

Author:

Bill Shannon, John Mani

See Also:

Serialized Form

Field Summary
- Fields inherited from class jakarta.mail.search.StringTerm
  ignoreCase, pattern

Constructor Summary

Constructors
Constructor Description

HeaderTerm(java.lang.String headerName, java.lang.String pattern)
Constructor.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`boolean`	`equals(java.lang.Object obj)`	Equality comparison.
`java.lang.String`	`getHeaderName()`	Return the name of the header to compare with.
`int`	`hashCode()`	Compute a hashCode for this object.
`boolean`	`match(Message msg)`	The header match method.

Methods inherited from class jakarta.mail.search.StringTerm
getIgnoreCase, getPattern, match

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

- Constructor Detail
  - HeaderTerm
```
public HeaderTerm(java.lang.String headerName,
                  java.lang.String pattern)
```
    Constructor.
    
    Parameters:
    
    headerName - The name of the header
    
    pattern - The pattern to search for
- Method Detail
  - getHeaderName
```
public java.lang.String getHeaderName()
```
    Return the name of the header to compare with.
    
    Returns:
    
    the name of the header
  - match
```
public boolean match(Message msg)
```
    The header match method.
    
    Specified by:
    
    match in class SearchTerm
    
    Parameters:
    
    msg - The match is applied to this Message's header
    
    Returns:
    
    true if the match succeeds, otherwise false
  - equals
```
public boolean equals(java.lang.Object obj)
```
    Equality comparison.
    
    Overrides:
    
    equals in class StringTerm
  - hashCode
```
public int hashCode()
```
    Compute a hashCode for this object.
    
    Overrides:
    
    hashCode in class StringTerm