SetDomainNotify()

From Rackspace Email & Apps API
Jump to: navigation, search

This function will set the notification percentage and message to use when a mailbox on a domain starts to get full. It can also configure another email address to receive a copy of the notification.

There are two special tags that can be used inside the notification message:

   <*USER*> will insert the userID (part before the @) of the mailbox that is getting full
   <*DOMAIN*> will insert the domain name of the mailbox that is getting full

Input Parameters

Six strings:

   Administrative username,
   Administrative password,
   Domain name,
   Notify percentage (string, whole numbers 0-100 only; 0 turns off notices)
   CC: address (string email address of someone who should *also* receive a copy of the notice, "" for none)
   Notify message (string of text of notification message).

Return Values

If successful, the return value of the function will be 1.

Consult the Result Code Table for a list of result codes and their meaning.