Email Objects
An Email address for validation.
Container for Email addresses.
Request wrapper for email REST methods.
Response wrapper for email REST methods.
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. 'bob@example.org').
JSON Representation
EmailList
An array or list of EmailAddress structures.
JSON Representation
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
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
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
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
Last updated