phlib/litmus-reseller-sdk

SDK to allow you to use the legacy Litmus Reseller SOAP API

3.0.0 2022-11-21 12:27 UTC

This package is auto-updated.

Last update: 2024-07-03 08:13:30 UTC


README

phlib/litmus-reseller-sdk

Code Checks Codecov Latest Stable Version Total Downloads Licence

SDK to allow you to use the legacy Litmus Reseller SOAP API. You can retrieve all available clients, create a test and get the results.

April 2021: Phlib have taken over the maintenance of this package from blaugueux. Huge thanks for trusting us to continue his work! We've been using this package for years in our commercial projects, so we're looking forward to keeping it going!

Thankfully, Litmus have archived the documentation for this legacy API.

Litmus deprecated this API in 2015. New implementations should use their current APIs, listed at docs.litmus.com.

Install

Via Composer

$ composer require phlib/litmus-reseller-sdk

Usage

See the Legacy litmus SOAP API docs for an example workflow.

  • Call Litmus::createEmailTest().
  • This will return a new EmailTest object containing the unique ID.
  • The ID can be used when calling Litmus::getEmailTest() to view the state.
  • The EmailTest::getResults() method can be used to get details on the state for each individual client in the test, the ID of which can be used with Litmus::getResult() to get the full result details.

Callbacks

If you have a callback URL configured with your Litmus reseller account, it will be called with an XML string when results are available, rather than needing to poll Litmus::getEmailTest(). Callback\Factory can be used to create the appropriate result object.

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.

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.

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/.