Skip to content

README: name, working badges, a short pitch, and where sending comes from #12

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
do-io merged 1 commit into from
Oct 20, 2026
Merged

README: name, working badges, a short pitch, and where sending comes from #12

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 12 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,9 +1,13 @@
# Laravel Mail Builder (`getodden/mail`)
# Odden Mail Builder (`getodden/mail`)

[![tests](https://github.com/getodden/mail/actions/workflows/tests.yml/badge.svg)](https://github.com/getodden/mail/actions/workflows/tests.yml)
[![Latest version](https://img.shields.io/packagist/v/getodden/mail)](https://packagist.org/packages/getodden/mail)
[![License: MIT](https://img.shields.io/packagist/l/getodden/mail)](LICENSE.md)
[![PHP](https://img.shields.io/packagist/php-v/getodden/mail)](https://packagist.org/packages/getodden/mail)

A modular, Outlook-bulletproof email building, auditing, and compilation engine for Laravel applications.

Build an email from 29 responsive blocks (in code, in a Filament form, or in a drag-and-drop editor), audit it before it goes out, and compile it to inlined HTML, AMP for Email, MJML, or plain text. It is a plain Laravel package: the compiler is PHP, with no Node step at send time.

Requires PHP 8.3+ and Laravel 12 or 13. Maintained by [CaskStack, LLC](https://odden.io).

**Status:** All 29 slot types are rendered by the compiler, described in the slot schema, and editable in both the Filament builder and the drag-and-drop editor.
Expand Down Expand Up @@ -388,6 +392,12 @@ npm run test:js # the editor's model and history (Node's built-in test runner

---

## Sending, lists and campaigns

This package builds and checks emails. It does not manage contacts, lists, consent or sending. Those come from [Odden CRM](https://github.com/getodden/crm) (open source) and its paid add-ons, or from your own application: `TemplateMailable` sends through any Laravel mailer. See [odden.io](https://odden.io) for Odden Cloud and the paid Marketing add-on.

---

## License

The MIT License (MIT). See [LICENSE.md](LICENSE.md).
Loading