GetPOPForwarding


Definition

Retrieve the email forwarding record—either POP or our email forwarding—for a specified mailbox name.

Usage

Use this command to retrieve the email forwarding record for a specified mailbox user name.

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

In the Email Settings section, the configure button retrieves forwarding records in a manner similar to the GetPOPForwarding 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 user name must be an existing email address for this domain name.

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 Mailbox name (for example, john in john@example.com) 50
ResponseType Optional Format of response. Permitted values are Text (default), HTML, or XML. 4

 

Returned parameters and values

Parameter Description
DomainName Domain SLD and TLD
DomainNameID Numeric domain name ID, from our database
UserName Mailbox name
ForwardTo Email forwarding address
Active Is this forwarding address active. 1 indicates yes.
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