SetPOPForwarding


Definition

Create, change, or delete an email forwarding address for a domain name.

Usage

Use this command to create, update, or delete email forwarding records for a domain name.

This command can be used to configure email forwarding addresses for both our POP mail and our email forwarding services.

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

The save changes button calls the SetPOPForwarding 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.

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
UserName Required The user name for this mailbox (email address will be UserName@sld.tld). 30
EMail Required Domain for this mailbox. Must be the same values as SLD and TLD above. Use format SLD.TLD (email address will be UserName@sld.tld). 78
ForwardTo Required Email address to forward to. Use format ForwardingAddress@example.com 130
Enable Required Add this email forwarding. Permitted values are:
0 Delete this email forwarding address
1 Add or change this email forwarding address
1
StatusFlags Optional Deliver to forwarding address. Permitted values are:
no value Deliver to original mailbox only
0 Deliver to both original mailbox and forwarding address
1 Deliver only to the forwarding address
1
ResponseType Optional Format of response. Permitted values are Text (default), HTML, or XML. 4

 

Returned parameters and values

Parameter Description
Success 1 indicates the query was successful
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