Rackspace Mailbox Spam (Rest API) - Revision history

Matt.Brown: Update route names and get XML payload

2020-10-14T21:16:04Z

Update route names and get XML payload

Matt.Brown: Update route names and get XML payload

2020-10-14T21:10:25Z

Update route names and get XML payload

SOADev at 16:18, 10 September 2019

2019-09-10T16:18:36Z

Appscp: remove accept header from examples to avoid confusion

2017-01-12T21:44:26Z

remove accept header from examples to avoid confusion

Appscp: /* v1 - Current */

2016-03-01T15:44:26Z

‎v1 - Current

Appscp at 18:45, 23 September 2014

2014-09-23T18:45:08Z

Appscp: v1 documentation

2013-12-04T22:23:22Z

v1 documentation

Appscp: /* Index */

2013-07-25T14:29:14Z

‎Index

Appscp: /* Index */

2013-07-25T14:28:41Z

‎Index

Appscp: /* Index */

2013-07-25T14:28:27Z

‎Index

@@ Line 308: / Line 308: @@
 </pre>
-=== IP Blacklist ===
+=== IP Blocklist ===
 ==== Index ====
@@ Line 314: / Line 314: @@
 ''URL'':
   <nowiki>[GET] https://api.emailsrvr.com/v1/customers/(customer account number)/domains/(domain name)
-         /rs/mailboxes/(mailbox name)/spam/ipblacklist</nowiki>
+         /rs/mailboxes/(mailbox name)/spam/ipblocklist</nowiki>
 ''Description'':
-This operation returns IP blacklist associated with the mailbox.
+This operation returns IP blocklist associated with the mailbox.
@@ Line 329: / Line 329: @@
 ''Example'':
 <pre>
-get '/customers/12345678/domains/example.com/rs/mailboxes/alex.smith/spam/ipblacklist'
+get '/customers/12345678/domains/example.com/rs/mailboxes/alex.smith/spam/ipblocklist'
 </pre>
@@ Line 336: / Line 336: @@
 <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 353: / Line 353: @@
 ''URL'':
   <nowiki>[POST] https://api.emailsrvr.com/v1/customers/(customer account number)/domains/(domain name)
