PHPackages                             reneeshkuttan/whitemail-api - 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. reneeshkuttan/whitemail-api

ActiveLibrary[API Development](/categories/api)

reneeshkuttan/whitemail-api
===========================

This package provides a wrapper for Whitemail Api

1.0.0(9y ago)013MITPHPPHP >=5.4.0

Since Nov 28Pushed 9y ago1 watchersCompare

[ Source](https://github.com/sr-verve-reneesh/abc)[ Packagist](https://packagist.org/packages/reneeshkuttan/whitemail-api)[ RSS](/packages/reneeshkuttan-whitemail-api/feed)WikiDiscussions master Synced 1mo ago

READMEChangelog (1)Dependencies (1)Versions (2)Used By (0)

WHITEMAIL API (PHP 5 Package)
=============================

[](#whitemail-api-php-5-package)

WhitemailApi is a PHP wrapper to whitemail api.

Contents
--------

[](#contents)

- [Installation](#installation)
- [Usage](#usage)
    - [Requirements](#requirements)
    - [Initialization](#initialization)
    - [Identify](#identify)
    - [Track](#track)
- [License](#license)

Installation
------------

[](#installation)

1. In order to install WhitemailApi, just add the following to your composer.json. Then run `composer update`:

```
"reneeshkuttan/whitemail-api": "1.0.x-dev"
```

Usage
-----

[](#usage)

### Requirements

[](#requirements)

Before you start, acquire your `API End Point` url and `API Key` from whitemail's company settings page.

### Initializtion

[](#initializtion)

Let's start by creating a new instance of `WhitemailApi`:

```
$api = new WhitemailApi($apiEndPoint, $apiKey);
```

### Identify

[](#identify)

Now we can send a call through the API to identify a subscriber

```
$subscriberData = [
	'email'  => "johns@example.com",
            'fields' => [
                'first_name' => 'John',
                'last_name' => 'Sam'
             ]
];

$api->identify($subscriberData);
```

On succesful request, the identify function would return an associative array with the details of the subscriber:

```
Array ( [success] => 1 [message] => Subscriber succesfully created/updated [subscriber] => Array ( [id] => 31 [uris] => Array ( [show] => http://client1.whitemail5.dev/subscriber/31 ) ) )
```

### Track

[](#track)

Use the `track()` function to track subscriber events:

```
$trackData = [
            'email' => 'johns@example.com',
            'eventName' => 'purchased',
            'data' => ['amt' => '40.50'],
        ];

$api->track($trackData);
```

On success this would return an associative array with status information

```
Array ( [success] => 1 [message] => Subscriber event added )
```

License
-------

[](#license)

WhitemailApi is free software distributed under the terms of the MIT license.

###  Health Score

25

—

LowBetter than 37% of packages

Maintenance20

Infrequent updates — may be unmaintained

Popularity5

Limited adoption so far

Community4

Small or concentrated contributor base

Maturity58

Maturing project, gaining track record

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

Unknown

Total

1

Last Release

3449d ago

### Community

Maintainers

![](https://www.gravatar.com/avatar/cf0196f21e2f14bfcd2ce8ed98156d2601a2acfcbd77164520dae1a57987214e?d=identicon)[reneesh](/maintainers/reneesh)

---

Tags

phpapiwhitemail

###  Code Quality

TestsPHPUnit

### Embed Badge

![Health badge](/badges/reneeshkuttan-whitemail-api/health.svg)

```
[![Health](https://phpackages.com/badges/reneeshkuttan-whitemail-api/health.svg)](https://phpackages.com/packages/reneeshkuttan-whitemail-api)
```

###  Alternatives

[jstolpe/instagram-graph-api-php-sdk

Instagram Graph API PHP SDK

13998.4k2](/packages/jstolpe-instagram-graph-api-php-sdk)

PHPackages © 2026

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