Beautymail - GitLite

KO | EN

gitlite — search

#react #ai #typescript #golang #go #linux #macos #java #windows #awesome #cli #awesome-list #security #mcp

Beautymail

(★ 1,312)

Send beautiful HTML emails with Laravel

File Explorer

Download Latest Version (.zip)

- stale.yml
- .gitkeep
- ark.png
- minty.png
- sunny.png
- widgets.png
- - settings.php
- - .gitkeep
- .gitkeep
.gitignore
.travis.yml
composer.json
phpunit.xml
README.md

# Installation Guide

1. Get the code

git clone https://github.com/snowfire/Beautymail

Downloads the entire project code from GitHub to your computer.

cd Beautymail

Moves into the project folder you just downloaded.

2. PHP (Composer)

Easy Recommended

Prerequisites

Git Needed to download the project code from GitHub.
PHP A PHP runtime is required.
Composer The package manager used to install PHP libraries.

composer require snowfire/beautymail

Type this command into your terminal and run it.

composer require illuminate/mail

Type this command into your terminal and run it.

✅ Run it with a built-in server like php -S localhost:8000, then open http://localhost:8000 in your browser.

Pulled directly from this repo's README.

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# Beautymail for Laravel

Beautymail makes it super easy to send beautiful responsive HTML emails. It's made for things like:

* Welcome emails
* Password reminders
* Invoices
* Data exports

### Index:

- [Templates](#templates)
- [Installation](#installation)
- [Send your first Beauty mail](#send-your-first-beauty-mail)
- [Options](#options)
- [Lumen support](#lumen-support)

## Templates

There are tons of great looking HTML email templates out there. Campaign Monitor and Mailchimp has released hundreds for free. It is pretty simple to adapt a template to Beautymail.

__Widgets__ by [Campaign Monitor](https://www.campaignmonitor.com/templates/all/):

![Widget Template](https://raw.githubusercontent.com/snowfire/Beautymail/master/screenshots/widgets.png)

__Minty__ by __Stamplia__:

![Widget Template](https://raw.githubusercontent.com/snowfire/Beautymail/master/screenshots/minty.png)

__Sunny__

![Widget Template](https://raw.githubusercontent.com/snowfire/Beautymail/master/screenshots/sunny.png)

## Installation

Add the package to your `composer.json` by running:

```bash
composer require snowfire/beautymail
```
    
Configure your settings such as logo url and social links in `config/beautymail.php`

## Send your first Beauty mail

Add this to your `routes/web.php`

```php
Route::get('/test', function()
{
	$beautymail = app()->make(Snowfire\Beautymail\Beautymail::class);
	$beautymail->send('emails.welcome', [], function($message)
	{
		$message
			->from('bar@example.com')
			->to('foo@example.com', 'John Smith')
			->subject('Welcome!');
	});

});
```

Now create `resources/views/emails/welcome.blade.php`

```html
@extends('beautymail::templates.widgets')

@section('content')

@include('beautymail::templates.widgets.articleStart')

<h4 class="secondary"><strong>Hello World</strong></h4>
		<p>This is a test</p>

@include('beautymail::templates.widgets.articleEnd')

@include('beautymail::templates.widgets.newfeatureStart')

<h4 class="secondary"><strong>Hello World again</strong></h4>
		<p>This is another test</p>

@include('beautymail::templates.widgets.newfeatureEnd')

@stop
```

That's it!

## Options

### _Template:_ Widgets

To change colours for the different segments, pass a colour variable:

```php
@include('beautymail::templates.widgets.articleStart', ['color' => '#0000FF'])
```

#### Minty template example

```html
@extends('beautymail::templates.minty')

@section('content')

@include('beautymail::templates.minty.contentStart')
		<tr>
			<td class="title">
				Welcome Steve
			</td>
		</tr>
		<tr>
			<td width="100%" height="10"></td>
		</tr>
		<tr>
			<td class="paragraph">
				This is a paragraph text
			</td>
		</tr>
		<tr>
			<td width="100%" height="25"></td>
		</tr>
		<tr>
			<td class="title">
				This is a heading
			</td>
		</tr>
		<tr>
			<td width="100%" height="10"></td>
		</tr>
		<tr>
			<td class="paragraph">
				More paragraph text.
			</td>
		</tr>
		<tr>
			<td width="100%" height="25"></td>
		</tr>
		<tr>
			<td>
				@include('beautymail::templates.minty.button', ['text' => 'Sign in', 'link' => '#'])
			</td>
		</tr>
		<tr>
			<td width="100%" height="25"></td>
		</tr>
	@include('beautymail::templates.minty.contentEnd')

@stop
```

### Ark template example

```html
@extends('beautymail::templates.ark')

@section('content')

@include('beautymail::templates.ark.heading', [
		'heading' => 'Hello World!',
		'level' => 'h1'
	])

@include('beautymail::templates.ark.contentStart')

<h4 class="secondary"><strong>Hello World</strong></h4>
        <p>This is a test</p>

@include('beautymail::templates.ark.contentEnd')

@include('beautymail::templates.ark.heading', [
		'heading' => 'Another headline',
		'level' => 'h2'
	])

@include('beautymail::templates.ark.contentStart')

<h4 class="secondary"><strong>Hello World again</strong></h4>
        <p>This is another test</p>

@include('beautymail::templates.ark.contentEnd')

@stop
```

#### Sunny template example

```html
@extends('beautymail::templates.sunny')

@section('content')

@include ('beautymail::templates.sunny.heading' , [
        'heading' => 'Hello!',
        'level' => 'h1',
    ])

@include('beautymail::templates.sunny.contentStart')

<p>Today will be a great day!</p>

@include('beautymail::templates.sunny.contentEnd')

@include('beautymail::templates.sunny.button', [
        	'title' => 'Click me',
        	'link' => 'http://google.com'
    ])

@stop
```

## Lumen support

In order to get this working on Lumen follow the installation instructions except for the `artisan vendor:publish` command, since Lumen does not provide this command. Instead you have to copy the assets folder from `vendor/snowfire/beautymail/public/` to the public folder in your Lumen project manually.

Make sure to also put the `beautymail.php` config file in the `config` folder (default available in `src/config/settings.php`)

### Enable mailing in Lumen

After this you will need to install and configure `illuminate/mailer` with:

composer require illuminate/mail
   
and add this to your `bootstrap/app.php`:

$app->withFacades();
    $app->register(App\Providers\AppServiceProvider::class);

See [this blog post](https://medium.com/@edwardsteven/using-lumen-and-laravel-mail-with-mailgun-270415daed37) for more details and how to use different mail libraries in lumen:

### Configure Beautymail classes and configuration parameters

In order to get Beautymail working on Lumen you need to add the following to your `bootstrap/app.php` in order to resolve missing config files, parameters and classes (before you register `BeautymailServiceProvider`):

// Provide required path variables
    $app->instance('path.config', env("STORAGE_DIR", app()->basePath()) . DIRECTORY_SEPARATOR . 'config');
    $app->instance('path.public', env("STORAGE_DIR", app()->basePath()) . DIRECTORY_SEPARATOR . 'public');

// Enable config for beautymail
    $app->configure('beautymail');
    
    // Provide class alliases to resolve Request and Config
    class_alias(\Illuminate\Support\Facades\Request::class, "\Request");
    class_alias(\Illuminate\Support\Facades\Config::class, "\Config");

### Start using Beautymail

Congratulations, you can know start using Beautymail in Lumen. See: [Send your first Beauty mail](#send-your-first-beauty-mail) on what to do next.