Search by

dcodegroup / laravel-logged-inbound-email

dcodegroup

Multi-provider inbound email webhooks for Laravel (Mailgun, Postmark, SendGrid, SES, Mailpit, Resend) with logging and processing for every inbound email.

Package info

github.com/DCODE-GROUP/laravel-logged-inbound-email

pkg:composer/dcodegroup/laravel-logged-inbound-email

Statistics

Installs: 24

Dependents: 0

Suggesters: 0

Stars: 0

0.0.2 2026-09-10 08:15 UTC

README

Multi-provider inbound email webhooks for Laravel. Incoming HTTP requests are verified per provider, normalized into an InboundMessage DTO, and handled asynchronously via one queued job class you configure.

Supported providers: Mailgun, Postmark, SendGrid, Amazon SES (via SNS), Mailpit, Resend.

Requirements: PHP ^8.4, Laravel 12.x+ (Illuminate ^12^13 per composer.json).

Install

composer require dcodegroup/laravel-logged-inbound-email

The package registers its service provider automatically (extra.laravel.providers in Composer).

Publish configuration (recommended)

php artisan vendor:publish --tag=logged-inbound-email-config

This copies config/inbound-email.php into your app. Until you publish, the package merges the same defaults from the vendor file.

Routes

Routes are registered under a configurable prefix (default webhooks/inbound). Middleware defaults to api (no session/CSRF). If you switch to web, add these paths to VerifyCsrfToken $except or use stateless verification.

Single-tenant (default)

organization_in_route is false. Pattern:

POST {prefix}/{provider}

Examples (default prefix):

Provider Example path
Mailgun POST /webhooks/inbound/mailgun
Postmark POST /webhooks/inbound/postmark
SendGrid POST /webhooks/inbound/sendgrid
SES (SNS) POST /webhooks/inbound/ses
Mailpit POST /webhooks/inbound/mailpit
Resend POST /webhooks/inbound/resend

Multi-tenant / SaaS

Set INBOUND_EMAIL_ORG_IN_ROUTE=true or config(['inbound-email.organization_in_route' => true]). Pattern:

POST {prefix}/{orgAlias}/{provider}

Example: POST https://your-app.test/webhooks/inbound/acme-corp/mailgun

  • {orgAlias} — Your tenant slug (per organization). It must match the regex in organization_alias_pattern (default: slug-like ASCII; see config/inbound-email.php).
  • The job receives $orgAlias as a separate constructor argument from the normalized message array (see Processing messages).

Switching modes: With multi-tenant routes enabled, old single-segment URLs such as POST /webhooks/inbound/mailgun are not registered. Point each provider’s webhook at the per-organization URL instead.

Prefix: INBOUND_EMAIL_ROUTE_PREFIX or config('inbound-email.route_prefix') (no leading/trailing slashes required in env; the package trims as needed).

Tenant column and relationship (opt-in)

