Sending from multiple Mailgun domains using Laravel Mail facade

Question

I'm using the Laravel 4's Mail::queue() to send emails, using the built in Mailgun driver. The problem is that there are multiple Mailgun domains I would like to be able to send emails from, but the domain must be set in app/config/services.php. Since I'm using Mail::queue(), I can't see how to dynamically set that configuration variable.

Is there any way to do what I'm asking? Ideally, I'd like to be able to pass in the domain when I call Mail::queue() (the Mailgun api key is the same for all the domains I want to send from).

Answer 1

I used Macros to add dynamic configuration. I don't remember if this can be done in Laravel 4 but works on 5.

Register macro in service provider (AppServiceProvider)

public function boot()
{
    Mail::macro('setConfig', function (string $key, string $domain) {

        $transport = $this->getSwiftMailer()->getTransport();
        $transport->setKey($key);
        $transport->setDomain($domain);

        return $this;
    });
}

Then I can use like this:

\Mail::setConfig($mailgunKey, $mailgunDomain)->to(...)->send(...)

In your case

\Mail::setConfig($mailgunKey, $mailgunDomain)->to(...)->queue(...)

Answer 2

Switching the configuration details of the Laravel Mailer at runtime is not that hard, however I don't know of any way it can be done using the Mail::queue facade. It can be done by using a combination of Queue::push and Mail::send (which is what Mail::queue does anyway).

The problem with the Mail::queue facade is that the $message parameter passed to the closure, is of type Illuminate\Mail\Message and we need to modify the mailer transport, which is only accessible through the Swift_Mailer instance (and that is readonly within the Message class).

You need to create a class responsible for sending the email, using a Mailgun transport instance that uses the domain you want:

use Illuminate\Mail\Transport\MailgunTransport;
use Illuminate\Support\SerializableClosure;

class SendQueuedMail {

    public function fire($job, $params)
    {
        // Get the needed parameters
        list($domain, $view, $data, $callback) = $params;

        // Backup your default mailer
        $backup = Mail::getSwiftMailer();

        // Setup your mailgun transport
        $transport = new MailgunTransport(Config::get('services.mailgun.secret'), $domain);
        $mailer = new Swift_Mailer($transport);

        // Set the new mailer with the domain
        Mail::setSwiftMailer($mailer);

        // Send your message
        Mail::send($view, $data, unserialize($callback)->getClosure());

        // Restore the default mailer instance
        Mail::setSwiftMailer($backup);
    }

}

And now you can queue emails like this:

use Illuminate\Support\SerializableClosure;

...

Queue::push('SendQueuedMail', ['domain.com', 'view', $data, serialize(new SerializableClosure(function ($message)
{
    // do your email sending stuff here
}))]);

While it's not using Mail::queue, this alternative is just as compact and easy to read. This code is not tested but should work.

Answer 3

This works in Laravel 5.4:

// Get the existing SwiftMailer
$swiftMailer = Mail::getSwiftMailer();

// Update the domain in the transporter (Mailgun)
$transport = $swiftMailer->getTransport();
$transport->setDomain('YOUR-DOMAIN.HERE');

// Use the updated version
$mailer = Swift_Mailer::newInstance($transport);
Mail::setSwiftMailer($mailer);

Answer 4

My use case was similar to this, in short I just wanted to automatically configure the mailgun sending domain at runtime, by looking at the domain set in the from address field of the message (which I set on the fly before sending using Mail::from(...)->send(...)). This would solve the OP's use case if they are setting the from address in the message to match the mailgun sending domain, which likely should be done.

My solution registers an alternate MailgunTransport which overrides the built in MailgunTransport and sets the domain before sending. This way I only need to register the new driver in my mail.php, and call Mail::send or Mail::queue.

config\mail.php:

'driver' => env('MAIL_DRIVER', 'mailgun-magic-domain')

providers\MailgunMagicDomainProvider:

<?php

namespace App\Providers;

use Illuminate\Support\ServiceProvider;

use Illuminate\Mail\Transport\MailgunTransport;
use Swift_Mime_Message;
use Illuminate\Support\Arr;

use GuzzleHttp\Client as HttpClient;

class MailgunMagicDomainProvider extends ServiceProvider
{
    /**
     * Bootstrap the application services.
     *
     * @return void
     */
    public function boot()
    {
        $swiftTransport = $this->app['swift.transport'];

        $swiftTransport->extend('mailgun-magic-domain', function($app) {
            $config = $app['config']->get('services.mailgun', []);

            $client = new HttpClient(Arr::add(
                Arr::get($config, 'guzzle', []), 'connect_timeout', 60
            ));

            return new MailgunTransportWithDomainFromMessage(
                $client, 
                $config['secret'], 
                $config['domain'] // <- we have to pass this in to avoid re-writing the whole transport, but we'll be dynamically setting this before each send anyway
            );
        });
    }

    /**
     * Register the application services.
     *
     * @return void
     */
    public function register()
    {

    }
}

/**
 * Overrides the built in Illuminate\Mail\Transport\MailgunTransport but doesnt pull the
 * mailgun sending domain from the config, instead it uses the domain in the from address 
 * to dynamically set the mailgun sending domain
 */
class MailgunTransportWithDomainFromMessage extends MailgunTransport 
{
    /**
     * {@inheritdoc}
     */
    public function send(Swift_Mime_Message $message, &$failedRecipients = null)
    {
        $this->setDomain($this->getDomainFromMessage($message));

        return parent::send($message, $failedRecipients);
    }

    protected function getDomainFromMessage(Swift_Mime_Message $message) 
    {
        $fromArray = $message->getFrom();

        if (count($fromArray) !== 1) {
            throw new \Exception('Cannot use the mailgun-magic-domain driver when there isn\'t exactly one from address');
        }

        return explode('@', array_keys($fromArray)[0])[1];
    }
}

config/app.php:

'providers' => [
    ...
    \App\Providers\MailgunMagicDomainProvider::class
],

Answer 5

Maybe it's useful to somebody, I solved it as follows;

In a ServiceProvider under the boot function/method;

public function boot()
{
    Mail::macro('setConfig', function (string $key, string $domain) {

        config()->set('services', array_merge(config('services'), [
            'mailgun' => [
                'domain' => $domain,
                'secret' => $key
            ]
        ]));
    });
}

Call to queue

Mail::setConfig($key, $domain)->to(...)->queue(...)