An open API service indexing awesome lists of open source software.

https://github.com/robrogers3/larajet

Mailjet Mail Transport for Laravel using Mailjet API V3
https://github.com/robrogers3/larajet

driver laravel mailjet mailjet-api transport

Last synced: 13 days ago
JSON representation

Mailjet Mail Transport for Laravel using Mailjet API V3

Awesome Lists containing this project

README

        

# Larajet

[![Package version](https://img.shields.io/packagist/v/robrogers/larajet.svg?style=flat-square)](https://packagist.org/packages/robrogers/larajet)
[![Software License][ico-license]](LICENSE.md)
[![Total downloads](http://img.shields.io/packagist/dt/robrogers/larajet.svg?style=flat-square)](https://packagist.org/packages/robrogers/larajet)

Larajet is a mail transport for Laravel. It is a MailJet integration package. Much like Mailgun, this allows for sending Mail via the mailjet api (based on Mailjet API v3.)
It supports Mailables and Notifables.

## Install

Via Composer

``` bash
$ composer require robrogers/larajet
```

## Configure

You will need to update app.php in the config directory:

In Package Service Providers section add:
```
Larajet\MailjetServiceProvider::class
```

Also, add this line to the 'aliases' array
```
'MailJet' => Larajet\Facades\MailJet::class,
```

Then you need to update config/services.php. Add this under Third Party Services:

``` php
'mailjet' => [
'public_key' => env('MAILJET_PUBLIC_KEY'),
'private_key' => env('MAILJET_PRIVATE_KEY'),
'from' => env('MAIL_FROM'),
'driver' => env('MAIL_DRIVER'),
'guzzle' => [],
'api_url' => 'https://api.mailjet.com/v3/send'
],
```

Lasty, you will need to update your .env file accordingly to set your MailJet Public and Private keys.

```
MAILJET_PUBLIC_KEY=YOUR_PUBLIC_KEY
MAILJET_PRIVATE_KEY=YOUR_PRIVATE_KEY
```

## Usage

The best way is to create a Mailable. e.g.

``` bash
php artisan make:mail TestMail
```

Then just mail it!

``` php
use App\Mail\TestMail;

Mail::to([email protected])
->subject('Test Mail')
->send(new TestMail);
```

Learn about [Mailables](https://laravel.com/docs/5.3/mail) on laravel.com

## Change log

Please see [CHANGELOG](CHANGELOG.md) for more information what has changed recently.

## Testing

``` bash
$ composer test
```
There is only one test. It tests the mail was sent.

Basically the steps are:
* Call a console command, or hit a route that sends an email.
* There are no more steps.

A route might look like:
``` php
use App\Mail\TestMail;

Route::get('/sendmail', function() {
Mail::to(\App\User::first()->email)
->send(new TestMail);
return 'sent?';
});
```

## Contributing

Please see [CONTRIBUTING](CONTRIBUTING.md) and [CONDUCT](CONDUCT.md) for details.

## Security

If you discover any security related issues, please email [email protected] instead of using the issue tracker.

## Credits

- [Rob Rogers][link-author]

## License

The MIT License (MIT). Please see [License File](LICENSE.md) for more information.

[ico-version]: https://img.shields.io/packagist/v/robrogers3/larajet.svg?style=flat-square
[ico-license]: https://img.shields.io/badge/license-MIT-brightgreen.svg?style=flat-square
[ico-travis]: https://img.shields.io/travis/robrogers3/larajet/master.svg?style=flat-square
[ico-scrutinizer]: https://img.shields.io/scrutinizer/coverage/g/robrogers3/larajet.svg?style=flat-square
[ico-code-quality]: https://img.shields.io/scrutinizer/g/robrogers3/larajet.svg?style=flat-square
[ico-downloads]: https://img.shields.io/packagist/dt/robrogers3/larajet.svg?style=flat-square

[link-packagist]: https://packagist.org/packages/robrogers3/larajet
[link-travis]: https://travis-ci.org/robrogers3/larajet
[link-scrutinizer]: https://scrutinizer-ci.com/g/robrogers3/larajet/code-structure
[link-code-quality]: https://scrutinizer-ci.com/g/robrogers3/larajet
[link-downloads]: https://packagist.org/packages/robrogers3/larajet
[link-author]: https://github.com/robrogers3
[link-contributors]: ../../contributors