ForwardMX has a fully featured API that is available on all account tiers, allowing you to add/update/delete domains and aliases from your applications.
It uses HTTP GET or HTTP POST with standard form field elements to receive the data, and returns a JSON object.
You must include a User-Agent header with both:
- The name of your application
- A link to your application or your email address
We use this information to get in touch if you're doing something wrong. Here are examples of acceptable User-Agent headers:
User-Agent: My Awesome Website (http://myawesomewebsite.com/contact.php)User-Agent: Ewen Montagu ([email protected])
If you don't include a User-Agent header, you may receive a 400 Bad Request or a 403 Forbidden response.
We also have a WordPress plugin and Ruby Gem, as well as an unofficial PHP/Composer library from Eduard Wiesner and an unofficial Clojure library from ianjs.
GET/POST https://forwardmx.net/api/domains/Returns a list of all your domains
| key | required | Your API Key (Login and see your account page) |
[
{
"domain":"example.com",
"status":"active"
}
]GET/POST https://forwardmx.net/api/forwarders/Returns a list of all aliases for a domain
| key | required | Your API Key (Login and see your account page) |
| domain | required | A domain you want the aliases for |
[
{
"source":"@",
"destination":"[email protected]",
}
]GET/POST https://forwardmx.net/api/domain/create/Create a new domain on your account
| key | required | Your API Key (Login and see your account page) |
| domain | required | A domain you want to add to your account |
{"ok": "$Message"}{"error": "$Message"}GET/POST https://forwardmx.net/api/domain/destroy/Destroy a domain from your account
| key | required | Your API Key (Login and see your account page) |
| domain | required | A domain you want to destroy |
{"ok": "$Message"}{"error": "$Message"}GET/POST https://forwardmx.net/api/forwarders/create/Create a new forwarder on your account/domain
| key | required | Your API Key (Login and see your account page) |
| domain | required | A domain on which you want to edit the alias |
| user | required | Any username without @domain |
| destination | required | A email address the messages should be forwarded to |
{"ok": "$Message"}{"error": "$Message"}GET/POST https://forwardmx.net/api/forwarders/update/Update a forwarder entry on your domain
| key | required | Your API Key (Login and see your account page) |
| domain | required | A domain on which you want to edit the alias |
| user | required | @ for catch all, or any username without @domain you want to change |
| destination | required | A email address the messages should be forwarded to |
{"ok": "$Message"}{"error": "$Message"}GET/POST https://forwardmx.net/api/forwarders/destroy/Destroy a alias from your account/domain
| key | required | Your API Key (Login and see your account page) |
| domain | required | A domain on which you want to edit the alias |
| user | required | Alias source you want to remove |
{"ok": "$Message"}{"error": "$Message"}Writing and deleting operations all return either as hash with ok: message, or error: message.
{"ok": "$Message"}{"error": "$Message"}