Difference between revisions of "Rackspace Storage Notification (Rest API)"

Revision as of 10:46, 23 September 2014

v1 - Current

Show

URL:

[GET] https://api.emailsrvr.com/v1/customers/(customer account number)/domains/(domain name)/rs/storageNotification

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: RSMailbox.xsd

Example:

get '/customers/12345678/domains/example.com/rs/storageNotification', 'text/xml'

XML Result Example:

<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>

Json Result Example:

{"enabled":true, "notificationCC":"test@email.net", "notificationMessage":"Test", "notificationPercentage":99}

Edit

URL:

[PUT] https://api.emailsrvr.com/v1/customers/(customer account number)/domains/(domain name)/rs/storageNotification

Description:

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

Example:

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'
}