Adding support for Mailgun's parameters to Laravel

README.md

Adding support for Mailgun's parameters to Laravel.

This gist is about adding support for Mailgun's parameters (o:tag, o:testmode, etc..) to your application.

Override.

1. Add these files to your Laravel project :

   • app/Mail/TransportManager.php
   • app/Mail/Transport/MailgunTransport.php
   • app/Providers/MailServiceProvider.php

2. In app.php, replace the line Illuminate\Mail\MailServiceProvider::class, with App\Providers\MailServiceProvider::class,

Test.

• You can test your options using the provided command app/Console/Commands/MailgunParameterTest.php
• Add the following line to the $command array in app/Console/Kernel.php : MailgunParameterTest::class,
• Run the test in console : php artisan test:mailgun-parameter-test --to=%yourEmailAddressHere%
• Have a look at your Mailgun Logs and your should see a "Test delievered" entry! :)

Profit!

MailgunParameterTest.php

# app/Console/Commands/MailgunParameterTest.php

<?php
namespace App\Console\Commands;

use App\Mail\Transport\MailgunTransport;
use Illuminate\Console\Command;
use Illuminate\Mail\Mailable;
use Illuminate\Mail\Mailer;
use Illuminate\Mail\Message;


/**
 * Class MailgunParameterTest
 * @package App\Console\Commands
 */
class MailgunParameterTest extends Command
{
    /** @var string */
    protected $signature = 'test:mailgun-parameter-test {--to=}';
    /** @var string */
    protected $description = 'This command contains code blocks to be tested.';
    /** @var Mailer */
    protected $mailer;


    /**
     * MailgunParameterTest constructor.
     * @param Mailer $mailer
     * @param Mailable $mailable
     */
    public function __construct(Mailer $mailer)
    {
        parent::__construct();

        $this->mailer = $mailer;
    }

    /**
     * Execute the console command.
     */
    public function handle()
    {
        /** @var MailgunTransport $transport */
        $transport = $this->mailer->getSwiftMailer()->getTransport();

        $transport->setOptions([
            'o:tag' => 'This is a tag.',
            'o:testmode' => 'yes'
        ]);

        $email = $this->option('to');
        $this->mailer->raw("This is a test", function ($message) use ($email) {
            /** @var Message $message */
            $message
                ->subject("Testing")
                ->to($email);
        });
    }
}

MailgunTransport.php

# app/Mail/Transport/MailgunTransport.php

<?php
namespace App\Mail\Transport;


/**
 * Class MailgunTransport
 * @package App\Mail\Transport
 *
 * @description This override adds support to Mailgun's options.
 */
class MailgunTransport extends \Illuminate\Mail\Transport\MailgunTransport {
    /** @var array */
    protected $options = [];

    /**
     * @param \Swift_Mime_SimpleMessage $message
     * @param null $failedRecipients
     * @param array $options
     * @return int
     */
    public function send(\Swift_Mime_SimpleMessage $message, &$failedRecipients = null, $options = [])
    {
        $this->beforeSendPerformed($message);

        $to = $this->getTo($message);

        $message->setBcc([]);

        $payload = $this->payload($message, $to);

        // Support for mailgun's options is added here.
        foreach ($this->options as $key => $value) {
            $payload['multipart'][] = [
                'name' => $key,
                'contents' => $value
            ];
        }

        $this->client->post($this->url, $payload);

        $this->sendPerformed($message);

        return $this->numberOfRecipients($message);
    }

    /**
     * @param array $options
     * @return $this
     */
    public function setOptions($options) {
        $this->options = $options;
        return $this;
    }
}

MailServiceProvider.php

# app/Providers/MailServiceProvider.php

<?php
namespace App\Providers;

use App\Mail\TransportManager;


/**
 * Class MailServiceProvider
 * @package App\Providers
 *
 * @description The point of this override is to make sure SwiftMailer use our
 * implementation of MailgunTransport.
 */
