GetPOP3


Definition

Gets all POP3 accounts for a domain name.

Usage

Use this command to generate a list of the POP mail accounts belonging to a domain name. Return information includes mailbox names and BundleID numbers for the domain’s POP paks.

Availability

All resellers have access to this command.

Implementation on eNom.com

Log on to resellertest.enom.com with Login ID resellid, password resellpw.

https://resellertest.enom.com/domains/DomainDetail.asp?DomainNameID=152533676

In the domain control panel, email settings box, if the current service is POP mail, clicking the configure button calls the GetPOP3 command.

Constraints

The query must meet the following requirements:

  • The login ID and password must be valid.
  • The domain name must belong to this account.
  • The domain must use eNom’s domain name servers.

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
SLD Required Second-level domain name (for example, enom in enom.com) 63
TLD Required Top-level domain name (extension) 15
GetDefaultOnly Optional If this is set to 1, extra blank input records are returned for user input on the POP3 form. Primarily used in XML output. 1
ResponseType Optional Format of response. Permitted values are Text (default), HTML, or XML. 4

 

Returned parameters and values

Parameter Description
EmailCount Number of email accounts on the domain name.
UsernameX POP user name for this email account (this mailbox). Indexed X = 1 to
EmailCount if ResponseType=text or HTML.
PasswordX POP password name for the email account. Indexed X = 1 to EmailCount if ResponseType=text or HTML.
QuotaX Maximum storage capacity for each mailbox, in megabytes. Indexed X = 1 to EmailCount if ResponseType=text or HTML.
ExpDateX Expiration date of the POP3 account. Indexed X = 1 to EmailCount if ResponseType=text or HTML.
BundleIDX ID number of this POP pak. Indexed X = 1 to EmailCount if ResponseType=text or HTML.
AutoRenewX Auto-renewal setting for this POP3 account and its POP pak. 1 signifies that auto-renew is on, 0 off. Indexed X = 1 to EmailCount if ResponseType=text or HTML.
QuotaUsedX Number of MB of storage space currently in use for this account. Indexed X =1 to EmailCount if ResponseType=text or HTML.
[Pak]BundleIDX ID number of this POP pak. Prefixed Pak and indexed X = 1 to Count if ResponseType=text or HTML.
[Pak]QtyPurchasedX Total number of POP accounts that have been purchased for this domain name. Prefixed xed X = 1 to Count if ResponseType=text or HTML.
[Pak]QtyAvailableX Total number of POP accounts currently configured for this domain name. Prefixed xed Pak and indexed X = 1 to Count if ResponseType=text or HTML.
[Pak]ExpDateX Expiration date of this POP pak. Prefixed Pak and indexed X = 1 to Count if ResponseType=text or HTML.
[Pak]AutoRenewX Auto-renewal setting for this POP pak. 1 signifies that auto-renew is on, 0 off. Prefixed Pak and indexed X = 1 to Count if ResponseType=text or HTML.
[Pak]QuotaX Maximum storage capacity for each mailbox, in megabytes. Prefixed Pak and indexed X = 1 to Count if ResponseType=text or HTML.
Command Name of command executed
ErrCount The number of errors if any occurred. If The number of errors if any occurred. If greater than 0 check the Err(1 to ErrCount) values.
ErrX 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 textThe 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 eater than 0 the transaction failed If greater than 0 the transaction failed. The parameter Err(ErrCount) can be presented to the client. Otherwise process the returned parameters as defined above.

Example