SetUpPOP3User


Definition

Set up a POP3 mailbox for your domain.

Usage

Use this command when you have purchased a POP3 email pak (see PurchasePOPBundle) and want to set up mailboxes for your domain.

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/POPConfig.asp?DomainNameID=152533676

On the POP3 Mail page, below the Add users to this Email Pak box, the save changes button calls the SetUpPOP3User 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.
  • A POP mail pak must have been purchased for the domain and the correct BundleID supplied.
  • There must be at least one mailbox available in the email pak (BundleID) referenced.

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
BundleID Required POP pak ID number to add the user to (must have already been purchased). The order confirmation for purchasing the bundle contains the Bundle ID, or you can retrieve it using the GetPOP3 command. integer
UserNameX Required The user name to set up (email address will be UserNameX@sld.tld).
UserNameX is indexed, starting with UserName1. You can configure multiple user names in a single query string
30
IsAdminX Optional Should UserNameX have administrative privileges over all mailboxes associated with this domain name. Administrative privileges allow this user to reset the password for mailboxes, and delete mailboxes. Permitted values are:
0 Regular user (can change the password for their own mailbox but no one else’s)
1 Administrator (when this user logs on to Webmail and goes to the admin page, he or she can see all mailboxes for this domain name, can reset passwords for any or all mailboxes, and can delete any or all mailboxes).
IsAdminX is indexed, starting with IsAdmin1. You can configure multiple user names in a single query string
1
PasswordX Required POP3 password.
PasswordX is indexed, starting with Password1. You can configure multiple user names in a single query string
50
DisplayNameX Optional User's full name, as it appears in return name in Web mail.
DisplayNameX is indexed, starting with DisplayName1. You can configure multiple user names in a single query string
60
ResponseType Optional Format of response. Permitted values are Text (default), HTML, or XML. 4

 

Returned parameters and values

Parameter Description
Command Name of command executed
ErrCount 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 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 parameter Err(ErrCount) can be presented to the client. Otherwise process the returned parameters as defined above.

Example