README

Email API and SMTP relay to not just send and measure email sending, but also alert and optimise. We provide you with tools, expertise and support needed to reliably deliver emails to your customers inboxes on time, every time.

Installation & Usage

Requirements

PHP 7.4 and later. Should also work with PHP 8.0.

Composer

To install the bindings via Composer, add the following to composer.json:

{
  "require": {
    "arseniusz8/sendpost_php": "^1.0.0"
  }
}

Then run composer install

Manual Installation

Download the files and include autoload.php:

<?php
require_once('/path/to/sendpost/vendor/autoload.php');

Getting Started

Please follow the installation procedure and then run the following:

    <?php
      require_once(__DIR__ . '/vendor/autoload.php');
      $client = new GuzzleHttp\Client();

      $apiInstance = new sendpost\api\EmailApi($client);
  
      $x_sub_account_api_key = 'your_api_key'; // string | Sub-Account API Key
      $email_message = new \sendpost\model\EmailMessage(); 
      $email_message->setSubject('Hello World');
      $email_message->setHtmlBody('<strong>it works!</strong>');
      $email_message->setIppool('PiedPiper');
      $from = new \sendpost\model\From();
      $from->setEmail('richard@piedpiper.com');

      $to = new \sendpost\model\To();
      $to->setEmail('gavin@hooli.com');
      $email_message->setTo(array($to));
      $email_message->setFrom($from);

      try {
          $result = $apiInstance->sendEmail($x_sub_account_api_key, $email_message);
          print_r($result);
      } catch (Exception $e) {
          echo 'Exception when calling EmailApi->sendEmail: ', $e->getMessage(), PHP_EOL;
      }
    ?>

API Endpoints

All URIs are relative to https://api.sendpost.io/api/v1

Class	Method	HTTP request	Description
EmailApi	sendEmail	POST /subaccount/email/
EmailApi	sendEmailWithTemplate	POST /subaccount/email/template

Models

Authorization

Endpoints do not require authorization.

Tests

To run the tests, use:

composer install
vendor/bin/phpunit

Author

hello@sendpost.io

arseniusz8 / sendpost_php

Maintainers

Details