View source for Rackspace Storage Notification (Rest API)

__TOC__

== v1 - Current ==

=== Show ===

''URL'':
 <nowiki>[GET] https://api.emailsrvr.com/v1/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.


''Example'':
<pre>
get '/customers/12345678/domains/example.com/rs/storageNotification'
</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'':
 <nowiki>[PUT] https://api.emailsrvr.com/v1/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)
|-
| 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',
{ 
  'enabled' => 'true',
  'notificationPercentage' => '90',
  'notificationMessage' => 'Your mailbox "<*USER*>@<*DOMAIN*>" is almost full.',
  'notificationCC' => 'test@testdomain.com'
} 
</pre>