lshtmweb/mailer-laravel

Mail driver for Mailer system. You will need the mailer system for this to work.

Mailer Laravel

This package contains a new mail driver that allows laravel to send emails using the default laravel methods., _(*1)

Getting Started

Install the application via compose composer require lshtmweb/mailer-laravel., _(*2)

Add to your service providers list.
Register the mail service provider if you have not already done so.
$app->register(\Illuminate\Mail\MailServiceProvider::class);
Register the new mailer provider after the MailServiceProvider
$app->register(\Lshtmweb\MailerLaravel\MailerMailProvider::class);, _(*3)

Run the following to get the configuration file. php artisan vendor:publish, _(*4)

Add your application credentials to you .env file.
You will need to set up the following keys., _(*5)

'MAILER_URL', 'http://mailer.app' //URL to your instance of mailer.
'MAILER_APP_ID', //Application ID generated when you register the application
'MAILER_APP_KEY' //Application key generated when you register application

Sending an email

To send an email. You will first need to define certain parameters. There is a MailerObject class to help you do so.
Construct your code as so to send using the built in mail wrapper., _(*6)

$object = new MailerObject;
$object->setTemplate('templatekey');
$object->setRecipient("example@test.com");
SendsMailerEmails::sendEmail($object);

For more control, you can use the syntax below to get access to the full array of sending options., _(*7)

$mailer = new MailerObject;
$mailer->setTemplate('templatekey');
$mailer->setRecipient("example@test.com");

Mail::raw('', function ($m) use ($mailer) {
         $m->to($mailer->getRecipient(), $mailer->getRecipient())->subject($mailer->getSubject());
         $m->getSwiftMessage()->mailerObject = $mailer;
});

You can also send the request using the MailerMail Facade, _(*8)

Creating a Template

To create a template, you need to send a request.
Create a data packet like this:, _(*9)

$data = [
    'title'        => 'Template title',
    'description'  => 'Template description',
    'content'      => 'Template content in HTML',
    'type'         => 1,
    'template_key' => 'TEMPLATE_KEY'
];

Please not that the template key is important to give you another way of calling the template without having to remember the template UUID., _(*10)

Send the request using the MailerMail facade., _(*11)

Issues and Suggestions

If you find any issues, raise a ticket!, _(*12)