API Documentation

Everything you must know in one place


Gets email forwarding settings for the requested domain.

Example Request


Request Parameters

Global parameters are not shown here for clarity, but should be present in all requests

Name Type MaxLength Required? Description
DomainName String 70 Yes Domain name to get settings

Example Response

<?xml version="1.0" encoding="UTF-8"?>
<ApiResponse Status="OK">
  <Errors />
  <CommandResponse Type="namecheap.domains.dns.getEmailForwarding">
    <DomainDNSGetEmailForwardingResult Domain="domain.com">
      <Forward mailbox="name1">name1@domain.com</Forward>
      <Forward mailbox="name2">name2@domain.com</Forward>

Response Parameters

Name Description
Domain The domain name for which you are trying to get email forwarding details.
Mailbox The email forwarding mailbox that was created.

Error Codes

Specifies the error codes that might be returned from this method

Number Description
2019166 Domain not found
2030166 Edit permission for domain is not supported
2030288 Cannot complete this command as this domain is not using proper DNS servers
3031510 Error From Enom when Errorcount <> 0
3050900 Unknown error from Enom
4022328 Unable to get EmailForwarding records from database
3011288 Invalid nameserver
5050900 Unhandled Exceptions


We welcome your comments, questions, corrections and additional information relating to this article. Your comments may take some time to appear. Please be aware that off-topic comments will be deleted.

If you need specific help with your account, feel free to contact our Support Team. Thank you.

Need help? We're always here for you.

× Close