PHPackages                             keltuo/php-smartemailing - PHPackages - PHPackages  [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register)

1. [Directory](/)
2. /
3. [API Development](/categories/api)
4. /
5. keltuo/php-smartemailing

ActiveLibrary[API Development](/categories/api)

keltuo/php-smartemailing
========================

Smart Emailing API v3 client for PHP

1.0.1(4y ago)58.4k↑83.3%2[1 issues](https://github.com/keltuo/php-smartemailing/issues)MITPHPPHP &gt;=8.0

Since Nov 12Pushed 4y ago1 watchersCompare

[ Source](https://github.com/keltuo/php-smartemailing)[ Packagist](https://packagist.org/packages/keltuo/php-smartemailing)[ RSS](/packages/keltuo-php-smartemailing/feed)WikiDiscussions main Synced 1mo ago

READMEChangelog (2)Dependencies (7)Versions (3)Used By (0)

[![Contributors](https://camo.githubusercontent.com/5bdcadb4c8f47c07c69e9be672fad8b58d5ef55f5d42e9aacccae4769792d98c/68747470733a2f2f696d672e736869656c64732e696f2f6769746875622f636f6e7472696275746f72732f6b656c74756f2f7068702d736d617274656d61696c696e672e7376673f7374796c653d666f722d7468652d6261646765)](https://github.com/keltuo/php-smartemailing/graphs/contributors)[![Forks](https://camo.githubusercontent.com/94aae9be8081d46936797684300c36450640097e89ae8b883410edc97d809729/68747470733a2f2f696d672e736869656c64732e696f2f6769746875622f666f726b732f6b656c74756f2f7068702d736d617274656d61696c696e672e7376673f7374796c653d666f722d7468652d6261646765)](https://github.com/keltuo/php-smartemailing/network/members)[![Stargazers](https://camo.githubusercontent.com/7a80b1b2c1577a11e0534bc53afa587dc78478473200ea7b3081d6e3cfe952ed/68747470733a2f2f696d672e736869656c64732e696f2f6769746875622f73746172732f6b656c74756f2f7068702d736d617274656d61696c696e672e7376673f7374796c653d666f722d7468652d6261646765)](https://github.com/keltuo/php-smartemailing/stargazers)[![Issues](https://camo.githubusercontent.com/1b83b3026cda172d67dcaba4ad7e606771cf6c5c074b5b3039192082e0dddb3a/68747470733a2f2f696d672e736869656c64732e696f2f6769746875622f6973737565732f6b656c74756f2f7068702d736d617274656d61696c696e672e7376673f7374796c653d666f722d7468652d6261646765)](https://github.com/keltuo/php-smartemailing/issues)[![MIT License](https://camo.githubusercontent.com/bf85bb57c76eb116905f93b776c6ff563c9ffe2e003954b2846ea20e2dbb6ac3/68747470733a2f2f696d672e736869656c64732e696f2f6769746875622f6c6963656e73652f6b656c74756f2f7068702d736d617274656d61696c696e672e7376673f7374796c653d666f722d7468652d6261646765)](https://github.com/keltuo/php-smartemailing/blob/main/LICENSE)[![LinkedIn](https://camo.githubusercontent.com/d52963778220cbec61d6ed72270f9735024ffceeb551e5c3933d4e03b4694cf1/68747470733a2f2f696d672e736869656c64732e696f2f62616467652f2d4c696e6b6564496e2d626c61636b2e7376673f7374796c653d666f722d7468652d6261646765266c6f676f3d6c696e6b6564696e26636f6c6f72423d353535)](https://linkedin.com/in/lukaspaiskr)

 [ ![Logo](https://camo.githubusercontent.com/7be4fcef1d9e2d43fdabc1f2646614fd57abced4e258b24e8338864d60c2a270/68747470733a2f2f7777772e736d617274656d61696c696e672e637a2f77702d636f6e74656e742f75706c6f6164732f323032302f30392f4c6f676f5f536d617274456d61696c696e672e737667) ](http://smartemailing.cz)### Smart Emailing PHP Client Library v3

[](#smart-emailing-php-client-library-v3)

 The UnOfficial (maybe one day) PHP library for using the [ SmartEmailing v3 API](https://app.smartemailing.cz/docs/api/v3/index.html).
 [**Explore the docs »**](https://app.smartemailing.cz/docs/api/v3/index.html)

 [Examples](https://github.com/keltuo/php-smart-emailing/examples) · [Report Bug](https://github.com/keltuo/php-smart-emailing/issues) · [Request Feature](https://github.com/keltuo/php-smart-emailing/issues)

 Table of Contents1. [Getting Started](#getting-started)
    - [Installation](#installation)
2. [Usage](#usage)
3. [Tests](#tests)
    - [Basic usage](#basic-usage)
    - [How to set up PHP storm for Run test via docker](#how-to-set-up-php-storm-for-run-test-via-docker)
4. [Api Coverage Tree](#api-coverage-tree)
    - [SmartEmailing Doc API V3](#smartemailing-doc-api-v3)
5. [ToDo - report bugs](#todo)
6. [Contributing](#contributing)
7. [License](#license)
8. [Contact](#contact)

Getting Started
---------------

[](#getting-started)

Before using this library, you must have a valid API Key. To get an API Key, please log in to your SmartEmailing account.

### Installation

[](#installation)

This library requires PHP 8 and higher.

The recommended way to install the SmartEmailing PHP Library is through composer.

```
# Install Composer
curl -sS https://getcomposer.org/installer | php

```

```
composer require keltuo/php-smartemailing

```

After installing, you need to require Composer's autoloader:

```
require 'vendor/autoload.php';
use SmartEmailing\SmartEmailing;
```

([back to top](#top))

Usage
-----

[](#usage)

```
use SmartEmailing\SmartEmailing;
// Create an Api instance with your username and apiKey.
$sm = new SmartEmailing('username', 'api-key');

// Call shortcut method for request Contacts
$sm->contacts()
    ->getList()->getData();
```

*For more examples, please refer to the [Documentation](https://app.smartemailing.cz/docs/api/v3/index.html)*

([back to top](#top))

Tests
-----

[](#tests)

In project is Docker Compose file, which support PHP8-cli and composer image.

### Basic usage

[](#basic-usage)

Download composer dependecy and run Unit Tests

```
docker-compose up
```

### How to set up PHP storm for Run test via docker

[](#how-to-set-up-php-storm-for-run-test-via-docker)

\[link\]

([back to top](#top))

Api coverage tree
-----------------

[](#api-coverage-tree)

#### SmartEmailing Doc API V3

[](#smartemailing-doc-api-v3)

- Tests [Code Examples](https://github.com/keltuo/php-smartemailing/blob/main/examples/Tests.php) | [doc api](https://app.smartemailing.cz/docs/api/v3/index.html#api-Tests)
    - Aliveness test
    - GET Login test
    - POST Login test
- Contactlists [Code Examples](https://github.com/keltuo/php-smartemailing/blob/main/examples/Contactlists) | [doc api](https://app.smartemailing.cz/docs/api/v3/index.html#api-Contactlists)
    - Count of added contacts in list
    - Create new Contactlist
    - Distribution of Contactlist
    - Get Contactlists
    - Get single Contactlist
    - Truncate Contactlist
    - Update Contactlist
- Customfields [Code Examples](https://github.com/keltuo/php-smartemailing/blob/main/examples/Customfields) | [doc api](https://app.smartemailing.cz/docs/api/v3/index.html#api-Customfields)
    - Create new Customfield
    - Delete Customfield
    - Get Customfield values
    - Get Customfields
    - Get single Customfield
- Automation [Code Examples](https://github.com/keltuo/php-smartemailing/blob/main/examples/Automation.php) | [doc api](https://app.smartemailing.cz/docs/api/v3/index.html#api-Automation)
    - Trigger event
- Contacts [Code Examples](https://github.com/keltuo/php-smartemailing/blob/main/examples/Contacts/) | [doc api](https://app.smartemailing.cz/docs/api/v3/index.html#api-Contacts)
    - Change e-mail address of single contact
    - Forget contact
    - Get Contacts
    - Get single Contact
- Contacts in lists [Code Examples](https://github.com/keltuo/php-smartemailing/blob/main/examples/Contacts-in-lists/) | [doc api](https://app.smartemailing.cz/docs/api/v3/index.html#api-Contacts_in_lists)
    - Get all Contacts in list
    - Get confirmed Contacts in list
    - Get unsubscribed Contacts in list
- Custom campaigns [Code Examples](https://github.com/keltuo/php-smartemailing/blob/main/examples/Custom-campaigns/) | [doc api](https://app.smartemailing.cz/docs/api/v3/index.html#api-Custom_campaigns)
    - Send bulk custom SMS
    - Send bulk custom emails
    - Send transactional emails
- Customfield Options [Code Examples](https://github.com/keltuo/php-smartemailing/blob/main/examples/Customfield-options/) | [doc api](https://app.smartemailing.cz/docs/api/v3/index.html#api-Customfield_Options)
    - Create new Customfield option
    - Delete Customfield option
    - Get Customfield options
    - Get single Customfield option
    - Update Customfield option
- E shops [Code Examples](https://github.com/keltuo/php-smartemailing/blob/main/examples/Eshops/) | [doc api](https://app.smartemailing.cz/docs/api/v3/index.html#api-E_shops)
    - Add Placed order
    - Import orders in bulk
- Emails [Code Examples](https://github.com/keltuo/php-smartemailing/blob/main/examples/Emails/) | [doc api](https://app.smartemailing.cz/docs/api/v3/index.html#api-Emails)
    - Create e-mail from template
    - Create new E-mail
    - Get E-mails
    - Get confirmation emails
    - Get single E-mail
- Generic collections *TODO*
    - Bulk upsert items
    - Delete item
- Exchange collections *TODO*
    - Get items
    - Get single item
- Generic events *TODO*
    - Bulk upsert events
    - Delete event
    - Get events
    - Get single event
- Import [Code Examples](https://github.com/keltuo/php-smartemailing/blob/main/examples/Import/) | [doc api](https://app.smartemailing.cz/docs/api/v3/index.html#api-Import)
    - Import contacts
- Newsletter [Code Examples](https://github.com/keltuo/php-smartemailing/blob/main/examples/Newsletter/) | [doc api](https://app.smartemailing.cz/docs/api/v3/index.html#api-Newsletter)
    - Create newsletter
- Processing purposes [Code Examples](https://github.com/keltuo/php-smartemailing/blob/main/examples/Processing-purposes/) | [doc api](https://app.smartemailing.cz/docs/api/v3/index.html#api-Processing_purposes)
    - Create new Processing purpose
    - Get Processing purpose connections
    - Get Processing purposes
    - Revoke Processing purpose connection
- Scoring [Code Examples](https://github.com/keltuo/php-smartemailing/blob/main/examples/Scoring/) | [doc api](https://app.smartemailing.cz/docs/api/v3/index.html#api-Scoring)
    - Scoring result history for all contacts
- Stats [Code Examples](https://github.com/keltuo/php-smartemailing/blob/main/examples/Stats/) | [doc api](https://app.smartemailing.cz/docs/api/v3/index.html#api-Stats)
    - Get campaign sent stats
    - Get newsletter stats summaries
- Transactional emails [Code Examples](https://github.com/keltuo/php-smartemailing/blob/main/examples/Transactional-emails/) | [doc api](https://app.smartemailing.cz/docs/api/v3/index.html#api-Transactional_emails)
    - Get transactional email ids
- Web Forms [Code Examples](https://github.com/keltuo/php-smartemailing/blob/main/examples/Web-forms/) | [doc api](https://app.smartemailing.cz/docs/api/v3/index.html#api-Web_Forms)
    - Get all Web Form ids and names
    - Get single Web Form structure
- Webhooks [Code Examples](https://github.com/keltuo/php-smartemailing/blob/main/examples/Webhooks/) | [doc api](https://app.smartemailing.cz/docs/api/v3/index.html#api-Webhooks)
    - Create new Webhook
    - Delete Webhook
    - Get Webhooks

([back to top](#top))

ToDo
----

[](#todo)

See the [open issues](https://github.com/keltuo/php-smartemailing/issues) for a full list of proposed features (and known issues).

([back to top](#top))

Contributing
------------

[](#contributing)

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are **greatly appreciated**.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

1. Fork the Project
2. Create your Feature Branch (`git checkout -b feature/AmazingFeature`)
3. Commit your Changes (`git commit -m 'Add some AmazingFeature'`)
4. Push to the Branch (`git push origin feature/AmazingFeature`)
5. Open a Pull Request

([back to top](#top))

License
-------

[](#license)

Distributed under the MIT License. See `LICENSE` for more information.

([back to top](#top))

Contact
-------

[](#contact)

Lukas Paiskr - [@keltuo](https://twitter.com/keltuo) -

Project Link:

([back to top](#top))

###  Health Score

31

—

LowBetter than 68% of packages

Maintenance16

Infrequent updates — may be unmaintained

Popularity29

Limited adoption so far

Community9

Small or concentrated contributor base

Maturity56

Maturing project, gaining track record

 Bus Factor1

Top contributor holds 100% of commits — single point of failure

How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window.

**Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores.

**Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement.

**Maturity (30%)** — Project age, version count, PHP version support, and release stability.

###  Release Activity

Cadence

Every ~34 days

Total

2

Last Release

1614d ago

### Community

Maintainers

![](https://avatars.githubusercontent.com/u/2955345?v=4)[Lukas Paiskr](/maintainers/keltuo)[@keltuo](https://github.com/keltuo)

---

Top Contributors

[![keltuo](https://avatars.githubusercontent.com/u/2955345?v=4)](https://github.com/keltuo "keltuo (2 commits)")

---

Tags

phpapiclientemailingsmartsmart emailing

###  Code Quality

TestsPHPUnit

Static AnalysisPHPStan

Code StylePHP\_CodeSniffer

Type Coverage Yes

### Embed Badge

![Health badge](/badges/keltuo-php-smartemailing/health.svg)

```
[![Health](https://phpackages.com/badges/keltuo-php-smartemailing/health.svg)](https://phpackages.com/packages/keltuo-php-smartemailing)
```

###  Alternatives

[openai-php/laravel

OpenAI PHP for Laravel is a supercharged PHP API client that allows you to interact with the Open AI API

3.7k7.6M74](/packages/openai-php-laravel)[kunalvarma05/dropbox-php-sdk

Dropbox PHP API V2 SDK (Unofficial)

3633.0M18](/packages/kunalvarma05-dropbox-php-sdk)[resend/resend-php

Resend PHP library.

574.7M21](/packages/resend-resend-php)[mozex/anthropic-laravel

Anthropic PHP for Laravel is a supercharged PHP API client that allows you to interact with the Anthropic API

71226.4k1](/packages/mozex-anthropic-laravel)[picqer/sendcloud-php-client

A PHP Client for the SendCloud API

45400.4k1](/packages/picqer-sendcloud-php-client)[sima-land/api-php-client

Client library for Simaland APIs

311.5k](/packages/sima-land-api-php-client)

PHPackages © 2026

[Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)
