notifiablehq / receive-email
Let your Laravel app receive emails.
Requires
- php: ^8.2
- illuminate/support: ^12.2 || ^13.0
- php-mime-mail-parser/php-mime-mail-parser: ^9.0
Requires (Dev)
- larastan/larastan: ^3.9
- laravel/pint: ^1.21
- orchestra/testbench: ^10.1 || ^11.0
- pestphp/pest: ^3.7
- dev-main
- 0.18.1
- 0.18.0
- 0.17.0
- 0.16.0
- 0.15.2
- 0.15.1
- 0.15.0
- 0.14.5
- 0.14.4
- 0.14.3
- 0.14.2
- 0.14.1
- 0.14.0
- 0.13.4
- 0.13.3
- 0.13.2
- 0.13.1
- 0.13.0
- 0.12.1
- 0.12.0
- 0.11.2
- 0.11.1
- 0.11.0
- 0.10.3
- 0.10.2
- 0.10.1
- 0.10.0
- 0.9.2
- 0.9.1
- 0.9.0
- 0.8.0
- 0.7.0
- 0.6.1
- 0.6.0
- 0.5.1
- 0.5.0
- 0.4.0
- 0.3.3
- 0.3.2
- 0.3.1
- 0.3.0
- 0.2.1
- 0.2.0
- 0.1.0
- 0.0.3
- 0.0.2
- 0.0.1
- dev-refine-docs
- dev-postfix-hardening
- dev-fix/code-review-issues
- dev-feat/laravel-13-support
This package is auto-updated.
Last update: 2026-04-15 01:05:57 UTC
README
Let your Laravel app receive emails.
Installation
composer require notifiablehq/receive-email
Usage
1. Publish Config and Migrations
Publish the configuration and migration files:
php artisan vendor:publish --provider="Notifiable\\ReceiveEmail\\ReceiveEmailServiceProvider" --tag=receive-email
Then run the migrations:
php artisan migrate
2. Listen for Incoming Emails
Whenever an email is received, the package will dispatch the Notifiable\\ReceiveEmail\\Events\\EmailReceived event. On Laravel 11 and above, you should use a listener class:
Create the Listener
Generate a listener class:
php artisan make:listener HandleIncomingEmail
Then implement the handle method:
namespace App\Listeners; use Notifiable\ReceiveEmail\Events\EmailReceived; class HandleIncomingEmail { public function handle(EmailReceived $event): void { $email = $event->email; \Log::info('Received email with subject: ' . $email->parsedMail()->subject()); } }
3. Accessing Email Data
The Email model gives you access to sender, recipients, subject, and body through the parsedMail method. Example:
/** @var \Notifiable\ReceiveEmail\Contracts\ParsedMailContract $mail */ $mail = $email->parsedMail(); $subject = $mail->subject(); $textBody = $mail->text(); $htmlBody = $mail->html(); $recipients = $mail->recipients();
Forge Deployment
- Add this to your recipes, you can name it
Install Mailparse. Make sure the user isroot.
apt-get update apt-get install -y php-cli php-mailparse
-
If you already have an existing server, run this recipe on that server. Otherwise, create a new server and make sure to select this recipe as a
Post-Provision Recipe. You'll have to showAdvance Settingsto select this. -
Once you have the server ready, open up
Port 25, add your site, and deploy your Laravel app. -
Activate an SSL certificate for your site in Forge (Sites > your site > SSL). Forge uses Let's Encrypt and places certs at:
- Certificate:
/etc/nginx/ssl/your-application-domain.com/server.crt - Private key:
/etc/nginx/ssl/your-application-domain.com/server.key
- Certificate:
-
SSH into your Forge server and go to your site directory. Then run the setup command as a
super user:
sudo php artisan notifiable:setup-postfix domain-that-receives-email.com \
--user=forge \
--tls-cert=/etc/nginx/ssl/your-application-domain.com/server.crt \
--tls-key=/etc/nginx/ssl/your-application-domain.com/server.key \
--with-spf
Important: Always pass
--user=forge(or your deploy user) when running withsudo. Without it, the pipe transport will run asroot.
Available options:
| Option | Description |
|---|---|
--user=forge |
The system user Postfix runs the pipe command as. Required when using sudo. |
--tls-cert= |
Path to the TLS certificate file (PEM format). Enables opportunistic TLS for inbound SMTP. |
--tls-key= |
Path to the TLS private key file (PEM format). Must be provided together with --tls-cert. |
--with-spf |
Installs postfix-policyd-spf-python and configures SPF verification for inbound mail. |
-
Add the following DNS records to your domain:
Type Host Value A your-application-domain.com your.forge.ip.address Type Host Value Priority MX domain-that-receives-email.com your-application-domain.com 10 Type Host Value TXT domain-that-receives-email.com v=spf1 mx -all The SPF TXT record tells other mail servers that only your MX host is authorized to send mail for this domain. Even though this is a receive-only server, publishing an SPF record prevents others from spoofing your domain.
Configuration
After publishing the config file, you can tune the following settings in config/receive_email.php:
| Key | Default | Description |
|---|---|---|
message-size-limit |
26214400 (25MB) |
Maximum inbound email size in bytes. Written to Postfix's message_size_limit. |
pipe-concurrency |
4 |
Maximum concurrent pipe processes. Maps to maxproc in master.cf. |
storage-disk |
local |
Filesystem disk for storing raw email files. |
email-table |
emails |
Table name for the Email model. |
sender-table |
senders |
Table name for the Sender model. |
To apply changes to message-size-limit or pipe-concurrency, re-run the setup command.
Research References
Credits
The solutions in this package are inspired by the following projects: