Dovecot

Create Admin:

Function To create a new admin account
Command CMD_ACCOUNT_ADMIN
Method GET or POST
Success Returns Text
Failure Returns Text
Form Values:
Name Value
actioncreate
usernameThe Admin's username. 4-8 characters, alphanumeric
email A valid email address
passwd The admins password. 5+ characters, ascii
passwd2 Password double check. 5+ characters, ascii
notify yes or no. If yes, an email will be sent to email

Create Admin:

Function To create a new admin account. Exactly the same as CMD_ACCOUNT_ADMIN except return value
Command CMD_API_ACCOUNT_ADMIN
Method GET or POST
Success Returns error=0&text=text&details=details
Failure Returns error=1&text=text&details=details

Create Reseller:

Function To create a new reseller account using a pre-made package
Command CMD_ACCOUNT_RESELLER
Method GET or POST
Success Returns Text
Failure Returns Text
Form Values:
Name Value
action create
add Submit
username The Reseller's username. 4-8 characters, alphanumeric
email A valid email address
passwdThe admins password. 5+ characters, ascii
passwd2Password double check. 5+ characters, ascii
domain A valid domain name in the form: domain.com
package One of the Reseller packages created by an admin
ip shared, sharedreseller or assign. If shared, domain will use the server's main ip. assign will use one of the reseller's ips. sharedreseller will set the resellers ip to shared and assign the reseller to it.
notify yes or no. If yes, an email will be sent to email

Create Custom Reseller:

Function To create a new reseller account without the need for a reseller package
Command CMD_ACCOUNT_RESELLER
Method GET or POST
Success Returns Text
Failure Returns Text
Form Values:
Name Value
action create
add Submit
username The Reseller's username. 4-8 characters, alphanumeric
email A valid email address
passwd The admins password. 5+ characters, ascii
passwd2 Password double check. 5+ characters, ascii
domain A valid domain name in the form: domain.com
bandwidth Amount of bandwidth Reseller will be allowed to use. Number, in Megabytes
ubandwidth ON or OFF. If ON, bandwidth is ignored and no limit is set
quota Amount of disk space Reseller will be allowed to use. Number, in Megabytes
uquota ON or OFF. If ON, quota is ignored and no limit is set
vdomains Number of domains the reseller and his/her User's are allowed to create
uvdomains ON or OFF. If ON, vdomains is ignored and no limit is set
nsubdomains Number of subdomains the reseller and his/her User's are allowed to create
unsubdomains ON or OFF. If ON, nsubdomains is ignored and no limit is set
ips Number of ips that will be allocated to the Reseller upon account during account
nemails Number of pop accounts the reseller and his/her User's are allowed to create
unemailsON or OFF Unlimited option for nemails
nemailfNumber of forwarders the reseller and his/her User's are allowed to create
unemailf ON or OFF Unlimited option for nemailf
nemailml Number of mailing lists the reseller and his/her User's are allowed to create
unemailmlON or OFF Unlimited option for nemailml
nemailrNumber of autoresponders the reseller and his/her User's are allowed to create
unemailr ON or OFF Unlimited option for nemailr
mysql Number of MySQL databases the reseller and his/her User's are allowed to create
umysql ON or OFF Unlimited option for mysql
domainptr Number of domain pointers the reseller and his/her User's are allowed to create
udomainptr ON or OFF Unlimited option for domainptr
ftp Number of ftp accounts the reseller and his/her User's are allowed to create
uftp ON or OFF Unlimited option for ftp
aftp ON or OFF If ON, the reseller and his/her users will be able to have anonymous ftp accounts.
php ON or OFF If ON, the reseller and his/her users will have the ability to run php scripts.
cgi ON or OFF If ON, the reseller and his/her users will have the ability to run cgi scripts in their cgi-bins.
ssl ON or OFF If ON, the reseller and his/her users will have the ability to access their websites through secure https://.
ssh ON or OFF If ON, the reseller will be have an ssh account.
userssh ON or OFF If ON, the reseller will be allowed to create ssh accounts for his/her users.
dnscontrol ON or OFF If ON, the reseller will be able to modify his/her dns records and to create users with or without this option.
dns OFF or TWO or THREE. If OFF, no dns's will be created. TWO: domain ip for ns1 and another ip for ns2. THREE: domain has own ip. ns1 and ns2 have their own ips
serverip ON or OFF If ON, the reseller will have the ability to create users using the servers main ip.
ip shared or assign. If shared, domain will use the server's main ip. assign will use one of the reseller's ips
notify yes or no. If yes, an email will be sent to email

Create Reseller:

