PHPackages mailexpert/email-deliverability-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. [Mail & Notifications](/categories/mail) 4. / 5. mailexpert/email-deliverability-bundle ActiveMautic-plugin[Mail & Notifications](/categories/mail) mailexpert/email-deliverability-bundle ====================================== Checks contact email deliverability using external API. 00PHP Since Nov 15Pushed 5mo agoCompare [ Source](https://github.com/mailexpert/EmailDeliverabilityBundle)[ Packagist](https://packagist.org/packages/mailexpert/email-deliverability-bundle)[ RSS](/packages/mailexpert-email-deliverability-bundle/feed)WikiDiscussions main Synced 1mo ago READMEChangelog (3)DependenciesVersions (1)Used By (0) Email Deliverability Bundle =========================== [](#email-deliverability-bundle) A Mautic plugin that automatically checks email deliverability status for contacts using an external API service. Features -------- [](#features) - **Automatic Email Validation**: Validates email addresses when contacts are created or updated - **Real-time API Integration**: Connects to your email deliverability API service - **Custom Field Integration**: Stores deliverability status in a custom contact field - **Configurable**: Easy setup through Mautic's configuration interface - **Prevents Duplicates**: Smart processing to avoid checking the same email multiple times Requirements ------------ [](#requirements) - Mautic 4.x or 5.x - PHP 7.4 or higher - Access to an email deliverability checking API Installation ------------ [](#installation) ### Method 1: Manual Installation [](#method-1-manual-installation) 1. Download the plugin or clone this repository: ``` cd /path/to/mautic/plugins git clone https://github.com/mailexpert/EmailDeliverabilityBundle.git ``` 2. Set correct permissions: ``` chown -R www-data:www-data EmailDeliverabilityBundle ``` 3. Install the plugin: ``` cd /path/to/mautic php bin/console mautic:plugins:install php bin/console cache:clear ``` ### Method 2: Using Composer [](#method-2-using-composer) ``` cd /path/to/mautic composer require mailexpert/email-deliverability-bundle php bin/console mautic:plugins:install php bin/console cache:clear ``` Configuration ------------- [](#configuration) ### 1. Configure API Settings [](#1-configure-api-settings) 1. Go to **Settings** → **Plugins** 2. Find **Email Deliverability Plugin** and click on it 3. Click the **gear/settings icon** to configure 4. **Enable the plugin** by toggling "Published" to ON 5. Configure the API settings: - **API URL**: `https://emaildelivery.space/me/checkemail` (default) - **API Key**: Get your API key from or send an email to 6. Click **Save & Close** ### 2. Clear Cache [](#2-clear-cache) ``` php bin/console cache:clear ``` Usage ----- [](#usage) Once installed and configured, the plugin works automatically: 1. **Custom Field Creation**: The plugin automatically creates a `deliverability_status` custom field on first use if it doesn't exist 2. **New Contacts**: When a new contact is created (via form, API, or manual entry), the plugin automatically checks the email deliverability 3. **Updated Contacts**: When a contact's email is updated, the plugin re-validates if the status is empty or "not\_checked" 4. **Status Field**: The deliverability status is stored in the `deliverability_status` custom field ### Deliverability Statuses [](#deliverability-statuses) The plugin stores various statuses returned by your API, such as: - `deliverable` - Email is valid and deliverable - `soft bounce` - Email has received Soft Bounce response - `hard bounce` - Email has received Hard Bounce response - `sent` - Email is used to send an email (but no additional info for the outcome) - `unknown` - Unable to determine status - `not_checked` - Email hasn't been checked yet [![Deliverability Statuses](https://camo.githubusercontent.com/c7027629644920700b8d4823258b4db7332fb68d3f0d5470978c61fedd4872fa/68747470733a2f2f656d61696c64656c69766572792e73706163652f6173736574732f696d616765732f64656c697665726162696c6974795f73746174757365732e6a7067)](https://emaildelivery.space/assets/images/deliverability_statuses.jpg) ### Mautic UI [](#mautic-ui) [![Mautic Contacts UI](https://camo.githubusercontent.com/e69a214fa43c6e3cc320d60bfc03baf67bbcf66a7b5be10b2e48a335e6ba2cc1/68747470733a2f2f656d61696c64656c69766572792e73706163652f6173736574732f696d616765732f706c7567696e5f73637265656e73686f742e706e67)](https://emaildelivery.space/assets/images/plugin_screenshot.png) API Integration --------------- [](#api-integration) The plugin integrates with the Email Deliverability API service at . ### Getting Your API Key [](#getting-your-api-key) 1. Visit 2. Sign up or log in to your account 3. Navigate to your API settings 4. Copy your API key 5. Add it to the plugin configuration in Mautic (Settings → Plugins → Email Deliverability Plugin) Alternatively, send an email to ### Default API Endpoint [](#default-api-endpoint) The plugin uses `https://emaildelivery.space/me/checkemail` as the default API endpoint. This can be customized in the plugin configuration if needed. ### API Request/Response [](#api-requestresponse) The plugin sends email validation requests to the API and processes the response to determine deliverability status. Troubleshooting --------------- [](#troubleshooting) ### Plugin Not Working [](#plugin-not-working) 1. **Check if plugin is enabled**: - Go to Settings → Plugins - Ensure "Email Deliverability Plugin" is Published 2. **Verify custom field exists**: - Go to Settings → Custom Fields - The plugin should have automatically created a field with alias `deliverability_status` - If not, the plugin will create it on the first contact save 3. **Check logs**: ``` tail -f /var/www/html/var/logs/mautic_prod.log ``` 4. **Enable debug logging** (for development): ``` # Check debug logs cat /tmp/deliverability_debug.log ``` ### API Connection Issues [](#api-connection-issues) 1. **Verify API key is correct**: - Go to Settings → Plugins → Email Deliverability Plugin - Ensure your API key from is entered correctly 2. **Test API endpoint manually**: ``` curl -X GET https://emaildelivery.space/me/checkemail?email=inboxfull1@gmail.com \ -H "Content-Type: application/json" \ -d '{"api_key":"your-key"}' ``` 3. **Check API credentials** in plugin configuration 4. **Verify network connectivity** from your Mautic server to emaildelivery.space ### Clear Cache [](#clear-cache) If changes aren't taking effect: ``` php bin/console cache:clear rm -rf var/cache/* ``` Development ----------- [](#development) ### File Structure [](#file-structure) ``` EmailDeliverabilityBundle/ ├── Config/ │ └── config.php # Plugin configuration ├── EventListener/ │ └── ContactSubscriber.php # Event listener for contact changes ├── Helper/ │ └── DeliverabilityChecker.php # API integration helper ├── Integration/ │ └── EmailDeliverabilityIntegration.php # Integration class └── EmailDeliverabilityBundle.php # Main bundle class ``` ### Adding Debug Logging [](#adding-debug-logging) For debugging, you can add logging to track plugin behavior: ``` file_put_contents('/tmp/deliverability_debug.log', date('Y-m-d H:i:s') . " - Your debug message\n", FILE_APPEND ); ``` ### Running Tests [](#running-tests) ``` cd /path/to/mautic php bin/phpunit --filter EmailDeliverability ``` Contributing ------------ [](#contributing) Contributions are welcome! Please: 1. Fork the repository 2. Create a feature branch (`git checkout -b feature/amazing-feature`) 3. Commit your changes (`git commit -m 'Add amazing feature'`) 4. Push to the branch (`git push origin feature/amazing-feature`) 5. Open a Pull Request License ------- [](#license) This plugin is open-source software. Please check the LICENSE file for details. Support ------- [](#support) - **Issues**: Report bugs or request features on [GitHub Issues](https://github.com/mailexpert/EmailDeliverabilityBundle/issues) - **Documentation**: [Mautic Plugin Documentation](https://docs.mautic.org/) - **Community**: [Mautic Community Forums](https://forum.mautic.org/) Credits ------- [](#credits) Developed by [Mail Xpert](https://github.com/mailexpert) Changelog --------- [](#changelog) ### Version 1.1 [](#version-11) - Added automatic email validation on contact creation - Improved error handling and logging - Added support for multiple deliverability statuses - Enhanced API integration ### Version 1.0 [](#version-10) - Initial release - Basic email deliverability checking - Custom field integration ### Health Score 16 — LowBetter than 5% of packages Maintenance48 Moderate activity, may be stable Popularity0 Limited adoption so far Community2 Small or concentrated contributor base Maturity13 Early-stage or recently created project 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. ### Community Maintainers ![](https://www.gravatar.com/avatar/cf06991dc6c53bf835926646b4a6093a500f0e1cf83cc6696b43783185860ab0?d=identicon)[wobos](/maintainers/wobos) ### Embed Badge ![Health badge](/badges/mailexpert-email-deliverability-bundle/health.svg) ``` [![Health](https://phpackages.com/badges/mailexpert-email-deliverability-bundle/health.svg)](https://phpackages.com/packages/mailexpert-email-deliverability-bundle) ``` ### Alternatives [tijsverkoyen/css-to-inline-styles CssToInlineStyles is a class that enables you to convert HTML-pages/files into HTML-pages/files with inline styles. This is very useful when you're sending emails. 5.8k505.3M228](/packages/tijsverkoyen-css-to-inline-styles)[minishlink/web-push Web Push library for PHP 1.9k12.0M53](/packages/minishlink-web-push)[laravel-notification-channels/twilio Provides Twilio notification channel for Laravel 2587.7M12](/packages/laravel-notification-channels-twilio)[spatie/url-signer Generate a url with an expiration date and signature to prevent unauthorized access 4422.3M16](/packages/spatie-url-signer)[mattketmo/email-checker Throwaway email detection library 2742.0M5](/packages/mattketmo-email-checker)[laravel-notification-channels/discord Laravel notification driver for Discord. 2371.3M11](/packages/laravel-notification-channels-discord) PHPackages © 2026 [Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)