mslwk/freshmail

Library for calling FreshMail REST API

1.0.3 2021-07-02 06:09 UTC

This package is auto-updated.

Last update: 2021-11-02 06:53:50 UTC


README

Build Status Scrutinizer Code Quality Code Coverage Latest Stable Version License Total Downloads

FreshMail REST API client library

The library was designed to provide simple interface for using FreshMail API. It is a standalone and requires no outside libraries to work.

Usage

A simple interface is provided to communicate with the API. To call the Ping service:

Use the library:

Alt text

Call the API:

Alt text

Installation

Use composer to include the library in your project.

composer require mslwk/freshmail

Features

The library provides methods of communicating with the API to:

  • Test connection
  • Send transactional emails
  • Send SMS messages
  • Create a new campaign
  • Edit, delete, test and send an existing campaign
  • Create, delete, get data about and edit a subscriber
  • Create, delete and edit a subscription list
  • Get subscription lists
  • Register a new account
  • Spam-test an email