Email forwards API

Email Forward attributes

Please refer to the definition of the EmailForward data type in our OpenAPI documentation.

List email forwards

GET /:account/domains/:domain/email_forwards

List email forwards for the domain in the account.

Parameters

Name Type Description
:account integer The account id
:domain string, integer The domain name or id

Sorting

For general information about sorting, please refer to the main guide.

Deprecated since 25 January 2021

The from and to fields in Email Forward schema have been deprecated. The from field has been renamed to alias_email and the to field has been renamed to destination_email for clarity. Use alias_email and destination_email instead.

Name Description
id Sort email forwards by ID
from Sort email forwards by sender (alphabetical order)
to Sort email forwards by recipient (alphabetical order)

The default sorting policy is by ascending id.

Example

List all email forwards for the domain example.com in the account 1010:

curl  -H 'Authorization: Bearer <token>' \
      -H 'Accept: application/json' \
      https://api.dnsimple.com/v2/1010/domains/example.com/email_forwards

Response

Responds with HTTP 200.

{
  "data": [
    {
      "id": 24809,
      "domain_id": 235146,
      "alias_email": ".*@a-domain.com",
      "destination_email": "jane.smith@example.com",
      "created_at": "2017-05-25T19:23:16Z",
      "updated_at": "2017-05-25T19:23:16Z",
      "from": ".*@a-domain.com",
      "to": "jane.smith@example.com",
      "active": true
    }
  ],
  "pagination": {
    "current_page": 1,
    "per_page": 30,
    "total_entries": 1,
    "total_pages": 1
  }
}

Errors

Responds with HTTP 401 in case of case of authentication issues.

Create an email forward

POST /:account/domains/:domain/email_forwards

Parameters

Name Type Description
:account integer The account id
:domain string, integer The domain name or id

Example

Create an email forward under the domain example.com in the account 1010:

curl  -H 'Authorization: Bearer <token>' \
      -H 'Accept: application/json' \
      -H 'Content-Type: application/json' \
      -X POST \
      -d '<json>' \
      https://api.dnsimple.com/v2/1010/domains/example.com/email_forwards

Input

Name Type Description
alias_name string Required. The receiving email recipient, the name part only without the domain. The domain is automatically appended.
destination_email string Required. The email recipient the messages are delivered to.
Example
{
  "alias_name": "john.doe",
  "destination_email": "john@another.com"
}

Response

Responds with HTTP 201 on success, renders the email forward.

{
  "data": {
    "id": 41872,
    "domain_id": 235146,
    "alias_email": "example@dnsimple.xyz",
    "destination_email": "example@example.com",
    "created_at": "2021-01-25T13:54:40Z",
    "updated_at": "2021-01-25T13:54:40Z",
    "from": "example@dnsimple.xyz",
    "to": "example@example.com",
    "active": true
  }
}

Errors

Responds with HTTP 400 if the email forward cannot be created.

Responds with HTTP 401 in case of case of authentication issues.

Retrieve an email forward

GET /:account/domains/:domain/email_forwards/:email_forward

Parameters

Name Type Description
:account integer The account id
:domain string, integer The domain name or id
:email_forward integer The email forward id

Example

Get the email forward with the ID 1 in the domain example.com, in the account 1010:

curl  -H 'Authorization: Bearer <token>' \
      -H 'Accept: application/json' \
      https://api.dnsimple.com/v2/1010/domains/example.com/email_forwards/1

Response

Responds with HTTP 200, renders the email forward.

{
  "data": {
    "id": 41872,
    "domain_id": 235146,
    "alias_email": "example@dnsimple.xyz",
    "destination_email": "example@example.com",
    "created_at": "2021-01-25T13:54:40Z",
    "updated_at": "2021-01-25T13:54:40Z",
    "from": "example@dnsimple.xyz",
    "to": "example@example.com",
    "active": true
  }
}

Errors

Responds with HTTP 401 in case of case of authentication issues.

Delete an email forward

DELETE /:account/domains/:domain/email_forwards/:email_forward

Delete the email forward from the domain.

Parameters

Name Type Description
:account integer The account id
:domain string, integer The domain name or id
:email_forward integer The email forward id

Example

Delete the email forward with ID 1 under the domain example.com, in the account 1010:

curl  -H 'Authorization: Bearer <token>' \
      -H 'Accept: application/json' \
      -H 'Content-Type: application/json' \
      -X DELETE \
      https://api.dnsimple.com/v2/1010/domains/example.com/email_forwards/1

Response

Responds with HTTP 204 on success.

Errors

Responds with HTTP 400 if the email forward cannot be deleted.

Responds with HTTP 401 in case of case of authentication issues.