Laravel Mailjet
Laravel package for handling Mailjet API v3 using this wrapper: https://github.com/mailjet/mailjet-apiv3-php
It also provides a mailjetTransport for Laravel mail feature
Installation
First, include the package in your dependencies:
composer require mailjet/laravel-mailjet
Then, you need to add some informations in your configuration files. You can find your Mailjet API key/secret here. Please also set your email from address and name.
- In the providers array:
'providers' => [
...
Mailjet\LaravelMailjet\MailjetServiceProvider::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
MAIL_FROM_ADDRESS=YOUR_EMAIL_FROM_ADDRESS
MAIL_FROM_NAME=YOU_FROM_NAME
Full configuration
For details head to configuration doc.
Mail driver configuration
In order to use Mailjet as your Mail driver, you need to update the mail driver in your config/mail.php or your .env file to MAIL_MAILER=mailjet (for Laravel 6 and older use MAIL_DRIVER constant instead), and make sure you are using a valid and authorised from email address configured on your Mailjet account. The sending email addresses and domain can be managed here
For Laravel 7+ you also need to specify new available mail driver in config/mail.php:
'mailers' => [
...
'mailjet' => [
'transport' => 'mailjet',
],
],
For usage, please check the Laravel mail documentation
Usage
In order to usage this package, you first need to import Mailjet Facade in your code:
use Mailjet\LaravelMailjet\Facades\Mailjet;
Then, in your code you can use one of the methods 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 Mailjet API client with the method getClient() and make your own custom request to Mailjet API.
If you need to delete a contact, you need to register ContactsServiceProvider:
- In the providers array:
'providers' => [
...
\Mailjet\LaravelMailjet\Providers\ContactsServiceProvider::class,
...
]
and use it:
public function handle(ContactsV4Service $contactsV4Service)
{
$response = $contactsV4Service->delete(351406781);
...
}
ToDo
- Add additional unit tests to increase code coverage.
![Driver [mailjet] not supported](https://avatars.githubusercontent.com/u/25492845?v=4)
303 Oct 7, 2022
3 Aug 9, 2022
279 Dec 28, 2022
7 Dec 7, 2022
4 Dec 11, 2022
6 May 31, 2023
1 Mar 26, 2022
1 Jan 23, 2022
2 Dec 30, 2022
18 Aug 17, 2021
5 Oct 7, 2022
4 Sep 26, 2022
689 Dec 27, 2022
394 Dec 23, 2022
9 Oct 27, 2022
23 Feb 16, 2022
36 Oct 7, 2022
42 Nov 14, 2022
14 Dec 24, 2022