avido/smtpeter-php-api

Api client for smtpeter.com

0.0.7 2022-11-22 12:57 UTC

Requires

• php: ^7.3 || ^8.0
• ext-json: *
• guzzlehttp/guzzle: ^7.2
• illuminate/collections: ^8.0|^9.0

Requires (Dev)

• overtrue/phplint: ^2.3
• phpunit/phpunit: ^9.5
• squizlabs/php_codesniffer: ^3.5

MIT

• Sebastiaan Blaas

• php
• api
• smtpeter

README

This release is not production ready yet.. use at own risk!

Requirements

To use the smtpeter api client, the following things are required:

• A Copernica account
• Generate your API Key

Installation

You can install the package using composer.

composer require avido/smtpeter-php-api

Getting started

Initialize the Smtpeter php api client and set your API key:

$client = new \Avido\Smtpeter\Client($apiKey);

Templates

List all templates

Templates list results can be limit with an offset and limit variable

$templates = $client->templates->list();
$templatesWithLimit = $client->templates->list($offset, $limit);

Retrieve specific template

$template = $client->template->get($id);

Emails

Send out email using template

// simple email
$email = new Email([
    'templateId' => 1,
    'to' => '[e-mail]',
    'data' => ['array' => 'of replacement vars']
]);
// email with bcc
$email = new Email([
    'templateId' => 1,
    'to' => '[e-mail]',
    'bcc' => '[e-mail]',
    'data' => ['array' => 'of replacement vars']
]);
// email with replyTo address
$email = new Email([
    'templateId' => 1,
    'to' => '[e-mail]',
    'replyTo' => '[e-mail]',
    'data' => ['array' => 'of replacement vars']
]);

$client->email->send($email);

Resend email

$messageId = 'abcdef1234';
$client->email->resend($messageId   );

Retrieve email

$messageId = 'abcdef1234';
// by default only the html body is retrieved. 
$loadHtml = true;
$loadAttachments = true;
$loadHeaders = true;
$client->email->get($messageId, $loadHtml, $loadAttachments, $loadHeaders);

Events

Get events for specific messageId

$messageId = 'abcdef1234';
$events = $client->events->message($messageId);
// optional you can filter by date/ tags
$from = '2022-01-01';
$end = '2022-01-07';
$filterd = $client->events->message($messageId, $from, $end);
print_r($events);
...
Illuminate\Support\Collection Object
(
    [items:protected] => Array
        (
            [0] => Avido\Smtpeter\Resources\Event Object
             (
                [id] => abcdef1234
                [time] => DateTime Object
                    (
                        [date] => 2022-02-01 08:36:01.000000
                        [timezone_type] => 3
                        [timezone] => UTC
                    )
            
                [recipient] => [e-mail]
                ...
             )
        )
)

For more examples see tests folder