WebHostUpdatePOPPassword


Definition

Change the password for a POP mailbox in a Web hosting package.

Usage

Use this command to change the password for a POP mailbox in a Web hosting package. To change the password for a POP mailbox associated with a domain account, use one of the POP commands in our domain account API catalog.

Availability

All resellers have access to this command.

Implementation on eNom.com

Log on to webhostingtest.ehost-services.com with Login ID resellwebid, password resellwebpw.

http://webhostingtest.ehost-services.com/email/accounts.asp

The SAVE ALL CHANGES button calls the WebHostUpdatePOPPassword 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 be associated with 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 Name of the Web hosting account that contains the POP mailbox for which you want to change the password 14
UserName Required Email alias of the POP mailbox for which you want to change the password. For example, if the email address is john.doe@resellerdocs.com, supply UserName=john.doe 50
IsAdmin Either IsAdmin or NewPassword is Required. They may be used together. Should UserName have administrative privileges over all mailboxes associated with this domain name in this Web hosting account? 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 in this Web hosting account, can reset passwords for any or all mailboxes, and can delete any or all mailboxes) 1
NewPassword Either IsAdmin or NewPassword is Required. They may be used together. New password for UserName mailbox 50
SLD Required Second-level domain name (for example, enom in enom.com) 63
TLD Required Top-level domain name (extension) 15
ResponseType Optional Format of response. Options 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.
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