Skip to content

Commit

Permalink
Update README
Browse files Browse the repository at this point in the history
  • Loading branch information
Baspa committed Oct 4, 2024
1 parent 3cd6efd commit 437edbd
Showing 1 changed file with 6 additions and 10 deletions.
16 changes: 6 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ Hi! We are a web development agency from Nijmegen in the Netherlands and we use

## Why this package

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.
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.

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.

Expand All @@ -26,17 +26,17 @@ As we got tired of the situation that a customer needs to call us, we want to kn
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:

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

## Upcoming features

We're currently in the process of writing mail events support for other popular email service providers like Resend, SendGrid, Amazon SES and Mailtrap.
- 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.
- Relate emails being send in Laravel directly to Eloquent models, for example the order confirmation email attached to an Order model.

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

Expand All @@ -61,14 +61,10 @@ php artisan vendor:publish --tag="mails-migrations"
php artisan migrate
```

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:
Add the API key of your email service provider to the `config/services.php` file in your Laravel project, currently we only support Postmark:

```
[
'mailgun' => [
'token' => '...',
],
'postmark' => [
'token' => '...',
]
Expand All @@ -78,7 +74,7 @@ Add the API key of your email service provider to the `config/services.php` file
When done, run this command with the slug of your service provider:

```bash
php artisan mail:webhooks [service] // where [service] is your provider, e.g. postmark or mailgun
php artisan mail:webhooks [service] // where [service] is your provider, e.g. postmark
```

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

0 comments on commit 437edbd

Please sign in to comment.