Skip to content

[3.6.1] Improve README for Laravel #49

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

Merged
gaalferov merged 1 commit into from
Jul 24, 2025
Merged

[3.6.1] Improve README for Laravel #49

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
18 changes: 15 additions & 3 deletions src/Bridge/Laravel/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -274,7 +274,7 @@ Artisan::command('send-template-mail', function () {
;

MailtrapClient::initSendingEmails(
apiKey: env('MAILTRAP_API_KEY') // your API token from here https://mailtrap.io/api-tokens
apiKey: config('services.mailtrap-sdk.apiKey') // your API token from here https://mailtrap.io/api-tokens
)->send($email);
})->purpose('Send Template Mail');
```
Expand All @@ -300,12 +300,12 @@ Artisan::command('batch-send-mail', function () {
// Choose either Transactional API or Bulk API
// For Transactional API
$mailtrap = MailtrapClient::initSendingEmails(
apiKey: env('MAILTRAP_API_KEY'), // Your API token from https://mailtrap.io/api-tokens
apiKey: config('services.mailtrap-sdk.apiKey'), // Your API token from https://mailtrap.io/api-tokens
);

// OR for Bulk API (uncomment the line below and comment out the transactional initialization)
// $mailtrap = MailtrapClient::initSendingEmails(
// apiKey: env('MAILTRAP_API_KEY'), // Your API token from https://mailtrap.io/api-tokens
// apiKey: config('services.mailtrap-sdk.apiKey'), // Your API token from https://mailtrap.io/api-tokens
// isBulk: true // Enable bulk sending
//);

Expand Down Expand Up @@ -342,6 +342,18 @@ The Mailtrap library is fully compatible with **Laravel 9.x and above**.

But you can still use this library as a standalone. More example how to use, you can find [here](../../../examples)

### WARNING
If you encounter the `IncompleteDsnException` error, it is likely that you are using an outdated Laravel version
and the configuration parameters were not set automatically by Laravel service provider.
Please add them manually to the `config/services.php` file and after that run the `php artisan config:clear` command.

```php
'mailtrap-sdk' => [
'host' => env('MAILTRAP_HOST', 'send.api.mailtrap.io'),
'apiKey' => env('MAILTRAP_API_KEY'),
'inboxId' => env('MAILTRAP_INBOX_ID'),
],
```

## Resources

Expand Down