Difference between revisions of "GetDomainSettings()"

From Rackspace Email & Apps API
Jump to: navigation, search
(New page: This function will report domain level settings including: domain aliases, base max mailbox size, max mailboxes, and the first username and password on the subaccount holding the domain. ...)
 
(Parameters)
 
Line 12: Line 12:
 
     Max permitted mailboxes (integer, 0 = no limit),
 
     Max permitted mailboxes (integer, 0 = no limit),
 
     Placeholder integer (ignore contents),
 
     Placeholder integer (ignore contents),
     Admin username,
+
     Admin username
    Admin password (unencrypted return value-- though the conversation happens over SSL)
+
 
 
===Return Values===
 
===Return Values===
 
If successful, the return value of the function will be 1.
 
If successful, the return value of the function will be 1.
  
 
Consult the [[resultcodes|Result Code Table]] for a list of result codes and their meaning.
 
Consult the [[resultcodes|Result Code Table]] for a list of result codes and their meaning.

Latest revision as of 15:15, 13 July 2012

This function will report domain level settings including: domain aliases, base max mailbox size, max mailboxes, and the first username and password on the subaccount holding the domain.

Parameters

Three strings, a result string, three result integers, and two more result strings:

   Administrative username,
   Administrative password,
   Domain name,
   Domain alias list (comma delimited string as in "company.net, company.com"),
   Base max mailbox size (integer, MB, default max size for mailboxes on the domain),
   Max permitted mailboxes (integer, 0 = no limit),
   Placeholder integer (ignore contents),
   Admin username

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.