Difference between revisions of "AddDomain()"

From Rackspace Email & Apps API
Jump to: navigation, search
(New page: This function will add a new sub-account and place a new domain inside that subaccount. If you need to add a new domain to an existing account, use Subaccount_AddDomain(). ===Paramet...)
 
 
(One intermediate revision by the same user not shown)
Line 3: Line 3:
 
===Parameters===
 
===Parameters===
  
Four strings, three integers, three more strings:
+
Four strings, three integers, two more strings, and a string array:
 
     Administrative username,
 
     Administrative username,
 
     Administrative password,
 
     Administrative password,
Line 13: Line 13:
 
     New admin username (username of first admin for the subaccount),
 
     New admin username (username of first admin for the subaccount),
 
     New admin password (password of first admin for the subaccount),
 
     New admin password (password of first admin for the subaccount),
     Placeholder (string, set it to empty)
+
     Placeholder (array of strings, set it to empty)
 
===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 08:53, 21 October 2008

This function will add a new sub-account and place a new domain inside that subaccount. If you need to add a new domain to an existing account, use Subaccount_AddDomain().

Parameters

Four strings, three integers, two more strings, and a string array:

   Administrative username,
   Administrative password,
   Name of account/domain to be added,
   Aliases to the domain (e.g. example.net might be an alias to example.com, emptry string if no domain aliases),
   Max mailbox size (integer, MB, default max size for mailboxes when created for this domain),
   Max number of users (integer),
   Placeholder (integer, set it to 1),
   New admin username (username of first admin for the subaccount),
   New admin password (password of first admin for the subaccount),
   Placeholder (array of strings, set it to empty)

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.