8. Contact Validation: Email ¶

Contents

Contact Validation: Email
- Email

8.1. Email ¶

Beyond simple email formatting checks, the Email Validation API will validate the connectivity status of an email address by interrogating the mail servers responsible for receiving email on behalf of the address.

The final connectivity status of an email address is provided in the StatusDescription field in the response. Possible values are shown in the table below.

Note: An email address contains two parts, the local part and the domain part. The format of email addresses are local-part@domain where the local-part may be up to 64 characters long and the domain part may have a maximum of 255 characters.

E.g. In the email address mr-great@my-company.com, mr-great is the local part and my-company.com is the domain part.

8.1.1. API URL Endpoint and URL Format ¶

https://services.inivio.com.au/validate/email?query_string

The query string is composed of a series of field-value pairs field1=value1&field2=value2&field3=value3

8.1.2. Authentication ¶

Basic Authentication over HTTPS

8.1.3. Query String Fields and Values ¶

Query String Field/Parameter	Values	Type
`value`	email address	Mandatory Field

Note

API endpoint URLs including the parameters in the query string are not case sensitive.

8.1.4. Response Format ¶

XML, JSON depends on “Accept” field in the HTTP header.

Example – Setting ‘Accept’ field in the HTTP header

httpRequest.setRequestHeader('Accept', 'application/json');
Or XMLHttpRequest. setRequestHeader('Accept',"application/json");

8.1.5. Response status codes ¶

Status Code	Notes
`Valid`	The e-mail address is valid/confirmed
`Invalid`	The e-mail address is not valid
`Uncertain`	These are domains that respond to every verification request in the affirmative and therefore cannot be fully verified. (also known as a ‘catch-all’ mail servers)
`Unknown`	The results proved to be inconclusive, most of the time a domain did not respond quickly enough.
`Exception`	There was an internal/other error

8.1.5.1. IsDisposable Flag ¶

The IsDisposable flag returns a true or false value and is included in a response if the email is from a known temporary email provider. Disposable addresses are created to be Valid only temporarily so their owners can sign up for promotions or services without using a primary address.

8.1.6. Example 1 ¶

8.1.6.1. Request ¶

https://services.inivio.com.au/validate/email?value=mr-great@inivio.com.au

8.1.6.2. Response ¶

<VerificationResult
        xmlns="http://schemas.datacontract.org/2004/07/ImpCommon.DataContract"
        xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
  <LocalPart>mr-great</LocalPart>
  <DomainPart>inivio.com.au</DomainPart>
  <StatusDescription>Uncertain</StatusDescription>
</VerificationResult>

8.1.7. Example 2 ¶

8.1.7.1. Request ¶

https://services.inivio.com.au/validate/email?value=membership.query@veda.com.au

8.1.7.2. Response ¶

{
        "LocalPart": "membership.query",
        "DomainPart": "veda.com.au",
        "StatusDescription": "Uncertain"
}

8.1.8. Example 3 ¶

8.1.8.1. Request ¶

https://services.inivio.com.au/validate/email?value=noname@nocompanylikethis.net

8.1.8.2. Response ¶

{
        "LocalPart": "noname",
        "DomainPart": "nocompanylikethis.net",
        "IsDisposable": false,
        "StatusDescription": "Invalid"
}