Skip to content

Latest commit

 

History

History
104 lines (87 loc) · 4.04 KB

CHANGELOG.md

File metadata and controls

104 lines (87 loc) · 4.04 KB
Raw

Change Log

All notable changes to this project will be documented in this file.

The format is based on Keep a Changelog and this project adheres to Semantic Versioning.

[Unreleased]

[5.1.1] - 2021-08-10

Fixed

  • Clean-up temporary local file for any errors while trying to download a file.

[5.1.0] - 2021-08-09

Added

  • Add support for Guzzle v7. Guzzle v6 is retained as an optional dependency to avoid breaking BC for PHP v7.1 in this package.

Fixed

  • Update client version identifier used in user-agent.

[5.0.1] - 2021-05-31

Added

  • Add support for PHP v8 (^7.1 | ^8.0).

[5.0.0] - 2019-05-03

Changed

  • Package name changed to maxemail/api-php
  • Namespaces have been changed from Emailcenter\MaxemailApi to Maxemail\Api. Sorry.

Removed

[4.1.0] - 2019-05-01

Changed

  • Default Maxemail URI changed to https://mxm.xtremepush.com/. This will only affect implementations using the default URI but with no impact, as the old and new domains resolve to the same Maxemail instance.

[4.0.1] - 2017-08-21

Changed

  • HTTP Client debug logging is disabled by default to save resources if not needed. Enable via the constructor's debugLogging option.

[4.0.0] - 2017-08-08

Added

  • Apply GNU LGPLv3 software licence
  • Dedicated package-specific Exception classes. These extend the original SPL Exception classes, so no changes should be required in any implementation. This now means that all package exceptions implement Mxm\Exception\Exception.
  • Use Guzzle to handle HTTP connection. Exceptions thrown for networking errors (connection timeout, DNS errors, etc.) will be an instance of GuzzleHttp\Exception\RequestException. This extends \RuntimeException so any existing catch blocks will continue to function without any necessary changes. Errors returned by Maxemail as a response to an API call will now throw Emailcenter\MaxemailApi\Exception\ClientException which extends the same \RuntimeException used previously.
  • Helper::setLogLevel() can be used to increase the log level from the default of debug. This might be useful if you want to see the file transfer logs at info and filter out the raw HTTP client logs at debug.
  • Deprecated API methods will be logged at warning level and trigger a PHP E_USER_DEPRECATED error.

Changed

  • Namespaces have been changed from Mxm\Api to Emailcenter\MaxemailApi.
  • Deprecate API config keys for user and pass, replaced with username and password respectively
  • Primary class has changed from Mxm\Api to Emailcenter\MaxemailApi\Client. See README for usage example including config changes above.

Removed

  • Removed support for PHP 5.x as it is no longer actively supported by the PHP project
  • Remove API config key for host. Most implementations using the default instance of Maxemail will not need to make any other change. If connecting to a non-standard instance of Maxemail, a new key uri can be provided.

[3.1.2] - 2017-01-16

Changed

  • Removed API method name from debug log message (still available in log context)

[3.1.1] - 2016-12-14

Changed

  • Update documentation URLs
  • Increase API user-agent version to 3.1

[3.1.0] - 2016-03-18

Added

  • Support for CURLFile in PHP ^5.5 - HT @sh41
  • Official support for php70, although no code changes are required

[3.0.0] - 2015-03-23

Added

  • File upload and download helpers
  • Make API classes logger-aware for better debugging

Changed

  • API config parameters, see README

[2.0.0] - 2014-10-16

Added

  • Implement Composer to easily add this package to existing projects

Changed

  • Update project to PSR-4 style, raising minimum PHP requirement to 5.4
    • If you require compatibility with a PHP version prior to 5.4, please use the 1.x release (and seriously consider upgrading as php53 is end-of-life)