API Method "email_check_cms" CMS-related version of email_check
This method performs short email checking using antispam key. It returns only one field "result".
Method's response is information about the existence of an email address.
Call Requires GET Parameters:
- method_name — should be 'email_check'
- auth_key — Database API key. To obtain a key please get an account here: https://cleantalk.org/register?platform=api
Optional GET Parameters:
- email — email address to check
Example request:
https://api.cleantalk.org/?method_name=email_check_cms&auth_key=123456&email=stop_email@example.com
API returns JSON string, for example:
{"data":{"stop_email@example.com":{"result":"EXISTS"}}}
Responses Explanation:
data — array with checked records, which contains them in the following format: "record":{array of check results}.
An array of check results may contain the next fields:
- EXISTS — address exists,
- NOT_EXISTS — address not exists,
- MX_FAIL, MX_ERROR — сannot obtain information about e-mail or domain.
Restrictions:
If you get calls limit, API returns error notice. Example:
{"error_message":"Calls limit exceeded.","error_no":10}
The current calls limit is 100 per 60 seconds.
You can ask us any question concerning the CleanTalk Anti-Spam via:
It would also be interesting
- CleanTalk Anti-Spam check_message API MethodCleanTalk Anti-Spam "check_message" API method description This method is the best to use on forms that...
- Encoding Contact Data with a Shortcode and Hook for Third-Party PluginsEncoding Contact Data with a Shortcode and Hook for Third-Party Plugins This article explains how to...
- CleanTalk API methodsCleanTalk API methods This article describes public API methods by CleanTalk for spam and bot checking,...