The service tests if a mail address belongs to a domain providing temporary, disposable email addresses.
Syntax | …/svc/2.0/address/disposable/<address> |
Example | …/svc/2.0/address/disposable/foo@bar.com |
Parameter | An ASCII email address as last part of the URL |
Result
<disposableStatus> <infoId>a:bar.com</infoId> <result>1</result> </disposableStatus>
or
{"infoId": "a:bar.com", "result": 1}
- result: the evaluation result
- 0: not a disposable email address
- 1: is a disposable email address
- infoId: if result == 1, this contains the ID for looking up more information about a disposable address resource. An ID stands for a domain (prefix a:) or a mailexchanger (prefix m:).
Functionality
If a match is found then also a positive result (1) is returned. The ID’s of matching entries, the domain name or mailexchanger names, are also returned for further lookup.
Each execution of the check will be documented as a business event (database table business_event) with type 104.
Information about a disposable resource
The disposable info API call returns information about disposable resources.
Syntax | …/svc/2.0/info/disposable/<id> |
Example | …/svc/2.0/info/disposable/a:bar.com |
Parameter | An ID (domain with prefix :a or mailexchanger name with prefix :m) as the last part of the URL |
Result
<disposableInfo> <country>USA</country> <id>bar.com</id> <owner>Dosposabil</owner> <remarks>No sign-in necessary</remarks> <validity>3T</validity> <disposableInfo>
or
{ "country":"USA", "id":"bar.com", "owner":"Dosposabil", "remarks":"No sign-in necessary", "validity":"3T" }
The structure of the result document is:
- id: the ID of the resource, which is also the domain or mailexchanger name representing the provider
- owner: the name of the maintaining entity, if known
- country: country name for the provider organization
- remarks: further details about the resource
- validity:lifetime for the disposable addresses provided by this domain (not defined for mailexchangers)
Functionality
If no data is available for an ID the server will signal this with HTTP response code 204 (No Content) and return no result (null).
Each execution of the check will be documented as a business event (database table business_event) with type 105.