2017 © Pedro Peláez
 

library mxm-api-php

Emailcenter Maxemail API Client

image

emailcenter/mxm-api-php

Emailcenter Maxemail API Client

  • Monday, August 21, 2017
  • by qubit05
  • Repository
  • 5 Watchers
  • 3 Stars
  • 3,242 Installations
  • PHP
  • 0 Dependents
  • 0 Suggesters
  • 1 Forks
  • 0 Open issues
  • 8 Versions
  • 11 % Grown

The README.md

Maxemail API Client for PHP

Code Checks Codecov Latest Stable Version Total Downloads Licence, (*1)

Self-contained client in PHP for simplifying access to the Maxemail API, (*2)

Requirements

PHP, (*3)

This package requires at least PHP 8.1 . Please see previous releases if you require compatibility with an older version of PHP., (*4)

Composer will verify any other environment requirements on install/update., (*5)

When creating a new major version of this package, we MAY drop support for PHP versions which are no longer actively supported by the PHP project., (*6)

Installation

Including this package in your application is made easy by using Composer., (*7)

$ composer require maxemail/api-php

Usage Example

// Instantiate Client:
$config = [
    'token' => 'apitoken',
];
$api = new \Maxemail\Api\Client($config);

// General:
$result = $api->serviceName->method($arg1, $arg2);
var_dump($result);

Logging

If you want more useful development-time debug info, throw the API a PSR-compatible logger:, (*8)

$logger = new Logger(); // Must implement \Psr\Log\LoggerInterface
$api->setLogger($logger);

For a quick-start to logging (plus advanced multi-destination logging!), see Phlib/Logger, (*9)

Helpers

The client also includes a Helper class to take care of common scenarios that are more complicated than the simple request-response model., (*10)

The helper is accessed from the client by the getHelper() method:, (*11)

$api->getHelper()->downloadFile(...);

See the in-line documentation for helper methods for the required and optional parameters., (*12)

License

This package is free software: you can redistribute it and/or modify it under the terms of the GNU Lesser General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version., (*13)

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more details., (*14)

You should have received a copy of the GNU Lesser General Public License along with this program. If not, see http://www.gnu.org/licenses/., (*15)

The Versions

21/08 2017

dev-master

9999999-dev

Emailcenter Maxemail API Client

  Sources   Download

LGPL-3.0

The Requires

 

The Development Requires

21/08 2017

4.0.1

4.0.1.0

Emailcenter Maxemail API Client

  Sources   Download

LGPL-3.0

The Requires

 

The Development Requires

08/08 2017

4.0.0

4.0.0.0

Emailcenter Maxemail API Client

  Sources   Download

LGPL-3.0

The Requires

 

The Development Requires

16/01 2017

3.1.2

3.1.2.0

Maxemail API

  Sources   Download

The Requires

 

The Development Requires

14/12 2016

3.1.1

3.1.1.0

Maxemail API

  Sources   Download

The Requires

 

The Development Requires

18/03 2016

3.1

3.1.0.0

Maxemail API

  Sources   Download

The Requires

 

The Development Requires

23/03 2015

3.0

3.0.0.0

Maxemail API

  Sources   Download

The Requires

 

16/10 2014

2.0

2.0.0.0

Maxemail API

  Sources   Download

The Requires

  • php ~5.4