com.mailgun.model.verification.AddressValidationResponse Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of mailgun-java Show documentation

The Mailgun SDK for Java enables Java developers to work with Mailgun API efficiently.

The newest version!

package com.mailgun.model.verification;

import com.fasterxml.jackson.annotation.JsonProperty;
import lombok.Builder;
import lombok.Value;
import lombok.extern.jackson.Jacksonized;

import java.util.List;

/**
 * 
 * Address Validation Response.
 * 
 *
 * @see field-explanation
 */
@Value
@Jacksonized
@Builder
public class AddressValidationResponse {

    /**
     * 
     * Email address being validated
     * 
     */
    @JsonProperty("address")
    String address;

    /**
     * 
     * If the domain is in a list of disposable email addresses, this will be appropriately categorized.
     * 
     */
    @JsonProperty("is_disposable_address")
    Boolean isDisposableAddress;

    /**
     * 
     * Checks the mailbox portion of the email if it matches a specific role type (admin, sales or webmaster).
     * 
     */
    @JsonProperty("is_role_address")
    Boolean isRoleAddress;

    /**
     * 
     * List of potential reasons why a specific validation may be unsuccessful.
     * 
     *
     * @see reason-explanation
     */
    @JsonProperty("reason")
    List reason;

    /**
     * 
     * Either deliverable, undeliverable, do_not_send, catch_all or unknown.
     * 
     *
     * @see result-types
     */
    @JsonProperty("result")
    String result;

    /**
     * 
     * high, medium, low or unknown.
     * Depending on the evaluation of all aspects of the given email.
     * 
     */
    @JsonProperty("risk")
    String risk;

}