Skip to content

docs: Update installation guide for Laravel 11+ and clarify package auto-discovery #90

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

docs: Update installation guide for Laravel 11+ and clarify package auto-discovery #90

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
94 changes: 67 additions & 27 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,41 +16,75 @@ 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.
Then, you need to add some configuration. You can find your Mailjet API key/secret [here](https://app.mailjet.com/account/api_keys).

* In the providers array:
### Laravel 11.0+ (Recommended)

Laravel 11+ removed the `providers` and `aliases` arrays from `config/app.php`. This package uses **Laravel Package Auto-Discovery** (available since Laravel 5.5), which automatically registers the service provider and `Mailjet` facade alias when you install the package via Composer.

**No manual registration needed!** Just configure your credentials:

* Add to `config/services.php`:

```php
'providers' => [
...
Mailjet\LaravelMailjet\MailjetServiceProvider::class,
...
'mailjet' => [
'key' => env('MAILJET_APIKEY'),
'secret' => env('MAILJET_APISECRET'),
]
```

## Laravel 11.0+
In the file `example-app/bootstrap/providers.php`
* Add to your `.env` file:

```php
MAILJET_APIKEY=YOUR_APIKEY
MAILJET_APISECRET=YOUR_APISECRET
MAIL_MAILER=mailjet
MAIL_FROM_ADDRESS=YOUR_EMAIL_FROM_ADDRESS
MAIL_FROM_NAME=YOUR_FROM_NAME
```

* Add mailjet mailer to `config/mail.php`:

```php
'mailers' => [
...
'mailjet' => [
'transport' => 'mailjet',
],
],
```

**Optional:** If you have disabled auto-discovery, manually register the provider in `bootstrap/providers.php`:
```php
use Mailjet\LaravelMailjet\MailjetServiceProvider;

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

### Laravel 9.x / 10.x (Auto-Discovery Available)

**Note:** Package auto-discovery works automatically in these versions too! Manual registration is only needed if you've disabled auto-discovery in your `composer.json`.

* In the aliases array:
If you need manual registration, edit `config/app.php`:

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

'aliases' => [
...
'Mailjet' => Mailjet\LaravelMailjet\Facades\Mailjet::class,
...
]
```

* In the services.php file:
Then add to `config/services.php`:

```php
'mailjet' => [
Expand All @@ -59,34 +93,31 @@ return [
]
```

* In your .env file:
And to your `.env` file:

```php
MAILJET_APIKEY=YOUR_APIKEY
MAILJET_APISECRET=YOUR_APISECRET
MAIL_MAILER=mailjet
MAIL_FROM_ADDRESS=YOUR_EMAIL_FROM_ADDRESS
MAIL_FROM_NAME=YOU_FROM_NAME
MAIL_FROM_NAME=YOUR_FROM_NAME
```

**Note:** For Laravel 7+, you also need to add mailjet to `config/mail.php` (see [Mail driver configuration](#mail-driver-configuration) section below).

## 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)
To use Mailjet as your Mail driver, make sure you've completed the installation steps above, including:

For Laravel 7+ you also need to specify new available mail driver in config/mail.php:
```
'mailers' => [
...
1. Set `MAIL_MAILER=mailjet` in your `.env` file (use `MAIL_DRIVER` for Laravel 6 and older)
2. Add the mailjet mailer to `config/mail.php` mailers array (Laravel 7+)
3. Configure a valid and authorized sender email address on your [Mailjet account](https://app.mailjet.com/account/sender)

'mailjet' => [
'transport' => 'mailjet',
],
],
```
For usage, please check the [Laravel mail documentation](https://laravel.com/docs/master/mail)
For detailed mail usage, check the [Laravel mail documentation](https://laravel.com/docs/master/mail)

## Usage

Expand Down Expand Up @@ -121,8 +152,17 @@ All method return `Mailjet\Response` or throw a `MailjetException` in case of AP
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:

**Laravel 11+:** Add to `bootstrap/providers.php`:
```php
return [
App\Providers\AppServiceProvider::class,
Mailjet\LaravelMailjet\MailjetServiceProvider::class,
Mailjet\LaravelMailjet\Providers\ContactsServiceProvider::class,
];
```

**Laravel 9.x/10.x:** Add to `config/app.php` providers array:
```php
'providers' => [
...
Expand All @@ -131,7 +171,7 @@ If you need to delete a contact, you need to register ContactsServiceProvider:
]
```

and use it:
Then use it:
```php
public function handle(ContactsV4Service $contactsV4Service)
{
Expand Down
87 changes: 75 additions & 12 deletions docs/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,44 +15,107 @@ 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).
Then, you need to add some configuration. You can find your Mailjet API key/secret [here](https://app.mailjet.com/account/api_keys).

* In the providers array add the service providers you want to use, for example:
### Laravel 11.0+ (Recommended)

Laravel 11+ removed the `providers` and `aliases` arrays from `config/app.php`. This package uses **Laravel Package Auto-Discovery** (available since Laravel 5.5), which automatically registers the service provider and `Mailjet` facade alias when you install the package via Composer.

**No manual registration needed!** Just configure your credentials:

* Add to `config/services.php`:

```php
'providers' => [
...
Mailjet\LaravelMailjet\MailjetServiceProvider::class,
Mailjet\LaravelMailjet\MailjetMailServiceProvider::class,
...
Mailjet\LaravelMailjet\Providers\CampaignDraftServiceProvider::class
'mailjet' => [
'key' => env('MAILJET_APIKEY'),
'secret' => env('MAILJET_APISECRET'),
]
```

* In the aliases array
* Add to your `.env` file:

```php
MAILJET_APIKEY=YOUR_APIKEY
MAILJET_APISECRET=YOUR_APISECRET
MAIL_MAILER=mailjet
```

* Add mailjet mailer to `config/mail.php`:

```php
'mailers' => [
...
'mailjet' => [
'transport' => 'mailjet',
],
],
```

**Optional:** If you have disabled auto-discovery, manually register the provider in `bootstrap/providers.php`:
```php
use Mailjet\LaravelMailjet\MailjetServiceProvider;

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

**Additional Service Providers:** If you need specific features (campaigns, contacts, templates, etc.), you can manually register additional service providers in `bootstrap/providers.php`:
```php
Mailjet\LaravelMailjet\Providers\CampaignDraftServiceProvider::class,
Mailjet\LaravelMailjet\Providers\ContactsServiceProvider::class,
// etc.
```

### Laravel 9.x / 10.x (Auto-Discovery Available)

**Note:** Package auto-discovery works automatically in these versions too! Manual registration is only needed if you've disabled auto-discovery in your `composer.json`.

If you need manual registration, edit `config/app.php`:

```php
'providers' => [
...
Mailjet\LaravelMailjet\MailjetServiceProvider::class,
// Optional: add additional service providers as needed
Mailjet\LaravelMailjet\Providers\CampaignDraftServiceProvider::class,
...
],

'aliases' => [
...
'Mailjet' => Mailjet\LaravelMailjet\Facades\Mailjet::class,
...
]
```

* In the services.php file
Then add to `config/services.php`:

```php
mailjet' => [
'mailjet' => [
'key' => env('MAILJET_APIKEY'),
'secret' => env('MAILJET_APISECRET'),
]
```

* In your .env file
And to your `.env` file:

```php
MAILJET_APIKEY=YOUR_APIKEY
MAILJET_APISECRET=YOUR_APISECRET
MAIL_MAILER=mailjet
```

**Note:** For Laravel 7+, you also need to add mailjet to `config/mail.php`:

```php
'mailers' => [
...
'mailjet' => [
'transport' => 'mailjet',
],
],
```

## Usage
Expand Down