Maileon PHP API Client The Maileon PHP API client is a PHP library that allows your PHP application to interface with Maileon. This means that there’s a few things less to worry about because the client will handle them for you:
HTTP connection setup
API Authentication
Mapping function calls to REST requests
Serialization and deserialization of XML and JSON data to PHP data structures
The PHP API Client has been moved to Github in order to allow transparent development and uses Composer as a build system for your projects. You can find the latest version, here: https://github.com/xqueue/maileon-php-api-client
Optionally, you can download the (outdated) last stable standalone release maileon-php-client-1.5.5 here . There is also a minimal version without documentation and code examples to include in your programming project directly: maileon-php-client-min-1.5.5
Requirements (outdated, see GitHub for newer information) Changelog (outdated, see GitHub for newer information) Date: 2020-01-20
Changed url encode scheme for contact fields so spaces are allowed
Added method for setting “ignore_permissions” (trigger mails, only)
Date: 2019-11-08
Fixed bug with deserializing mailing subjects
Added method for getting sender alias
Date: 2019-10-16
Fixed bug with transaction types de-/serialization not handling boolean values correctly (storeonly and required attributes)
Date: 2019-09-02
Fixed deserialization bug with transaction types having SimpleXML objects as values instead of just the content
Date: 2019-07-08
Set default value for getting contact filters to 100
Added deserialization of previewtext for properly retrieving the mailing preview text
Added method to retrieve mailings by state (thanks to ‘Verlagsgruppe Hüthig Jehle Rehm GmbH’)
Date: 2019-04-05
Added CRUD methods for managing account placeholders
Added methods for getting/settung mailing preview texts
Date: 2018-12-10
Added description for transaction type and transaction type attributes when creating or retrieving a type
Added ‘date’ as attribute type
Added attributes in analytics report service (goals, timestamps as epoch and sql timestamps and external id)
Fixed missing parameter ‘nlaccountid’ when unsubscribing by email
Fixed path for creating contacts from /contacts to /contacts/email
Fixed space in “src” or “subscription_page” parameter of methods creating contacts causing 505 responses
Date: 2018-11-16
Added method to retrieve url for single mail reports
Added parameter for unsubscribing contacts from several newsletter accounts by email ($nlAccountIds)
Added methods for getting and setting templates to a single newsletter
Added method for resetting mailing content to template state
Added method for getting (unique) conversions
Date: 2018-07-06
Added methods to send test mails to single contacts and test targetgroups
Date: 2018-06-26
Fixed possible warnings and notices with return headers when using proxy configuration
Date: 2018-06-25
Added methods for setting and updating schedules for regular mailings
Fixed problem with response headers being parsed wrong when using a proxy server
Date: 2018-06-22
Fixed bug causing mailings with spaces in their names not being found when searching by that name
Date: 2018-05-15
Changed method toArray in Transaction.php to avoid wrong serialization
Date: 2018-02-28
Fixed possible problem with empty(trim(…)) as empty expects a variable instead of return value in ContactsService
Date: 2018-02-09
Added check to \com_maileon_api_AbstractMaileonService::appendArrayFields if passed parameter is really an array. This caused “Invalid argument supplied for foreach()” if used wrong.
Added method getResponseHeaders to result object which returns an array of all headers and their values
Date:2017-11-15
Trimmed values for DOI mailing keys
Fixed bug when getting contacts and results where partially XML elements instead of strings (like the email address)
Adding default value for “checksum” to “” for updating contacts to indicate for customers which value to set if using “ignore_checksum”
Date: 2017-08-03
Added methods and objects to manage custom properties of mailings
Date: 2017-08-01
Added Parameter “authorized” to deleteAllContacts and set it by default to NO to avoid removing contacts by mistake
Fixed contact-by-email-operations to use /email/ resource
Allowing usage of IDs for contacts with synchronizingContacts
Added method to add attachments to regular mailings (thanks to Wanadis)
Added parameter “prefer_maileon_id” to “SynchronizeContacts” method
Date: 2016-12-12
Fixed not urlencoding single unsubscription reasons
Date: 2016-12-09
Fixed using text/plain for getting textversions
Added methods to set and get a mailing locale
Added method to execute RSS SmartMailing functionality
Added method to set/get tags of mailings
Date: 2016-08-12
Changed com_maileon_api_json_JSONDeserializer::json_decode to use associative arrays instead of objects
Added STATE to standard contact fields
Added getSubject and setSubject to mailing service
Date: 2016-06-06
Renamed class Debug to XQDebug to avoid collisions with other classes (not using namespace due to backwards compatibility to PHP 5.3)Debug::setDebug(false); make sure to change it to XQDebug::setDebug(false);
Added methods and parameters to specify unsubscription reasons
Set urlencode when getting mails by scheduleTime
Added functions to simplify permission handling and fallback values when setting an invalid permission (thanks to Wiera)
Updated transaction report handling (thanks to Wiera)
Unified json serialization/deserialization (thanks to Wiera)
Date: 2016-04-29
Fixed possible problems with utf8_encode and custom field names with special characters by using mb_string_convert instead
Fixed initialitation of content in transactions. Previous version caused empty content to be an empty array [] instead of an empty object {}
Added method to embed link tags in click-report
Added parameter archivingDuration for transactions types. This parameter describes the time in days a transaction event should be archived. Default is “forever”.
Added methods to get target groups and their count
Maileon Java API Client The Maileon Java API client is an Java wrapper for the REST API written for Java 1.7+.maileon-java-client-0.7.2 . This release works with version 1.0 of the Maileon API.
Changelog Date: 2018-09-14
Version 0.7.0
Added methods for triggering and retrieving mailing checks
Added debug option to configuration
Added option for ignoring SSL errors in debug mode to configuration
Removed dependency on commons-codec, used Java8 Base64 encoding for transaction attachments
Removed usage of deprecated methods in tests
Date: 2017-05-23
Version 0.6.3
Maileon Ruby API Client The Maileon Ruby API Client can be downloaded at GitHub .
