Download the PHP package kiwicom/email-on-acid-sdk without Composer
On this page you can find all versions of the php package kiwicom/email-on-acid-sdk. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download kiwicom/email-on-acid-sdk
More information about kiwicom/email-on-acid-sdk
Files in kiwicom/email-on-acid-sdk
Package email-on-acid-sdk
Short Description This library provides basic functionality for work with Email on Acid API
License BSD-3-Clause GPL-2.0 GPL-3.0
Homepage https://www.kiwi.com
Informations about the package email-on-acid-sdk
Email on Acid SDK
Installation
composer require "kiwicom/email-on-acid-sdk"
Usage
Create ApiFactory with required parameters - apikey
and password
can be obtained in Account
section on https://www.emailonacid.com
Creating of Email testing api example:
Creating new test require EmailTestRequest as argument , filling required data where one of url / html must be provided as email content and returning Response\NewEmailTest with data about your new test
Results of API calls are immutable objects from \EmailOnAcid\Response
namespace or simple string[].
Fetching tests results example:
For fetching test results you need testId which is provided in Response\NewEmailTest (testId is used for operations like links test, email content test, spam test, code analysis so you probably want to store it somewhere after creating new test)
Exception types
\EmailOnAcid\Ecxception\ApiRequestException
- unexpected api errors
\EmailOnAcid\Ecxception\UnsuccessfulActionException
- some of api calls provides only true|false result without any additional data; UnsuccessfulActionException
is thrown in case of false result
\EmailOnAcid\Ecxception\NotFoundException
- can be thrown in cases where requested content is not found (mostly related to functions that require test id as parameter and it does not exist on api)