Tuxedo is an easy way to send transactional emails with Laravel's Mail classes, with the templates already done for you.
- Run the following command:
$ composer require tomirons/tuxedo- Open your
config/app.phpand add the following class to yourprovidersarray:
TomIrons\Tuxedo\TuxedoServiceProvider::class- (Optional) If you would like to edit the templates, run the following command to publish them
php artisan vendor:publish --provider=TomIrons\Tuxedo\TuxedoServiceProviderThere are currently 3 different types of classes you can extend. ActionMailable, AlertMailable, and InvoiceMailable, and each have their own special properties and methods.
These methods are currently only available in ActionMailable and AlertMailable.
greeting($greeting)- Sets the greeting for the message.line($line)- Add a line of text to the message.
color($color)- Sets the color of the button. Available options areblue,green, andred.action($text, $url)- Sets the button text and url.success()- Sets the button color togreen.error()- Sets the button color tored.info()- Sets the button color toblue.
<?php
namespace App\Mail;
use Illuminate\Bus\Queueable;
use Illuminate\Queue\SerializesModels;
use Illuminate\Contracts\Queue\ShouldQueue;
use TomIrons\Tuxedo\Mailables\ActionMailable;
class TuxedoTestMail extends ActionMailable
{
use Queueable, SerializesModels;
/**
* Create a new message instance.
*
* @return void
*/
public function __construct()
{
//
}
/**
* Build the message.
*
*/
public function build()
{
return $this->greeting('Hello!')
->success()
->line('Some line of text to tell you what exactly is going on.')
->action('Click Me', 'http://example.com')
->line('Some other information to be displayed after the button.');
}
}info()- Sets the type of the alert toinfo.warning()- Sets the type of the alert towarning.success()- Sets the type of the alert tosuccess.error()- Sets the type of the alert toerror.type($type)- Sets the type of alert, options areinfo,success,warning, anderror.message($message)- Sets the message to display in the alert.
<?php
namespace App\Mail;
use Illuminate\Bus\Queueable;
use Illuminate\Queue\SerializesModels;
use Illuminate\Contracts\Queue\ShouldQueue;
use TomIrons\Tuxedo\Mailables\AlertMailable;
class TuxedoTestMail extends AlertMailable
{
use Queueable, SerializesModels;
/**
* Create a new message instance.
*
* @return void
*/
public function __construct()
{
//
}
/**
* Build the message.
*
*/
public function build()
{
return $this->greeting('Hello!')
->error()
->message('Something has gone wrong, please contact support.')
->line('Some line of text to tell you what exactly is going on.');
}
}$keys|array- Set which keys to use when looking for an item's name and price.
id($id)- Sets the invoice ID.name($name)- Sets the name to begin the invoice with.date($date)- Sets the date to display at the top of the invoice table.due($date)- Sets the due date of the invoice.url($url)- Sets the URL to pay the invoice.items($items)- Add an list of items to the invoice. Acceptable variable types areCollectionandarray.calculate($taxPercent, $shipping)- Calculates the tax and final total, MUST be the last method called.
<?php
namespace App\Mail;
use Carbon\Carbon;
use Illuminate\Bus\Queueable;
use Illuminate\Mail\Mailable;
use Illuminate\Queue\SerializesModels;
use Illuminate\Contracts\Queue\ShouldQueue;
use TomIrons\Tuxedo\Mailables\InvoiceMailable;
class InvoiceMail extends InvoiceMailable
{
use Queueable, SerializesModels;
/**
* Create a new message instance.
*
* @return void
*/
public function __construct()
{
//
}
/**
* Build the message.
*
* @return $this
*/
public function build()
{
return $this->id(123456)
->name('John Doe')
->date(Carbon::now()->format('l, M j Y \a\t g:i a'))
->due(Carbon::now()->addDays(7)->format('l, M j Y \a\t g:i a'))
->url('https://example.com')
->items([
['product_name' => 'Example Product', 'product_price' => 123.99],
['product_name' => 'Second Product', 'product_price' => 321.99]
6F5D
])
->calculate(3, 15);
}
}Tuxedo is open-sourced software licensed under the MIT license