PHPackages                             aridez/simple-mail-builder - PHPackages - PHPackages  [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register)

1. [Directory](/)
2. /
3. aridez/simple-mail-builder

ActiveLibrary

aridez/simple-mail-builder
==========================

A tool to easily create emails in Laravel using a fluent interface

1.0.0(1y ago)0169[1 issues](https://github.com/Aridez/simple-mail-builder/issues)MITPHP

Since Sep 16Pushed 1y ago1 watchersCompare

[ Source](https://github.com/Aridez/simple-mail-builder)[ Packagist](https://packagist.org/packages/aridez/simple-mail-builder)[ RSS](/packages/aridez-simple-mail-builder/feed)WikiDiscussions main Synced 1mo ago

READMEChangelog (1)Dependencies (2)Versions (2)Used By (0)

Simple Mail Builder
===================

[](#simple-mail-builder)

A tool to easily create emails in Laravel using a fluent interface.

Table of Contents
-----------------

[](#table-of-contents)

- [Simple Mail Builder](#simple-mail-builder)
    - [Table of Contents](#table-of-contents)
    - [Installation](#installation)
    - [Usage](#usage)
        - [Basic Usage](#basic-usage)
        - [Quick reference](#quick-reference)
        - [Creating new components](#creating-new-components)
        - [Creating a new theme](#creating-a-new-theme)
        - [Passing additional data](#passing-additional-data)
    - [Contributing](#contributing)
    - [Other](#other)

Installation
------------

[](#installation)

You can install the package via composer:

```
composer require aridez/simple-mail-builder
```

If you want to customize the mail views, you can publish them running:

```
php artisan vendor:publish --provider="Aridez\MailBuilder\Providers\MailBuilderServiceProvider"
```

Usage
-----

[](#usage)

### Basic Usage

[](#basic-usage)

To start using the package, you need to create an instance of `MailMessageBuilder` or just use the `Mailbuilder` facade. Here's a basic example of how to use the package within a Laravel notification:

```
use Illuminate\Notifications\Notification;
use Aridez\MailBuilder\Facades\MailBuilder;

class WelcomeMessage extends Notification
{

    [...]

    public function toMail(object $notifiable)
    {
        return MailBuilder::brand('https://i.imgur.com/KO1vcE9.png')->space(15)
            ->title('Welcome ' . $notifiable->name)->space(20)
            ->text('Thank you for signing up for . We\'re really happy to have you! Click the link below to login to your account:')->space(10)
            ->button('Login to Your Account', 'google.es')->space(10)
            ->text('Best regards,')->space(5)
            ->italic('The company team')
            ->include(['footer' => 'The company Ltd, 35 Avenue. City 10115, USA']);
    }
}
```

This code will create an email that looks like this:

[![preview](https://raw.githubusercontent.com/Aridez/simple-mail-builder/main/preview.jpg)](https://raw.githubusercontent.com/Aridez/simple-mail-builder/main/preview.jpg)

### Quick reference

[](#quick-reference)

The `MailMessageBuilder` class provides several methods to add components and pass data to your views:

MethodDescription`brand(string $image_url)`Insert a brand image component.`title(string $title)`Insert a title component.`text(string $text)`Insert a plain text component.`button(string $button_text, string $button_url)`Insert a clickable button component.`link(string $link_text, string $link_url)`Insert a clickable link component.`italic(string $text)`Insert a grey italic text component.`space(int $height)`Insert vertical space component.`theme(string $theme)`Change the theme of the email view.`component(string $name, array $props = [])`Insert an arbitrary component with props.`include(array $data)`Append an array of top-level data.### Creating new components

[](#creating-new-components)

You can customize your views by creating or modifying the default theme of this package. First, publish the views as seen in the [installation](#installation) section. This makes them available under the folder `resources\views\vendow\mailbuilder\components\themes\default`.

In order to create a component, just create a new blade file under that directory. You can take another of the default theme components as an example. Let's create a small text component called `small-text.blade.php`:

```

@props([
    'text' => null
])

            {{$text}}

```

Now, we will be able to use this component by calling the function [component](#quick-reference). The first parameter is a string that must be the name of the view (in this case `small-text`) and the second is a key => value array where the keys must be the same as the props defined in our component:

```
public function toMail(object $notifiable)
{
    return MailBuilder::component('small-text', ['text' => 'This text is passed through the component props now!']);
}
```

### Creating a new theme

[](#creating-a-new-theme)

To create a new whole custom theme, just create a new folder under `resources\views\vendor\mailbuilder\components\themes` with the name of the theme you want to use and modify there the files accordingly:

resources/views/vendor/mailbuilder/components/themes
│
├── default
│ ├── brand.md
│ ├── title.md
│ ├── text.md
│ ├── button.md
│ ├── link.md
│ ├── italic.md
│ └── space.md
│
├── blue
│ ├── brand.md
│ ├── title.md
│ ├── text.md
│ ├── button.md
│ ├── link.md
│ ├── italic.md
│ └── space.md

Whenever you create a new theme, it is important to use the `index.blade.php` as an entry point and also include the following lines where you will want to insert the parametrized components:

```
@foreach ($components as $component)
@component($component['view'], $component['props'])
@endcomponent
@endforeach
```

These lines are in charge of calling, rendering and passing any props to the corresponding view. You can take a look at the `index.blade.php` file as an example.

Finally, to use a different theme you can call the [theme](#quick-reference) function passing the name of the theme as a parameter:

```
public function toMail(object $notifiable)
{
    return MailBuilder::theme('blue')->...;
}
```

### Passing additional data

[](#passing-additional-data)

Sometimes, you will also want to pass additional data accessible from your `index.blade.php` component, for example for headers or footers. For those cases you can use the [include](#quick-reference) function and pass a key => value array that will get passed normally to your view. For example, if we want to access a `$footer` variable from our index component we can do:

```
    public function toMail(object $notifiable)
    {
        return MailBuilder::include(['footer' => 'The company Ltd, 35 Avenue. City 10115, USA'])->...<
    }
```

> 📝 **Note:** Make sure to avoid using the `components` key since it is reserved to render the array of components

Contributing
------------

[](#contributing)

Contributions are welcome! Please follow these guidelines:

1. Fork the repository.
2. Create a new branch (`git checkout -b feature/your-feature`).
3. Make your changes.
4. Commit your changes (`git commit -am 'Add new feature'`).
5. Push to the branch (`git push origin feature/your-feature`).
6. Create a new Pull Request.

To prepare the development environment, you need to add it to your Laravel application. Developing locally, you can create a local repository. In your Laravel project's `composer.json`, add the local repository path:

```
"repositories": [
    {
        "type": "path",
        "url": "/simple-mail-builder"
    }
]
```

Then you can require the package normally:

```
composer require aridez/simple-mail-builder
```

Other
-----

[](#other)

- Responsive email templates by [ckissi](https://github.com/ckissi/responsive-html-email-templates)

###  Health Score

25

—

LowBetter than 37% of packages

Maintenance35

Infrequent updates — may be unmaintained

Popularity10

Limited adoption so far

Community7

Small or concentrated contributor base

Maturity39

Early-stage or recently created project

 Bus Factor1

Top contributor holds 100% of commits — single point of failure

How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window.

**Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores.

**Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement.

**Maturity (30%)** — Project age, version count, PHP version support, and release stability.

###  Release Activity

Cadence

Unknown

Total

1

Last Release

601d ago

### Community

Maintainers

![](https://www.gravatar.com/avatar/abc2691586e1fac915f6692bc492ad9fd36bebe6ac4588c6a1d46384432be934?d=identicon)[Aridez](/maintainers/Aridez)

---

Top Contributors

[![Aridez](https://avatars.githubusercontent.com/u/22683419?v=4)](https://github.com/Aridez "Aridez (4 commits)")

###  Code Quality

TestsPHPUnit

### Embed Badge

![Health badge](/badges/aridez-simple-mail-builder/health.svg)

```
[![Health](https://phpackages.com/badges/aridez-simple-mail-builder/health.svg)](https://phpackages.com/packages/aridez-simple-mail-builder)
```

PHPackages © 2026

[Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)