Download the PHP package salines/cakephp-mail-interceptor without Composer
On this page you can find all versions of the php package salines/cakephp-mail-interceptor. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download salines/cakephp-mail-interceptor
More information about salines/cakephp-mail-interceptor
Files in salines/cakephp-mail-interceptor
Package cakephp-mail-interceptor
Short Description CakePHP plugin to intercept and redirect outgoing emails to a specified address. Useful for development and staging environments.
License MIT
Homepage https://github.com/salines/cakephp-mail-interceptor
FAQ
Example:
In general, it is recommended to use always a project to download your libraries. In an application normally there is more than one library needed.
- Some hosting areas are not accessible by a terminal or SSH. Then it is not possible to use Composer.
- To use Composer is sometimes complicated. Especially for beginners.
- Composer needs much resources. Sometimes they are not available on a simple webspace.
- If you are using private repositories you don't need to share your credentials. You can set up everything on our site and then you provide a simple download link to your team member.
- Simplify your Composer build process. Use our own command line tool to download the vendor folder as binary. This makes your build process faster and you don't need to expose your credentials for private repositories.
Informations about the package cakephp-mail-interceptor
CakePHP Mail Interceptor
A CakePHP 5.x plugin that intercepts all outgoing emails and redirects them to a specified address. Perfect for development and staging environments where you want to test email functionality without sending emails to real users.
Why Use This Plugin?
When developing or testing applications that send emails, you need a way to prevent emails from reaching real users. There are several approaches:
Paid services like Mailtrap or Mailosaur work great but require subscriptions and external dependencies.
Local tools like Mailpit, MailHog, or MailCatcher are excellent free alternatives, but they require local installation and configuration - which isn't always possible in shared hosting environments, Docker-less setups, or restricted infrastructure.
This plugin offers a zero-infrastructure solution:
- No additional services to install or maintain
- Works with your existing email transport (SMTP, Mailgun, SES, etc.)
- Simple configuration change - just wrap your existing transport
- Ideal for shared staging environments where installing local tools isn't an option
- Perfect for quick local development without setting up additional services
Features
- Redirects all outgoing emails to a single address
- Preserves original recipient information in email headers (
X-Original-To,X-Original-Cc,X-Original-Bcc) - Adds configurable subject prefix to identify intercepted emails
- Optionally includes original recipients in subject line
- Logs all intercepted emails
- Works with any underlying CakePHP mail transport (SMTP, Mailgun, etc.)
Requirements
- PHP 8.1+
- CakePHP 5.0+
Installation
Load the plugin in your src/Application.php:
Configuration
Configure the transport in your config/app_local.php:
Configuration Options
| Option | Type | Default | Description |
|---|---|---|---|
transport |
string | required | Name of the underlying transport to use for sending |
to |
string | required | Email address where all emails will be redirected |
subjectPrefix |
string | 'INTERCEPTED' |
Tag used in subject line prefix |
includeOriginalInSubject |
bool | true |
Whether to include original recipients in subject prefix |
logInterceptions |
bool | true |
Whether to log intercepted emails |
How It Works
When an email is sent through the InterceptTransport:
- Original recipients (To, Cc, Bcc) are saved to custom headers
- All recipients are replaced with the configured
toaddress - Subject is modified with prefix and/or original recipients
- Email is sent using the underlying transport
- Interception is logged (if enabled)
Example
Original email:
- To:
[email protected] - Cc:
[email protected] - Subject:
Your Order Confirmation
Intercepted email:
- To:
[email protected] - Subject:
[DEV: [email protected]] Your Order Confirmation - Header
X-Original-To:[email protected] - Header
X-Original-Cc:[email protected]
Recommended: Use Plus-Addressed Emails
We recommend using plus-addressed (subaddressed) emails for intercepted mail:
Benefits of plus addressing:
- Easy filtering - Create inbox rules to automatically sort intercepted emails by project or environment
- Quick identification - Instantly see which project/environment an email came from
- Single inbox - Use one email account for all projects without mixing emails
- No extra accounts - No need to create separate email addresses for each project
Most email providers support plus addressing, including Gmail, Outlook, ProtonMail, Fastmail, and others.
Environment-Based Configuration
A common pattern is to use the intercept transport only in non-production environments:
Testing
Contributing
Contributions are welcome! Please feel free to submit a Pull Request.
- Fork the repository
- Create your feature branch (
git checkout -b feature/amazing-feature) - Commit your changes (
git commit -m 'Add some amazing feature') - Push to the branch (
git push origin feature/amazing-feature) - Open a Pull Request
License
MIT License. See LICENSE for details.
