Address spam trap check
The check tests whether the address provided is known as a spam trap:
Syntax | /svc/2.0/address/spamtrap/<address> |
Example | /svc/2.0/address/spamtrap/foo@bar.com |
Parameter | An ASCII email address as last part of the URL |
Result
<spamtrapStatus>
<infoId>foo@bar.com</infoId>
<result>1</result>
<trapType>1</trapType>
</spamtrapStatus>
or
{"infoId": "foo@bar.com", "result": 1}
The result document contains:
- result: the evaluation result
- 0: address is not a known spam trap
- 1: address is a known spam trap
- infoId: if the result is 1, this field contains the ID for looking up more information about a spam trap resource.
- trapType: the kind of spam trap found
- 0: not a known spam trap
- 1: the email address, the mailbox is a known spam trap
- 2: the domain of the email address is a known spam trap
Functionality
The service tests the address against the contents of the configured data source. If there is a match it returns a positive result and the resource ID of the spam trap that matched.
Information about a spam trap resource
The botrisk info API call returns information about spam trap resources.
Syntax | /svc/2.0/info/spamtrap/<id> |
Example | /svc/2.0/info/spamtrap/foo@bar.com |
Parameter | An ID (string) as the last part of the URL |
Result
<spamtrapInfo>
<id>foo@bar.com</id>
<trapType>1</trapType>
<owner>Spamtrap ... GmbH</owner>
<remarks>Sending to spam traps of this kind leads to the following reactions ...</remarks>
<url>spam110trap.de/x1</url>
</spamtrapInfo>
or
{
"id":"foo@bar.com",
"trapType":1,
"owner":"Spamtrap ... GmbH",
"remarks":"Sending to spam traps of this kind leads to the following reactions ...",
"url":"spam110trap.de/x1"
}
The structure of the result document is:
- id: resource ID
- trapType: scope/kind of spam trap
- 1: single email address
- 2: a domain
- owner: the name of the maintaining entity, if known
- remarks: details about the resource
- url: a URL with more informtion about the provider, reactions
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).