PHPackages                             andi/kickbox-bundle - 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. andi/kickbox-bundle

AbandonedArchivedSymfony-bundle[API Development](/categories/api)

andi/kickbox-bundle
===================

Symfony Kickbox Bundle

1.1.0(10y ago)45.3k2MITPHP

Since Jun 6Pushed 10y ago3 watchersCompare

[ Source](https://github.com/AbdoulNdiaye/kickbox-bundle)[ Packagist](https://packagist.org/packages/andi/kickbox-bundle)[ Docs](https://github.com/AbdoulNdiaye/kickbox-bundle)[ RSS](/packages/andi-kickbox-bundle/feed)WikiDiscussions master Synced 1mo ago

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

 [![Kickbox Email Verification Service](https://camo.githubusercontent.com/f851d769253442d262f6ce04c09d6ab577c074da245351403d68d71bbee100f4/68747470733a2f2f7374617469632e6b69636b626f782e696f2f6b69636b626f785f6769746875622e706e67)](https://camo.githubusercontent.com/f851d769253442d262f6ce04c09d6ab577c074da245351403d68d71bbee100f4/68747470733a2f2f7374617469632e6b69636b626f782e696f2f6b69636b626f785f6769746875622e706e67)

[![SensioLabsInsight](https://camo.githubusercontent.com/939fe6f97a40950e0ffc0060d2bfd032d2092cf0c10026a9bfb2f3265238fdb9/68747470733a2f2f696e73696768742e73656e73696f6c6162732e636f6d2f70726f6a656374732f34303464613838332d393231372d346339662d386535642d3366346331306335303235352f6269672e706e67)](https://insight.sensiolabs.com/projects/404da883-9217-4c9f-8e5d-3f4c10c50255)

[![Scrutinizer Code Quality](https://camo.githubusercontent.com/85b247b0edc866e272d12c7b3cc8e7127782f02347a2d8a66be8b65c09fbfdd7/68747470733a2f2f7363727574696e697a65722d63692e636f6d2f672f4162646f756c4e64696179652f6b69636b626f782d62756e646c652f6261646765732f7175616c6974792d73636f72652e706e673f623d6d6173746572)](https://scrutinizer-ci.com/g/AbdoulNdiaye/kickbox-bundle/?branch=master)[![Code Coverage](https://camo.githubusercontent.com/4b485bcd22ffffcd06622c0dc8d0c918386251189c0b6038174e6b56bbc70b82/68747470733a2f2f7363727574696e697a65722d63692e636f6d2f672f4162646f756c4e64696179652f6b69636b626f782d62756e646c652f6261646765732f636f7665726167652e706e673f623d6d6173746572)](https://scrutinizer-ci.com/g/AbdoulNdiaye/kickbox-bundle/?branch=master)[![Build Status](https://camo.githubusercontent.com/81e3a83f3510a5d3929b2941458c807622c2b121adb5d4473a4492e38e17efb7/68747470733a2f2f7472617669732d63692e6f72672f4162646f756c4e64696179652f6b69636b626f782d62756e646c652e7376673f6272616e63683d6d6173746572)](https://travis-ci.org/AbdoulNdiaye/kickbox-bundle)

[![Latest Stable Version](https://camo.githubusercontent.com/5c565eaa6bede9e54e09e3bdb8915bcf50fade05eb903fa7e9bd4731f6a0b770/68747470733a2f2f706f7365722e707567782e6f72672f616e64692f6b69636b626f782d62756e646c652f762f737461626c65)](https://packagist.org/packages/andi/kickbox-bundle)[![Latest Unstable Version](https://camo.githubusercontent.com/25ed05c22547853cf44d2f89456a46c23a7554addaaea41a5a6a74b015a52521/68747470733a2f2f706f7365722e707567782e6f72672f616e64692f6b69636b626f782d62756e646c652f762f756e737461626c65)](https://packagist.org/packages/andi/kickbox-bundle)[![License](https://camo.githubusercontent.com/062d31b482059ee9b87ffccd317d5dfa0d0eb9d9d96cde46799ec7f84b9ee9a7/68747470733a2f2f706f7365722e707567782e6f72672f616e64692f6b69636b626f782d62756e646c652f6c6963656e7365)](https://packagist.org/packages/andi/kickbox-bundle)

[![Join the chat at https://gitter.im/AbdoulNdiaye/kickbox-bundle](https://camo.githubusercontent.com/abe08b740a4156153736f791393ec4da6619c4be73212e75769f52edacc0e2b5/68747470733a2f2f6261646765732e6769747465722e696d2f4a6f696e253230436861742e737667)](https://gitter.im/AbdoulNdiaye/kickbox-bundle?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)

Email Verification Library for Symfony
======================================

[](#email-verification-library-for-symfony)

Kickbox determines if an email address is not only valid, but associated with a actual user. Uses include:

- Preventing users from creating accounts on your applications using fake, misspelled, or throw-away email addresses.
- Reducing bounces by removing old, invalid, and low quality email addresses from your mailing lists.
- Saving money and projecting your reputation by only sending to real email users.

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

[](#getting-started)

To begin, hop over to [kickbox.io](http://kickbox.io) and create a free account. Once you've signed up and logged in, click on **API Settings** and then click **Add API Key**. Take note of the generated API Key - you'll need it to setup the client as explained below.

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

[](#installation)

Make sure you have [composer](https://getcomposer.org) installed.

Add the following to your composer.json

```
$ php composer.phar require andi/kickbox-bundle
```

> This package follows the `PSR-4` convention names for its classes, which means you can easily integrate these classes loading in your own autoloader.

Register the bundle in app/AppKernel.php

```
public function registerBundles()
{
    $bundles = array(
        new Andi\KickBoxBundle\AndiKickBoxBundle(),
    );
}
```

In your config.yml, you must configure:

```
# Default configuration for extension with alias: "andi_kick_box"
andi_kick_box:

    # API key list.
    api_keys:             # Required
        toto:
            # The api key generated in kickbox.io.
            key: YOU_API_KEY       # Required
        tata:
            key: AN_OTHER_API_KEY
    # The default API name. If not set, the default value will be the first api name.
    default_api_name: tata

    # The endpoint of the kickbox API.
    endpoint:             'https://api.kickbox.io/v2/verify'
```

Usage
-----

[](#usage)

Add the following code to our controller:

```
public function indexAction($email)
{
    $kickboxClient = $this->get('kickbox_client');
    $response      = $kickboxClient->verify($email);
}
```

We can also get a service name with a specific key defined in config.yml

Example:

```
	$kickboxClient = $this->get('kickbox_client');  // The default client. In our example : tata
	$kickboxClient = $this->get('kickbox_client.tata');
    $kickboxClient = $this->get('kickbox_client.toto');
```

To simply verify an email :

```
	$response = $kickboxClient->verify($email);
```

With a timeout :

```
   // Maximum time, in milliseconds, for the API to complete a verification request. Default value : 6000
   $response = $kickboxClient->verify($email, 6000);
```

> An exception can be thrown by the api client if the HTTP status code is not 200 : Andi\\KickBoxBundle\\Exception\\KickBoxApiException

Response
--------

[](#response)

A successful API call responds with the following object:

```
    $response->getBalance();      // The remaining credit balance (Daily + On Demand).
    $response->getDomain();       // The domain of the provided email address.
    $response->getEmail();        // Returns a normalized version of the provided email address.
    $response->getReason();       // The reason for the result.
    $response->getResponseTime(); // The elapsed time (in milliseconds) it took Kickbox to process the request.
    $response->getResult();       // The verification result: deliverable, undeliverable, risky, unknown
    $response->getSuggestion();   // Returns a suggested email if a possible spelling error was detected.
    $response->getSendex();       // A quality score of the provided email address ranging between 0 (no quality) and 1 (perfect quality).
    $response->getUser();         // The user (a.k.a local part) of the provided email address. (bob@example.com -> bob).

    $response->isAcceptAll();     // If the email was accepted, but the domain appears to accept all emails addressed to that domain.
    $response->isDisposable();    // If the email address uses a disposable domain like trashmail.com or mailinator.com.
    $response->isFree();          // If the email address uses a free email service like gmail.com or yahoo.com.
    $response->isRole();          // If the email address is a role address
    $response->isSuccess();       // If the API request was successful.
```

All the Kickbox API is explained here : [Using api API](http://docs.kickbox.io/v2.0/docs/using-the-api)

###  Health Score

33

—

LowBetter than 75% of packages

Maintenance20

Infrequent updates — may be unmaintained

Popularity23

Limited adoption so far

Community12

Small or concentrated contributor base

Maturity64

Established project with proven stability

 Bus Factor1

Top contributor holds 75% 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 ~31 days

Total

2

Last Release

3968d ago

### Community

Maintainers

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

---

Top Contributors

[![nd-roy](https://avatars.githubusercontent.com/u/1609522?v=4)](https://github.com/nd-roy "nd-roy (36 commits)")[![AbdoulNdiaye](https://avatars.githubusercontent.com/u/86954300?v=4)](https://github.com/AbdoulNdiaye "AbdoulNdiaye (12 commits)")

---

Tags

apikickbox

###  Code Quality

TestsPHPUnit

### Embed Badge

![Health badge](/badges/andi-kickbox-bundle/health.svg)

```
[![Health](https://phpackages.com/badges/andi-kickbox-bundle/health.svg)](https://phpackages.com/packages/andi-kickbox-bundle)
```

###  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)[mailchimp/transactional

458.9M16](/packages/mailchimp-transactional)[get-stream/stream-chat

A PHP client for Stream Chat (https://getstream.io/chat/)

301.8M2](/packages/get-stream-stream-chat)[convertkit/convertkitapi

Kit PHP SDK for the Kit API

2167.1k1](/packages/convertkit-convertkitapi)

PHPackages © 2026

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