The mailserver diagnosis API call returns information about the behaviour of mailservers, when asked about the existence of email addresses.
Syntax | …/svc/2.0/info/mailserverdiagnosis/<domain> |
Example | …/svc/2.0/info/mailserverdiagnosis/bar.com |
Parameter | An ASCII domain name as last part of the URL |
Result
<mailserverDiagnosisInfo> <result>2</result> </mailserverDiagnosisInfo>
or
{"result": 2}
If successful (response code 200) the service will return a document containing the diagnosis for the mailservers of the domain requested. If no data is available for a domain the server will signal this with HTTP response code 204 (No Content) and return no result (null).
The document contains:
- result: the diagnosis for the mailservers of a domain when asked about the existence of an e-mail address
- 1: the mailservers answer truthfully
- 2: the mailservers answer always with address exists (catchall)
- 3: the mailservers answer always with address does not exist (catchall)
- 4: the mailservers answer with errors or aren’t available
- 6: the mailservers answer truthfully, but use Greylisting
Functionality
The service looks up the domain name in the SMTP Cache and returns the data currently stored there, or null (response code 204) if the domain name is currently not included in the SMTP Cache. The result is a snapshot of the current state of the SMTP cache, which is dynamic, so subsequent requests might return different results. An exception to this rule are the domain exceptions, a configurable list of domain names with fixed diagnostics values. These domains take precedence, so the service will always return the configured diagnostics values.
If the SMTP cache is inactive the service will always return null (response code 204).
Each execution of the check will be documented as a business event (database table business_event) with type 121, including the result.