WebHostGetPOPBoxes


Definition

Retrieve a list of the POP mailboxes in a Web hosting account.

Usage

Use this command to generate a list of POP mailboxes in a Web hosting account.

Availability

All resellers have access to this command.

Implementation on eNom.com

Log on to webhostingtest.ehost–services.com with Login ID resellid, password resellpw.

http://webhostingtest.ehost-services.com/Default.asp?

In the Email Accounts section, the Edit link calls the WebHostGetPOPBoxes command.

Constraints

The query must meet the following requirements:

  • The login ID and password must be valid.
  • The Web hosting account must belong to this domain account.
  • The domain name must belong to this domain account, and to this Web hosting account.

Input parameters

Build the query string using this syntax:

https://resellertest.enom.com/interface.asp?
command=nameofcommand&uid=yourloginid&pw=yourpassword &paramname=paramvalue&nextparamname=nextparamvalue

 

Parameter Status Description Max Size
UID Required Account login ID 20
PW Required Account password 20
HostAccount Required Web hosting account to retrieve POP mailbox list for 14
SLD Optional Second-level domain name (for example, enom in enom.com) for which you want a list of POP mailboxes 63
TLD Optional Top-level domain name (extension) for which you want a list of POP mailboxes 15
GetQuota Optional; default is 1 Return the storage allocation for this Web hosting account? Permitted values are 0 and 1 15
ResponseType Optional Format of response. Options are Text (default), HTML, or XML. 4

 

Returned parameters and values

Parameter Description
UserNameX
Responses in HTML or text format are numbered, X=1 to POPCount
Email alias for this POP mailbox
DomainNameX Domain this POP mailbox is associated with
QuotaX Disk space in MB for this Web hosting account; can be upgraded
POPCount Total number of POP mailboxes in this Web hosting account
Command Name of command executed
ErrCount The number of errors if any occurred. If greater than 0 check the Err(1 to ErrCount) values.
Err(x) Error messages explaining the failure. These can be presented as is back to the client
Done True indicates this entire response has reached you successfully

 

Notes

  • The default response format is plain text. To receive the response in HTML or XML format, send ResponseType=HTML or ResponseType=XML in your request.
  • Check the return parameter ErrCount. If greater than 0 the transaction failed. The parameterErr(ErrCount) can be presented to the client. Otherwise process the returned parameters as defined above.

Example