<commit_before># Tuxedo
[![Version](https://img.shields.io/packagist/v/tomirons/tuxedo.svg)](https://packagist.org/packages/tomirons/tuxedo)
[![License](https://poser.pugx.org/tomirons/tuxedo/license.svg)](https://packagist.org/packages/tomirons/tuxedo)
[![Total Downloads](https://img.shields.io/packagist/dt/tomirons/tuxedo.svg)](https://packagist.org/packages/tomirons/tuxedo)

Tuxedo is an easy way to send transactional emails with Laravel's `Mail` classes, with the templates already done for you.

## Contents

- [Installation](#installation)
- [Classes](#classes)
    - [ActionMailable](#actionmailable)
    - [AlertMailable](#alertmailable)
    - [InvoiceMailable](#invoicemailable)
- [License](#license)

## Installation
1) Run the following command:

````shell
$ composer require tomirons/tuxedo
````
    
2) Open your `config/app.php` and add the following class to your `providers` array:

````php
TomIrons\Tuxedo\TuxedoServiceProvider::class
````
    
3) (Optional) If you would like to edit the templates, run the following command to publish them

````shell
php artisan vendor:publish --provider=TomIrons\Tuxedo\TuxedoServiceProvider
````
    
## Classes
There are currently 3 different types of classes you can extend. `ActionMailable`, `AlertMailable`, and `InvoiceMailable`, and each have their own special properties and methods.

#### General Methods
- `gretting($gretting)` - Sets the greeting for the message.
- `line($line)` - Add a line of text to the message.
  
### ActionMailable

#### Methods
- `header($header)` - Sets the header text for the message. Defaults to `Hello!`
- `color($color)` - Sets the color of the button. Available options are `blue`, `green`, and `red`.
- `action($text, $url)` - Sets the button text and url.
- `success()` - Sets the button color to `green`.
- `error()` - Sets the button color to `red`.
  
#### Example
````php
<?php

namespace App\Mail;

use Illuminate\Bus\Queueable;
use Illuminate\Queue\SerializesModels;<commit_msg>add helpful information<commit_after># Tuxedo
[![Version](https://img.shields.io/packagist/v/tomirons/tuxedo.svg)](https://packagist.org/packages/tomirons/tuxedo)
[![License](https://poser.pugx.org/tomirons/tuxedo/license.svg)](https://packagist.org/packages/tomirons/tuxedo)
[![Total Downloads](https://img.shields.io/packagist/dt/tomirons/tuxedo.svg)](https://packagist.org/packages/tomirons/tuxedo)

Tuxedo is an easy way to send transactional emails with Laravel's `Mail` classes, with the templates already done for you.

## Contents

- [Installation](#installation)
- [Classes](#classes)
    - [ActionMailable](#actionmailable)
    - [AlertMailable](#alertmailable)
    - [InvoiceMailable](#invoicemailable)
- [License](#license)

## Installation
1) Run the following command:

````shell
$ composer require tomirons/tuxedo
````
    
2) Open your `config/app.php` and add the following class to your `providers` array:

````php
TomIrons\Tuxedo\TuxedoServiceProvider::class
````
    
3) (Optional) If you would like to edit the templates, run the following command to publish them

````shell
php artisan vendor:publish --provider=TomIrons\Tuxedo\TuxedoServiceProvider
````
    
## Classes
There are currently 3 different types of classes you can extend. `ActionMailable`, `AlertMailable`, and `InvoiceMailable`, and each have their own special properties and methods.

#### General Methods
These methods are currently only available in `ActionMailable` and `AlertMailable`.
- `gretting($gretting)` - Sets the greeting for the message.
- `line($line)` - Add a line of text to the message.
  
### ActionMailable

#### Methods
- `header($header)` - Sets the header text for the message. Defaults to `Hello!`
- `color($color)` - Sets the color of the button. Available options are `blue`, `green`, and `red`.
- `action($text, $url)` - Sets the button text and url.
- `success()` - Sets the button color to `green`.
- `error()` - Sets the button color to `red`.
  
#### Example
````php
<?php

namespace App\Mail;

use Illuminate\Bus\Queueable;
use Illuminate\Queue\SerializesModels;
{'fraction_non_alphanumeric': 0.14380530973451328, 'fraction_numerical': 0.0019665683382497543, 'mean_word_length': 4.796296296296297, 'pattern_counts': {'":': 0, '<': 5, '<?xml version=': 0, '>': 3, 'https://': 12, 'lorem ipsum': 0, 'www.': 0, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 2, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '1001028', 'n_tokens_mistral': 1320, 'n_tokens_neox': 1272, 'n_words': 373}