Record Class MailpitSpamAssassinResponse

java.lang.Object

java.lang.Record

io.micronaut.email.mailpit.client.model.MailpitSpamAssassinResponse

Record Components:

error - Error message.

spam - Whether the message is spam.

rules - Matched rules.

score - Spam score.

public record MailpitSpamAssassinResponse(@Nullable String error, boolean spam, @Nullable List<MailpitSpamAssassinRule> rules, double score)
extends Record

Mailpit SpamAssassin check response.

Since:

3.1.0

Constructor Summary

Constructors

Constructor	Description
MailpitSpamAssassinResponse(@Nullable String error, boolean spam, @Nullable List<MailpitSpamAssassinRule> rules, double score)	Creates an instance of a MailpitSpamAssassinResponse record class.

Method Summary

Modifier and Type	Method	Description
final boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
@Nullable String	error()	Returns the value of the error record component.
final int	hashCode()	Returns a hash code value for this object.
@Nullable List<MailpitSpamAssassinRule>	rules()	Returns the value of the rules record component.
double	score()	Returns the value of the score record component.
boolean	spam()	Returns the value of the spam record component.
final String	toString()	Returns a string representation of this record class.

Methods inherited from class Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Details

MailpitSpamAssassinResponse

public MailpitSpamAssassinResponse(@Nullable String error,
 boolean spam,
 @Nullable List<MailpitSpamAssassinRule> rules,
 double score)

Creates an instance of a MailpitSpamAssassinResponse record class.

Parameters:

error - the value for the error record component

spam - the value for the spam record component

rules - the value for the rules record component

score - the value for the score record component

Method Details

toString

public final String toString()

Returns a string representation of this record class. The representation contains the name of the class, followed by the name and value of each of the record components.

Specified by:

toString in class Record

Returns:

a string representation of this object

hashCode

public final int hashCode()

Returns a hash code value for this object. The value is derived from the hash code of each of the record components.

Specified by:

hashCode in class Record

Returns:

a hash code value for this object

equals

public final boolean equals(Object o)

Indicates whether some other object is "equal to" this one. The objects are equal if the other object is of the same class and if all the record components are equal. Reference components are compared with Objects::equals(Object,Object); primitive components are compared with the compare method from their corresponding wrapper classes.

Specified by:

equals in class Record

Parameters:

o - the object with which to compare

Returns:

true if this object is the same as the o argument; false otherwise.

error

public @Nullable String error()

Returns the value of the error record component.

Returns:

the value of the error record component

spam

public boolean spam()

Returns the value of the spam record component.

Returns:

the value of the spam record component

rules

public @Nullable List<MailpitSpamAssassinRule> rules()

Returns the value of the rules record component.

Returns:

the value of the rules record component

score

public double score()

Returns the value of the score record component.

Returns:

the value of the score record component