IsValid
Checks if an email address is valid.
To connect to this service you'll need to use one of these endpoints:
Description
Checks an email address for validity at the requested level. Choose from a quick syntax-level check, a more detailed MX-level check, right up to a full mailbox test.
Remember that more detailed checks can take longer to complete, so pick the validation level that is most appropriate for your use-case.
Parameters
The following parameters can be supplied to this method
username |
username apikey- , e.g.
apikey-ABCD-1234-EFGH-5678
|
---|---|
password |
password |
email The email address to validate |
|
level | level The level to validate the
|
options | options |
Advanced Options
The following options can be specified as part of the option
parameter. Each option is specified
as a key/value pair. The list of available names is shown below, along with a description of the allowable values
for that name.
Common Options | |
---|---|
Name | Description |
ApplicationName | ApplicationName Gives the name of the calling application - used to break down usage by application in the usage reports on the dashboard |
Service-Specific Options | |
Name | Description |
MissingMXRecordHandling | MissingMXRecordHandling If the The default Alternatively the values |
Results
This method returns an object containing the following fields:
Status |
Status Success field is true , the other results described below can be used to get the results of the method.
If Success is false , some error occurred in calling the method, such as the authentication failed or the
account is out of credits. The details of the error can be obtained from the ErrorMessage field, and any other results should be ignored
|
---|---|
Result | Result A status code indicating if the email address could be validated. The following values are available:
|