Download the PHP package xqueue/maileon-api-client without Composer
On this page you can find all versions of the php package xqueue/maileon-api-client. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download xqueue/maileon-api-client
More information about xqueue/maileon-api-client
Files in xqueue/maileon-api-client
Package maileon-api-client
Short Description API-Client to XQ:Maileon
License MIT
Homepage https://www.maileon.de
FAQ
Example:
In general, it is recommended to use always a project to download your libraries. In an application normally there is more than one library needed.
- Some hosting areas are not accessible by a terminal or SSH. Then it is not possible to use Composer.
- To use Composer is sometimes complicated. Especially for beginners.
- Composer needs much resources. Sometimes they are not available on a simple webspace.
- If you are using private repositories you don't need to share your credentials. You can set up everything on our site and then you provide a simple download link to your team member.
- Simplify your Composer build process. Use our own command line tool to download the vendor folder as binary. This makes your build process faster and you don't need to expose your credentials for private repositories.
Informations about the package maileon-api-client
Maileon API Client
Provides an API client to connect to XQueue Maileon's REST API and (de-)serializes all API functions and data for easier use in PHP projects.
Maileon's REST API documentation can be found here.
Table of contents
- Requirements
- Installation
- Usage
- Examples
Requirements
The API client requires PHP >= 7.0 with libxml and libcurl.
Additionally all requests use an SSL encrypted API endpoint. To enable SSL support in CURL, please follow these steps:
- Download the official SSL cert bundle by CURL from https://curl.haxx.se/ca/cacert.pem
- Save the bundle to a directory that can be accessed by your PHP installation
- Add the following entry to your php.ini (remember to change the path to where you put the cert bundle):
Installation
You can add this library to your project using Composer:
Usage
The API client divides the features of Maileon's REST API into specific consumable services. Each service provides all functions of it's specific category.
The following services are available:
-
Contacts Read, subscribe, edit, unsubscribe or delete contacts. Functions for individual contacts or bulk requests if required.
-
Blacklists Manage your blacklists.
-
Contactfilters Segmentate your address pool by filter rules.
-
Targetgroups Manage distribution lists to specify who gets which mailing.
-
Reports Get all KPI information about your mailings and general reportings about your contact pool.
-
Mailings Manage and control your mailings.
-
Transactions Manage transaction endpoints (events) or send new transactions to trigger sendouts or Marketing Automation programs.
-
Marketing Automations Start your predefined Marketing Automation programs.
-
Accounts Configure specific account features.
-
Medias Manage mailing templates.
- Webhooks Manage automatic data distributions to notify external systems of specific events.
Examples
Contact examples
-
Request basic contact data identified by their email address:
-
Request a contact identified by it's email address including their first name and a predefined custom field and also check for a valid response:
-
Create a contact in Maileon
- Synchronize a larger list of contacts in bulk
Report example
-
Print all unsubscriptions:
- Get KPI data for a specific mailing:
Mailing example
- Create a new mailing, add custom HTML content, attach a target group and send it immediately:
Transaction example
- Send a new transaction including product information as an order confirmation:
All versions of maileon-api-client with dependencies
ext-curl Version *
ext-mbstring Version *
ext-libxml Version *