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 ¶mname=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

The following query creates mailbox james@resellerdocs.com and requests the response in XML format:
Query
https://resellertest.enom.com/interface.asp?
command=SetupPop3user&uid=resellid&pw=resellpw &sld=resellerdocs&tld=com&BundleID=5134 &UserName1=james&Password1=resellpw &DisplayName1=James+Doe&responsetype=xml
In the response, the value 0 for parameter ErrCount indicates that the query was successful:
Output
<interface-response>
<Success>True</Success>
<AccountsCreated>1</AccountsCreated>
<AccountsFailed>0</AccountsFailed>
<Command>SETUPPOP3USER</Command>
<Language>eng</Language>
<ErrCount>0</ErrCount>
<ResponseCount>0</ResponseCount>
<MinPeriod>1</MinPeriod>
<MaxPeriod>10</MaxPeriod>
<Server>sjl21wresellt01</Server>
<Site>eNom</Site>
<IsLockable>True</IsLockable>
<IsRealTimeTLD>True</IsRealTimeTLD>
<TimeDifference>+8.00</TimeDifference>
<ExecTime>8.547</ExecTime>
<Done>true</Done>
<debug/>
<TrackingKey>37bb5652-5250-4483-a877-368f2eb7674f</TrackingKey>
<RequestDateTime>12/12/2011 12:57:20 AM</RequestDateTime>
</interface-response>

The following query creates mailbox james@resellerdocs.com and requests the response in HTML format:
Query
https://resellertest.enom.com/interface.asp?
command=SetupPop3user&uid=resellid&pw=resellpw &sld=resellerdocs&tld=com&BundleID=5134 &UserName1=james&Password1=resellpw &DisplayName1=James+Doe&responsetype=html
In the response, the value 0 for parameter ErrCount indicates that the query was successful:
Output
;URL Interface
;Machine is SJL0VWRESELL_T1
;Encoding Type is utf-8
Success: True
AccountsCreated: 1
AccountsFailed: 0
Command: SETUPPOP3USER
APIType: API.NET
Language: eng
ErrCount: 1
Err1: Invalid Item specified
ResponseCount: 0
MinPeriod: 1
MaxPeriod: 10
Server: sjl0vwresell_t1
Site: eNom
IsLockable:
IsRealTimeTLD:
TimeDifference: +0.00
ExecTime: 0.172
Done: true
TrackingKey: 6d72b4a4-8558-4c99-b222-3b00c0f3926d
RequestDateTime: 2/5/2015 3:40:01 PM

The following query creates mailbox james@resellerdocs.com and requests the response in Text format:
Query
https://resellertest.enom.com/interface.asp?
command=SetupPop3user&uid=resellid&pw=resellpw &sld=resellerdocs&tld=com&BundleID=5134 &UserName1=james&Password1=resellpw &DisplayName1=James+Doe&responsetype=text
In the response, the value 0 for parameter ErrCount indicates that the query was successful:
Output
;URL Interface
;Machine is SJL0VWRESELL_T1
;Encoding Type is utf-8
Success=True
AccountsCreated=1
AccountsFailed=0
Command=SETUPPOP3USER
APIType=API.NET
Language=eng
ErrCount=1
Err1=Invalid Item specified
ResponseCount=0
MinPeriod=1
MaxPeriod=10
Server=sjl0vwresell_t1
Site=eNom
IsLockable=
IsRealTimeTLD=
TimeDifference=+0.00
ExecTime=0.094
Done=true
TrackingKey=5715a3fd-e803-4105-a57e-75ebbb9231d1
RequestDateTime=2/5/2015 3:41:19 PM