name.com API

ListEmailForwardings

ListEmailForwardings returns a paginated list of email forwarding entries for a domain.

Endpoint: GET /v4/domains/{domainName}/email/forwarding

Parameters:

domainName
(path parameters)

string

DomainName is the domain to list email forwarded boxes for.

perPage

int32

Per Page is the number of records to return per request. Per Page defaults to 1,000.

page

int32

Page is which page to return.

Response:

emailForwarding

[]*EmailForwarding


(Model Definition)

EmailForwarding is the list of forwarded email boxes.

nextPage

int32

NextPage is the identifier for the next page of results. It is only populated if there is another page of results after the current page.

lastPage

int32

LastPage is the identifier for the final page of results. It is only populated if there is another page of results after the current page.

Example:

curl -u 'username:token' 'https://api.dev.name.com/v4/domains/example.org/email/forwarding'
{
    "emailForwarding": [
        {
            "domainName": "example.org",
            "emailBox": "admin",
            "emailTo": "webmaster@example.net"
        }
    ]
}

GetEmailForwarding

GetEmailForwarding returns an email forwarding entry.

Endpoint: GET /v4/domains/{domainName}/email/forwarding/{emailBox}

Parameters:

domainName
(path parameters)

string

DomainName is the domain to list email forwarded box for.

emailBox
(path parameters)

string

EmailBox is which email box to retrieve.

Response:

domainName
(read only)

string

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

emailBox

string

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

emailTo

string

EmailTo is the entire email address to forward email to.

Example:

curl -u 'username:token' 'https://api.dev.name.com/v4/domains/example.org/email/forwarding/admin'
{
    "domainName": "example.org",
    "emailBox": "admin",
    "emailTo": "webmaster@example.net"
}

CreateEmailForwarding

CreateEmailForwarding creates an email forwarding entry. If this is the first email forwarding entry, it may modify the MX records for the domain accordingly.

Endpoint: POST /v4/domains/{domainName}/email/forwarding

Parameters:

domainName
(path parameters)

string

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

emailBox

string

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

emailTo

string

EmailTo is the entire email address to forward email to.

Response:

domainName
(read only)

string

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

emailBox

string

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

emailTo

string

EmailTo is the entire email address to forward email to.

Example:

curl -u 'username:token' 'https://api.dev.name.com/v4/domains/example.org/email/forwarding' -X POST -H 'Content-Type: application/json' --data '{"emailBox":"admin","emailTo":"webmaster@example.net"}'
{
    "domainName": "example.org",
    "emailBox": "admin",
    "emailTo": "webmaster@example.net"
}

UpdateEmailForwarding

UpdateEmailForwarding updates which email address the email is being forwarded to.

Endpoint: PUT /v4/domains/{domainName}/email/forwarding/{emailBox}

Parameters:

domainName
(path parameters)

string

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

emailBox
(path parameters)

string

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

emailTo

string

EmailTo is the entire email address to forward email to.

Response:

domainName
(read only)

string

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

emailBox

string

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

emailTo

string

EmailTo is the entire email address to forward email to.

Example:

curl -u 'username:token' 'https://api.dev.name.com/v4/domains/example.org/email/forwarding/admin' -X PUT -H 'Content-Type: application/json' --data '{"emailTo":"webmaster@example.net"}'
{
    "domainName": "example.org",
    "emailBox": "admin",
    "emailTo": "webmaster@example.net"
}

DeleteEmailForwarding

DeleteEmailForwarding deletes the email forwarding entry.

Endpoint: DELETE /v4/domains/{domainName}/email/forwarding/{emailBox}

Parameters:

domainName
(path parameters)

string

DomainName is the domain to delete the email forwarded box from.

emailBox
(path parameters)

string

EmailBox is which email box to delete.

Response:

Empty response.

Example:

curl -u 'username:token' 'https://api.dev.name.com/v4/domains/example.org/email/forwarding/admin' -X DELETE
{}