Function To create a new reseller account. Exactly the same as CMD_ACCOUNT_RESELLER except return value
Command CMD_API_ACCOUNT_RESELLER
Method GET or POST
Success Returns error=0&text=text&details=details
Failure Returns error=1&text=text&details=details

Create User:

Function To create a new user account using a pre-made package
Command CMD_API_ACCOUNT_USER
Method GET or POST
Success Returns Text
Failure Returns Text
Form Values:
Name Value
action create
add Submit
username The User's username. 4-8 characters, alphanumeric
email A valid email address
passwd The User's password. 5+ characters, ascii
passwd2 Password double check. 5+ characters, ascii
domain A valid domain name in the form: domain.com
package One of the User packages created by the Reseller
ip One of the ips which is available for user creation. Only free or shared ips are allowed.
notify yes or no. If yes, an email will be sent to email

Create Custom User:

Function To create a new user account without the need for a user package
Command CMD_API_ACCOUNT_USER
Method GET or POST
Success Returns Text
Failure Returns Text
Form Values:
Name Value
action create
add Submit
username The Users's username. 4-8 characters, alphanumeric
email A valid email address
passwd The User's password. 5+ characters, ascii
passwd2 Password double check. 5+ characters, ascii
domain A valid domain name in the form: domain.com
bandwidth Amount of bandwidth User will be allowed to use. Number, in Megabytes
ubandwidth ON or OFF. If ON, bandwidth is ignored and no limit is set
quota Amount of disk space User will be allowed to use. Number, in Megabytes
uquota ON or OFF. If ON, quota is ignored and no limit is set
vdomains Number of domains the User will be allowed to create
uvdomains ON or OFF. If ON, vdomains is ignored and no limit is set
nsubdomains Number of subdomains the User will be allowed to create
unsubdomains ON or OFF. If ON, nsubdomains is ignored and no limit is set
nemails Number of pop accounts the User will be allowed to create
unemails ON or OFF Unlimited option for nemails
nemailf Number of forwarders the User will be allowed to create
unemailf ON or OFF Unlimited option for nemailf
nemailml Number of mailing lists the User will be allowed to create
unemailml ON or OFF Unlimited option for nemailml
nemailr Number of autoresponders the User will be allowed to create
unemailr ON or OFF Unlimited option for nemailr
mysql Number of MySQL databases the User will be allowed to create
umysql ON or OFF Unlimited option for mysql
domainptr Number of domain pointers the User will be allowed to create
udomainptr ON or OFF Unlimited option for domainptr
ftp Number of ftp accounts the User will be allowed to create
uftp ON or OFF Unlimited option for ftp
aftp ON or OFF If ON, the User will be able to have anonymous ftp accounts.
cgi ON or OFF If ON, the User will have the ability to run cgi scripts in their cgi-bin.
php ON or OFF If ON, the User will have the ability to run php scripts.
spam ON or OFF If ON, the User will have the ability to run scan email with SpamAssassin.
cron ON or OFF If ON, the User will have the ability to creat cronjobs.
catchall ON or OFF If ON, the User will have the ability to enable and customize a catch-all email (*@domain.com).
ssl ON or OFF If ON, the User will have the ability to access their websites through secure https://.
ssh ON or OFF If ON, the User will have an ssh account.
sysinfo ON or OFF If ON, the User will have access to a page that shows the system information.
dnscontrol ON or OFF If ON, the User will be able to modify his/her dns records.

Create User:

Function To create a new User account. Exactly the same as CMD_ACCOUNT_USER except return value
Command CMD_API_ACCOUNT_USER
Method GET or POST
Success Returns error=0&text=text&details=details
Failure Returns error=1&text=text&details=details

Get List of IPs and get IP info:

Function To get the list of IPs currently owned by this reseller. If value ip is passed, information about that IP is returned instead
Command CMD_API_SHOW_RESELLER_IPS
Method GET or POST
Success Returns url encoded array in list[] OR url encoded string
Failure Returns error=1
Form Values:
Name Value
( ip ) Optional. If passed, info about the ip is generated. If not, the list of IPs is generated in the list[]. Information includes: ns: if a nameserver is on this ip, it will be listed here, reseller: if allocated to a reseller, their username will be here , status: “server” (server's ip) “owned” or “free”, value:if owned, the user who owns it, else the # of users using it
 
commands/accounts.txt · Last modified: 2010/03/01 22:18 by muscardin
 
Except where otherwise noted, content on this wiki is licensed under the following license:CC Attribution-Noncommercial-Share Alike 3.0 Unported
Please visit Automatic Backlinks to start earning free backlinks Recent changes RSS feed Donate Powered by PHP Valid XHTML 1.0 Valid CSS Driven by DokuWiki Can't choose poker website? Play at the no deposit poker and forget about bad luck!