Email Objects
Last updated
Last updated
The EmailAddress is used to supply email addresses for validation.
Type: StringThe email address (e.g. 'bob@example.org').
An array or list of EmailAddress structures.
An EmailRestRequest object is used when invoking the Harmony RightAddress email validation REST service methods.
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.
An EmailRestResponse object is returned from the Harmony RightAddress email validation REST service methods.
Type: EmailList
The list of EmailAddress structures being returned from the REST service method.
Type: String
The status of the request (i.e. 'SUCCESS' or 'ERROR').
Type: String[]
Any error messages generated during the REST service method invocation (e.g. '[ "Access is denied" ]')
A ValidatedEmailAddress object extends a standard EmailAddress object and is returned in the validate method response.
See EmailAddress for inherited attributes.
Type: Boolean
email_valid
: true if the email address syntax conforms to RFC 2822 standard, false otherwise.
Type: Boolean
True if the email address does not appear in the internal email block list, false otherwise.
Type: Boolean
domain_exists
: true if the domain of the email address exists and has proper Domain Name Server (DNS) records, false otherwise.
Type: Boolean
mailserver_exists
: True if there is a mail server for that domain, false otherwise.
Type: Boolean
email_exists
: true if the mailbox for the email address has been found to exist without sending an email, false otherwise.
A FeatureOption object is used to supply option values when invoking the email validation REST service methods.
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).
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.