javax.mail.search.FromStringTerm Maven / Gradle / Ivy
/*
* Copyright (c) 1997, 2020 Oracle and/or its affiliates. All rights reserved.
*
* This program and the accompanying materials are made available under the
* terms of the Eclipse Public License v. 2.0, which is available at
* http://www.eclipse.org/legal/epl-2.0.
*
* This Source Code may also be made available under the following Secondary
* Licenses when the conditions for such availability set forth in the
* Eclipse Public License v. 2.0 are satisfied: GNU General Public License,
* version 2 with the GNU Classpath Exception, which is available at
* https://www.gnu.org/software/classpath/license.html.
*
* SPDX-License-Identifier: EPL-2.0 OR GPL-2.0 WITH Classpath-exception-2.0
*/
package jakarta.mail.search;
import jakarta.mail.Message;
import jakarta.mail.Address;
/**
* This class implements string comparisons for the From Address
* header.
*
* Note that this class differs from the FromTerm class
* in that this class does comparisons on address strings rather than Address
* objects. The string comparisons are case-insensitive.
*
* @since JavaMail 1.1
*/
public final class FromStringTerm extends AddressStringTerm {
private static final long serialVersionUID = 5801127523826772788L;
/**
* Constructor.
*
* @param pattern the address pattern to be compared.
*/
public FromStringTerm(String pattern) {
super(pattern);
}
/**
* Check whether the address string specified in the constructor is
* a substring of the From address of this Message.
*
* @param msg The comparison is applied to this Message's From
* address.
* @return true if the match succeeds, otherwise false.
*/
@Override
public boolean match(Message msg) {
Address[] from;
try {
from = msg.getFrom();
} catch (Exception e) {
return false;
}
if (from == null)
return false;
for (int i=0; i < from.length; i++)
if (super.match(from[i]))
return true;
return false;
}
/**
* Equality comparison.
*/
@Override
public boolean equals(Object obj) {
if (!(obj instanceof FromStringTerm))
return false;
return super.equals(obj);
}
}