Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/oneduo/laravel-mail-scheduler
An efficient way to send emails in batches from your Laravel application
https://github.com/oneduo/laravel-mail-scheduler
batch laravel mail php scheduler
Last synced: about 2 months ago
JSON representation
An efficient way to send emails in batches from your Laravel application
- Host: GitHub
- URL: https://github.com/oneduo/laravel-mail-scheduler
- Owner: oneduo
- License: mit
- Created: 2022-11-16T18:08:09.000Z (about 2 years ago)
- Default Branch: main
- Last Pushed: 2023-02-17T16:19:03.000Z (almost 2 years ago)
- Last Synced: 2024-05-01T09:50:04.036Z (8 months ago)
- Topics: batch, laravel, mail, php, scheduler
- Language: PHP
- Homepage:
- Size: 238 KB
- Stars: 5
- Watchers: 2
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE.md
- Security: SECURITY.md
Awesome Lists containing this project
README
# Laravel Mail Scheduler
[](/LICENSE)
[](https://packagist.org/packages/oneduo/laravel-mail-scheduler)
[](https://packagist.org/packages/oneduo/laravel-mail-scheduler)
[](https://github.com/oneduo/laravel-mail-scheduler/actions/workflows/tests.yml)
---
This package gives you the ability to send emails in batches. After creating ScheduledEmails you may send emails using the auto schedule feature or registering the command in the Console kernel yourself.
## Table of Contents
- [Getting Started](#getting_started)
- [Prerequisites](#prerequisites)
- [Installing](#installing)
- [Configuration](#configuration)
- [Usage](#usage)
- [Configuration](#configuration-file)
- [Authors](#authors)
- [Changelog](#changelog)
- [Security](#security)
- [Contributing](#contributing)
- [Credits](#credits)
- [License](#license)
### Prerequisites
This package requires the following :
- PHP 8.1 or higher
- Laravel 8.0 or higher
### Installing
To get started, you will need to install the following dependencies :
```sh
composer require oneduo/laravel-mail-scheduler
```
That's it, you're ready to go!
### Configuration
You may publish the package's configuration by running the following command :
```sh
php artisan vendor:publish --tag="mail-scheduler-config"
```
> **Note** You can find details about the configuration options in the [configuration file section](#configuration-file).
The package provides a fluent facade to create a scheduled email:
```php
to(['[email protected]'])
->save();
```
### Encryption
For security reasons you may want to encrypt the mailable to protect sensible data. You may use the `encrypted` method:
```php
to(['[email protected]'])
->encrypted() // will encrypt the mailable in database
->save();
```
### Configure mailer
You may want to use a specific mailer for schedule email.
```php
to(['[email protected]'])
->mailer('my_mailer') // mailer defined in config/mail.php
->save();
```
### Link email to a source model
You may want to link a ScheduledEmail instance to one of your models using a `morphTo` relationship. It could be a user or a product. It's up to you.
```php
first();
$instance = ScheduledEmail::mailable(new OrderShipped($product))
->to(['[email protected]'])
->encrypted() // will encrypt the mailable in database
->source($product) //
->save();
```
```php
morphMany(ScheduledEmail::class, 'source');
}
}
```
### Send emails
The package can register the command for you when `auto_schedule` is true. You may configure the CRON expression with `schedule_cron`.
If you want more control on the scheduler, you may disable the `auto_schedule` and register the command yourself:
```php
command('mail-scheduler:send')
->everyMinute()
->between('08:00', '18:00');
}
/**
* Register the commands for the application.
*
* @return void
*/
protected function commands()
{
$this->load(__DIR__.'/Commands');
require base_path('routes/console.php');
}
}
```
### Error handling
If an exception occurs while sending an email, the exception message and stacktrace will be saved into the model. The command will resend emails with an error status till `max_attempts` is reached.
| Key | Description | Type | Default |
|---------------------|--------------------------------------------------------------------------------------|----------|--------------------|
| `max_attempts` | Maximum number of attempts to send an email | `int` | `3` |
| `batch_size` | Number of scheduled emails to send in a batch | `int` | `100` |
| `auto_schedule` | Toggles whether or not to register the send email command into the Laravel scheduler | `bool` | `true` |
| `schedule_cron` | The CRON expression used to send emails | `string` | `*/5 * * * *` |
| `table_name` | The table name of the ScheduledEmail model | `string` | `scheduled_emails` |
| `insert_chunk_size` | The chunk size to use to insert emails when using the `createMany` method | `int` | `500` |
- [Mikaël Popowicz](https://github.com/mikaelpopowicz)
- [Charaf Rezrazi](https://github.com/rezrazi)
See also the list of [contributors](https://github.com/oneduo/nova-file-manager/contributors) who
participated in this project.
## Changelog
Please see [CHANGELOG](CHANGELOG.md) for more information what has changed recently.
## Security
Please review [our security policy](../../security/policy) on how to report security vulnerabilities.
## Contributing
Please see [CONTRIBUTING](CONTRIBUTING.md) for details.
## License
The MIT License (MIT). Please see [License File](LICENSE.md) for more information.