class MailServiceProvider extends \Illuminate\Mail\MailServiceProvider
{
    /**
     * Register the Swift Mailer instance.
     *
     * @return void
     */
    public function registerSwiftMailer()
    {
        $this->registerSwiftTransport();

        // Once we have the transporter registered, we will register the actual Swift
        // mailer instance, passing in the transport instances, which allows us to
        // override this transporter instances during app start-up if necessary.
        $this->app->singleton('swift.mailer', function ($app) {
            if ($domain = $app->make('config')->get('mail.domain')) {
                \Swift_DependencyContainer::getInstance()
                    ->register('mime.idgenerator.idright')
                    ->asValue($domain);
            }

            return new \Swift_Mailer($app['swift.transport']->driver());
        });
    }

    /**
     * Register the Swift Transport instance.
     *
     * @return void
     */
    protected function registerSwiftTransport()
    {
        $this->app->singleton('swift.transport', function ($app) {
            return new TransportManager($app);
        });
    }
}

TransportManager.php

# app/Mail/TransportManager.php

<?php

namespace App\Mail;

use App\Mail\Transport\MailgunTransport;

/**
 * Class TransportManager
 * @package App\Mail
 *
 * @description Switches Laravel's MailgunTransport to ours which adds
 * functionalities.
 */
class TransportManager extends \Illuminate\Mail\TransportManager
{
    /**
     * Create an instance of the Mailgun Swift Transport driver.
     *
     * @return MailgunTransport
     */
    protected function createMailgunDriver()
    {
        $config = $this->app['config']->get('services.mailgun', []);

        return new MailgunTransport(
            $this->guzzle($config),
            $config['secret'], $config['domain']
        );
    }
}

Hi @j0um,
can i use it with markdown email and mailable class ?

Hi! This error means \Illuminate\Mail\Transport\MailgunTransport is not being overriden by \App\Mail\Transport\MailgunTransport. The cause might be that step no.2 has been skipped or maybe there is some kind of cache preventing the application from getting the right service provider. You might want to try "php artisan cache:clear" and/or "php artisan config:cache". Good luck!

…

On Tue, Jun 11, 2019 at 10:19 AM Matteo ***@***.***> wrote: Hi @j0um <https://github.com/j0um>, i'm using this gist with L5.8. But when i tried to run artisan command, i got an error: undefined method setOptions i've follow the instructions, but never change. What am i missing ? — You are receiving this because you were mentioned. Reply to this email directly, view it on GitHub <https://gist.github.com/27df29e165a1c1e0634a8dee2122db99?email_source=notifications&email_token=ABPLOD2RPTALKX4RH4JSLBDPZ6X5HA5CNFSM4HW63CCKYY3PNVWWK3TUL52HS4DFVNDWS43UINXW23LFNZ2KUY3PNVWWK3TUL5UWJTQAFTPRA#gistcomment-2940688>, or mute the thread <https://github.com/notifications/unsubscribe-auth/ABPLOD5W4IWOQYBMZE7M6VLPZ6X5HANCNFSM4HW63CCA> .

@mdeprezzo Yes this is what it's meant for! :)

Ok, i've some cache to clear.

But how can i use with mailable. I mean, inside command test, there's only an example with mailer right?

i tried something like that:

Mail::to('email@example.com')
  ->send(new MailableEmail, null, ['o:tag' => 'test'])

but on mailgun log, there are no tags reported

@j0um I still need your help 💃

If you use a mailable Class (like Mail::to(...)->send(new ClassName())) you don't need this.
You can simply build the Mailgun Tags in your class build method:

// Within public function build() in your Mail/Classname.php
$this->withSwiftMessage(function($message) {
            /**
             * @var $message \Swift_Message
             */
            $message->getHeaders()->addTextHeader('X-Mailgun-Tag', 'tagname');
        });

@riyuk already did thanks, anyway!!