Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/mailjet/laravel-mailjet
Laravel package for Mailjet API V3 and Laravel Mailjet Mail Transport
https://github.com/mailjet/laravel-mailjet
email laravel laravel54 mailjet mailjet-api packagist php transactional-emails
Last synced: 27 days ago
JSON representation
Laravel package for Mailjet API V3 and Laravel Mailjet Mail Transport
- Host: GitHub
- URL: https://github.com/mailjet/laravel-mailjet
- Owner: mailjet
- License: mit
- Created: 2017-06-26T15:22:29.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2024-03-13T17:06:43.000Z (8 months ago)
- Last Synced: 2024-04-26T21:21:23.455Z (7 months ago)
- Topics: email, laravel, laravel54, mailjet, mailjet-api, packagist, php, transactional-emails
- Language: PHP
- Homepage:
- Size: 2.77 MB
- Stars: 91
- Watchers: 9
- Forks: 94
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE.md
Awesome Lists containing this project
README
# Laravel Mailjet
[](https://travis-ci.org/mailjet/laravel-mailjet)
[](https://packagist.org/packages/mailjet/laravel-mailjet)
[](https://packagist.org/packages/mailjet/laravel-mailjet)
[](https://github.com/mailjet/laravel-mailjet/blob/master/LICENSE.md)
[](https://mailjet.github.io/laravel-mailjet/)
Laravel package for handling Mailjet API v3 using this wrapper:
It also provides a mailjetTransport for [Laravel mail feature](https://laravel.com/docs/master/mail)
## 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](https://app.mailjet.com/account/api_keys).
Please also set your email from address and name.
* In the providers array:
```php
'providers' => [
...
Mailjet\LaravelMailjet\MailjetServiceProvider::class,
...
]
```
## Laravel 11.0+
In the file `example-app/bootstrap/providers.php`
```php
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:
```php
'mailjet' => [
'key' => env('MAILJET_APIKEY'),
'secret' => env('MAILJET_APISECRET'),
]
```
* In your .env file:
```php
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](docs/configuration.md).
## 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](https://app.mailjet.com/account/sender)
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](https://laravel.com/docs/master/mail)
## 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](https://dev.mailjet.com/email-api/v3/apikey/)
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:
```php
'providers' => [
...
\Mailjet\LaravelMailjet\Providers\ContactsServiceProvider::class,
...
]
```
and use it:
```php
public function handle(ContactsV4Service $contactsV4Service)
{
$response = $contactsV4Service->delete(351406781);
...
}
```