Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/mailcarrierapp/mailcarrier
Mailing platform with templates and logs included.
https://github.com/mailcarrierapp/mailcarrier
email-sender mail mailing mailing-system
Last synced: about 2 months ago
JSON representation
Mailing platform with templates and logs included.
- Host: GitHub
- URL: https://github.com/mailcarrierapp/mailcarrier
- Owner: mailcarrierapp
- License: mit
- Created: 2022-07-19T11:45:56.000Z (about 2 years ago)
- Default Branch: master
- Last Pushed: 2024-04-26T13:19:40.000Z (5 months ago)
- Last Synced: 2024-04-27T13:53:17.567Z (5 months ago)
- Topics: email-sender, mail, mailing, mailing-system
- Language: PHP
- Homepage: https://mailcarrier.app
- Size: 3.4 MB
- Stars: 145
- Watchers: 1
- Forks: 10
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE.md
Awesome Lists containing this project
- awesome-opensource-email - MailCarrier - Mailing platform with templates and logs included. - `MIT`, `php`, `Laravel` (Email Platform / Newsletter Platform)
README
User friendly, provider-aware, mailing platform with templates and logs included.
Design global layouts, compose your template, preview your emails and send them with your desired provider (SES, MailGun etc.) through intuitive and friendly API endpoint protected by your desired auth guard. Then, inspect them through logs.
### Features
- 🎨 **Beautiful syntax**: Explore a beautiful, expressive template syntax similar to JS thanks to [Twig by Symfony](https://twig.symfony.com).
- 🧩 **Provider aware**: Bring your desired provider to send email, such as Amazon SES, MailGun, SendGrid etc.
- ✨ **Friendly APIs**: Use a friendly and well documented API endpoint to send your emails.
- 🔐 **Secure by default**: Both authentication and API endpoint are always secure: use one of the pre-built auth system or bring your own.
- 📎 **Attachments**: Upload or retrieve attachments from a remote source such *S3*, *Spaces* etc.
- 🪄 **Hackable**: MailCarrier relies on [Laravel](https://laravel.com/) and [Filament](https://filamentphp.com/), that means that over 30K packages are available to customise your MailCarrier instance.
- ⏳ **Queues**: You can choose whether or not to send emails in a enqueued, background jobs, to not block the user experience.
## Quick start
### Classic way
**Prerequisites**: PHP 8.1, Composer
```shell
curl "https://mailcarrier.app/create" | bash
```
Learn more about [the classic way](https://mailcarrier.app/docs/getting-started/installation).
### Docker
```shell
docker run -p 80:80 -ti mailcarrier/mailcarrier
```
Learn more about [running with Docker](https://mailcarrier.app/docs/getting-started/running-docker).
## Testing
```bash
composer test
```
## Changelog
Please see [CHANGELOG](CHANGELOG.md) for more information on what has changed recently.
## Contributing
Please see [CONTRIBUTING](https://github.com/mailcarrierapp/.github/blob/master/CONTRIBUTING.md) for details.
## Security Vulnerabilities
Please review [our security policy](../../security/policy) on how to report security vulnerabilities.
## Credits
- [Danilo Polani](https://github.com/danilopolani)
- [All Contributors](../../contributors)
## License
The MIT License (MIT). Please see [License File](LICENSE.md) for more information.