Skip to content
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,10 @@ CHANGELOG
`Billing.PhoneVerificationMethod` enum has the values `DELIVERED_CODE`,
`NETWORK`, and `OTHER`. Do not set `phoneWasVerificationSuccessful` if no
verification was attempted.
* Added `wasVerificationSuccessful` and `verificationTime` to the `Email`
request object. These describe the most recent verification of the email
address. Do not set `wasVerificationSuccessful` if no verification was
attempted.

4.4.0 (2026-07-21)
------------------
Expand Down
2 changes: 2 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -224,6 +224,8 @@ Transaction request = new Transaction.Builder(
new Email.Builder()
.address("fraud@ster.com")
.domain("ster.com")
.verificationTime(ZonedDateTime.parse("2026-10-01T14:30:00Z"))
.wasVerificationSuccessful(true)
.build()
).event(
new Event.Builder()
Expand Down
42 changes: 42 additions & 0 deletions src/main/java/com/maxmind/minfraud/request/Email.java
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@
import java.security.MessageDigest;
import java.security.NoSuchAlgorithmException;
import java.text.Normalizer;
import java.time.ZonedDateTime;
import java.util.Arrays;
import java.util.Collections;
import java.util.HashMap;
Expand All @@ -21,6 +22,8 @@ public final class Email extends AbstractModel {
private final String address;
private final boolean hashAddress;
private final String domain;
private final Boolean wasVerificationSuccessful;
private final ZonedDateTime verificationTime;
private static final Map<String, String> typoDomains;
private static final Map<String, String> typoTlds;
private static final Map<String, String> equivalentDomains;
Expand Down Expand Up @@ -298,6 +301,8 @@ private Email(Email.Builder builder) {
address = builder.address;
hashAddress = builder.hashAddress;
domain = builder.domain;
wasVerificationSuccessful = builder.wasVerificationSuccessful;
verificationTime = builder.verificationTime;
}

/**
Expand All @@ -308,6 +313,8 @@ public static final class Builder {
private String address;
private boolean hashAddress;
private String domain;
private Boolean wasVerificationSuccessful;
private ZonedDateTime verificationTime;

/**
* The constructor for the builder.
Expand Down Expand Up @@ -383,6 +390,25 @@ public Email.Builder domain(String domain) {
return this;
}

/**
* @param wasSuccessful Whether the most recent verification of the email address
* succeeded. Do not set this if no verification was attempted.
* @return The builder object.
*/
public Email.Builder wasVerificationSuccessful(Boolean wasSuccessful) {
wasVerificationSuccessful = wasSuccessful;
return this;
}

/**
* @param time The date and time of the most recent verification of the email address.
* @return The builder object.
*/
public Email.Builder verificationTime(ZonedDateTime time) {
verificationTime = time;
return this;
}

/**
* @return An instance of {@code Email} created from the fields set on this builder.
*/
Expand Down Expand Up @@ -571,4 +597,20 @@ private static boolean isValidDomainLabel(String label) {
public String domain() {
return domain;
}

/**
* @return Whether the most recent verification of the email address succeeded.
*/
@JsonProperty("was_verification_successful")
public Boolean wasVerificationSuccessful() {
return wasVerificationSuccessful;
}

/**
* @return The date and time of the most recent verification of the email address.
*/
@JsonProperty("verification_time")
public ZonedDateTime verificationTime() {
return verificationTime;
}
}
28 changes: 28 additions & 0 deletions src/test/java/com/maxmind/minfraud/request/EmailTest.java
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
package com.maxmind.minfraud.request;

import static org.junit.jupiter.api.Assertions.assertEquals;
import static org.junit.jupiter.api.Assertions.assertFalse;
import static org.junit.jupiter.api.Assertions.assertNull;
import static org.junit.jupiter.api.Assertions.assertThrows;

Expand All @@ -10,14 +11,41 @@
import java.nio.charset.StandardCharsets;
import java.security.MessageDigest;
import java.security.NoSuchAlgorithmException;
import java.time.ZonedDateTime;
import java.util.HashMap;
import java.util.Map;
import org.junit.jupiter.api.Test;
import org.junit.jupiter.params.ParameterizedTest;
import org.junit.jupiter.params.provider.ValueSource;
import org.skyscreamer.jsonassert.JSONAssert;

public class EmailTest {

@Test
public void testWasVerificationSuccessful() {
var email = new Builder().wasVerificationSuccessful(false).build();
assertFalse(email.wasVerificationSuccessful());
}

@Test
public void testVerificationTime() {
var time = ZonedDateTime.now();
var email = new Builder().verificationTime(time).build();
assertEquals(time, email.verificationTime());
}

@Test
public void testVerificationSerialization() throws Exception {
var email = new Builder()
.wasVerificationSuccessful(false)
.verificationTime(ZonedDateTime.parse("2026-10-01T14:30:00Z"))
.build();

var expectedJSON = "{was_verification_successful:false,"
+ "verification_time:'2026-10-01T14:30:00Z'}";
JSONAssert.assertEquals(expectedJSON, email.toJson(), true);
}

@Test
public void testAddress() {
var email = new Builder().address("test@test.org").build();
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -34,6 +34,8 @@ public static Transaction fullTransaction() throws Exception {
return makeTransaction(new Email.Builder()
.address("test@maxmind.com")
.domain("maxmind.com")
.wasVerificationSuccessful(true)
.verificationTime(ZonedDateTime.parse("2026-10-01T14:30:00Z"))
.build());
}

Expand All @@ -42,6 +44,8 @@ public static Transaction fullTransactionEmailMd5() throws Exception {
.address("test@maxmind.com")
.hashAddress()
.domain("maxmind.com")
.wasVerificationSuccessful(true)
.verificationTime(ZonedDateTime.parse("2026-10-01T14:30:00Z"))
.build());
}

Expand Down
4 changes: 3 additions & 1 deletion src/test/resources/test-data/full-request-email-md5.json
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,9 @@
},
"email": {
"address": "977577b140bfb7c516e4746204fbdb01",
"domain": "maxmind.com"
"domain": "maxmind.com",
"was_verification_successful": true,
"verification_time": "2026-10-01T14:30:00Z"
},
"billing": {
"first_name": "First",
Expand Down
4 changes: 3 additions & 1 deletion src/test/resources/test-data/full-request.json
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,9 @@
},
"email": {
"address": "test@maxmind.com",
"domain": "maxmind.com"
"domain": "maxmind.com",
"was_verification_successful": true,
"verification_time": "2026-10-01T14:30:00Z"
},
"billing": {
"first_name": "First",
Expand Down
Loading