Welcome

This documentation will explain the API functions available to developers for maintenance of a Deliver account. It also explains the special APIs used for sending or receiving an email using HTTP(S).

Authentication

All Deliver API requests should be authenticated using the API UID and API Key of an appropriate virtual server. This information can be found in the 'Server Setup' tab after creating a virtual mailserver. These values should be sent with all requests using HTTP Basic authentication.

Data format

Data must be inserted and returned using JSON encoding. When sending data, the following HTTP header should be used to identify the format:

Content-Type: application/json

Supported functionality

The API currently supports the following functionality:

  • Domains (Create, Delete, List)
  • Mailboxes (Create, Delete, Update, List)
  • Send emails (Send API)
  • Receive emails (Receive API, initiated by Deliver)