Rackspace Storage Notification (Rest API) - Revision history

Appscp: remove accept header from examples to avoid confusion

2017-01-12T21:45:07Z

remove accept header from examples to avoid confusion

Appscp: /* v1 - Current */

2016-03-01T15:44:46Z

‎v1 - Current

Appscp at 18:46, 23 September 2014

2014-09-23T18:46:25Z

Appscp: v1 documentation

2013-12-04T22:23:39Z

v1 documentation

Appscp: /* Show */

2013-07-25T14:30:25Z

‎Show

Zhen.wei: minor typo fix.

2011-06-21T15:50:09Z

minor typo fix.

James.morgan: Created page with 'TOC == Show == ''URL'': [GET] https://api.emailsrvr.com/v0/customers/(customer account number)/domains/(domain name) /rs/storageNotification) ''…'

2010-11-01T02:52:20Z

Created page with '__TOC__ == Show == ''URL'': <nowiki>[GET] https://api.emailsrvr.com/v0/customers/(customer account number)/domains/(domain name) /rs/storageNotification)</nowiki> ''…'

New page

__TOC__

== Show ==

''URL'':
<nowiki>[GET] https://api.emailsrvr.com/v0/customers/(customer account number)/domains/(domain name)
/rs/storageNotification)</nowiki>

''Description'':

The show operation will return detailed information about a given domain's Rackspace Mailbox storage notification settings that control whether an email notification is sent to users when their mailbox reaches a certain capacity.

''Remarks'':

The show operation only supports the GET HTTP verb. For .xml format refer to the following schema document: [http://api.emailsrvr.com/v0/Schemas/RSMailbox.xsd RSMailbox.xsd]

''Example'':
<pre>
get '/customers/12345678/domains/example.com/rs/storageNotification', 'text/xml'
</pre>

''XML Result Example'':
<pre>
<rsStorageNotification xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns="urn:xml:rsStorageNotification">
<enabled>true</enabled>
<notificationCC>test@email.net</notificationCC>
<notificationMessage>The mailbox is getting full.</notificationMessage>
<notificationPercentage>99</notificationPercentage>
</rsStorageNotification>
</pre>

''Json Result Example'':
<pre>
{"enabled":true, "notificationCC":"test@email.net", "notificationMessage":"Test", "notificationPercentage":99}
</pre>

== Edit ==

''URL'':
Edit: [PUT] https://api.emailsrvr.com/v0/customers/(customer account number)/domains/(domain name)
/rs/storageNotification</nowiki>

''Description'':

The edit operation will set detailed information about a given domain's Rackspace Mailbox storage notification settings.

{| class="wikitable"
!''Field Name''
!''Data Type''
!''Description''
|-
| enabled
| boolean
| Activates domain storage notification. (Required for Add)
|-
| notificationPercentage
| int
| The storage percentage that triggers the notification. (Required for Add) (Valid Values: 50, 60, 70, 80, 90, 99)
|-
| notificationMessage
| string
| The notification message. (The special tag <*USER*> will substitute in the username. The special tag <*DOMAIN*> will substitute in the domain.)
|-
| notificationCC
| string
| An email address the notification message will be carbon copied to.
|}

''Example'':
<pre>
post '/customers/12345678/domains/example.com/rs/mailboxes/alex.smith', 'text/xml',
{
'enabled' => 'true',
'notificationPercentage' => '90',
'notificationMessage' => 'Your mailbox "<*USER*>@<*DOMAIN*>" is almost full.',
'notificationCC' => 'test@testdomain.com'
}
</pre>

← Older revision		Revision as of 15:44, 1 March 2016
Line 16:		Line 16:
	''Remarks'':		''Remarks'':

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

@@ Line 1: / Line 1: @@
 __TOC__
-== v0 - Current ==
+== v1 - Current ==
 === Show ===
 ''URL'':
-  <nowiki>[GET] https://api.emailsrvr.com/v0/customers/(customer account number)/domains/(domain name)/rs/storageNotification</nowiki>
+  <nowiki>[GET] https://api.emailsrvr.com/v1/customers/(customer account number)/domains/(domain name)/rs/storageNotification</nowiki>
@@ Line 43: / Line 43: @@
 ''URL'':
-  <nowiki>[PUT] https://api.emailsrvr.com/v0/customers/(customer account number)/domains/(domain name)/rs/storageNotification</nowiki>
+  <nowiki>[PUT] https://api.emailsrvr.com/v1/customers/(customer account number)/domains/(domain name)/rs/storageNotification</nowiki>
 ''Description'':

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

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

@@ Line 21: / Line 21: @@
 ''Example'':
 <pre>
-get '/customers/12345678/domains/example.com/rs/storageNotification', 'text/xml'
+get '/customers/12345678/domains/example.com/rs/storageNotification'
 </pre>
@@ Line 73: / Line 73: @@
 ''Example'':
 <pre>
-post '/customers/12345678/domains/example.com/rs/mailboxes/alex.smith', 'text/xml',
+post '/customers/12345678/domains/example.com/rs/mailboxes/alex.smith',
+{
    'enabled' => 'true',

@@ Line 4: / Line 4: @@
 ''URL'':
-  <nowiki>[GET] https://api.emailsrvr.com/v0/customers/(customer account number)/domains/(domain name)
+  <nowiki>[GET] https://api.emailsrvr.com/v0/customers/(customer account number)/domains/(domain name)/rs/storageNotification</nowiki>
@@ Line 42: / Line 41: @@
 ''URL'':
-Edit: [PUT] https://api.emailsrvr.com/v0/customers/(customer account number)/domains/(domain name)
+ <nowiki>[PUT] https://api.emailsrvr.com/v0/customers/(customer account number)/domains/(domain name)/rs/storageNotification</nowiki>
 ''Description'':
@@ Line 56: / Line 54: @@
 | enabled
 | boolean
-| Activates domain storage notification. (Required for Add)
+| Activates domain storage notification. (Required)
 |-
 | notificationPercentage