Laravel package for handling Mailjet API V3 using this wrapper: https://github.com/mailjet/mailjet-apiv3-php
It also provide a mailjetTransport for Laravel mail feature
First, include the package in your dependencies
composer require mailjet/laravel-mailjet
Then, you need to add some informations in your configuration files
- In the providers array
'providers' => [
...
Mailjet\LaravelMailjet\MailjetServiceProvider::class,
Mailjet\LaravelMailjet\MailjetMailServiceProvider::class,
...
]
- In the aliases array
'aliases' => [
...
'Mailjet' => Mailjet\LaravelMailjet\Facades\Mailjet::class,
...
]
- In the services.php file
mailjet' => [
'key' => env('MAILJET_APIKEY'),
'secret' => env('MAILJET_APISECRET'),
]
- In your .env file
MAILJET_APIKEY=YOUR_APIKEY
MAILJET_APISECRET=YOUR_APISECRET
'mailjet' => [
'key' => env('MAILJET_APIKEY'),
'secret' => env('MAILJET_APISECRET'),
'transactionnal' => [
'call' => true,
'options' => [
'url' => 'api.mailjet.com',
'version' => 'v3.1',
'call' => true,
'secured' => true
]
],
'common' => [
'call' => true,
'options' => [
'url' => 'api.mailjet.com',
'version' => 'v3',
'call' => true,
'secured' => true
]
]
]
You can pass settings to MailjetClient.
transactionnal
: settings to sendAPI clientcommon
: setting to MailjetClient accessible throught the Facade Mailjet
In order to use Mailjet as Mail driver, you need to change the mail driver in your config/mail.php
or your .env
file to MAIL_DRIVER=mailjet
, and make sure you have a valid and authorised from-address configured on your Mailjet account.
For usage, check the Laravel mail documentation
To use it, you need to import Mailjet Facade in your file
use Mailjet\LaravelMailjet\Facades\Mailjet;
Then, in your code you can use one of the method available in the MailjetServices :
Low level API methods:
Mailjet::get($resource, $args, $options)
Mailjet::post($resource, $args, $options)
Mailjet::put($resource, $args, $options)
Mailjet::delete($resource, $args, $options)
High level API methods:
Mailjet::getAllLists($filters)
Mailjet::createList($body)
Mailjet::getListRecipients($filters)
Mailjet::getSingleContact($id)
Mailjet::createContact($body)
Mailjet::createListRecipient($body)
Mailjet::editListrecipient($id, $body)
For more informations about the filters you can use in each methods, refer to the Mailjet API documentation
All method return Mailjet\Response or throw a MailjetException in case of API error.
You can also get the client with the method getClient()
and make your own request to Mailjet API.
- More Tests