Rackspace Storage Notification (Rest API)

From Rackspace Email & Apps API
Revision as of 14:45, 12 January 2017 by Appscp (talk | contribs) (remove accept header from examples to avoid confusion)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to: navigation, search

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.


Example:

get '/customers/12345678/domains/example.com/rs/storageNotification'


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.

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:

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