By default the inbound_emails table has no tenant_id column at all. Set INBOUND_EMAIL_MULTI_TENANT_ENABLED=true (and INBOUND_EMAIL_TENANT_MODEL to your tenant model's FQCN) before running php artisan migrate in your app, and the migration adds a nullable, indexed tenant_id column, and InboundEmail::tenant() becomes available as a belongsTo relation to that model.

The package never populates tenant_id itself — your app sets it on the row after it exists.

This is a one-time, initial-setup flag. Flipping it after the table has already been migrated does not retroactively add or drop the column; write your own follow-up migration if you enable multi-tenancy later. Calling tenant() while the flag is off returns null rather than a relation instance.

Email-based tenant discovery

An alternative to organization_in_route for setups where the webhook route isn't controllable (e.g. a fixed provider URL): identify the tenant from the recipient address itself. The package's default technique is plus-addressing, {tenant_identifier}+{process}@domain.

Set INBOUND_EMAIL_EMAIL_BASED_TENANCY_ENABLED=true or config(['inbound-email.email_based_tenancy_enabled' => true]). Unlike organization_in_route, this is not mutually exclusive — both strategies can be enabled at the same time. When both produce a tenant identifier and they disagree, the route-derived value wins (plus-addressing is a fallback, not an override).

The resolved identifier is stored on InboundEmail::organization_alias, same as route-based discovery.

To use your own scheme instead of plus-addressing, set INBOUND_EMAIL_TENANT_RESOLVER (or config(['inbound-email.tenant_resolver' => ...])) to the FQCN of a class implementing Dcodegroup\LaravelLoggedInboundEmail\Contracts\EmailBasedTenantResolver:

use Dcodegroup\LaravelLoggedInboundEmail\Contracts\EmailBasedTenantResolver;

class SubdomainTenantResolver implements EmailBasedTenantResolver
{
    public function resolve(array $recipients): ?string
    {
        // Your own parsing/lookup logic here.
    }
}

The class is resolved via the container, so it may declare its own constructor dependencies.

Configuration overview

Env / concern Purpose
INBOUND_EMAIL_ROUTE_PREFIX URL prefix for all inbound routes (default webhooks/inbound).
INBOUND_EMAIL_ORG_IN_ROUTE true = {orgAlias}/{provider} URLs; false = {provider} only.
INBOUND_EMAIL_ORG_ALIAS_PATTERN Regex (no delimiters) for {orgAlias} when org routing is on.
INBOUND_EMAIL_MULTI_TENANT_ENABLED true adds the tenant_id column/index at migration time and enables InboundEmail::tenant(). Default false.
INBOUND_EMAIL_TENANT_MODEL FQCN of your tenant model, used by InboundEmail::tenant().
INBOUND_EMAIL_EMAIL_BASED_TENANCY_ENABLED true = also parse the tenant identifier from a plus-addressed recipient ({tenant_identifier}+{process}@domain). Can be combined with INBOUND_EMAIL_ORG_IN_ROUTE; the route value wins on disagreement.
INBOUND_EMAIL_TENANT_RESOLVER FQCN of a class implementing EmailBasedTenantResolver, used when email-based tenancy is enabled. Default: package EmailAddressTenantResolver.
INBOUND_EMAIL_JOB FQCN of your queued job (implements ProcessesInboundEmail). Default: package ProcessInboundEmailJob (debug log only).
INBOUND_EMAIL_QUEUE_CONNECTION Optional queue connection for the dispatch.
INBOUND_EMAIL_QUEUE Optional queue name for the dispatch.

Provider secrets and options (set only what you use):

Env Provider
INBOUND_EMAIL_MAILGUN_SIGNING_KEY Mailgun
INBOUND_EMAIL_POSTMARK_WEBHOOK_SECRET Postmark
INBOUND_EMAIL_SENDGRID_VERIFICATION_KEY SendGrid
INBOUND_EMAIL_SES_ALLOW_UNSIGNED_SNS, INBOUND_EMAIL_SES_S3_DISK SES
INBOUND_EMAIL_MAILPIT_BASE_URL, INBOUND_EMAIL_MAILPIT_API_TOKEN, INBOUND_EMAIL_MAILPIT_WEBHOOK_SECRET Mailpit
INBOUND_EMAIL_RESEND_WEBHOOK_SECRET, INBOUND_EMAIL_RESEND_API_KEY, INBOUND_EMAIL_RESEND_API_BASE_URL Resend

Full keys and comments live in the published config/inbound-email.php.

Processing messages

The webhook controller verifies the request, builds an InboundMessage, and dispatches your job class from config('inbound-email.job'). There is no extra wrapper job.

Job requirements

  1. Implement Dcodegroup\LaravelLoggedInboundEmail\Contracts\ProcessesInboundEmail (extends ShouldQueue).
  2. Use Illuminate\Foundation\Bus\Dispatchable (and typically Queueable, InteractsWithQueue, SerializesModels).
  3. array $message — Serialized InboundMessage (InboundMessage::toArray() shape).
  4. Multi-tenant only: second constructor parameter string $orgAlias — value of {orgAlias} from the URL. When organization_in_route is false, the package dispatches with only $message, so a one-argument constructor remains valid for single-tenant setups.

Rebuild the DTO in handle():

$inbound = \Dcodegroup\LaravelLoggedInboundEmail\InboundMessage::fromArray($this->message);

Dispatch behavior

organization_in_route Call
false YourJob::dispatch($messageArray)
true YourJob::dispatch($messageArray, $orgAlias)

Queue connection and queue name from config are applied to the pending dispatch when set.

Example job

use Illuminate\Bus\Queueable;
use Illuminate\Foundation\Bus\Dispatchable;
use Illuminate\Queue\InteractsWithQueue;
use Illuminate\Queue\SerializesModels;
use Dcodegroup\LaravelLoggedInboundEmail\Contracts\ProcessesInboundEmail;
use Dcodegroup\LaravelLoggedInboundEmail\InboundMessage;

final class HandleInboundEmail implements ProcessesInboundEmail
{
    use Dispatchable;
    use InteractsWithQueue;
    use Queueable;
    use SerializesModels;

    /**
     * @param  array<string, mixed>  $message
     */
    public function __construct(
        public array $message,
        public string $orgAlias = '',
    ) {}

    public function handle(): void
    {
        $inbound = InboundMessage::fromArray($this->message);

        // When using organization_in_route, resolve the tenant from $this->orgAlias.
        // Use $inbound->provider, ->subject, ->text, ->metadata, etc.
    }
}

Registering your job class

Environment or published config:

INBOUND_EMAIL_JOB=App\Jobs\HandleInboundEmail

Runtime (e.g. AppServiceProvider):

$this->app->boot(function (): void {
    config(['inbound-email.job' => \App\Jobs\HandleInboundEmail::class]);
});

Development

composer test      # PHPUnit
composer analyse   # PHPStan
composer format    # Laravel Pint