Domain Spam (Rest API) - Revision history

Matt.Brown: Update route names and get XML payload

2020-10-14T21:03:46Z

Update route names and get XML payload

Matt.Brown: Update route names and get XML payload

2020-10-14T20:47:30Z

Update route names and get XML payload

Appscp: remove accept header from examples to avoid confusion

2017-01-12T21:36:35Z

remove accept header from examples to avoid confusion

Appscp: /* v1 - Current */

2016-03-01T15:41:28Z

‎v1 - Current

Appscp at 18:37, 23 September 2014

2014-09-23T18:37:37Z

Appscp: v1 documentation

2013-12-04T22:22:35Z

v1 documentation

Appscp: /* Index IP Safelist */

2013-07-25T14:19:49Z

‎Index IP Safelist

Appscp: /* Index Safelist */

2013-07-25T14:19:35Z

‎Index Safelist

Appscp: /* Index IP Blacklist */

2013-07-25T14:19:22Z

‎Index IP Blacklist

Appscp: /* Index Blacklist */

2013-07-25T14:18:33Z

‎Index Blacklist

@@ Line 333: / Line 333: @@
 </pre>
-=== IP Blacklist ===
+=== IP Blocklist ===
-==== Index IP Blacklist ====
+==== Index IP Blocklist ====
 ''URL'':
-  <nowiki>[GET] https://api.emailsrvr.com/v1/customers/(customer account number)/domains/(domain name)/spam/ipblacklist</nowiki>
+  <nowiki>[GET] https://api.emailsrvr.com/v1/customers/(customer account number)/domains/(domain name)/spam/ipblocklist</nowiki>
 ''Description'':
-This operation returns IP blacklist associated with the domain.
+This operation returns IP blocklist associated with the domain.
@@ Line 353: / Line 353: @@
 ''Example'':
 <pre>
-get '/customers/12345678/domains/example.com/spam/ipblacklist'
+get '/customers/12345678/domains/example.com/spam/ipblocklist'
 </pre>
@@ Line 360: / Line 360: @@
 <pre>
 <?xml version="1.0" encoding="utf-8"?>
-<ipBlacklist xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns="urn:xml:ipBlacklist">
+<ipBlocklist xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns="urn:xml:ipBlocklist">
    <addresses>
      <ip>216.12.34.1</ip>
      <ip>216.12.34.2</ip>
    </addresses>
-</ipBlacklist>
+</ipBlocklist>
 </pre>
@@ Line 373: / Line 373: @@
 {"addresses":["216.12.34.1","216.12.34.2"]}
-==== Add IP Blacklist ====
+==== Add IP Blocklist ====
 ''URL'':
-  <nowiki>[POST] https://api.emailsrvr.com/v1/customers/(customer account number)/domains/(domain name)/spam/ipblacklist/(ip address)</nowiki>
+  <nowiki>[POST] https://api.emailsrvr.com/v1/customers/(customer account number)/domains/(domain name)/spam/ipblocklist/(ip address)</nowiki>
 ''Description'':
-Adds an IP to the blacklist.
+Adds an IP to the blocklist.
 ''Example'':
 <pre>
-post '/customers/12345678/domains/example.com/spam/blacklist/216.12.34.1'
+post '/customers/12345678/domains/example.com/spam/blocklist/216.12.34.1'
 </pre>
@@ Line 402: / Line 402: @@
 |}
-==== Delete IP Blacklist ====
+==== Delete IP Blocklist ====
 ''URL'':
-  <nowiki>[DELETE] https://api.emailsrvr.com/v1/customers/(customer account number)/domains/(domain name)/spam/ipblacklist/(ip address)</nowiki>
+  <nowiki>[DELETE] https://api.emailsrvr.com/v1/customers/(customer account number)/domains/(domain name)/spam/ipblocklist/(ip address)</nowiki>
 ''Description'':
-Removes an IP from the blacklist.
+Removes an IP from the blocklist.
 ''Example'':
 <pre>
-delete '/customers/12345678/domains/example.com/spam/ipblacklist/216.12.34.1'
+delete '/customers/12345678/domains/example.com/spam/ipblocklist/216.12.34.1'
 </pre>
