GetSpamList

Retrieve the list of available SPAM filters through our API service. 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/getSpamList - Default (XML) Request
https://sandbox.emailonacid.com/v4/getSpamList/xml - XML Request
https://sandbox.emailonacid.com/v4/getSpamList/json - JSON Request

Production:

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

Request:

No content is necessary for this request, other than having the content-type properly set for the response type.

Response:

XML

<?xml version="1.0" encoding="utf-8"?>
<xml>
    <spam_client>
        <spam_code>4</spam_code>
        <spam_name><![CDATA[AOL]]></spam_name>
    </spam_client>
    <spam_client>
        <spam_code>1</spam_code>
        <spam_name><![CDATA[Gmail]]></spam_name>
    </spam_client>
    .....
</xml>

JSON

[
    {
        "spam_client": {
            "spam_code": "4",
            "spam_name": "AOL"
        }
    },
    {
        "spam_client": {
            "spam_code": "1",
            "spam_name": "Gmail"
        }
    },
    ...
]

Response Details

Element Description
spam_client Container object for the spam_code-spam_name pairs of Spam Clients.
spam_code Our unique identifier for the Spam Client. This code can be used in the createStandAloneSpamTest API call.
spam_name Human-readable name of the Spam Client.