Skip to content

Commit

Permalink
Update README
Browse files Browse the repository at this point in the history
  • Loading branch information
Baspa committed Aug 30, 2024
1 parent 1e64806 commit be7cf5b
Showing 1 changed file with 12 additions and 1 deletion.
13 changes: 12 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,9 +5,19 @@
[![GitHub Code Style Action Status](https://img.shields.io/github/actions/workflow/status/vormkracht10/filament-mails/fix-php-code-styling.yml?branch=main&label=code%20style&style=flat-square)](https://github.com/vormkracht10/filament-mails/actions?query=workflow%3A"Fix+PHP+code+styling"+branch%3Amain)
[![Total Downloads](https://img.shields.io/packagist/dt/vormkracht10/filament-mails.svg?style=flat-square)](https://packagist.org/packages/vormkracht10/filament-mails)

Filament Mails can collect everything you might want to track about the mails that has been sent by your Filament app. Common use cases are provided in this package:

- Log all sent emails with only specific attributes
- View all sent emails in the browser using the viewer
- Collect feedback about the delivery from email providers using webhooks
- Relate sent emails to Eloquent models
- Get automatically notified when email bounces
- Prune logging of emails periodically
- Resend logged email to another recipient

This is where your description should go. Limit it to a paragraph or two. Consider adding a small example.
## 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, Mailgun or Resend 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.

## Installation

Expand Down Expand Up @@ -71,6 +81,7 @@ Please review [our security policy](../../security/policy) on how to report secu
## Credits

- [Baspa](https://github.com/vormkracht10)
- [Mark van Eijk](https://github.com/markvaneijk)
- [All Contributors](../../contributors)

## License
Expand Down

0 comments on commit be7cf5b

Please sign in to comment.