coresender/coresender

The Coresender PHP SDK.

1.0.3 2020-07-01 10:37 UTC

This package is not auto-updated.

Last update: 2021-05-05 15:24:33 UTC


README

This is the officially supported PHP library for Coresender. It allows you to quickly and easily integrate with our API and improve your email deliverability.

Prerequisites

  • PHP version 7.1+
  • The Coresender service. You can start with a free 100 emails/month developer plan and move to one of our pricing plans when you're done.

Installation

To install the SDK, you will need to be using Composer.

The Coresender PHP SDK is not hard coupled to Guzzle, Buzz or any other library that sends HTTP messages. Instead, it uses the PSR-18 client abstraction. This will give you the flexibility to choose what PSR-7 implementation and HTTP client you want to use.

Run the following command to get started:

composer require coresender/coresender kriswallsmith/buzz nyholm/psr7

Usage

Here's how to send an email using the SDK:

require 'vendor/autoload.php';

use Coresender\Coresender;
use Coresender\Helpers\EmailBuilder;

$builder = new EmailBuilder();
$builder
    ->setFrom('jean.luc@example.com', 'Jean-Luc Picard')
    ->addToRecipient('geordi@example.com', 'Geordi La Forge')
    ->setSubject('I need engines')
    ->setBodyText('Geordi, I need engines, now!')
    ->setBodyHtml('<p>Geordi, I need engines, <strong>now!</strong></p>')
;

$sendingApi = Coresender::createSendEmailApi('<<INSERT SENDING ACCOUNT ID>>', '<<INSERT SENDING ACCOUNT API KEY>>');
$sendingApi->simpleEmail($builder->getEmail());

Here's how to send a batch of emails using the SDK:

require 'vendor/autoload.php';

use Coresender\Coresender;
use Coresender\Helpers\EmailBuilder;

$sendingApi = Coresender::createSendEmailApi('<<INSERT SENDING ACCOUNT ID>>', '<<INSERT SENDING ACCOUNT API KEY>>');

$builder = new EmailBuilder();
$builder
    ->setFrom('jean.luc@example.com', 'Jean-Luc Picard')
    ->addToRecipient('geordi@example.com', 'Geordi La Forge')
    ->setSubject('I need engines')
    ->setBodyText('Geordi, I need engines, now!')
    ->setBodyHtml('<p>Geordi, I need engines, <strong>now!</strong></p>')
    ->addToReplyTo('deanna@example.com', 'Deanna Troi')
;
$sendingApi->addToBatch($builder->getEmail());

$builder = new EmailBuilder();
$builder
    ->setFrom('jean.luc@example.com', 'Jean-Luc Picard')
    ->addToRecipient('worf@example.com', 'Mr. Worf')
    ->setSubject('Rise shields')
    ->setBodyText('Mr. Worf, rise shields, now!')
    ->setBodyHtml('<p>Mr. Worf, rise shields, <strong>now!</strong></p>')
;
$sendingApi->addToBatch($builder->getEmail());

$sendingApi->execute();

Response

The result of an API call is a domain object.

$sendingApi = Coresender::createSendEmailApi('<<INSERT SENDING ACCOUNT ID>>', '<<INSERT SENDING ACCOUNT API KEY>>');
$result = $sendingApi->execute();

echo 'All accepted:' . $result->allAccepted();

foreach ($result as $entry) {
    echo $entry->getMessageId() . ': ' . $entry->getStatus();
}

Debug logging

This SDK does minimal logging for error debugging purpose. To enable it pass any PSR-3 logger instance, like Monolog.

use Monolog\Logger;

$logger = new Logger();

Coresender::setLogger($logger);

Contribute

The Coresender PHP SDK is an open-source project released under MIT license. We welcome any contributions!

You can help by:

  • Writing new code
  • Creating issues if you find problems
  • Helping others with their issues
  • Reviewing PRs