The right way for a mail tenant aware

[masterix21]

I have discovered a bug using the package with a custom mail switch task in the last weeks.

I was using a custom task to change the sender information like so:

/** 
    !!! WARN !!!
    DON'T USE IT, BECAUSE CONTAINS A BUG 
*/
class SwitchMailTask implements SwitchTenantTask
{
    protected ?array $originalFrom;
    protected ?array $originalReplyTo;

    public function makeCurrent(Tenant $tenant): void
    {
        $this->originalFrom = config('mail.from');
        $this->originalReplyTo = config('mail.reply_to');

        $this->setup($tenant);
    }

    private function setup(Tenant $tenant): void
    {
        $replyToName = data_get($tenant->mail, 'from.name') ?: $tenant->title ?: config('mail.from.name');
        $replyToAddress = data_get($tenant->mail, 'from.address') ?: $tenant->email ?: config('mail.from.address');

        config()->set('mail.from', [
            'address' => $tenant->id.'@mooplan.it',
            'name' => $replyToName,
        ]);

        config()->set('mail.reply_to', [
            'address' => $replyToAddress,
            'name' => $replyToName,
        ]);

        $this->forgetInstance();
    }

    public function forgetCurrent(): void
    {
        config([
            'mail.from' => $this->originalFrom,
            'mail.reply_to' => $this->originalReplyTo,
        ]);

        $this->forgetInstance();
    }

    protected function forgetInstance(): void
    {
        app()->forgetInstance('mail.manager');
    }
}

When the server load increased, tenant1 sent many emails with the sender of tenant2.

Why? Due to the queue concurrency issue, two horizon processes share the same app instance.

To solve the issue, you should handle the MessageSending event dispatched by Laravel when your app sends an email.

class AppServiceProvider extends ServiceProvider
{
    public function boot(): void
    {
        app('events')->listen(MessageSending::class, function (MessageSending $event) {
            if (! Tenant::checkCurrent()) {
                return;
            }

            $tenant = Tenant::current();

            $event->message->from(new Address($tenant->id.'@spatie.be', $tenant->title));
            $event->message->replyTo(new Address($tenant->email, $tenant->title));
        });
    }
}

So, now you rock 🎉