Skip to content

Commit 437edbd

Browse files
committed
Update README
1 parent 3cd6efd commit 437edbd

File tree

1 file changed

+6
-10
lines changed

1 file changed

+6
-10
lines changed

README.md

Lines changed: 6 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ Hi! We are a web development agency from Nijmegen in the Netherlands and we use
1313

1414
## Why this package
1515

16-
Email as a protocol is very error prone. Succesfull email delivery is not guaranteed in any way, so it is best to monitor your email sending realtime. Using external services like Postmark or Mailgun email gets better by offering things like logging and delivery feedback, but it still needs your attention and can fail silently but horendously. Therefore we created Laravel Mails that fills in all the gaps.
16+
Email as a protocol is very error prone. Succesfull email delivery is not guaranteed in any way, so it is best to monitor your email sending realtime. Using external services like Postmark email gets better by offering things like logging and delivery feedback, but it still needs your attention and can fail silently but horendously. Therefore we created Laravel Mails that fills in all the gaps.
1717

1818
Using Laravel we create packages to scratch a lot of our own itches, as we get to certain challenges working for our clients and on our projects. One of our problems in our 13 years of web development experience is customers that contact us about emails not getting delivered.
1919

@@ -26,17 +26,17 @@ As we got tired of the situation that a customer needs to call us, we want to kn
2626
Laravel Mails can collect everything you might want to track about the mails that has been sent by your Laravel app. Common use cases are provided in this package:
2727

2828
- Log all sent emails, attachments and events with only specific attributes
29-
- Works currently for popular email service providers Postmark and Mailgun
29+
- Works currently for popular email service provider Postmark
3030
- Collect feedback about the delivery status from email providers using webhooks
31-
- You can relate emails being send in Laravel directly to Eloquent models, for example the order confirmation email attached to an Order model
3231
- Get quickly and automatically notified when email hard/soft bounces or the bouncerate goes too high
3332
- Prune all logged emails periodically to keep the database nice and slim
3433
- Resend logged emails to another recipient
3534
- View all sent emails in the browser using complementary package [Filament Mails](https://github.com/vormkracht10/filament-mails)
3635

3736
## Upcoming features
3837

39-
We're currently in the process of writing mail events support for other popular email service providers like Resend, SendGrid, Amazon SES and Mailtrap.
38+
- We're currently in the process of writing mail events support for other popular email service providers like Mailgun, Resend, SendGrid, Amazon SES and Mailtrap.
39+
- Relate emails being send in Laravel directly to Eloquent models, for example the order confirmation email attached to an Order model.
4040

4141
## Looking for a UI? We've got your back: [Filament Mails](https://github.com/vormkracht10/filament-mails)
4242

@@ -61,14 +61,10 @@ php artisan vendor:publish --tag="mails-migrations"
6161
php artisan migrate
6262
```
6363

64-
Add the API key of your email service provider to the `config/services.php` file in your Laravel project, currently we support Postmark and Mailgun:
64+
Add the API key of your email service provider to the `config/services.php` file in your Laravel project, currently we only support Postmark:
6565

6666
```
6767
[
68-
'mailgun' => [
69-
'token' => '...',
70-
],
71-
7268
'postmark' => [
7369
'token' => '...',
7470
]
@@ -78,7 +74,7 @@ Add the API key of your email service provider to the `config/services.php` file
7874
When done, run this command with the slug of your service provider:
7975

8076
```bash
81-
php artisan mail:webhooks [service] // where [service] is your provider, e.g. postmark or mailgun
77+
php artisan mail:webhooks [service] // where [service] is your provider, e.g. postmark
8278
```
8379

8480
And for changing the configuration you can publish the config file with:

0 commit comments

Comments
 (0)