@@ Line 430: / Line 430: @@
 | invalid ip address: 123
 |-
-| Entered IP is not on the current blacklist
+| Entered IP is not on the current blocklist
 | 400
-| 216.12.34.1 is not found on the blacklist
+| 216.12.34.1 is not found on the blocklist
 |}
-==== Edit IP Blacklist ====
+==== Edit IP Blocklist ====
 ''URL'':
-  <nowiki>[PUT] https://api.emailsrvr.com/v1/customers/(customer account number)/domains/(domain name)/spam/ipblacklist</nowiki>
+  <nowiki>[PUT] https://api.emailsrvr.com/v1/customers/(customer account number)/domains/(domain name)/spam/ipblocklist</nowiki>
 ''Description'':
-Edit IP addresses on the blacklist.
+Edit IP addresses on the blocklist.
 {| class="wikitable"
@@ Line 465: / Line 465: @@
 ''Example'':
 <pre>
-put '/customers/12345678/domains/example.com/spam/ipblacklist',
+put '/customers/12345678/domains/example.com/spam/ipblocklist',
+{
    'addList' => '216.12.34.%,216.12.%.%',

@@ Line 189: / Line 189: @@
-=== Blacklist ===
+=== Blocklist ===
-==== Index Blacklist ====
+==== Index Blocklist ====
 ''URL'':
-  <nowiki>[GET] https://api.emailsrvr.com/v1/customers/(customer account number)/domains/(domain name)/spam/blacklist</nowiki>
+  <nowiki>[GET] https://api.emailsrvr.com/v1/customers/(customer account number)/domains/(domain name)/spam/blocklist</nowiki>
 ''Description'':
-This operation returns the email address blacklist associated with the domain.
+This operation returns the email address blocklist associated with the domain.
@@ Line 209: / Line 209: @@
 ''Example'':
 <pre>
-get '/customers/12345678/domains/example.com/spam/blacklist'
+get '/customers/12345678/domains/example.com/spam/blocklist'
 </pre>
@@ Line 217: / Line 217: @@
 <pre>
 <?xml version="1.0" encoding="utf-8"?>
-<blacklist xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns="urn:xml:blacklist">
+<blocklist xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns="urn:xml:blocklist">
    <addresses>
      <address>name1@spam.com</address>
      <address>name2@spam.com</address>
    </addresses>
-</blacklist>
+</blocklist>
 </pre>
@@ Line 230: / Line 230: @@
 {"addresses":["name1@spam.com","name2@spam.com"]}
-==== Add Blacklist ====
+==== Add Blocklist ====
 ''URL'':
-  <nowiki>[POST] https://api.emailsrvr.com/v1/customers/(customer account number)/domains/(domain name)/spam/blacklist/(email address)</nowiki>
+  <nowiki>[POST] https://api.emailsrvr.com/v1/customers/(customer account number)/domains/(domain name)/spam/blocklist/(email address)</nowiki>
 ''Description'':
-Adds an email address or domain to the blacklist.
+Adds an email address or domain to the blocklist.
 ''Example'':
 <pre>
-post '/customers/12345678/domains/example.com/spam/blacklist/anyone@spam.com'
+post '/customers/12345678/domains/example.com/spam/blocklist/anyone@spam.com'
 </pre>
@@ Line 260: / Line 260: @@
 | Entered current domain
 | 400
-| Adding example.com would blacklist the current domain
+| Adding example.com would blocklist the current domain
 |}
-==== Delete Blacklist ====
+==== Delete Blocklist ====
 ''URL'':
-  <nowiki>[DELETE] https://api.emailsrvr.com/v1/customers/(customer account number)/domains/(domain name)/spam/blacklist/(email address)</nowiki>
+  <nowiki>[DELETE] https://api.emailsrvr.com/v1/customers/(customer account number)/domains/(domain name)/spam/blocklist/(email address)</nowiki>
 ''Description'':
-Removes an email address or domain from the blacklist.
+Removes an email address or domain from the blocklist.
 ''Example'':
 <pre>
-delete '/customers/12345678/domains/example.com/spam/blacklist/anyone@yahoo.com'
+delete '/customers/12345678/domains/example.com/spam/blocklist/anyone@yahoo.com'
 </pre>
@@ Line 291: / Line 291: @@
 | invalid email address: abc
 |-
-| Entered email or domain is not on the current blacklist
+| Entered email or domain is not on the current blocklist
 | 400
 | abc@junkmail.com is not found on the list
 |}
