Email Objects

EmailAddress	An Email address for validation.
EmailList	Container for Email addresses.
EmailRestRequest	Request wrapper for email REST methods.
EmailRestResponse	Response wrapper for email REST methods.
ValidatedEmailAddress	An Email address object containing the results of the validation.

EmailAddress

The EmailAddress is used to supply email addresses for validation.

address

Type: StringThe email address (e.g. '[email protected]').

JSON Representation

{
    "address": "[email protected]"
}

EmailList

An array or list of EmailAddress structures.

JSON Representation

[ 
    { 
        address: "[email protected]" 
    },
    {
        address: "[email protected]"
    },
    ... 
]

EmailRestRequest

An EmailRestRequest object is used when invoking the Harmony RightAddress email validation REST service methods.

payload

Type: EmailList

The list of EmailAddress structures being passed to the REST service method.

sourceOfTruth

Type: String

The Source of Truth to use for the validation.

featureOptions

Type: FeatureOption

An Object containing the values for the feature options available for the validation.

JSON Representation

{
    "payload": [ { "address": "[email protected]" } ],
    "sourceOfTruth": "VE_ALL",
    "featureOptions: { "timeout": "1500" }
}

EmailRestResponse

An EmailRestResponse object is returned from the Harmony RightAddress email validation REST service methods.

payload

Type: EmailList

The list of EmailAddress structures being returned from the REST service method.

status

Type: String

The status of the request (i.e. 'SUCCESS' or 'ERROR').

messages

Type: String[]

Any error messages generated during the REST service method invocation (e.g. '[ "Access is denied" ]')

JSON Representation

{
    "status": "SUCCESS",
    "messages": [],
    "payload": [ 
        {
            "address": "[email protected]"
        }
    ]
}

ValidatedEmailAddress <<extends>> EmailAddress

A ValidatedEmailAddress object extends a standard EmailAddress object and is returned in the validate method response.

See EmailAddress for inherited attributes.

formatValidated

Type: Boolean

email_valid: true if the email address syntax conforms to RFC 2822 standard, false otherwise.

blackListValidated

Type: Boolean

True if the email address does not appear in the internal email block list, false otherwise.

domainValidated

Type: Boolean

domain_exists: true if the domain of the email address exists and has proper Domain Name Server (DNS) records, false otherwise.

mailServerValidated

Type: Boolean

mailserver_exists: True if there is a mail server for that domain, false otherwise.

mailboxValidated

Type: Boolean

email_exists: true if the mailbox for the email address has been found to exist without sending an email, false otherwise.

JSON Representation

{
    "address": "[email protected]",
    "mailBoxValidated": false,
    "mailServerValidated": false,
    "domainValidated": false,
    "blackListValidated": true,
    "formatValidated": true
}

FeatureOption

A FeatureOption object is used to supply option values when invoking the email validation REST service methods.

timeout

Type: String

Value of the timeout in milliseconds, if the validation process takes longer than the time specified, timeout error message will be given. Default value is 10000ms (10 seconds).

JSON Representation

{
    "timeout": "1500"
}