{"id":2175,"date":"2017-08-22T00:00:00","date_gmt":"2017-08-22T00:00:00","guid":{"rendered":"https:\/\/www.mailboxvalidator.com\/resources3\/articles\/consuming-mailboxvalidator-api-using-php\/"},"modified":"2017-08-22T00:00:00","modified_gmt":"2017-08-22T00:00:00","password":"","slug":"consuming-mailboxvalidator-api-using-php","status":"publish","type":"docs","link":"https:\/\/www.mailboxvalidator.com\/resources\/articles\/consuming-mailboxvalidator-api-using-php\/","title":{"rendered":"Consuming the MailboxValidator API using PHP"},"content":{"rendered":"
\n

\"Consuming-the-MailboxValidator-API-using-PHP\"<\/a><\/h2>\n

What is the MailboxValidator API?<\/h2>\n<\/div>\n

The MailboxValidator API is an easy to use RESTful API which allows a registered user to validate a single email address to make sure that the email is valid. Programmers can leverage on this API to validate form entries whenever users sign up for an account to make sure the supplied email address is not fake or a disposable email. There are many uses for email validations as the MailboxValidator API can also determine if an email is from a free email provider or if it is a role-based email address among other things.<\/p>\n

 <\/p>\n

\n

Getting started<\/h2>\n<\/div>\n

First of all, an API key is needed to be able to utilize this API. So head on to the API plans page<\/a> and sign up for the free API plan. Once you have done this, you\u00e2\u20ac\u2122ll be assigned an API key. You\u00e2\u20ac\u2122ll need to pass this key to the API during every query which we will demonstrate in our sample PHP code below.<\/p>\n

 <\/p>\n

\n

API calling method via GET<\/h2>\n<\/div>\n

Example of how to validate a single email address:<\/p>\n

GET<\/span> https:\/\/api.mailboxvalidator.com\/v1\/validation\/single?email=test@test.com&key=\n<\/pre>\n
<your API key><\/em><\/p>\n
&format=<\/pre>\n
<json or xml><\/em><\/p>\n
There are 3 parameters that the API will accept. The email<\/strong> parameter is mandatory and should be the email address you wish to validate. The key<\/strong> parameter is also mandatory and contains the API key you were assigned when you signed up for an API plan above. The last parameter format<\/strong> is optional so if you omit it, the default setting is to return the validation results in the form of a JSON string. You can also include this parameter with xml<\/strong> as the value if you want the results in an XML string.<\/p>\n
 <\/p>\n
\n
Result fields<\/h2>\n<\/div>\n
Some of the important fields that you should be aware of are listed below along with some explanations of their meanings:<\/p>\n