README

A PHP client for the Mailmatics API.

This library is in development. Use it at your risk.

Requirements

PHP >= 5.4
Composer
(optional) cURL extension
(optional) Guzzle >= 6

Installation

The recommended way to install PHP Mailmatics SDK is through Composer.

$ curl -sS https://getcomposer.org/installer | php

Next, run the Composer command to install the latest stable version:

$ php composer.phar require mailmatics/php-sdk

After installing, you need to require the Composer’s autoloader:

require 'vendor/autoload.php';

Authentication

PHP Mailmatics SDK supports two authentication modes:

1. API key:

use Mailmatics\Client;

$client = new Client(['apiKey' => '...']);

2. Simple login:

use Mailmatics\Client;

$client = new Client(['username' => 'admin', 'password' => '12345']);

Options

TODO

HTTP Client

Internally, PHP Mailmatics SDK uses an implementation of Mailmatics\HttpClientInterface. The default is Mailmatics\HttpClient\StreamClient. You can change it by passing it to the client constructor:

use Mailmatics\Client;
use Mailmatics\HttpClient\CurlClient;

$client = new Client($credentials, $options, new CurlClient());

The more powerful implementation is the Mailmatics\HttpClient\GuzzleHttpClient, that require the Guzzle library.

use Mailmatics\HttpClient\GuzzleHttpClient;

$httpClient = new GuzzleHttpClient();

You can pass your instance of Guzzle client in the constructor:

use GuzzleHttp\Client as GuzzleClient;
use Mailmatics\HttpClient\GuzzleHttpClient;

$guzzleClient = new GuzzleClient();
$httpClient = new GuzzleHttpClient($guzzleClient);

Lists

Get all lists:

$lists = $client->getLists()->all();

Get a single list:

$list = $client->getLists()->get(123);

Subscribe a user to a list

$list = $client->getLists()->addSubscriber($listId, $email);

You can specify also first and last name:

$data = [
	'firstname' => 'John',
	'lastname' => 'Smith',
];

$list = $client->getLists()->addSubscriber(123, $email, $data);

...or the fullname (Mailmatics automagicaly split first and last name):

$data = [
	'fullname' => 'John Smith',
];

$list = $client->getLists()->addSubscriber(123, $email, $data);

Unsubscribe a user

To unsubscribe a user from a list, you must have his subscriber ID.

$list = $client->getLists()->unsubscribe($listId, $subscriberId);

TODO: How can I obtain the subscriber ID?

Transactional Emails

Get all transactional emails:

$emails = $client->getTransactional()->all();

Get a single transactional email:

$email = $client->getTransactional()->get(123);

Send a transactional email:

$data = [
	'firstName' => 'John',
	'lastName' => 'Smith'
];

$email = $client->getTransactional()->send(123, 'john@example.com', $data);

Send a scheduled transactional email:

$data = [
	'firstName' => 'John',
	'lastName' => 'Smith'
];

$schedule = new DateTime('2018-12-25 12:30:00');

$email = $client->getTransactional()->send(123, 'john@example.com', $data, $schedule);

License

This library is licensed under the MIT License - see the LICENSE file for details.

mailmatics / php-sdk

Maintainers

Details