-==== Edit Blacklist ====
+==== Edit Blocklist ====
 ''URL'':
-  <nowiki>[PUT] https://api.emailsrvr.com/v1/customers/(customer account number)/domains/(domain name)/spam/blacklist</nowiki>
+  <nowiki>[PUT] https://api.emailsrvr.com/v1/customers/(customer account number)/domains/(domain name)/spam/blocklist</nowiki>
 ''Description'':
-Edit email addresses on the blacklist.
+Edit email addresses on the blcklist.
 {| class="wikitable"
@@ Line 326: / Line 326: @@
 ''Example'':
 <pre>
-put '/customers/12345678/domains/example.com/spam/blacklist',
+put '/customers/12345678/domains/example.com/spam/blocklist',
+{
    'addList' => '@%.example.com,abc@example.com',

@@ Line 21: / Line 21: @@
 ''Example'':
 <pre>
-get '/customers/12345678/domains/example.com/spam/settings', 'text/xml'
+get '/customers/12345678/domains/example.com/spam/settings'
 </pre>
@@ Line 157: / Line 157: @@
 <pre>
-put '/customers/me/domains/example.com/spam/settings', 'text/xml',
+put '/customers/me/domains/example.com/spam/settings',
+{
    'filterLevel' => 'on',
@@ Line 209: / Line 209: @@
 ''Example'':
 <pre>
-get '/customers/12345678/domains/example.com/spam/blacklist', 'text/xml'
+get '/customers/12345678/domains/example.com/spam/blacklist'
 </pre>
@@ Line 243: / Line 243: @@
 ''Example'':
 <pre>
-post '/customers/12345678/domains/example.com/spam/blacklist/anyone@spam.com', 'text/xml'
+post '/customers/12345678/domains/example.com/spam/blacklist/anyone@spam.com'
 </pre>
@@ Line 276: / Line 276: @@
 ''Example'':
 <pre>
-delete '/customers/12345678/domains/example.com/spam/blacklist/anyone@yahoo.com', 'text/xml'
+delete '/customers/12345678/domains/example.com/spam/blacklist/anyone@yahoo.com'
 </pre>
@@ Line 330: / Line 330: @@
    'addList' => '@%.example.com,abc@example.com',
    'removeList' => '@examp%.com'
-},
 </pre>
@@ Line 354: / Line 353: @@
 ''Example'':
 <pre>
-get '/customers/12345678/domains/example.com/spam/ipblacklist', 'text/xml'
+get '/customers/12345678/domains/example.com/spam/ipblacklist'
 </pre>
@@ Line 387: / Line 386: @@
 ''Example'':
 <pre>
-post '/customers/12345678/domains/example.com/spam/blacklist/216.12.34.1', 'text/xml'
+post '/customers/12345678/domains/example.com/spam/blacklist/216.12.34.1'
 </pre>
@@ Line 416: / Line 415: @@
 ''Example'':
 <pre>
-delete '/customers/12345678/domains/example.com/spam/ipblacklist/216.12.34.1', 'text/xml'
+delete '/customers/12345678/domains/example.com/spam/ipblacklist/216.12.34.1'
 </pre>
@@ Line 470: / Line 469: @@
    'addList' => '216.12.34.%,216.12.%.%',
    'removeList' => '216.%.%.%'
-},
 </pre>
@@ Line 494: / Line 492: @@
 ''Example'':
 <pre>
-get '/customers/12345678/domains/example.com/spam/safelist', 'text/xml'
+get '/customers/12345678/domains/example.com/spam/safelist'
 </pre>
@@ Line 528: / Line 526: @@
 ''Example'':
 <pre>
-post '/customers/12345678/domains/example.com/spam/safelist/anyone@yahoo.com', 'text/xml'
+post '/customers/12345678/domains/example.com/spam/safelist/anyone@yahoo.com'
 </pre>
@@ Line 558: / Line 556: @@
 ''Example'':
 <pre>
-delete '/customers/12345678/domains/example.com/spam/safelist/anyone@yahoo.com', 'text/xml'
+delete '/customers/12345678/domains/example.com/spam/safelist/anyone@yahoo.com'
 </pre>
@@ Line 612: / Line 610: @@
    'addList' => '@%.example.com,abc@example.com',
    'removeList' => '@examp%.com'
-},
 </pre>
