Skip to main content
GET
/
core
/
v1
/
domains
/
{domainName}
/
email
/
forwarding
/
{emailBox}
Get Email Forwarding
curl --request GET \
  --url https://api.dev.name.com/core/v1/domains/{domainName}/email/forwarding/{emailBox} \
  --header 'Authorization: Basic <encoded-value>'
{
  "domainName": "example.com",
  "emailBox": "admin",
  "emailTo": "webmaster@example.com"
}

Authorizations

​
Authorization
string
header
required

Authenticate via HTTP Basic with your account username and API token. Examples use an explicit 'Authorization: Basic <base64(username:token)>' header; 'curl -u username:token' is equivalent. For sandbox, append "-test" to your username and use your sandbox token on api.dev.name.com.

Path Parameters

​
domainName
string
required

DomainName is the domain to list email forwarded box for.

​
emailBox
string
required

EmailBox is which email box to retrieve.

Response

A successful response.

EmailForwarding contains all the information for an email forwarding entry.

​
domainName
string
required

DomainName is the domain part of the email address to forward.

Minimum length: 1
Example:

"example.com"

​
emailBox
string
required

EmailBox is the user portion of the email address to forward.

Minimum length: 1
Example:

"admin"

​
emailTo
string<email>
required

EmailTo is the entire email address to forward email to.

Example:

"webmaster@example.com"

⌘I