Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions CHANGELOG
Original file line number Diff line number Diff line change
@@ -1,3 +1,7 @@
Date 2025-11-17
Version 1.12.1
- Fix encoding issue in path for unsubscribeContactByExternalId

Date 2025-09-18
Version 1.12.0
- Added support for param trash in mailing endpoints
Expand Down
14 changes: 7 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ Maileon's REST API documentation can be found [here](https://maileon.com/support

The API client requires `PHP >= 7.0` with `libxml` and `libcurl`.

Additionally all requests use an SSL encrypted API endpoint.
Additionally, all requests use an SSL encrypted API endpoint.
To enable SSL support in CURL, please follow these steps:
1. Download the official SSL cert bundle by CURL from https://curl.haxx.se/ca/cacert.pem
2. Save the bundle to a directory that can be accessed by your PHP installation
Expand All @@ -38,7 +38,7 @@ composer require xqueue/maileon-api-client

## 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 API client divides the features of Maileon's REST API into specific consumable services. Each service provides all functions of its specific category.

The following services are available:

Expand All @@ -48,8 +48,8 @@ Read, subscribe, edit, unsubscribe or delete contacts. Functions for individual
* **Blacklists**
Manage your blacklists.

* **Contactfilters**
Segmentate your address pool by filter rules.
* **Contact filters**
Segment your address pool by filter rules.

* **Targetgroups**
Manage distribution lists to specify who gets which mailing.
Expand Down Expand Up @@ -106,7 +106,7 @@ $contact = $contactsService->getContactByEmail('foo@bar.com')->getResult();
*/
```

* 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:
* Request a contact identified by its email address including their first name and a predefined custom field and also check for a valid response:
```php
<?php

Expand Down Expand Up @@ -264,13 +264,13 @@ do {
);

foreach ($getUnsubscribers->getResult() as $unsubscriber) {
printf('%s unsusbcribed in mailing %u at %s'.PHP_EOL,
printf('%s unsubscribed in mailing %u at %s'.PHP_EOL,
$unsubscriber->contact->email,
$unsubscriber->mailingId,
$unsubscriber->timestamp
);
}
} while($getUnsubscribers->getResponseHeaders()['X-Pages'] >= $index);
} while($getUnsubscribers->getResponseHeader('x-pages') >= $index);
```

* Get [KPI](https://kpi.org/KPI-Basics) data for a specific mailing:
Expand Down
9 changes: 6 additions & 3 deletions composer.json
Original file line number Diff line number Diff line change
Expand Up @@ -22,9 +22,12 @@
"require" : {
"php" : "^7.0|^8.0",
"ext-curl" : "*",
"ext-mbstring" : "*",
"ext-libxml" : "*"
},
"ext-dom": "*",
"ext-json": "*",
"ext-libxml" : "*",
"ext-mbstring" : "*",
"ext-simplexml": "*"
},
"require-dev" : {
"phpunit/phpunit" : "^4",
"phpstan/phpstan": "^1.8"
Expand Down
Loading