- pact.HasMailPartials: plugins declare <plugin>::mail.partials.<name>,
loaded from views/mail/partials/<name>.htm; HasMailTemplates is unchanged
- bodies and layouts call {{ partial "name" "key" value ... }}; a call in a
Markdown body leaves a per-render random token swapped after goldmark, so
raw HTML stays disabled for bodies
- built-in partials button, panel, table and subcopy, built-in layouts
system and minimal next to the unchanged default, reachable by alias
after a plugin's own aliases
- NewDBSource also reads customized and database-only layouts and
customized partials; a layout's CSS goes before mail.css
Plan 35-01, task 3.
168 lines
9.4 KiB
Markdown
168 lines
9.4 KiB
Markdown
---
|
|
title: Mail
|
|
description: Ship WinterCMS-style mail templates in a plugin, send them through postcard, and deliver them with the memory, log or SMTP driver.
|
|
section: services
|
|
order: 70
|
|
---
|
|
# Mail
|
|
|
|
WinterCMS plugins ship mail templates in `views/mail` and send them with `Mail::send`. SummerCMS keeps the file format and the dotted template names; [postcard](../../modules/postcard/README.md) loads them at boot and sends them through a configured driver.
|
|
|
|
## Templates and layouts
|
|
|
|
A plugin implements `pact.HasMailTemplates`: it returns its embedded `views/mail` files, the template names it ships and short aliases for its layouts. A template named `acme.blog::mail.welcome` lives in `views/mail/welcome.htm` (dots in the name become directories), and a plugin may only register names in its own namespace. A missing file, a duplicate name or an unknown layout alias fails the start-up.
|
|
|
|
The file format is WinterCMS's: an INI header with the `subject`, the `layout` alias and a `description`, a `==` line, then a Markdown body with Go template variables such as `{{ .name }}`. A layout has a header, a text wrapper and an HTML wrapper, separated by `==` lines, each with `{{ .Content }}` where the message goes. A template without a `layout` uses the built-in `default` layout; see [Built-in layouts](#built-in-layouts).
|
|
|
|
Each message gets an HTML part, rendered from the Markdown, and a plain-text part. `mail.css` and `mail.brandCss` are inlined into the layout's style block.
|
|
|
|
## Partials
|
|
|
|
A partial is a block that several templates and layouts share, such as a button or a footer note. A plugin implements `pact.HasMailPartials`: it returns its embedded `views/mail` files and the partial names it ships. A partial named `acme.blog::mail.partials.note` lives in `views/mail/partials/note.htm`, and its file has the layout format, with a text section and an HTML section:
|
|
|
|
```text
|
|
name = "Note"
|
|
==
|
|
NOTE: {{ .text }}
|
|
==
|
|
<div class="note">{{ .text }}</div>
|
|
```
|
|
|
|
The name must be in the plugin's namespace and under `mail.partials.`; otherwise, or when the file is missing or the name is declared twice, the start-up fails. A plugin can ship partials without shipping templates.
|
|
|
|
A body or a layout calls a partial with its name and pairs of a key and a value:
|
|
|
|
```text
|
|
{{ partial "button" "url" .link "body" "Track the order" "type" "positive" }}
|
|
|
|
{{ partial "acme.blog::mail.partials.note" "text" .note }}
|
|
```
|
|
|
|
A bare name is one of the built-in partials; a plugin's partial is called by its full name, from any plugin's mail. The pairs become the partial's variables. The HTML section is used in the HTML part and the text section in the plain-text part.
|
|
|
|
| Built-in partial | Arguments | Renders |
|
|
|------------------|-----------|---------|
|
|
| `button` | `url`, `body`, `type` (`primary`, `positive` or `negative`) | A link styled as a button. |
|
|
| `panel` | `body` | A highlighted block; the body is Markdown. |
|
|
| `table` | `body` | A Markdown table. |
|
|
| `subcopy` | `body` | Small print under a rule; the body is Markdown. |
|
|
|
|
In a body, write the call on a line of its own with blank lines around it. Bodies are Markdown and raw HTML in them is still dropped; postcard inserts a partial's HTML after the Markdown conversion, through a random token that a variable's value cannot contain. Inside a partial's HTML section, `{{ markdown .body }}` renders a value as Markdown.
|
|
|
|
## Built-in layouts
|
|
|
|
Three layouts are available to every plugin's templates without declaring an alias:
|
|
|
|
| `layout` | Renders |
|
|
|----------|---------|
|
|
| `default` | The message in a plain page. Used when the template names no layout. |
|
|
| `system` | WinterCMS's system layout: the message in a centred table, then a note that it was sent automatically. |
|
|
| `minimal` | The message directly in the page body, with the style block only. |
|
|
|
|
A plugin's own alias wins over `system` and `minimal`; `default` cannot be redefined.
|
|
|
|
## Sending
|
|
|
|
At boot, `postcard.Activate` publishes one `postcard.Mailer` on the application, and `postcard.BootPlugin` registers each plugin's templates as it boots. Look the mailer up with `app.Lookup[postcard.Mailer]()` and send a `postcard.Message` with the template name, the recipients and the variables. Tests build the catalog and a memory driver directly, and read back what was sent:
|
|
|
|
```go src=modules/postcard/example_test.go#ExampleMailer_Send
|
|
// At boot, postcard.BootPlugin registers what pact.HasMailTemplates
|
|
// declares; a test registers the same thing directly.
|
|
cat := postcard.NewCatalog()
|
|
err := cat.Register("acme.blog", mailFS,
|
|
[]string{"acme.blog::mail.welcome"},
|
|
map[string]string{"blog": "acme.blog::mail.layouts.blog"})
|
|
if err != nil {
|
|
fmt.Println(err)
|
|
return
|
|
}
|
|
driver := postcard.NewMemoryDriver() // mail.driver: memory
|
|
mailer := postcard.NewMailer(cat, driver, postcard.Options{From: "blog@example.com"})
|
|
|
|
err = mailer.Send(context.Background(), postcard.Message{
|
|
Template: "acme.blog::mail.welcome",
|
|
To: []string{"ada@example.com"},
|
|
Vars: map[string]any{"name": "Ada"},
|
|
})
|
|
if err != nil {
|
|
fmt.Println(err)
|
|
return
|
|
}
|
|
sent := driver.Messages()[0]
|
|
fmt.Println(sent.From, sent.To, sent.Subject)
|
|
fmt.Println(sent.Text)
|
|
fmt.Println(strings.Contains(sent.HTML, `<div class="blog-mail"><p>Hi <strong>Ada</strong>`))
|
|
|
|
// Header injection is refused before any driver sees the message.
|
|
err = mailer.Send(context.Background(), postcard.Message{
|
|
Template: "acme.blog::mail.welcome",
|
|
To: []string{"ada@example.com\r\nBcc: all@example.com"},
|
|
Vars: map[string]any{"name": "Ada"},
|
|
})
|
|
fmt.Println(err != nil, len(driver.Messages()))
|
|
// Output:
|
|
// blog@example.com [ada@example.com] Welcome, Ada
|
|
// Hi **Ada**, thanks for joining the blog.
|
|
//
|
|
// -- The Acme blog
|
|
// true
|
|
// true 1
|
|
```
|
|
|
|
postcard does not pick a locale. For a per-language template, register one name per language (`acme.blog::mail.welcome_pl`) and pass the full name.
|
|
|
|
Before a driver sees a message, postcard refuses a subject or address with a line break, parses every address with `net/mail`, and rejects rendered HTML that contains script, iframe, object or embed tags, inline event handlers, or `javascript:`, `vbscript:` or `data:` URLs. Variables are escaped by Go's `html/template`.
|
|
|
|
`postcard.Mailer.Send` delivers before it returns. To keep a request fast, send from a queued job, and send after the write that triggered the mail has committed; see [Queued jobs](jobs.md) and [Transactions](../database/transactions.md).
|
|
|
|
## Overrides from the admin
|
|
|
|
A plugin's mail files are the default text. postcard also owns a set of mail tables, created by `migrate` with the framework's other tables, where an administrator's edit of a template is stored. A row of `system_mail_templates` with `is_custom` set overrides the template named in its `code`: its subject, body and layout replace the file's. The body keeps the file's format, Markdown with Go template variables.
|
|
|
|
`postcard.Mailer.Send` reads that row on every send and caches nothing, so an edit applies to the next message in every process that shares the database, a `queue:work` worker included. The subject is the first of these that is set:
|
|
|
|
1. `postcard.Message.Subject`, when the caller passes one;
|
|
2. the override's subject;
|
|
3. the file's subject.
|
|
|
|
Layouts and partials have rows too, in `system_mail_layouts` and `system_mail_partials`. A customized row replaces the file's wrappers or sections, and a layout row whose `code` is not a file layout's name is a layout that exists only in the database, which a template override can select. A layout row's CSS goes before `mail.css` in the layout's style block.
|
|
|
|
An override cannot stop mail from going out:
|
|
|
|
- With no database, or before `migrate` has created the tables, the file version is sent. A failed lookup is logged as a warning, at most once a minute.
|
|
- An override of the template, its layout or a partial that does not parse, fails while rendering (it uses a field of a variable the caller does not pass, for example) or fails the safety checks is logged as an error with the template name, and the message is sent from the files alone.
|
|
- An override whose layout no longer exists is rendered in the `default` layout, with a warning.
|
|
|
|
The log lines carry the component `postcard`. In a test, pass any `postcard.OverrideSource` in `postcard.Options.Overrides` to supply overrides without a database; `postcard.NewDBSource` is the one `postcard.Activate` installs.
|
|
|
|
## Drivers
|
|
|
|
`mail.driver` selects the driver:
|
|
|
|
| Driver | Delivers |
|
|
|--------|----------|
|
|
| `memory` (default) | Nowhere: messages are kept in the process, for tests. |
|
|
| `log` | To the log: headers and the text part, never the HTML part or credentials. For development. |
|
|
| `smtp` | Through an SMTP server with the configured TLS policy. |
|
|
|
|
The SMTP settings go in `config/mail.yaml`, with the password in the environment (`SUMMER_MAIL__SMTP__PASSWORD`):
|
|
|
|
```yaml
|
|
driver: smtp
|
|
from: blog@example.com
|
|
smtp:
|
|
host: smtp.example.com
|
|
port: 587
|
|
username: blog
|
|
password: <secret>
|
|
tls: mandatory
|
|
```
|
|
|
|
`mail.smtp.tls` defaults to `mandatory`: the connection must upgrade with STARTTLS, and sending fails if the server does not offer it. postcard never infers a plain connection. The other two values exist for local mail catchers only:
|
|
|
|
- `starttls` (or `opportunistic`) uses TLS when the server offers it and sends in plain text when it does not, so an attacker on the network can strip the upgrade.
|
|
- `none` sends in plain text.
|
|
|
|
> [!WARNING]
|
|
> Use `starttls` or `none` only against a local development mail catcher. In production, keep the default `mandatory`.
|