-         /rs/mailboxes/(mailbox name)/spam/ipblacklist/(ip address)</nowiki>
+         /rs/mailboxes/(mailbox 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/rs/mailboxes/alex.smith/spam/blacklist/216.12.34.1', {}
+post '/customers/12345678/domains/example.com/rs/mailboxes/alex.smith/spam/blocklist/216.12.34.1', {}
 </pre>
@@ Line 370: / Line 370: @@
 ''URL'':
   <nowiki>[DELETE] https://api.emailsrvr.com/v1/customers/(customer account number)/domains/(domain name)
-             /rs/mailboxes/(mailbox name)/spam/ipblacklist/(ip address)</nowiki>
+             /rs/mailboxes/(mailbox 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/rs/mailboxes/alex.smith/spam/ipblacklist/216.12.34.1'
+delete '/customers/12345678/domains/example.com/rs/mailboxes/alex.smith/spam/ipblocklist/216.12.34.1'
 </pre>
@@ Line 391: / Line 391: @@
 !''Sample Message''
 |-
-| 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
 |}
@@ Line 400: / Line 400: @@
 ''URL'':
   <nowiki>[PUT] https://api.emailsrvr.com/v1/customers/(customer account number)/domains/(domain name)
-                /rs/mailboxes/(mailbox name)/spam/ipblacklist</nowiki>
+                /rs/mailboxes/(mailbox name)/spam/ipblocklist</nowiki>
 ''Description'':
-Edit IP addresses on the blacklist.
+Edit IP addresses on the blocklist.
 {| class="wikitable"
@@ Line 427: / Line 427: @@
 ''Example'':
 <pre>
-put '/customers/12345678/domains/example.com/rs/mailboxes/jane.doe/spam/ipblacklist',
+put '/customers/12345678/domains/example.com/rs/mailboxes/jane.doe/spam/ipblocklist',
+{
    'addList' => '216.12.34.%,216.12.%.%',

@@ Line 161: / Line 161: @@
-=== Blacklist ===
+=== Blocklist ===
 ==== Index ====
@@ Line 167: / Line 167: @@
 ''URL'':
   <nowiki>[GET] https://api.emailsrvr.com/v1/customers/(customer account number)/domains/(domain name)
-         /rs/mailboxes/(mailbox name)/spam/blacklist</nowiki>
+         /rs/mailboxes/(mailbox name)/spam/blocklist</nowiki>
 ''Description'':
-This operation returns email address blacklist associated with the mailbox.
+This operation returns email address blocklist associated with the mailbox.
@@ Line 182: / Line 182: @@
 ''Example'':
 <pre>
-get '/customers/12345678/domains/example.com/rs/mailboxes/alex.smith/spam/blacklist'
+get '/customers/12345678/domains/example.com/rs/mailboxes/alex.smith/spam/blocklist'
 </pre>
@@ Line 190: / Line 190: @@
 <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 207: / Line 207: @@
 ''URL'':
   <nowiki>[POST] https://api.emailsrvr.com/v1/customers/(customer account number)/domains/(domain name)
-         /rs/mailboxes/(mailbox name)/spam/blacklist/(email address)</nowiki>
+         /rs/mailboxes/(mailbox 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/rs/mailboxes/alex.smith/spam/blacklist/anyone@spam.com', {}
+post '/customers/12345678/domains/example.com/rs/mailboxes/alex.smith/spam/blocklist/anyone@spam.com', {}
 </pre>
@@ Line 234: / Line 234: @@
 | Entered current domain
 | 400
-| Adding example.com would blacklist the current domain
+| Adding example.com would blocklist the current domain
 |}
@@ Line 241: / Line 241: @@
 ''URL'':
   <nowiki>[DELETE] https://api.emailsrvr.com/v1/customers/(customer account number)/domains/(domain name)
-             /rs/mailboxes/(mailbox name)/spam/blacklist/(email address)</nowiki>
+             /rs/mailboxes/(mailbox 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/rs/mailboxes/alex.smith/spam/blacklist/anyone@yahoo.com'
+delete '/customers/12345678/domains/example.com/rs/mailboxes/alex.smith/spam/blocklist/anyone@yahoo.com'
 </pre>
@@ Line 266: / Line 266: @@
 | 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 blacklist
+| abc@junkmail.com is not found on the blocklist
 |}
@@ Line 275: / Line 275: @@
 ''URL'':
   <nowiki>[PUT] https://api.emailsrvr.com/v1/customers/(customer account number)/domains/(domain name)
-                /rs/mailboxes/(mailbox name)/spam/blacklist</nowiki>
+                /rs/mailboxes/(mailbox name)/spam/blocklist</nowiki>
 ''Description'':
-Edit email addresses on the blacklist.
+Edit email addresses on the blocklist.
 {| class="wikitable"
@@ Line 301: / Line 301: @@
 ''Example'':
 <pre>
-put '/customers/12345678/domains/example.com/rs/mailboxes/jane.doe/spam/blacklist',
+put '/customers/12345678/domains/example.com/rs/mailboxes/jane.doe/spam/blocklist',
+{
    'addList' => '@%.example.com,abc@example.com',

@@ Line 43: / Line 43: @@
 <pre>
-{"filterLevel":"on","rsEmailSettings":"hasFolderCleaner":false,"spamFolderAgeLimit":0,"spamFolderNumLimit":0,
+{ "filterLevel":"on",
-"spamForwardingAddress":"","spamHandling":"toFolder"}}
+  "rsEmailSettings":{
 </pre>
@@ Line 50: / Line 57: @@
 ''URL'':
-  <nowiki>[PUT] https://api.emailsrvr.com/v1/customers/(customer account number)/domains/(domain name)
+  <nowiki>[PUT] https://api.emailsrvr.com/v1/customers/(customer account number)/domains/(domain name)/rs/mailboxes/(mailbox name)/spam/settings</nowiki>

@@ Line 19: / Line 19: @@
 ''Example'':
 <pre>
-get '/customers/12345678/domains/example.com/rs/mailboxes/alex.smith/spam/settings', 'text/xml'
+get '/customers/12345678/domains/example.com/rs/mailboxes/alex.smith/spam/settings'
 </pre>
@@ Line 176: / Line 176: @@
 ''Example'':
 <pre>
-get '/customers/12345678/domains/example.com/rs/mailboxes/alex.smith/spam/blacklist', 'text/xml'
+get '/customers/12345678/domains/example.com/rs/mailboxes/alex.smith/spam/blacklist'
 </pre>
@@ Line 211: / Line 211: @@
 ''Example'':
 <pre>
-post '/customers/12345678/domains/example.com/rs/mailboxes/alex.smith/spam/blacklist/anyone@spam.com', {},'text/xml'
+post '/customers/12345678/domains/example.com/rs/mailboxes/alex.smith/spam/blacklist/anyone@spam.com', {}
 </pre>
@@ Line 245: / Line 245: @@
 ''Example'':
 <pre>
-delete '/customers/12345678/domains/example.com/rs/mailboxes/alex.smith/spam/blacklist/anyone@yahoo.com', 'text/xml'
+delete '/customers/12345678/domains/example.com/rs/mailboxes/alex.smith/spam/blacklist/anyone@yahoo.com'
 </pre>
@@ Line 299: / Line 299: @@
    'addList' => '@%.example.com,abc@example.com',
    'removeList' => '@examp%.com'
-},
 </pre>
@@ Line 324: / Line 323: @@
 ''Example'':
 <pre>
-get '/customers/12345678/domains/example.com/rs/mailboxes/alex.smith/spam/ipblacklist', 'text/xml'
+get '/customers/12345678/domains/example.com/rs/mailboxes/alex.smith/spam/ipblacklist'
 </pre>
@@ Line 358: / Line 357: @@
 ''Example'':
 <pre>
-post '/customers/12345678/domains/example.com/rs/mailboxes/alex.smith/spam/blacklist/216.12.34.1', {},'text/xml'
+post '/customers/12345678/domains/example.com/rs/mailboxes/alex.smith/spam/blacklist/216.12.34.1', {}
 </pre>
@@ Line 375: / Line 374: @@
 ''Example'':
 <pre>
-delete '/customers/12345678/domains/example.com/rs/mailboxes/alex.smith/spam/ipblacklist/216.12.34.1', 'text/xml'
+delete '/customers/12345678/domains/example.com/rs/mailboxes/alex.smith/spam/ipblacklist/216.12.34.1'
 </pre>
@@ Line 426: / Line 425: @@
    'addList' => '216.12.34.%,216.12.%.%',
    'removeList' => '216.%.%.%'
-},
 </pre>
@@ Line 451: / Line 449: @@
 ''Example'':
 <pre>
-get '/customers/12345678/domains/example.com/rs/mailboxes/alex.smith/spam/safelist', 'text/xml'
+get '/customers/12345678/domains/example.com/rs/mailboxes/alex.smith/spam/safelist'
 </pre>
@@ Line 486: / Line 484: @@
 ''Example'':
 <pre>
-post '/customers/12345678/domains/example.com/rs/mailboxes/alex.smith/spam/safelist/anyone@yahoo.com', {},'text/xml'
+post '/customers/12345678/domains/example.com/rs/mailboxes/alex.smith/spam/safelist/anyone@yahoo.com', {}
 </pre>
@@ Line 516: / Line 514: @@
 ''Example'':
 <pre>
-delete '/customers/12345678/domains/example.com/rs/mailboxes/alex.smith/spam/safelist/anyone@yahoo.com', 'text/xml'
+delete '/customers/12345678/domains/example.com/rs/mailboxes/alex.smith/spam/safelist/anyone@yahoo.com'
 </pre>
@@ Line 571: / Line 569: @@
    'addList' => '@%.example.com,abc@example.com',
    'removeList' => '@examp%.com'
-},
 </pre>
@@ Line 596: / Line 593: @@
 ''Example'':
 <pre>
-get '/customers/12345678/domains/example.com/rs/mailboxes/alex.smith/spam/ipsafelist', 'text/xml'
+get '/customers/12345678/domains/example.com/rs/mailboxes/alex.smith/spam/ipsafelist'
 </pre>
@@ Line 631: / Line 628: @@
 ''Example'':
 <pre>
-post '/customers/12345678/domains/example.com/rs/mailboxes/alex.smith/spam/ipsafelist/216.12.34.1', {},'text/xml'
+post '/customers/12345678/domains/example.com/rs/mailboxes/alex.smith/spam/ipsafelist/216.12.34.1', {}
 </pre>
@@ Line 661: / Line 658: @@
 ''Example'':
 <pre>
-delete '/customers/12345678/domains/example.com/rs/mailboxes/alex.smith/spam/ipsafelist/216.12.34.1', 'text/xml'
+delete '/customers/12345678/domains/example.com/rs/mailboxes/alex.smith/spam/ipsafelist/216.12.34.1'
 </pre>
@@ Line 712: / Line 709: @@
    'addList' => '216.12.34.%,216.12.%.%',
    'removeList' => '216.%.%.%'
-},
 </pre>

@@ Line 14: / Line 14: @@
 ''Description'':
-This operation returns the spam settings associated with the mailbox. For .xml format refer to the following schema document: [http://api.emailsrvr.com/Schemas/RSMailboxSpamSetting.xsd RSMailboxSpamSetting.xsd]
+This operation returns the spam settings associated with the mailbox.
@@ Line 171: / Line 171: @@
 ''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 319: / Line 319: @@
 ''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 446: / Line 446: @@
 ''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 591: / Line 591: @@
 ''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: @@
 __TOC__
-== Spam Settings ==
+== v0 - Current ==
-=== Show ===
+=== Spam Settings ===
 ''URL'':
@@ Line 45: / Line 47: @@
 </pre>
-=== Edit ===
+==== Edit ====
 ''URL'':
@@ Line 153: / Line 155: @@
-== Blacklist ==
+=== Blacklist ===
-=== Index ===
+==== Index ====
 ''URL'':
@@ Line 195: / Line 197: @@
 {"addresses":["name1@spam.com","name2@spam.com"]}
-=== Add ===
+==== Add ====
 ''URL'':
@@ Line 229: / Line 231: @@
 |}
-=== Delete ===
+==== Delete ====
 ''URL'':
@@ Line 263: / Line 265: @@
 |}
-=== Edit ===
+==== Edit ====
 ''URL'':
@@ Line 301: / Line 303: @@
 </pre>
-== IP Blacklist ==
+=== IP Blacklist ===
-=== Index ===
+==== Index ====
 ''URL'':
@@ Line 342: / Line 344: @@
 {"addresses":["216.12.34.1","216.12.34.2"]}
-=== Add ===
+==== Add ====
 ''URL'':
@@ Line 359: / Line 361: @@
 </pre>
-=== Delete ===
+==== Delete ====
 ''URL'':
@@ Line 389: / Line 391: @@
 |}
