coloursfactory/refreshmailer

Implementation of FreshMail.pl REST API

dev-master 2017-06-21 09:03 UTC

Requires

• php: >=5.3.0
• ext-curl: *
• ext-json: *
• php-http/client-common: ^1.5
• php-http/client-implementation: ^1.0
• php-http/discovery: ^1.2
• psr/http-message: ^1.0

Requires (Dev)

• guzzlehttp/guzzle: ^6||^5
• guzzlehttp/psr7: ^1.4
• php-http/curl-client: ^1.7
• php-http/guzzle6-adapter: ^1.0
• php-http/message: ^1.5
• php-http/mock-client: ^1.0
• phpunit/phpunit: ^6

Suggests

• guzzlehttp/guzzle: ^6||^5
• guzzlehttp/psr7: ^1.4
• php-http/curl-client: ^1.7
• php-http/mock-client: ^1.0

MIT

• Konrad Pawlikowski

• curl
• Guzzle
• freshmail
• php-http
• httplug

README

With this package usage of freshmailer.pl REST API will be more comfortable.

It uses adapters to provide right PSR-7 compatible HTTP service.

Actully implemented ones are:

• cURL
• Guzzle6

Feel free to commit new adapters :)

See https://freshmail.pl/api_section/jak-zaczac/ for massive documentation.

http://freshmail.pl

Installation

Simply add to your composer.json file

{
    "require": {
        "preclowski/refreshmailer": "dev-master"
    }
}

or, require directly using

composer require preclowski/refreshmailer

Usage

use ColoursFactory\ReFreshMailer\FreshMailClient;
use ColoursFactory\ReFreshMailer\Http\GuzzleHttpAdapter;
use GuzzleHttp\Client;

$options = [
    'apiKey' => 'abcdef1234567890',
    'apiSecret' => 'abcdef1234567890',
];

$httpAdapter = new GuzzleHttpAdapter(new Client());
// or
$httpAdapter = new CurlHttpAdapter();

/** @var HttpAdapterInterface $httpAdapter */
$client = new FreshMailClient($httpAdapter, 'https://api.freshmail.com/rest/', $options);

$campaigns = $client->doRequest('/campaigns');

Reporting an issue or a feature request

Issues and feature requests are tracked in the Github issue tracker.