GetSpamResults

Get the SPAM Analysis results from an Acid Test. Add 'xml' as the last segment in the url request to return XML format. Add 'json' as the last segment in the url request to return JSON format.

URLs:

Sandbox:

https://sandbox.emailonacid.com/v4/getSpamResults - Default (XML) Request
https://sandbox.emailonacid.com/v4/getSpamResults/xml - XML Request
https://sandbox.emailonacid.com/v4/getSpamResults/json - JSON Request

Production:

https://api.emailonacid.com/v4/getSpamResults - Default (XML) Request
https://api.emailonacid.com/v4/getSpamResults/xml - XML Request
https://api.emailonacid.com/v4/getSpamResults/json - JSON Request

Request:

XML

<?xml version="1.0" encoding="utf-8"?>
<get_results>
    <eoa_test_id>UNIQUE EMAIL TEST ID</eoa_test_id>
</get_results>

JSON

{
    "eoa_test_id" : UNIQUE EMAIL TEST ID
}

JSON Validation Schema:

Click here to download.

Request Details

Element Description Data Type Required
eoa_test_id The reference id for the test to retrieve Integer Y

Response:

XML

<?xml version="1.0" encoding="utf-8"?>
<xml>
    <spam_results>
        <spam_result>
            <name>AOL</name>
            <spam>N</spam>
            <details></details>
        </spam_result>
        <spam_result>
            <name>Gmail</name>
            <spam>N</spam>
            <details><![CDATA[...]]></details>
        </spam_result>
        ...
    </spam_results>
</xml>

Response:

JSON

{
    "spam_results": [
        {
            "spam_result": {
                "name": "AOL",
                "spam": "N",
                "details": ""
            }
        },
        {
            "spam_result": {
                "name": "Gmail",
                "spam": "N",
                "details": ""
            }
        },
 		...
    ]
}

Response Details

Element Description
name Name of the SPAM filter.
spam Y if filter marked the email as SPAM, N if made it to the Inbox.
details Details of why the email was considered SPAM, will be blank if there are no details given by the SPAM filter. Detail items are separated by the pipe "|" character.