GetForwarding


Definition

Get email forwarding records for a domain name.

Usage

Use this command to display email forwarding records for a domain name.

A similar command, GetPOPForwarding, displays both email forwarding and POP records for a single email address.

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

On the domain control panel, if the e-mail settings service is set to e-mail forwarding, the configure button calls the GetForwarding 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 email forwarding 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
UserNameX Alias name to forward. Indexed X when ResponseType=Text or HTML.
Alias Alias name to forward. Present when ResponseType=XML
ForwardToX Email address to forward the alias to. Indexed X when ResponseType=Text or HTML.
Forward-To Email address to forward the alias to. Present when ResponseType=XML
StatusX Enabled status of email forwarding: 0 Email forwarding enabled 1 Email forwarding disabled Indexed X when ResponseType=Text or HTML.
EmailCount Number of email forwarding records currently configured
MaxEmail Total number of email forwarding records permitted for this domain name
EmailForwarding True
HostRecords True
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