mailcarrier/mailcarrier

Mailing platform with templates and logs included

v2.3.1 2024-04-26 13:19 UTC

Requires

• php: ^8.1
• filament/filament: 3.2.65
• flowframe/laravel-trend: ^0.1.5|^0.2
• illuminate/contracts: ^10.0|^11.0
• illuminate/database: ^10.0|^11.0
• laravel/prompts: ^0.1.16
• laravel/sanctum: ^3.2.1|^4.0
• laravel/socialite: ^5.6.1
• livewire/livewire: ^3.4
• nunomaduro/termwind: ^1.15|^2.0
• pboivin/filament-peek: ^2.2
• ralphjsmit/laravel-filament-components: ^2.0
• socialiteproviders/manager: ^4.3
• spatie/data-transfer-object: ^3.9.1
• twig/twig: ^3.5.1

Requires (Dev)

• larastan/larastan: ^2.8
• laravel/pint: ^1.7
• nunomaduro/collision: ^7.0|^8.1
• orchestra/testbench: ^8.0|^9.0
• pestphp/pest: ^2.3
• pestphp/pest-plugin-faker: ^2.0
• pestphp/pest-plugin-laravel: ^2.0
• phpstan/extension-installer: ^1.2
• phpstan/phpstan-deprecation-rules: ^1.1.3
• spatie/laravel-package-tools: ^1.16

MIT

• Danilo Polani

• laravel
• mailcarrier

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.
• 🧩 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 and Filament, 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

curl "https://mailcarrier.app/create" | bash

Learn more about the classic way.

Docker

docker run -p 80:80 -ti mailcarrier/mailcarrier

Learn more about running with Docker.

Testing

composer test

Changelog

Please see CHANGELOG for more information on what has changed recently.

Contributing

Please see CONTRIBUTING for details.

Security Vulnerabilities

Please review our security policy on how to report security vulnerabilities.

Credits

• Danilo Polani
• All Contributors

License

The MIT License (MIT). Please see License File for more information.