https://github.com/matbour/laravel-mailjet
Allow to use the Mailjet Templating Language in Laravel mailables.
https://github.com/matbour/laravel-mailjet
email laravel lumen mailjet
Last synced: 29 days ago
JSON representation
Allow to use the Mailjet Templating Language in Laravel mailables.
- Host: GitHub
- URL: https://github.com/matbour/laravel-mailjet
- Owner: matbour
- License: mit
- Created: 2020-05-29T07:25:47.000Z (almost 5 years ago)
- Default Branch: master
- Last Pushed: 2020-07-26T20:45:40.000Z (almost 5 years ago)
- Last Synced: 2025-02-02T18:33:00.953Z (3 months ago)
- Topics: email, laravel, lumen, mailjet
- Language: PHP
- Size: 9.77 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE.md
Awesome Lists containing this project
README
# Mailjet integration for Laravel and Lumen
Allow to use the [Mailjet Templating Language](https://www.mailjet.com/feature/templating-language/) in Laravel mailables.
**This package is not supported by Mailjet.**
This package follows the [Semantic Versioning specification](https://semver.org/).
## Prerequisites
- PHP >= 7.2
- Laravel/Lumen 6 or 7
### Compatibility matrix
| laravel-mailjet | Laravel / Lumen |
|-----------------|-----------------|
| ^1.0.0 | ^6.0 \|\| ^7.0 |
## Installation / configuration
Simply add the package to your dependencies.
```bash
composer require mathieu-bour/laravel-mailjet
```
### Laravel
The package support the [Package Discovery](https://laravel.com/docs/7.x/packages#package-discovery).
### Lumen
Add the service provider to your `bootstrap/app.php`.
## Configuration
In the `config/services.php`, add the following entry:
```php
return [
// ...
'mailjet' => [
'key' => 'your-mailjet-key',
'secret' => 'your-mailjet-secret',
'call' => true, // can be set to false to mock requests
'options' => ['version' => 'v3.1'], // additional Mailjet options, see https://github.com/mailjet/mailjet-apiv3-php#options
],
// ...
];
```
## Usage
You can now use the class `Windy\Mailjet\MailjetTemplateMailable` as a base for your emails.
Example:
```php
use Windy\Mailjet\MailjetTemplateMailable;
class PasswordForgottenMail extends MailjetTemplateMailable
{
/** @var int The Mailjet Template ID. */
protected $templateId = 1185614;
public $firstName;
public $resetLink;
public function __construct(User $user)
{
// You can now use {{var:firstName}} and {{var:resetLink}} variables in your Mailjet templates
$this->firstName = $user->firstname ?? $user->username ?? '';
$this->resetLink = 'https://mysite.com/password-reset?token=' . $user->token;
}
}
```