mailjet/laravel-mailjet

Laravel package for Mailjet API V3 and Laravel Mailjet Mail Transport

Laravel Mailjet

, _(*1)

Laravel package for handling Mailjet API v3 using this wrapper: https://github.com/mailjet/mailjet-apiv3-php, _(*2)

It also provides a mailjetTransport for Laravel mail feature, _(*3)

Installation

First, include the package in your dependencies:, _(*4)

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., _(*5)

• In the providers array:

'providers' => [
    ...
    Mailjet\LaravelMailjet\MailjetServiceProvider::class,
    ...
]

Laravel 11.0+

In the file example-app/bootstrap/providers.php, _(*6)

use Mailjet\LaravelMailjet\MailjetServiceProvider;

return [
    App\Providers\AppServiceProvider::class,
    MailjetServiceProvider::class,
];
````

* In the aliases array:

```php
'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., _(*7)

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, _(*8)

For Laravel 7+ you also need to specify new available mail driver in config/mail.php:, _(*9)

'mailers' => [
    ...

    'mailjet' => [
        'transport' => 'mailjet',
    ],
],

For usage, please check the Laravel mail documentation, _(*10)

Usage

In order to usage this package, you first need to import Mailjet Facade in your code:, _(*11)

use Mailjet\LaravelMailjet\Facades\Mailjet;

Then, in your code you can use one of the methods available in the MailjetServices., _(*12)

Low level API methods:, _(*13)

• Mailjet::get($resource, $args, $options)
• Mailjet::post($resource, $args, $options)
• Mailjet::put($resource, $args, $options)
• Mailjet::delete($resource, $args, $options)

High level API methods:, _(*14)

• 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, _(*15)

All method return Mailjet\Response or throw a MailjetException in case of API error., _(*16)

You can also get the Mailjet API client with the method getClient() and make your own custom request to Mailjet API., _(*17)

If you need to delete a contact, you need to register ContactsServiceProvider: * In the providers array:, _(*18)

'providers' => [
    ...
    \Mailjet\LaravelMailjet\Providers\ContactsServiceProvider::class,
    ...
]

and use it:, _(*19)

public function handle(ContactsV4Service $contactsV4Service)
{
    $response = $contactsV4Service->delete(351406781);
    ...
}