-=== Edit ===
+==== Edit ====
 ''URL'':
@@ Line 428: / Line 430: @@
 </pre>
-== Safelist ==
+=== Safelist ===
-=== Index ===
+==== Index ====
 ''URL'':
@@ Line 470: / Line 472: @@
 {"addresses":["name1@notspam.com","name2@notspam.com"]}
-=== Add ===
+==== Add ====
 ''URL'':
@@ Line 500: / Line 502: @@
 |}
-=== Delete ===
+==== Delete ====
 ''URL'':
@@ Line 534: / Line 536: @@
 |}
-=== Edit ===
+==== Edit ====
 ''URL'':
@@ Line 573: / Line 575: @@
 </pre>
-== IP Safelist ==
+=== IP Safelist ===
-=== Index ===
+==== Index ====
 ''URL'':
@@ Line 615: / Line 617: @@
 {"addresses":["192.168.0.1","192.168.0.2"]}
-=== Add ===
+==== Add ====
 ''URL'':
@@ Line 645: / Line 647: @@
 |}
-=== Delete ===
+==== Delete ====
 ''URL'':
@@ Line 675: / Line 677: @@
 |}
-=== Edit ===
+==== Edit ====
 ''URL'':

← Older revision		Revision as of 14:29, 25 July 2013
Line 444:		Line 444:
	''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/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]

← Older revision		Revision as of 14:28, 25 July 2013
Line 589:		Line 589:
	''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]

← Older revision		Revision as of 14:28, 25 July 2013
Line 317:		Line 317:
	''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]