@@ Line 637: / Line 634: @@
 ''Example'':
 <pre>
-get '/customers/12345678/domains/example.com/spam/ipsafelist', 'text/xml'
+get '/customers/12345678/domains/example.com/spam/ipsafelist'
 </pre>
@@ Line 671: / Line 668: @@
 ''Example'':
 <pre>
-post '/customers/12345678/domains/example.com/spam/safelist/216.12.34.1', 'text/xml'
+post '/customers/12345678/domains/example.com/spam/safelist/216.12.34.1'
 </pre>
@@ Line 700: / Line 697: @@
 ''Example'':
 <pre>
-delete '/customers/12345678/domains/example.com/spam/ipsafelist/216.12.34.1', 'text/xml'
+delete '/customers/12345678/domains/example.com/spam/ipsafelist/216.12.34.1'
 </pre>
@@ Line 754: / Line 751: @@
    'addList' => '216.12.34.%,216.12.%.%',
    'removeList' => '216.%.%.%'
-},
 </pre>

@@ Line 16: / Line 16: @@
 ''Remarks'':
-The Show operation only supports the GET HTTP verb. For .xml format, refer to the following schema document: [http://api.emailsrvr.com/Schemas/DomainSpamSetting.xsd DomainSpamSetting.xsd]
+The Show operation only supports the GET HTTP verb.
@@ Line 204: / Line 204: @@
 ''Remarks'':
-The Index operation only supports the GET HTTP verb. For .xml format, refer to the following schema document: [http://api.emailsrvr.com/Schemas/Blacklist.xsd Blacklist.xsd]
+The Index operation only supports the GET HTTP verb.
@@ Line 349: / Line 349: @@
 ''Remarks'':
-The Index operation only supports the GET HTTP verb. For .xml format, refer to the following schema document: [http://api.emailsrvr.com/Schemas/IpBlacklist.xsd IpBlacklist.xsd]
+The Index operation only supports the GET HTTP verb.
@@ Line 489: / Line 489: @@
 ''Remarks'':
-The Index operation only supports the GET HTTP verb. For .xml format, refer to the following schema document: [http://api.emailsrvr.com/Schemas/Safelist.xsd Safelist.xsd]
+The Index operation only supports the GET HTTP verb.
@@ Line 632: / Line 632: @@
 ''Remarks'':
-The Index operation only supports the GET HTTP verb. For .xml format, refer to the following schema document: [http://api.emailsrvr.com/Schemas/IpSafelist.xsd IpSafelist.xsd]
+The Index operation only supports the GET HTTP verb.

@@ Line 1: / Line 1: @@
-== v0 - Current ==
+== v1 - Current ==
 === Spam Settings ===
@@ Line 6: / Line 6: @@
 ''URL'':
-  <nowiki>[GET] https://api.emailsrvr.com/v0/customers/(customer account number)/domains/(domain name)/spam/settings</nowiki>
+  <nowiki>[GET] https://api.emailsrvr.com/v1/customers/(customer account number)/domains/(domain name)/spam/settings</nowiki>
@@ Line 55: / Line 55: @@
 ''URL'':
-  <nowiki>[PUT] https://api.emailsrvr.com/v0/customers/(customer account number)/domains/(domain name)/spam/settings</nowiki>
+  <nowiki>[PUT] https://api.emailsrvr.com/v1/customers/(customer account number)/domains/(domain name)/spam/settings</nowiki>
@@ Line 194: / Line 194: @@
 ''URL'':
-  <nowiki>[GET] https://api.emailsrvr.com/v0/customers/(customer account number)/domains/(domain name)/spam/blacklist</nowiki>
+  <nowiki>[GET] https://api.emailsrvr.com/v1/customers/(customer account number)/domains/(domain name)/spam/blacklist</nowiki>
@@ Line 233: / Line 233: @@
 ''URL'':
-  <nowiki>[POST] https://api.emailsrvr.com/v0/customers/(customer account number)/domains/(domain name)/spam/blacklist/(email address)</nowiki>
+  <nowiki>[POST] https://api.emailsrvr.com/v1/customers/(customer account number)/domains/(domain name)/spam/blacklist/(email address)</nowiki>
@@ Line 266: / Line 266: @@
 ''URL'':
-  <nowiki>[DELETE] https://api.emailsrvr.com/v0/customers/(customer account number)/domains/(domain name)/spam/blacklist/(email address)</nowiki>
+  <nowiki>[DELETE] https://api.emailsrvr.com/v1/customers/(customer account number)/domains/(domain name)/spam/blacklist/(email address)</nowiki>
@@ Line 299: / Line 299: @@
 ''URL'':
-  <nowiki>[PUT] https://api.emailsrvr.com/v0/customers/(customer account number)/domains/(domain name)/spam/blacklist</nowiki>
+  <nowiki>[PUT] https://api.emailsrvr.com/v1/customers/(customer account number)/domains/(domain name)/spam/blacklist</nowiki>
@@ Line 339: / Line 339: @@
 ''URL'':
-  <nowiki>[GET] https://api.emailsrvr.com/v0/customers/(customer account number)/domains/(domain name)/spam/ipblacklist</nowiki>
+  <nowiki>[GET] https://api.emailsrvr.com/v1/customers/(customer account number)/domains/(domain name)/spam/ipblacklist</nowiki>
@@ Line 377: / Line 377: @@
 ''URL'':
-  <nowiki>[POST] https://api.emailsrvr.com/v0/customers/(customer account number)/domains/(domain name)/spam/ipblacklist/(ip address)</nowiki>
+  <nowiki>[POST] https://api.emailsrvr.com/v1/customers/(customer account number)/domains/(domain name)/spam/ipblacklist/(ip address)</nowiki>
@@ Line 406: / Line 406: @@
 ''URL'':
-  <nowiki>[DELETE] https://api.emailsrvr.com/v0/customers/(customer account number)/domains/(domain name)/spam/ipblacklist/(ip address)</nowiki>
+  <nowiki>[DELETE] https://api.emailsrvr.com/v1/customers/(customer account number)/domains/(domain name)/spam/ipblacklist/(ip address)</nowiki>
@@ Line 439: / Line 439: @@
 ''URL'':
-  <nowiki>[PUT] https://api.emailsrvr.com/v0/customers/(customer account number)/domains/(domain name)/spam/ipblacklist</nowiki>
+  <nowiki>[PUT] https://api.emailsrvr.com/v1/customers/(customer account number)/domains/(domain name)/spam/ipblacklist</nowiki>
@@ Line 479: / Line 479: @@
 ''URL'':
-  <nowiki>[GET] https://api.emailsrvr.com/v0/customers/(customer account number)/domains/(domain name)/spam/safelist</nowiki>
+  <nowiki>[GET] https://api.emailsrvr.com/v1/customers/(customer account number)/domains/(domain name)/spam/safelist</nowiki>
@@ Line 518: / Line 518: @@
 ''URL'':
-  <nowiki>[POST] https://api.emailsrvr.com/v0/customers/(customer account number)/domains/(domain name)/spam/safelist/(email address)</nowiki>
+  <nowiki>[POST] https://api.emailsrvr.com/v1/customers/(customer account number)/domains/(domain name)/spam/safelist/(email address)</nowiki>
@@ Line 548: / Line 548: @@
 ''URL'':
-  <nowiki>[DELETE] https://api.emailsrvr.com/v0/customers/(customer account number)/domains/(domain name)/spam/safelist/(email address)</nowiki>
+  <nowiki>[DELETE] https://api.emailsrvr.com/v1/customers/(customer account number)/domains/(domain name)/spam/safelist/(email address)</nowiki>
@@ Line 581: / Line 581: @@
 ''URL'':
-  <nowiki>[PUT] https://api.emailsrvr.com/v0/customers/(customer account number)/domains/(domain name)/spam/safelist</nowiki>
+  <nowiki>[PUT] https://api.emailsrvr.com/v1/customers/(customer account number)/domains/(domain name)/spam/safelist</nowiki>
@@ Line 622: / Line 622: @@
 ''URL'':
-  <nowiki>[GET] https://api.emailsrvr.com/v0/customers/(customer account number)/domains/(domain name)/spam/ipsafelist</nowiki>
+  <nowiki>[GET] https://api.emailsrvr.com/v1/customers/(customer account number)/domains/(domain name)/spam/ipsafelist</nowiki>
@@ Line 661: / Line 661: @@
 ''URL'':
-  <nowiki>[POST] https://api.emailsrvr.com/v0/customers/(customer account number)/domains/(domain name)/spam/ipsafelist/(ip address)</nowiki>
+  <nowiki>[POST] https://api.emailsrvr.com/v1/customers/(customer account number)/domains/(domain name)/spam/ipsafelist/(ip address)</nowiki>
@@ Line 690: / Line 690: @@
 ''URL'':
-  <nowiki>[DELETE] https://api.emailsrvr.com/v0/customers/(customer account number)/domains/(domain name)/spam/ipsafelist/(email address)</nowiki>
+  <nowiki>[DELETE] https://api.emailsrvr.com/v1/customers/(customer account number)/domains/(domain name)/spam/ipsafelist/(email address)</nowiki>
@@ Line 723: / Line 723: @@
 ''URL'':
-  <nowiki>[PUT] https://api.emailsrvr.com/v0/customers/(customer account number)/domains/(domain name)/spam/ipsafelist</nowiki>
+  <nowiki>[PUT] https://api.emailsrvr.com/v1/customers/(customer account number)/domains/(domain name)/spam/ipsafelist</nowiki>

← Older revision		Revision as of 14:19, 25 July 2013
Line 630:		Line 630:
	''Remarks'':		''Remarks'':

−	The Index operation only supports the GET HTTP verb. For .xml format, refer to the following schema document: [http://api.emailsrvr.com~~/v0~~/Schemas/IpSafelist.xsd IpSafelist.xsd]	+	The Index operation only supports the GET HTTP verb. For .xml format, refer to the following schema document: [http://api.emailsrvr.com/Schemas/IpSafelist.xsd IpSafelist.xsd]

@@ Line 487: / Line 487: @@
 ''Remarks'':
-The Index operation only supports the GET HTTP verb. For .xml format, refer to the following schema document: [http://api.emailsrvr.com/v0/Schemas/Safelist.xsd Safelist.xsd]
+The Index operation only supports the GET HTTP verb. For .xml format, refer to the following schema document: [http://api.emailsrvr.com/Schemas/Safelist.xsd Safelist.xsd]
@@ Line 512: / Line 512: @@
 {"addresses":["name1@notspam.com","name2@notspam.com"]}
 === Add Safelist ===

← Older revision		Revision as of 14:19, 25 July 2013
Line 347:		Line 347:
	''Remarks'':		''Remarks'':

−	The Index operation only supports the GET HTTP verb. For .xml format, refer to the following schema document: [http://api.emailsrvr.com~~/v0~~/Schemas/IpBlacklist.xsd IpBlacklist.xsd]	+	The Index operation only supports the GET HTTP verb. For .xml format, refer to the following schema document: [http://api.emailsrvr.com/Schemas/IpBlacklist.xsd IpBlacklist.xsd]

← Older revision		Revision as of 14:18, 25 July 2013
Line 202:		Line 202:
	''Remarks'':		''Remarks'':

−	The Index operation only supports the GET HTTP verb. For .xml format, refer to the following schema document: [http://api.emailsrvr.com~~/v0~~/Schemas/Blacklist.xsd Blacklist.xsd]	+	The Index operation only supports the GET HTTP verb. For .xml format, refer to the following schema document: [http://api.emailsrvr.com/Schemas/Blacklist.xsd Blacklist.xsd]