buildcode/laravel-database-emails

Store and send e-mails using the database

Tuesday, July 24, 2018
by buildcode
Repository
1 Watchers
1 Stars
197 Installations

PHP
0 Dependents
0 Suggesters
6 Forks
0 Open issues
12 Versions
12 % Grown

The README.md

, _(*1)

Introduction

This package allows you to store and send e-mails using the database., _(*2)

Requirements

This package requires Laravel 11 or 12., _(*3)

Installation

Require the package using composer., _(*4)

composer require stackkit/laravel-database-emails

Publish the configuration files., _(*5)

php artisan vendor:publish --tag=database-emails-config
php artisan vendor:publish --tag=database-emails-migrations

Create the database table required for this package., _(*6)

php artisan migrate

Add the e-mail cronjob to your scheduler, _(*7)

protected function schedule(Schedule $schedule)
{
     $schedule->command('email:send')->everyMinute()->withoutOverlapping(5);
}

Usage

Send an email

E-mails are composed the same way mailables are created., _(*8)

use Stackkit\LaravelDatabaseEmails\Email;
use Illuminate\Mail\Mailables\Content;
use Stackkit\LaravelDatabaseEmails\Attachment;
use Illuminate\Mail\Mailables\Envelope;

Email::compose()
    ->content(fn (Content $content) => $content
        ->view('tests::dummy')
        ->with(['name' => 'John Doe'])
    )
    ->envelope(fn (Envelope $envelope) => $envelope
        ->subject('Hello')
        ->from('johndoe@example.com', 'John Doe')
        ->to('janedoe@example.com', 'Jane Doe')
    )
    ->attachments([
        Attachment::fromStorageDisk('s3', '/invoices/john-doe/march-2024.pdf'),
    ])
    ->send();
])

Sending emails to users in your application

Email::compose()
    ->user($user)
    ->send();

By default, the name column will be used to set the recipient's name. If you wish to use something different, you should implement the preferredEmailName method in your model., _(*9)

class User extends Model
{
    public function preferredEmailName(): string
    {
        return $this->first_name;
    }
}

By default, the email column will be used to set the recipient's e-mail address. If you wish to use something different, you should implement the preferredEmailAddress method in your model., _(*10)

class User extends Model
{
    public function preferredEmailAddress(): string
    {
        return $this->work_email;
    }
}

By default, the app locale will be used. If you wish to use something different, you should implement the preferredEmailLocale method in your model., _(*11)

class User extends Model implements HasLocalePreference
{
    public function preferredLocale(): string
    {
        return $this->locale;
    }
}

Using mailables

You may also pass a mailable to the e-mail composer., _(*12)

Email::compose()
    ->mailable(new OrderShipped())
    ->send();

Attachments

To start attaching files to your e-mails, you may use the attachments method like you normally would in Laravel. However, you will have to use this package's Attachment class., _(*13)

use Stackkit\LaravelDatabaseEmails\Attachment;

Email::compose()
    ->attachments([
        Attachment::fromPath(__DIR__.'/files/pdf-sample.pdf'),
        Attachment::fromPath(__DIR__.'/files/my-file.txt')->as('Test123 file'),
        Attachment::fromStorageDisk('my-custom-disk', 'test.txt'),
    ])
    ->send();

[!NOTE] Attachment::fromData() and Attachment::fromStorage() are not supported as they work with raw data., _(*14)

Attaching models to e-mails

You may attach a model to an e-mail. This can be useful to attach a user or another model that belongs to the e-mail., _(*15)

Email::compose()
    ->model(User::find(1));

Scheduling

You may schedule an e-mail by calling later instead of send. You must provide a Carbon instance or a strtotime valid date., _(*16)

Email::compose()
    ->later('+2 hours');

Queueing e-mails

[!IMPORTANT] When queueing mail using the queue function, it is no longer necessary to schedule the email:send command., _(*17)

Email::compose()->queue();

// On a specific connection
Email::compose()->queue(connection: 'sqs');

// On a specific queue
Email::compose()->queue(queue: 'email-queue');

// Delay (send mail in 10 minutes)
Email::compose()->queue(delay: now()->addMinutes(10));

If you need more flexibility, you may also pass your own job class:, _(*18)

Email::compose()->queue(jobClass: CustomSendEmailJob::class);

It could look like this:, _(*19)

<?php

namespace App\Jobs;

use Illuminate\Contracts\Queue\ShouldQueue;
use Stackkit\LaravelDatabaseEmails\SendEmailJob;

class CustomSendEmailJob extends SendEmailJob implements ShouldQueue
{
    // Define custom retries, backoff, etc...
}

Test mode

When enabled, all newly created e-mails will be sent to the specified test e-mail address. This is turned off by default., _(*20)

DB_EMAILS_TESTING_ENABLED=true
DB_EMAILS_TESTING_EMAIL=your-test-recipient@example.com

E-mails to send per minute

To configure how many e-mails should be sent each command., _(*21)

DB_EMAILS_LIMIT=20

Send e-mails immediately

Useful during development when Laravel Scheduler is not running, _(*22)

To enable, set the following environment variable:, _(*23)

DB_EMAILS_IMMEDIATELY=true

Pruning models

use Stackkit\LaravelDatabaseEmails\Email;

$schedule->command('model:prune', [
    '--model' => [Email::class],
])->daily();

By default, e-mails are pruned when they are older than 6 months., _(*24)

You may change that by adding the following to the AppServiceProvider.php:, _(*25)

use Stackkit\LaravelDatabaseEmails\Email;

public function register(): void
{
    Email::pruneWhen(function (Email $email) {
        return $email->where(...);
    });
}

The Versions

24/07 2018

dev-master

9999999-dev

Store and send e-mails using the database

Sources Download

MIT

The Requires

The Development Requires

by Marick van Tuil

24/07 2018

3.0.3

3.0.3.0

Store and send e-mails using the database

Sources Download

MIT

The Development Requires

by Marick van Tuil

24/07 2018

Store and send e-mails using the database

Sources Download

MIT

library laravel-database-emails

Store and send e-mails using the database

buildcode/laravel-database-emails

The README.md

Introduction

Requirements

Installation

Usage

Send an email

Sending emails to users in your application

Using mailables

Attachments

Attaching models to e-mails

Scheduling

Queueing e-mails

Test mode

E-mails to send per minute

Send e-mails immediately

Pruning models

The Versions

dev-master

The Requires

The Development Requires

by Marick van Tuil

3.0.3

The Development Requires

by Marick van Tuil

dev-development

The Development Requires

by Marick van Tuil

3.0.2

The Development Requires

by Marick van Tuil

3.0.1

The Development Requires

by Marick van Tuil

3.0.0

The Development Requires

by Marick van Tuil

2.0.0

The Development Requires

by Marick van Tuil

1.1.3

The Requires

The Development Requires

by Marick van Tuil

1.1.2

The Requires

The Development Requires

by Marick van Tuil

1.1.1

The Requires

The Development Requires

by Marick van Tuil

1.1.0

The Requires

The Development Requires

by Marick van Tuil

1.0.0

The Requires

by Marick van Tuil