messagex / messagex
A library to make requests to the Messagex API.
dev-master
2020-05-26 06:35 UTC
Requires
- guzzlehttp/guzzle: ^6.5
Requires (Dev)
- phpunit/phpunit: ^7
This package is auto-updated.
Last update: 2024-05-19 21:56:41 UTC
README
THIS SDK IS A WIP AND SHOULD NOT BE DOWNLOADED YET
This SDK provides enables PHP applications with an easy to use interface to the MessageX API.
Installation
composer require messagex/messagex
Examples
Sending email
Instantiate the library
use messagex\messagex; ... $client = new \PhpApiClient\Client($apiKey, $apiSecret);
The following example shows how to send an email.
$payload = [
"contactGroupId" => "70266b1a-3e07-4096-90ec-87c8015872ca",
"unsubscribeGroupId" => "4501ccf5-0f4b-4d36-b329-a0029b68ea0a",
"from" => [
"address" => "no-reply@smsglobal.com",
"name" => "MessageX"
],
"to" => [
[
"address" => "john@example.com",
"name" => "Test email message"
],
],
"subject" => "Transactional Email 1",
"content" => [
[
"type" => "text/html",
"body" => "<body>This is the body. Go to <a href=\"http://theage.com.au?one=two\">The Age</a> to see the news. Or go to <a href=\"https://google.com\">Google</a> to search for more</body>"
],
[
"type" => "text/plain",
"body" => "AAA Plaintext email content."
]
],
"replyTo" => [
"name" => "reply-to-me",
"address" => "someone@example.com"
],
];
$client->mail()->send($payload);
Testing
To run tests, run the script vendor/bin/phpunit --coverage-text
.