namshi/emailvision

This small library provides support for the 'REST' interface exposed by Emailvision.

1.1.3 2014-03-16 06:45 UTC

Requires (Dev)

• phpunit/phpunit: 3.7.21

MIT

• Alessandro Nadalin

README

This small library provides support for the "SOAP" interface exposed by EmailVision.

Installation

You can install this library via composer: have a look at the package on packagist.

The include it into your composer.json:

"namshi/emailvision": "1.0.*",

Pick major and minor version according to your needs.

Usage

Using this library is pretty trivial, the only "difficult" thing to do is to define the configuration needed by Emailvision:

<?php

use Namshi\Emailvision\Client;

$config = array('template_for_password_reset_email' => array(
    'random'            => 'iTag',
    'encrypt'           => 'sTag',
    'senddate'          => new \DateTime(),
    'uidkey'            => 'uKey',
    'stype'             => 'stype',
));

$emailvisionClient = new Client($config);
$emailvisionClient->sendEmail("template_for_password_reset_email", "[e-mail]", array('name' => 'Alex'));

Tests

You can run the test suite by first installing the dependencies and running PHPUnit:

php composer.phar update

phpunit

There are a couple integration tests that actually verify that the library works flawlessly, by actually hitting the emailvision API. Given that you need valid credentials for that, just create a file called emailvision.config in your system's temporary folder (sys_get_temp_dir()) with 3 parameters:

<?php

$encrypt    = 'xxx';
$random     = 'yyy';
$email      = '[e-mail]';

Have a look at the tests these variables are used.