This library is an implementation of the Ongage API. © Retail Food Group Ltd, 2014

0.1.2 2014-07-07 05:26 UTC


© 2014 Retail Food Group Ltd


This Library is a PHP implementation of the Ongage Email Platform API.

It is provided here free of charge, as-is by Retail Food Group Limited (ASX: RFG) under the MIT License. Please see LICENSE.TXT for any additional details.


This library features an implementation of most of the Ongage Documented Endpoints and Methods, as well as un-documented, potentially unsupported, but also very helpful methods.

Currently implemented endpoints:

"Campaign" Package

  • /api/mailings
  • /api/emails

"Esp" Package (Unsupported, Undocumented by Ongage)

  • /api/account_addresses
  • /api/esp_connections
  • /api/esps

"Lists" Package

  • /api/contacts
  • /api/lists/
  • /api/segments
  • /api/list_fields (Unsupported, Undocumented by Ongage)

"Reports" Package

  • /api/reports


Via Composer

Install composer in your project:

    curl -s https://getcomposer.org/installer | php

Create a composer.json file in your project root:

        "require": {
            "rfg/ongage-lib": "0.1*"

Install via composer:

    php composer.phar install

Add this line to your application’s code:

        require 'vendor/autoload.php';


        $list_id = ''; // Set your List ID here
        // Instantiate Ongage Object
        $ongage = new RfgOngage\Ongage('username', 'password', 'account_code');

        // Instantiate Contacts Object
        $contacts = new RfgOngage\Lists\Contacts();

        // Get Contacts for a list

        // Send Request
        $results = $ongage->send($contacts);

        // Echo raw results