OMA

OpenSRS Mail API (OMA)

The PHP toolkit now supports OMA (OpenSRS Mail API). The OMA API is the provisioning interface for the OpenSRS email system. It allows you to create, modify and delete mailboxes, aliases, domains and other aspects of the service. The interaction between the API and a client consists of a single HTTP POST request and HTTP response. The HTTP request and response bodies are formatted as JSON data.

Requirements

• cURL
• PHP curl library - http://www.php.net/manual/en/book.curl.php

Configurations

In opensrs/openSRS_config.php, edit the following lines,

define("MAIL_HOST", "https://admin.test.hostedemail.com/api");
define("MAIL_USERNAME", "YOUR_COMPANY_LEVEL_ADMIN_USERNAME");
define("MAIL_PASSWORD", "YOUR_COMPANY_LEVEL_ADMIN_PASSWORD");
define("MAIL_ENV", "OMA_ENVIRONMENT"); // LIVE OR TEST
define("MAIL_CLIENT", ""); // Optional

OMA_HOST should be, TEST: https://admin.test.hostedemail.com/api LIVE: https://admin.hostedemail.com/api