Spam Test API Documentation

API Documentation

  • Seamlessly integrate our spam filter and delivery test tools into your own products and applications using the G-Lock Spam Test API.

    All API requests utilize REST methods resulting in JSON or XML output

    Every API request requires the use of the apikey parameter, which is located in your account settings and available for API 1000 and API unlim plans.

    API Workflow

    1. Perform data GETs/PUTs/POSTs/DELETEs to https://spamtest.glockapps.com/api/v1/
    2. All POST methods must have Content-Type: application/x-www-form-urlencoded
    3. Return data in the JSON or XML format

    The HTTP status indicates whether an operation failed or succeeded, with extra information included in the HTTP response body.

    All APIs return standard error code formats.

    Unexpected query parameters are ignored.

  • Error Responses

    Error in URL (wrong method name)

    {
        "errorCode": 400,
        "errorText": "Bad Request"
    }
    

    500 Server Internal Error:

    {
        "errorCode": 500,
        "error": {
            "EParsingException": {
                "ClassName": "EParsingException",
                "Address": "0F52AC00",
                "Message": "Server exception message"
            }
        }
    }
    

    API Errors

    {
        "errorCode": 400,
        "error": {
            "code": 14,
            "msg": "Missing 'ApiKey' parameter"
        }
    }
    
    errorCodecodemsg
    4011Invalid API key
    4032Your account was deactivated
    4043No test is found for the provided id
    4004No more API points are available
    4046Header is not found for the specified ID
    4048No IP address is found
    4009No more IP addresses are allowed in the IP reputation monitor
    40010Duplicate IP is not allowed
    40312IP reputation monitor is not allowed for your plan
    40513Method not allowed
    40014Missing ‘%’ parameter
  • GET GetProviders

    The GetProviders API returns a list of GroupID of supported mailbox provides. Data is returned in the JSON or XML formats

    Resource URL:GET https://spamtest.glockapps.com/api/v1/GetProviders

    Parameters

    apikey required
    string (User ApiKey)
    Example of JSON Response:
    {
    	ID: 0,
    	"Groups": [
    		{
    		"GroupID": 1,
    		"GroupName": "Primary Webmail",
    		"Domains": [
    		"inbox.com",
    		"gmx.com",
    		"outlook.com",
    		"aol.com",
    		"yahoo.com",
    		"gmail.com",
    		"aol.com"
    		]
    		},
    	{...},
    	{
    		"GroupID": 2048,
    		"GroupName": "Spam Filter Check",
    		"Domains": [
    		"SpamAssassin",
    		"Postini (Google Apps)",
    		"Barracuda"
    		]
    	}
    	]
    }
    

    XML Resource URL:GET https://spamtest.glockapps.com/api/v1/GetProviders/xml

    Example of XML Response:
    <GetProviders>
    <ID>0</ID>
    	<Groups>
    		<GroupID>1</GroupID>
    		<GroupName>Primary Webmail</GroupName>
    		<Domains>inbox.com</Domains>
    		<Domains>gmx.com</Domains>
    		<Domains>outlook.com</Domains>
    		<Domains>aol.com</Domains>
    		<Domains>yahoo.com</Domains>
    		<Domains>gmail.com</Domains>
    		<Domains>aol.com</Domains>
    	</Groups>
    	<Groups>...</Groups>
    	<Groups>
    		<GroupID>2048</GroupID>
    		<GroupName>Spam Filter Check</GroupName>
    		<Domains>SpamAssassin</Domains>
    		<Domains>Postini (Google Apps)</Domains>
    		<Domains>Barracuda</Domains>
    	</Groups>
    </GetProviders>
    
  • GET GetProviders v2

    The GetProviders API v2 returns a list of supported mailbox providers and their ids used in the CreateTest method. It enables you to create a fully customized list of mailbox providers for testing the emails. Data is returned in the JSON or XML formats.

    Resource URL:GET https://spamtest.glockapps.com/api/v1/GetProviders?apikey={apikey}&v=2

    Parameters

    apikey required
    string (User ApiKey)
    v required
    =2
    Example of JSON Response:
    {
      "Groups": [
        {
          "GroupID": 2048,
          "GroupName": "Spam Filter Check",
          "ISPs": [
            {
              "id": 2,
              "name": "SpamAssassin",
              "domain": "SpamAssassin"
            },
            {
              "id": 3,
              "name": "Google Spam Filter",
              "domain": "Google Spam Filter"
            },
            {
              "id": 12,
              "name": "Barracuda",
              "domain": "Barracuda"
            }
          ]
        },
        {
          "GroupID": 256,
          "GroupName": "Europe Czech",
          "ISPs": [
            {
              "id": 4,
              "name": "Seznam.cz",
              "domain": "seznam.cz"
            }
          ]
        },
        {
          "GroupID": 64,
          "GroupName": "Europe France",
          "ISPs": [
            {
              "id": 5,
              "name": "Laposte.net (FR)",
              "domain": "laposte.net"
            },
            {
              "id": 11,
              "name": "Netcourrier.com (FR)",
              "domain": "netcourrier.com"
            },
            {
              "id": 27,
              "name": "Openmailbox.org",
              "domain": "openmailbox.org"
            },
            {
              "id": 37,
              "name": "Outlook (FR)",
              "domain": "outlook.fr"
            }
          ]
        },
        {
          "GroupID": 1,
          "GroupName": "Popular US",
          "ISPs": [
            {
              "id": 6,
              "name": "Apple",
              "domain": "icloud.com"
            },
            {
              "id": 15,
              "name": "Outlook",
              "domain": "outlook.com"
            },
            {
              "id": 16,
              "name": "AOL",
              "domain": "aol.com"
            },
            {
              "id": 17,
              "name": "Yahoo (Global)",
              "domain": "yahoo.com"
            },
            {
              "id": 20,
              "name": "Gmail",
              "domain": "gmail.com"
            },
            {
              "id": 30,
              "name": "Hotmail",
              "domain": "hotmail.com"
            }
          ]
        },
        {
          "GroupID": 32,
          "GroupName": "Europe Germany",
          "ISPs": [
            {
              "id": 7,
              "name": "Gmx.de",
              "domain": "gmx.de"
            },
            {
              "id": 9,
              "name": "Web.de",
              "domain": "web.de"
            },
            {
              "id": 10,
              "name": "Freenet.de",
              "domain": "freenet.de"
            },
            {
              "id": 25,
              "name": "Eclipso.de",
              "domain": "eclipso.de"
            },
            {
              "id": 39,
              "name": "Outlook (DE)",
              "domain": "outlook.de"
            }
          ]
        },
        {
          "GroupID": 8,
          "GroupName": "Business US",
          "ISPs": [
            {
              "id": 8,
              "name": "Gmx.com (Global)",
              "domain": "gmx.com"
            },
            {
              "id": 13,
              "name": "Zoho.com",
              "domain": "zoho.com"
            },
            {
              "id": 14,
              "name": "Godaddy",
              "domain": "GoDaddy"
            },
            {
              "id": 19,
              "name": "Mail.com",
              "domain": "mail.com"
            },
            {
              "id": 26,
              "name": "Exchange (Office365)",
              "domain": "office365.com"
            }
          ]
        },
        {
          "GroupID": 4,
          "GroupName": "Canada",
          "ISPs": [
            {
              "id": 18,
              "name": "Yahoo (Canada)",
              "domain": "yahoo.ca"
            }
          ]
        },
        {
          "GroupID": 512,
          "GroupName": "Russia",
          "ISPs": [
            {
              "id": 21,
              "name": "Mail.ru",
              "domain": "mail.ru"
            },
            {
              "id": 22,
              "name": "Yandex.ru",
              "domain": "yandex.ru"
            }
          ]
        },
        {
          "GroupID": 16,
          "GroupName": "Europe UK",
          "ISPs": [
            {
              "id": 24,
              "name": "Yahoo (UK)",
              "domain": "yahoo.co.uk"
            }
          ]
        },
        {
          "GroupID": 128,
          "GroupName": "Europe Italy",
          "ISPs": [
            {
              "id": 28,
              "name": "Libero.it",
              "domain": "libero.it"
            },
            {
              "id": 29,
              "name": "Virgilio.it",
              "domain": "virgilio.it"
            }
          ]
        },
        {
          "GroupID": 4096,
          "GroupName": "Brazil",
          "ISPs": [
            {
              "id": 31,
              "name": "BOL Mail (BR)",
              "domain": "bol.com.br"
            },
            {
              "id": 32,
              "name": "Yahoo (BR)",
              "domain": "yahoo.com.br"
            },
            {
              "id": 33,
              "name": "Outlook (BR)",
              "domain": "outlook.com.br"
            },
            {
              "id": 34,
              "name": "Gmail (BR)",
              "domain": "gmail.com"
            },
            {
              "id": 35,
              "name": "Locaweb (BR)",
              "domain": "vendasrd.com.br"
            }
          ]
        }
      ]
    }
    

    XML Resource URL:GET https://spamtest.glockapps.com/api/v1/GetProviders/xml?apikey={apikey}&v=2

    Example of XML Response:
    <?xml version="1.0" encoding="UTF-8"?>
    <GetProviders>
        <Groups>
            <GroupID>2048</GroupID>
            <GroupName>Spam Filter Check</GroupName>
            <ISPs>
                <id>2</id>
                <name>SpamAssassin</name>
                <domain>SpamAssassin</domain>
            </ISPs>
            <ISPs>
                <id>3</id>
                <name>Google Spam Filter</name>
                <domain>Google Spam Filter</domain>
            </ISPs>
            <ISPs>
                <id>12</id>
                <name>Barracuda</name>
                <domain>Barracuda</domain>
            </ISPs>
        </Groups>
        <Groups>
            <GroupID>256</GroupID>
            <GroupName>Europe Czech</GroupName>
            <ISPs>
                <id>4</id>
                <name>Seznam.cz</name>
                <domain>seznam.cz</domain>
            </ISPs>
        </Groups>
        <Groups>
            <GroupID>64</GroupID>
            <GroupName>Europe France</GroupName>
            <ISPs>
                <id>5</id>
                <name>Laposte.net (FR)</name>
                <domain>laposte.net</domain>
            </ISPs>
            <ISPs>
                <id>11</id>
                <name>Netcourrier.com (FR)</name>
                <domain>netcourrier.com</domain>
            </ISPs>
            <ISPs>
                <id>27</id>
                <name>Openmailbox.org</name>
                <domain>openmailbox.org</domain>
            </ISPs>
            <ISPs>
                <id>37</id>
                <name>Outlook (FR)</name>
                <domain>outlook.fr</domain>
            </ISPs>
        </Groups>
        <Groups>
            <GroupID>1</GroupID>
            <GroupName>Popular US</GroupName>
            <ISPs>
                <id>6</id>
                <name>Apple</name>
                <domain>icloud.com</domain>
            </ISPs>
            <ISPs>
                <id>15</id>
                <name>Outlook</name>
                <domain>outlook.com</domain>
            </ISPs>
            <ISPs>
                <id>16</id>
                <name>AOL</name>
                <domain>aol.com</domain>
            </ISPs>
            <ISPs>
                <id>17</id>
                <name>Yahoo (Global)</name>
                <domain>yahoo.com</domain>
            </ISPs>
            <ISPs>
                <id>20</id>
                <name>Gmail</name>
                <domain>gmail.com</domain>
            </ISPs>
            <ISPs>
                <id>30</id>
                <name>Hotmail</name>
                <domain>hotmail.com</domain>
            </ISPs>
        </Groups>
        <Groups>
            <GroupID>32</GroupID>
            <GroupName>Europe Germany</GroupName>
            <ISPs>
                <id>7</id>
                <name>Gmx.de</name>
                <domain>gmx.de</domain>
            </ISPs>
            <ISPs>
                <id>9</id>
                <name>Web.de</name>
                <domain>web.de</domain>
            </ISPs>
            <ISPs>
                <id>10</id>
                <name>Freenet.de</name>
                <domain>freenet.de</domain>
            </ISPs>
            <ISPs>
                <id>25</id>
                <name>Eclipso.de</name>
                <domain>eclipso.de</domain>
            </ISPs>
            <ISPs>
                <id>39</id>
                <name>Outlook (DE)</name>
                <domain>outlook.de</domain>
            </ISPs>
        </Groups>
        <Groups>
            <GroupID>8</GroupID>
            <GroupName>Business US</GroupName>
            <ISPs>
                <id>8</id>
                <name>Gmx.com (Global)</name>
                <domain>gmx.com</domain>
            </ISPs>
            <ISPs>
                <id>13</id>
                <name>Zoho.com</name>
                <domain>zoho.com</domain>
            </ISPs>
            <ISPs>
                <id>14</id>
                <name>Godaddy</name>
                <domain>GoDaddy</domain>
            </ISPs>
            <ISPs>
                <id>19</id>
                <name>Mail.com</name>
                <domain>mail.com</domain>
            </ISPs>
            <ISPs>
                <id>26</id>
                <name>Exchange (Office365)</name>
                <domain>office365.com</domain>
            </ISPs>
        </Groups>
        <Groups>
            <GroupID>4</GroupID>
            <GroupName>Canada</GroupName>
            <ISPs>
                <id>18</id>
                <name>Yahoo (Canada)</name>
                <domain>yahoo.ca</domain>
            </ISPs>
        </Groups>
        <Groups>
            <GroupID>512</GroupID>
            <GroupName>Russia</GroupName>
            <ISPs>
                <id>21</id>
                <name>Mail.ru</name>
                <domain>mail.ru</domain>
            </ISPs>
            <ISPs>
                <id>22</id>
                <name>Yandex.ru</name>
                <domain>yandex.ru</domain>
            </ISPs>
        </Groups>
        <Groups>
            <GroupID>16</GroupID>
            <GroupName>Europe UK</GroupName>
            <ISPs>
                <id>24</id>
                <name>Yahoo (UK)</name>
                <domain>yahoo.co.uk</domain>
            </ISPs>
        </Groups>
        <Groups>
            <GroupID>128</GroupID>
            <GroupName>Europe Italy</GroupName>
            <ISPs>
                <id>28</id>
                <name>Libero.it</name>
                <domain>libero.it</domain>
            </ISPs>
            <ISPs>
                <id>29</id>
                <name>Virgilio.it</name>
                <domain>virgilio.it</domain>
            </ISPs>
        </Groups>
        <Groups>
            <GroupID>4096</GroupID>
            <GroupName>Brazil</GroupName>
            <ISPs>
                <id>31</id>
                <name>BOL Mail (BR)</name>
                <domain>bol.com.br</domain>
            </ISPs>
            <ISPs>
                <id>32</id>
                <name>Yahoo (BR)</name>
                <domain>yahoo.com.br</domain>
            </ISPs>
            <ISPs>
                <id>33</id>
                <name>Outlook (BR)</name>
                <domain>outlook.com.br</domain>
            </ISPs>
            <ISPs>
                <id>34</id>
                <name>Gmail (BR)</name>
                <domain>gmail.com</domain>
            </ISPs>
            <ISPs>
                <id>35</id>
                <name>Locaweb (BR)</name>
                <domain>vendasrd.com.br</domain>
            </ISPs>
        </Groups>
    </GetProviders>
    
  • POST CreateTest

    Creates an email delivery and spam filtering test.

    Resource URL:POST https://spamtest.glockapps.com/api/v1/CreateTest

    Parameters

    apikey required
    string (User ApiKey)
    groups required
    integer (bitmask of groups)
    ExternalUserID
    optional string (External User ID)
    MailFrom
    optional string
    Subject
    optional string
    Example of JSON Response:
    {
    	TestID: "a9a6657p48976138166de32772b1bf40",
    	InsertHeader: "X-API-Campaign-id: a9a6657p-48976138-166de327-72b1bf40",
            InsertInBody: "id: a9a6657p-48976138-166de327-72b1bf40",
    	SeedList: [
    	"abc@ispdomain.com",
            ...
    	],
    	TotalCheck: 42,
    	TotalInDay: 42,
    	TotalInMonth: 42,
    	FreePoints: 0,
    	PaidPoints: 958
    }
    

    XML Resource URL:POST https://spamtest.glockapps.com/api/v1/CreateTest/xml

    Example of XML Response:
    <CreateTest>
    	<TestID>1bb91f73e9d31ea2830a5e73ce3ed328</TestID>
    	<InsertHeader>
    		X-API-Campaign-id: 1bb91f73-e9d31ea2-830a5e73-ce3ed328
    	</InsertHeader>
    	<InsertInBody>
    		id: 1bb91f73-e9d31ea2-830a5e73-ce3ed328
    	</InsertInBody>
    	<SeedList>abc@ispdomain.com</SeedList>
               ...
    	<TotalCheck>40</TotalCheck>
    	<TotalInDay>40</TotalInDay>
    	<TotalInMonth>40</TotalInMonth>
    	<FreePoints>0</FreePoints>
    	<PaidPoints>960</PaidPoints>
    </CreateTest>
    
  • POST CreateTest v2

    Creates an email delivery and spam filtering test with mailbox providers returned via the GetProviders v2 method.

    Resource URL:POST https://spamtest.glockapps.com/api/v1/CreateTest

    sample: https://spamtest.glockapps.com/api/v1/CreateTest?apikey={APIKEY}&groups=0&providers=6,15,16,17

    Parameters

    apikey required
    string (User ApiKey)
    groups required
    =0
    Providers
    list of comma separated ids of mailbox providers (returned via method GetProviders v2)
    ExternalUserID
    optional string (External User ID)
    MailFrom
    optional string
    Subject
    optional string
    Example of JSON Response:
    {
    	TestID: "a9a6657p48976138166de32772b1bf40",
    	InsertHeader: "X-API-Campaign-id: a9a6657p-48976138-166de327-72b1bf40",
            InsertInBody: "id: a9a6657p-48976138-166de327-72b1bf40",
    	SeedList: [
    	"abc@ispdomain.com",
            ...
    	],
    	TotalCheck: 42,
    	TotalInDay: 42,
    	TotalInMonth: 42,
    	FreePoints: 0,
    	PaidPoints: 958
    }
    

    XML Resource URL:POST https://spamtest.glockapps.com/api/v1/CreateTest/xml

    Example of XML Response:
    <CreateTest>
    	<TestID>1bb91f73e9d31ea2830a5e73ce3ed328</TestID>
    	<InsertHeader>
    		X-API-Campaign-id: 1bb91f73-e9d31ea2-830a5e73-ce3ed328
    	</InsertHeader>
    	<InsertInBody>
    		id: 1bb91f73-e9d31ea2-830a5e73-ce3ed328
    	</InsertInBody>
    	<SeedList>abc@ispdomain.com</SeedList>
               ...
    	<TotalCheck>40</TotalCheck>
    	<TotalInDay>40</TotalInDay>
    	<TotalInMonth>40</TotalInMonth>
    	<FreePoints>0</FreePoints>
    	<PaidPoints>960</PaidPoints>
    </CreateTest>
    
  • GET GetTestList

    Returns a full list of seed addresses. Data is returned in the XML or JSON format

    Resource URL:GET https://spamtest.glockapps.com/api/v1/GetTestList

    Parameters

    apikey required
    string (User ApiKey)
    ExternalUserID
    optional string (External User ID)
    DateFrom
    optional 2014-12-31 format: YYYY-MM-DD
    DateTo
    optional 2015-12-31 format: YYYY-MM-DD
    OrderBy
    optional (Created, Subject, MailFrom, Finished) ASC DESC
    limit
    optional integer used to specify request page size
    offset
    optional integer used to specify request starting offset
    Example of JSON Response:
    {
      "Count": 2,
      "Items": [
        {
          "TestId": "xxxxx8ecbf2062bfa02de87f25c0b43c",
          "Finished": false,
          "Date": "2016-04-07T12:48:06",
          "Subject": "Paradise",
          "From": "Glocksoft <support@example.com>",
          "ReturnPath": "support@example.com",
          "SenderIP": "69.164.196.115",
          "SenderScore": "100",
          "SenderHostName": "glockdb.com",
          "ReverseIP": "69.164.196.115",
          "Helo": "mail.glockdb.com",
          "ReverseHelo": "69.164.196.115",
          "IPListed": false,
          "IPTestFinished": true,
          "ExternalUserID": "1",
          "Meta": "",
          "Stats": {
            "Inbox": 25,
            "Other": 1,
            "Spam": 3,
            "NotDelivered": 1,
            "InboxRate": 86.66,
            "SpamRate": 10,
            "BounceRate": 3.33
          }
        },
        {
          "TestId": "b139aeda1c2914e3b579aafd3ceeb1bd",
          "Finished": false,
          "Date": "2015-12-08T07:53:46",
          "Subject": "Music lover",
          "From": "Send via SMTP server: mail.example.com",
          "ReturnPath": "bounce@example.com",
          "SenderIP": "67.20.55.31",
          "SenderScore": "65",
          "SenderHostName": "mail.example.com",
          "ReverseIP": "67.20.55.31",
          "Helo": "server.example.com",
          "ReverseHelo": "67.20.55.31",
          "IPListed": false,
          "IPTestFinished": true,
          "ExternalUserID": "1",
          "Meta": "",
          "Stats": {
            "Inbox": 19,
            "Other": 2,
            "Spam": 3,
            "NotDelivered": 2,
            "InboxRate": 80.76,
            "SpamRate": 11.53,
            "BounceRate": 7.69
          }
        }
      ]
    }
    

    XML Resource URL:GET https://spamtest.glockapps.com/api/v1/GetTestList/xml

    Example of XML Response:
    <GetTestList>
    <Count>2</Count>
    <Items>
        <TestId>xxxxxeda1c2914e3b579aafd3ceeb1bd</TestId>
        <Finished>false</Finished>
        <Date>2015-12-08T07:53:46</Date>
        <Subject>Music lover</Subject>
        <From>Send via SMTP server: mail.glocksoft.com</From>
        <ReturnPath>bounce@glocksoft.com</ReturnPath>
        <SenderIP>67.20.55.31</SenderIP>
        <SenderScore>65</SenderScore>
        <SenderHostName>mail.glocksoft.com</SenderHostName>
        <ReverseIP>67.20.55.31</ReverseIP>
        <Helo>server.glocksoft.com</Helo>
        <ReverseHelo>67.20.55.31</ReverseHelo>
        <IPListed>false</IPListed>
        <IPTestFinished>true</IPTestFinished>
        <ExternalUserID>1</ExternalUserID>
        <Meta/>
        <Stats>
            <Inbox>19</Inbox>
            <Other>2</Other>
            <Spam>3</Spam>
            <NotDelivered>2</NotDelivered>
            <InboxRate>80.76</InboxRate>
            <SpamRate>11.53</SpamRate>
            <BounceRate>7.69</BounceRate>
        </Stats>
    </Items>
    <Items>
        <TestId>xxxxx8ecbf2062bfa02de87f25c0b43c</TestId>
        <Finished>false</Finished>
        <Date>2016-04-07T12:48:06</Date>
        <Subject>Paradise</Subject>
        <From>Send via SMTP server: mail.glocksoft.com</From>
        <ReturnPath>support@glocksoft.com</ReturnPath>
        <SenderIP>69.164.196.115</SenderIP>
        <SenderScore>100</SenderScore>
        <SenderHostName>glockdb.com</SenderHostName>
        <ReverseIP>69.164.196.115</ReverseIP>
        <Helo>mail.glockdb.com</Helo>
        <ReverseHelo>69.164.196.115</ReverseHelo>
        <IPListed>false</IPListed>
        <IPTestFinished>true</IPTestFinished>
        <ExternalUserID>1</ExternalUserID>
        <Meta/>
        <Stats>
            <Inbox>25</Inbox>
            <Other>1</Other>
            <Spam>3</Spam>
            <NotDelivered>1</NotDelivered>
            <InboxRate>86.66</InboxRate>
            <SpamRate>10</SpamRate>
            <BounceRate>3.33</BounceRate>
        </Stats>
    </Items>
    </GetTestList>
    
  • GET GetTestResult

    Returns the delivery and spam filtering test results. Data is returned in the XML or JSON format

    Resource URL:GET https://spamtest.glockapps.com/api/v1/GetTestResult?apikey={APIKEY}&TestID={TestID}

    Parameters

    apikey required
    string (User ApiKey)
    TestId required
    string
    Example of JSON Response:
    {
        "TestID": "b50032db50387d83400597fa74bb91d8",
        "Created": "2016-04-15T10:28:04",
        "Finished": false,
        "DKIM": "pass",
        "SPF": "pass",
        "Subject": "Fwd: Save $499.00 on BEHAVE registration - ending soon!",
        "MailFrom": "\"Test User\" <example@gmail.com>",
        "Inboxes": [
            {
                "ISP": "AOL",
                "iType": "Inbox",
                "Received": "2016-04-15T10:28:50",
                "Visible": true,
                "HeaderID": "1cd03228e43de750c7820280e09456c3",
                "Delay": "00:00:01"
            },
    ...
            {
                "ISP": "Zoho.com",
                "iType": "Inbox",
                "Received": "2016-04-15T10:28:53",
                "Visible": true,
                "HeaderID": "aa7d4376877419658f23c768f883190b",
                "Delay": "00:00:04"
            }
        ],
        "SpamAssassin": {
            "Active": true,
            "Finished": true,
            "Score": -0.8,
            "Headers": [
                {
                    "Score": -0.7,
                    "Tag": "RCVD_IN_DNSWL_LOW",
                    "Description": "RBL: Sender listed at http://www.dnswl.org/, low  trust [74.125.82.65 listed in list.dnswl.org]"
                },
                {
                    "Score": 0,
                    "Tag": "FREEMAIL_FROM",
                    "Description": "Sender email is commonly abused enduser mail provider  (example[at]gmail.com)"
                },
                {
                    "Score": 0,
                    "Tag": "SPF_PASS",
                    "Description": "SPF: sender matches SPF record "
                },
                {
                    "Score": 0,
                    "Tag": "RCVD_IN_MSPIKE_H3",
                    "Description": "RBL: Good reputation (+3)  [74.125.82.65 listed in wl.mailspike.net]"
                },
                {
                    "Score": 0,
                    "Tag": "HTML_MESSAGE",
                    "Description": "BODY: HTML included in message "
                },
                {
                    "Score": -0.1,
                    "Tag": "DKIM_VALID_AU",
                    "Description": "Message has a valid DKIM or DK signature from author's  domain"
                },
                {
                    "Score": 0.1,
                    "Tag": "DKIM_SIGNED",
                    "Description": "Message has a DKIM or DK signature, not necessarily  valid"
                },
                {
                    "Score": -0.1,
                    "Tag": "DKIM_VALID",
                    "Description": "Message has at least one valid DKIM or DK signature "
                },
                {
                    "Score": 0,
                    "Tag": "RCVD_IN_MSPIKE_WL",
                    "Description": "Mailspike good senders "
                },
                {
                    "Score": 0,
                    "Tag": "LOTS_OF_MONEY",
                    "Description": "Huge... sums of money"
                }
            ]
        },
        "GoogleApps": {
            "Active": true,
            "Finished": true,
            "Spam": false,
            "Phishy": false
        },
        "Barracuda": {
            "Active": true,
            "Score": 2.6,
            "Headers": [
                {
                    "Score": 2.1,
                    "Tag": "BSF_SC3_MV0439",
                    "Description": "        META: Custom rule MV0439 "
                },
                {
                    "Score": 0,
                    "Tag": "HTML_MESSAGE",
                    "Description": "          BODY: HTML included in message "
                },
                {
                    "Score": 0.5,
                    "Tag": "BSF_SC0_SA079d",
                    "Description": "        META: Custom Rule SA079d "
                },
                {
                    "Score": 0,
                    "Tag": "BSF_SC0_MISMATCH_TO",
                    "Description": "   HEADER: Envelope rcpt doesn't match header"
                }
            ],
            "Reason": "",
            "ReasonExtra": ""
        },
        "SenderIP": "74.125.82.66",
        "SenderScore": "90",
        "SenderHostName": "mail-wm0-f66.google.com",
        "Helo": "mail-wm0-f66.google.com",
        "ReturnPath": "example@gmail.com",
        "ReverseHelo": "74.125.82.66",
        "ReverseIP": "74.125.82.66",
        "DNSBL": {
            "finished": true,
            "ipListed": true,
            "dnsbl": [
                {
                    "Server": "dnsbl.anticaptcha.net",
                    "Status": 1,
                    "txt": "Please see <a target=\"_blank\" href=\"http://dnsbl.anticaptcha.net/check/?ip=74.125.82.66\">http://dnsbl.anticaptcha.net/check/?ip=74.125.82.66</a>"
                },
                {
                    "Server": "ips.backscatterer.org",
                    "Status": 1,
                    "txt": "Sorry 74.125.82.66 is blacklisted at <a target=\"_blank\" href=\"http://www.backscatterer.org/?ip=74.125.82.66\">http://www.backscatterer.org/?ip=74.125.82.66</a>"
                },
                {
                    "Server": "spam.dnsbl.sorbs.net",
                    "Status": 1,
                    "txt": "Spam Received See: <a target=\"_blank\" href=\"http://www.sorbs.net/lookup.shtml?74.125.82.66\">http://www.sorbs.net/lookup.shtml?74.125.82.66</a>"
                }
            ]
        },
        "ExternalUserID": "",
        "Meta": "",
        "Stats": {
            "Inbox": 22,
            "Other": 1,
            "Spam": 6,
            "NotDelivered": 2,
            "InboxRate": 74.19,
            "SpamRate": 19.35,
            "BounceRate": 6.45
        }
    }
    

    Note: in the API, the Inbox rate includes the Tabs (Other) rate while in the reports the Inbox rate and Tabs rate are separated.

    InboxRate=(Inbox+Other)*100/Total,
         where Total = Inbox+Other+Spam+NotDelivered
         Other includes emails delivered in Promotional, Newsletter or Unknown folders

    XML Resource URL:GET https://spamtest.glockapps.com/api/v1/GetTestResult/xml

  • POST GetTestsResults

    Returns the results of all delivery and spam filtering tests. Data is returned in the XML or JSON format (max 50 items) if count > 50 – only first 50 tests is returned

    Resource URL:POST https://spamtest.glockapps.com/api/v1/GetTestsResults

    Parameters

    apikey required
    required string (User ApiKey)
    ids required
    comma separated testid (max 50 items)
    Example of JSON Response:
    [
        {
            "TestID": "1271a7029c9df08643b631b02cf9e116",
            "Created": "2015-12-30T16:58:15",
            "Finished": false,
            "DKIM": "pass",
            "SPF": "pass",
            "Subject": "Deadline -> Ends at Midnight Tonight",
            "MailFrom": "\"Tennessee State\" <membership@example.org>",
            "Inboxes": [
                {
                    "ISP": "AOL",
                    "iType": "Spam",
                    "Received": "2015-12-30T17:06:03",
                    "Visible": true,
                    "HeaderID": "08d44f159609fc91e09ed77a79cf5dac",
                    "Delay": "00:00:02"
                },
     ...
                {
                    "ISP": "Zoho.com",
                    "iType": "Inbox",
                    "Received": "2015-12-30T17:06:10",
                    "Visible": true,
                    "HeaderID": "3156e1ab31baada7869f68c7c8590099",
                    "Delay": "00:00:01"
                }
            ],
            "SpamAssassin": {
                "Active": true,
                "Finished": true,
                "Score": 0,
                "Headers": [
                    {
                        "Score": 0,
                        "Tag": "HEADER_FROM_DIFFERENT_DOMAINS",
                        "Description": "From and EnvelopeFrom 2nd level mail  domains are different"
                    },
                    {
                        "Score": 0,
                        "Tag": "T_RP_MATCHES_RCVD",
                        "Description": "Envelope sender domain matches handover relay  domain"
                    },
                    {
                        "Score": 0,
                        "Tag": "SPF_PASS",
                        "Description": "SPF: sender matches SPF record "
                    },
                    {
                        "Score": 0,
                        "Tag": "HTML_MESSAGE",
                        "Description": "BODY: HTML included in message "
                    },
                    {
                        "Score": 0.1,
                        "Tag": "DKIM_SIGNED",
                        "Description": "Message has a DKIM or DK signature, not necessarily  valid"
                    },
                    {
                        "Score": -0.1,
                        "Tag": "DKIM_VALID",
                        "Description": "Message has at least one valid DKIM or DK signature"
                    }
                ]
            },
            "GoogleApps": {
                "Active": true,
                "Finished": true,
                "Spam": false,
                "Phishy": false
            },
            "Barracuda": {
                "Active": true,
                "Score": 0,
                "Headers": [],
                "Reason": "",
                "ReasonExtra": ""
            },
            "SenderIP": "XX.159.65.XX",
            "SenderScore": "99",
            "SenderHostName": "vmta1x.example.com",
            "Helo": "vmta1x.example.com",
            "ReturnPath": "bounce@example.com",
            "ReverseHelo": "XX.159.65.XX",
            "ReverseIP": "XX.159.65.XX",
            "DNSBL": {
                "finished": true,
                "ipListed": false,
                "dnsbl": []
            },
            "ExternalUserID": "",
            "Meta": "",
            "Stats": {
                "Inbox": 18,
                "Other": 1,
                "Spam": 3,
                "NotDelivered": 5,
                "InboxRate": 70.37,
                "SpamRate": 11.11,
                "BounceRate": 18.51
            }
        },
        {
            "TestID": "2ef248c04979d6b3a7b283ec3dc32cca",
            "Created": "2015-12-30T16:50:39",
            "Finished": false,
            "DKIM": "",
            "SPF": "",
            "Subject": "Deadline Ends Today",
            "MailFrom": "\"Tennessee State\" <membership@example.org>",
            "Inboxes": [
                {
                    "ISP": "AOL",
                    "iType": "X",
                    "Received": "",
                    "Visible": true,
                    "HeaderID": "cfcd208495d565ef66e7dff9f98764da",
                    "Delay": ""
                },
    ...
                {
                    "ISP": "Zoho.com",
                    "iType": "Inbox",
                    "Received": "2015-12-30T16:58:04",
                    "Visible": true,
                    "HeaderID": "0df9b7bb2859008c54e1d5d9522d16be",
                    "Delay": "00:00:03"
                }
            ],
            "SpamAssassin": {
                "Active": false,
                "Finished": false,
                "Score": 0,
                "Headers": []
            },
            "GoogleApps": {
                "Active": false,
                "Finished": false,
                "Spam": false,
                "Phishy": false
            },
            "Barracuda": {
                "Active": true,
                "Score": 0,
                "Headers": [],
                "Reason": "",
                "ReasonExtra": ""
            },
            "SenderIP": "xx.159.65.xx",
            "SenderScore": "99",
            "SenderHostName": "vmta1x.example.com",
            "Helo": "vmta1x.example.com",
            "ReturnPath": "bounce@example.com",
            "ReverseHelo": "xx.159.65.xx",
            "ReverseIP": "xx.159.65.xx",
            "DNSBL": {
                "finished": true,
                "ipListed": false,
                "dnsbl": []
            },
            "ExternalUserID": "",
            "Meta": "",
            "Stats": {
                "Inbox": 1,
                "Other": 0,
                "Spam": 0,
                "NotDelivered": 27,
                "InboxRate": 3.57,
                "SpamRate": 0,
                "BounceRate": 96.42
            }
        }
    ]
    

    Note: in the API, the Inbox rate includes the Tabs (Other) rate while in the reports the Inbox rate and Tabs rate are separated.

    InboxRate=(Inbox+Other)*100/Total,
         where Total = Inbox+Other+Spam+NotDelivered
         Other includes emails delivered in Promotional, Newsletter or Unknown folders

    XML Resource URL:POST https://spamtest.glockapps.com/api/v1/GetTestsResults/xml

  • GET GetHeaders

    Returns the headers of a specific tested email. Data is returned in the XML or JSON format

    Resource URL:GET https://spamtest.glockapps.com/api/v1/GetHeaders

    Parameters

    apikey required
    string (User ApiKey)
    id required
    string (Header id)
    Example of JSON Response:
    {
      "HeaderID": "1cd03228e43de750c7820280e09456c3",
      "Headers": [
        {
          "Name": "Return-Path",
          "Value": "<example@gmail.com>"
        },
        {
          "Name": "Received",
          "Value": "from mail-wm0-f66.google.com (mail-wm0-f66.google.com [74.125.82.66]) (using TLSv1 with cipher RC4-SHA (128/128 bits)) (No client certificate requested) by mtaiw-mbc05.mx.aol.com (Internet Inbound) with ESMTPS id 252D170000083 for <marispurinsh@aol.com>; Fri, 15 Apr 2016 06:28:50 -0400 (EDT)"
        },
    ...
        {
          "Name": "X-AOL-SPF",
          "Value": "domain : gmail.com SPF : pass"
        }
      ]
    }
    

    XML Resource URL:GET https://spamtest.glockapps.com/api/v1/GetHeaders/xml

    Example of XML Response:
    <GetHeaders>
        <HeaderID>1cd03228e43de750c7820280e09456c3</HeaderID>
        <Headers>
            <Name>Return-Path</Name>
            <Value>
                <example@gmail.com>
                </Value>
            </Headers>
            <Headers>
                <Name>Received</Name>
                <Value>
    from mail-wm0-f66.google.com (mail-wm0-f66.google.com [74.125.82.66]) (using TLSv1 with cipher RC4-SHA (128/128 bits)) (No client certificate requested) by mtaiw-mbc05.mx.aol.com (Internet Inbound) with ESMTPS id 252D170000083 for 
                    <xxx@aol.com>; Fri, 15 Apr 2016 06:28:50 -0400 (EDT)
    
                 </Value>
             </Headers>
    ...
        <Headers>
            <Name>X-AOL-SPF</Name>
            <Value>domain : gmail.com SPF : pass</Value>
        </Headers>
    </GetHeaders>
    
  • GET GetSeedList

    Returns a full list of seed addresses. Data is returned in the XML or JSON format

    Resource URL:GET https://spamtest.glockapps.com/api/v1/GetSeedList

    Parameters

    apikey required
    string (User ApiKey)
    testid required
    string (Test id)
    Example of JSON Response:
    {
    TestID: "5c04925674920eb58467fb52ce4ef728",
    InsertHeader: "X-API-Campaign-id: 5c049256-74920eb5-8467fb52-ce4ef728",
    InsertInBody: "id: 5c049256-74920eb5-8467fb52-ce4ef728",
    SeedList: [
    	"email@domain.com",
    	...
    	],
    TotalCheck: 76,
    TotalInDay: 0,
    TotalInMonth: 0,
    FreePoints: 0,
    PaidPoints: 0
    }
    

    XML Resource URL:GET https://spamtest.glockapps.com/api/v1/GetSeedList/xml

    Example of XML Response:
    <GetSeedList>
    	<TestID>5c04925674920eb58467fb52ce4ef728</TestID>
    	<InsertHeader>
    		X-API-Campaign-id: 5c049256-74920eb5-8467fb52-ce4ef728
    	</InsertHeader>
    	<InsertInBody>id: 5c049256-74920eb5-8467fb52-ce4ef728</InsertInBody>
    	<SeedList>email@domain.com</SeedList>
    	...
    	<TotalCheck>76</TotalCheck>
    	<TotalInDay>0</TotalInDay>
    	<TotalInMonth>0</TotalInMonth>
    	<FreePoints>0</FreePoints>
    	<PaidPoints>0</PaidPoints>
    </GetSeedList>
    
  • POST AddIPToMonitor

    Adds the IP address to the IP Reputation Monitor

    Resource URL:POST https://spamtest.glockapps.com/api/v1/AddIPToMonitor

    Parameters

    apikey required
    string (User ApiKey)
    IP required
    string (IP Address)
    Alert
    optional integer (1-send alert, 0 – do not send alert)
    Note
    optional string (IP label, note, description)

    Success : Status Code:200 OK

    Example of JSON Response:
    {
       "ID": 223,
       "UserID": 75,
       "IP": "xx.120.103.xx",
       "SenderScore": "n/a",
       "CheckedTimes": 0,
       "LastChecked": "",
       "ListedIn": [],
       "Listed": 0,
       "SendAlert": 0,
       "Note": "mail.example.com",
       "Created": 135305937764,
       "Modified": 135305937764
    }
    

    XML Resource URL:POST https://spamtest.glockapps.com/api/v1/AddIPToMonitor/xml

    Example of XML Response:
    <AddIPToMonitor>
       <ID>223</ID>
       <UserID>75</UserID>
       <IP>xx.120.103.xx</IP>
       <SenderScore>n/a</SenderScore>
       <CheckedTimes>0</CheckedTimes>
       <LastChecked></LastChecked>
       <Listed>0</Listed>
       <SendAlert>0</SendAlert>
       <Note>mail.example.com</Note>
       <Created>135305937815</Created>
       <Modified>135305937815</Modified>
    </AddIPToMonitor>
    
  • POST AddNoteToIP

    Adds a note to an IP address

    Resource URL:POST https://spamtest.glockapps.com/api/v1/AddNoteToIP

    Parameters

    apikey required
    string (User ApiKey)
    IP required
    string (IP Address)
    Note
    optional string (IP label, note, description)

    Success : Status Code:200 OK

    Example of JSON Response:
    {
       "ID": 223,
       "UserID": 75,
       "IP": "xx.120.103.xx",
       "SenderScore": "n/a",
       "CheckedTimes": 0,
       "LastChecked": "",
       "ListedIn": [],
       "Listed": 0,
       "SendAlert": 0,
       "Note": "NEW NOTE",
       "Created": 135305937764,
       "Modified": 135305937764
    }
    

    XML Resource URL:POST https://spamtest.glockapps.com/api/v1/AddNoteToIP/xml

    Example of XML Response:
    <AddIPToMonitor>
       <ID>223</ID>
       <UserID>75</UserID>
       <IP>xx.120.103.xx</IP>
       <SenderScore>n/a</SenderScore>
       <CheckedTimes>0</CheckedTimes>
       <LastChecked></LastChecked>
       <Listed>0</Listed>
       <SendAlert>0</SendAlert>
       <Note>NEW NOTE</Note>
       <Created>135305937815</Created>
       <Modified>135305937815</Modified>
    </AddIPToMonitor>
    
  • DELETE DeleteIPFromMonitor

    Deletes an IP address from the IP Reputation Monitor

    Resource URL:DELETE https://spamtest.glockapps.com/api/v1/DeleteIPFromMonitor

    Parameters

    apikey required
    string (User ApiKey)
    IP required
    string (IP Address)

    XML Resource URL:DELETE https://spamtest.glockapps.com/api/v1/DeleteIPFromMonitor/xml

    Success : Status Code:200 OK

  • GET GetIPMonitored

    Returns a full list of monitored IP addresses. Data is returned in the XML or JSON format

    Resource URL:GET https://spamtest.glockapps.com/api/v1/GetIPMonitored

    Parameters

    apikey required
    string (User ApiKey)
    showdetails
    optional integer (1 – show listed list)
    Example of JSON Response:
    {
    	Count: 2,
    		Items: [
    	{
    		IP: "46.53.160.244",
    		LastChecked: "2015-07-29T06:45:15",
    		Listed: 1,
    		SendAlert: 0,
    		ListedCount: 4,
    		Note: "bla bla"
    		},
    	{
    		IP: "209.167.231.175",
    		LastChecked: "2015-07-29T07:15:05",
    		Listed: 0,
    		SendAlert: 0,
    		ListedCount: 0,
    		Note: "e175.en25.com"
    		}
    	]
    }
    

    XML Resource URL:GET https://spamtest.glockapps.com/api/v1/GetIPMonitored/xml

    Example of XML Response:
    <GetIPMonitored>
    <Count>2</Count>
    	<Items>
    		<IP>46.53.160.244</IP>
    		<LastChecked>2015-07-29T06:45:15</LastChecked>
    		<Listed>1</Listed>
    		<SendAlert>0</SendAlert>
    		<ListedCount>4</ListedCount>
    		<Note>bla bla</Note>
    	</Items>
    	<Items>
    		<IP>209.167.231.175</IP>
    		<LastChecked>2015-07-29T07:15:05</LastChecked>
    		<Listed>0</Listed>
    		<SendAlert>0</SendAlert>
    		<ListedCount>0</ListedCount>
    		<Note>e175.en25.com</Note>
    	</Items>
    </GetIPMonitored>
    
  • GET GetIPResult

    Returns the result of monitoring a specific IP address. Data is returned in the XML or JSON format

    Resource URL:GET https://spamtest.glockapps.com/api/v1/GetIPResult

    Parameters

    apikey required
    required string (User ApiKey)
    IP required
    string (IP Address)
    listed
    integer (1 – show only listed)
    Example of JSON Response:
    {
      "IP": "xx.120.103.xx",
      "Note": "mail.example.com",
      "SenderScore": "6",
      "LastChecked": "2016-04-15T05:57:40",
      "Status": 2,
      "Listed": 1,
      "ListedCount": 5,
      "ListedIn": [
        {
          "Server": "zen.spamhaus.org",
          "Status": 1,
          "txt": "<a target=\"_blank\" href=\"https://www.spamhaus.org/query/ip/xx.120.103.xx\">https://www.spamhaus.org/query/ip/xx.120.103.xx</a>"
        },
        {
          "Server": "xbl.spamhaus.org",
          "Status": 1,
          "txt": "<a target=\"_blank\" href=\"https://www.spamhaus.org/query/ip/xx.120.103.xx\">https://www.spamhaus.org/query/ip/xx.120.103.xx</a>"
        },
        {
          "Server": "cbl.abuseat.org",
          "Status": 1,
          "txt": "Blocked - see <a target=\"_blank\" href=\"http://www.abuseat.org/lookup.cgi?ip=xx.120.103.xx\">http://www.abuseat.org/lookup.cgi?ip=xx.120.103.xx</a>"
        },
        {
          "Server": "bad.psky.me",
          "Status": 1,
          "txt": "Bad Reputation. See <a target=\"_blank\" href=\"http://psky.me?xx.120.103.xx\">http://psky.me?xx.120.103.xx</a>"
        },
        {
          "Server": "cidr.bl.mcafee.com",
          "Status": 1,
          "txt": "<a target=\"_blank\" href=\"https://www.spamhaus.org/query/ip/xx.120.103.xx\">https://www.spamhaus.org/query/ip/xx.120.103.xx</a>"
        },
        {
          "Server": "rbl.schulte.org",
          "Status": 0,
          "txt": ""
        },
    ...
        {
          "Server": "dnsbl-1.uceprotect.net",
          "Status": 0,
          "txt": ""
        }
      ]
    }
    

    XML Resource URL:GET https://spamtest.glockapps.com/api/v1/GetIPResult/xml

    Example of XML Response:
    <GetIPResult>
        <IP>xx.120.103.xx</IP>
        <Note>mail.example.com</Note>
        <SenderScore>6</SenderScore>
        <LastChecked>2016-04-15T05:57:40</LastChecked>
        <Status>2</Status>
        <Listed>1</Listed>
        <ListedCount>5</ListedCount>
        <ListedIn>
            <Server>zen.spamhaus.org</Server>
            <Status>1</Status>
            <txt>
                <a target="_blank" href="https://www.spamhaus.org/query/ip/xx.120.103.xx">https://www.spamhaus.org/query/ip/xx.120.103.xx</a>
            </txt>
        </ListedIn>
        <ListedIn>
            <Server>xbl.spamhaus.org</Server>
            <Status>1</Status>
            <txt>
                <a target="_blank" href="https://www.spamhaus.org/query/ip/xx.120.103.xx">https://www.spamhaus.org/query/ip/xx.120.103.xx</a>
            </txt>
        </ListedIn>
        <ListedIn>
            <Server>cbl.abuseat.org</Server>
            <Status>1</Status>
            <txt>
    Blocked - see 
                <a target="_blank" href="http://www.abuseat.org/lookup.cgi?ip=xx.120.103.xx">http://www.abuseat.org/lookup.cgi?ip=xx.120.103.xx</a>
            </txt>
        </ListedIn>
        <ListedIn>
            <Server>bad.psky.me</Server>
            <Status>1</Status>
            <txt>
    Bad Reputation. See 
                <a target="_blank" href="http://psky.me?xx.120.103.xx">http://psky.me?xx.120.103.xx</a>
            </txt>
        </ListedIn>
        <ListedIn>
            <Server>cidr.bl.mcafee.com</Server>
            <Status>1</Status>
            <txt>
                <a target="_blank" href="https://www.spamhaus.org/query/ip/xx.120.103.xx">https://www.spamhaus.org/query/ip/xx.120.103.xx</a>
            </txt>
        </ListedIn>
        <ListedIn>
            <Server>rbl.schulte.org</Server>
            <Status>0</Status>
            <txt/>
        </ListedIn>
    ...
        <ListedIn>
            <Server>dnsbl-1.uceprotect.net</Server>
            <Status>0</Status>
            <txt/>
        </ListedIn>
    </GetIPResult>
    
  • GET Email

    Returns the RAW HTML code of a tested email

    Resource URL:GET https://spamtest.glockapps.com/api/v1/GetIPResult

    Request Details

    apikey required
    required string (User ApiKey)
    TestId required
    string
    Response:
    RAW HTML code of a tested email
      

Trusted by well known companies all over the world

EasyMail7 customers