Magic link, reset, alert and notice mails from one definition, in matching HTML and text.
<div class="email-row">
<figure class="email-figure">
<figcaption>light, 320px</figcaption>
<iframe class="email-frame" title="Magic link mail, light, 320px wide" data-email="magicLink" data-scheme="light" data-width="320"></iframe>
</figure>
<figure class="email-figure">
<figcaption>light, 600px</figcaption>
<iframe class="email-frame" title="Magic link mail, light, 600px wide" data-email="magicLink" data-scheme="light" data-width="600"></iframe>
</figure>
<figure class="email-figure">
<figcaption>dark, 320px</figcaption>
<iframe class="email-frame" title="Magic link mail, dark, 320px wide" data-email="magicLink" data-scheme="dark" data-width="320"></iframe>
</figure>
<figure class="email-figure">
<figcaption>dark, 600px</figcaption>
<iframe class="email-frame" title="Magic link mail, dark, 600px wide" data-email="magicLink" data-scheme="dark" data-width="600"></iframe>
</figure>
</div>
Installation
// package.json: "capsomer": "github:DrDustinEdwards/capsomer#v0.152.2"
import "capsomer/tokens.css";
import "capsomer/base.css";
import { checkUrl, renderEmail } from "capsomer/behavior/email";Usage
import { renderEmail, magicLink } from "capsomer/email";
const { subject, html, text } = renderEmail(magicLink, {
brand: { name: "Example Co", family: "purple" },
to: "reader@example.com",
url: "https://app.example.com/auth/verify?t=EXAMPLE-NOT-A-TOKEN",
expiresIn: "15 minutes",
});Examples
Magic link with a code
<div class="email-row">
<figure class="email-figure">
<figcaption>light, 320px</figcaption>
<iframe class="email-frame" title="Magic link mail with a code, light, 320px wide" data-email="magicLinkCode" data-scheme="light" data-width="320"></iframe>
</figure>
<figure class="email-figure">
<figcaption>dark, 600px</figcaption>
<iframe class="email-frame" title="Magic link mail with a code, dark, 600px wide" data-email="magicLinkCode" data-scheme="dark" data-width="600"></iframe>
</figure>
</div>
Verification
<div class="email-row">
<figure class="email-figure">
<figcaption>light, 320px</figcaption>
<iframe class="email-frame" title="Verification mail, light, 320px wide" data-email="verification" data-scheme="light" data-width="320"></iframe>
</figure>
<figure class="email-figure">
<figcaption>light, 600px</figcaption>
<iframe class="email-frame" title="Verification mail, light, 600px wide" data-email="verification" data-scheme="light" data-width="600"></iframe>
</figure>
<figure class="email-figure">
<figcaption>dark, 320px</figcaption>
<iframe class="email-frame" title="Verification mail, dark, 320px wide" data-email="verification" data-scheme="dark" data-width="320"></iframe>
</figure>
<figure class="email-figure">
<figcaption>dark, 600px</figcaption>
<iframe class="email-frame" title="Verification mail, dark, 600px wide" data-email="verification" data-scheme="dark" data-width="600"></iframe>
</figure>
</div>
Reset
<div class="email-row">
<figure class="email-figure">
<figcaption>light, 320px</figcaption>
<iframe class="email-frame" title="Reset mail, light, 320px wide" data-email="reset" data-scheme="light" data-width="320"></iframe>
</figure>
<figure class="email-figure">
<figcaption>light, 600px</figcaption>
<iframe class="email-frame" title="Reset mail, light, 600px wide" data-email="reset" data-scheme="light" data-width="600"></iframe>
</figure>
<figure class="email-figure">
<figcaption>dark, 320px</figcaption>
<iframe class="email-frame" title="Reset mail, dark, 320px wide" data-email="reset" data-scheme="dark" data-width="320"></iframe>
</figure>
<figure class="email-figure">
<figcaption>dark, 600px</figcaption>
<iframe class="email-frame" title="Reset mail, dark, 600px wide" data-email="reset" data-scheme="dark" data-width="600"></iframe>
</figure>
</div>
Alert
<div class="email-row">
<figure class="email-figure">
<figcaption>light, 320px</figcaption>
<iframe class="email-frame" title="Alert mail, light, 320px wide" data-email="alert" data-scheme="light" data-width="320"></iframe>
</figure>
<figure class="email-figure">
<figcaption>light, 600px</figcaption>
<iframe class="email-frame" title="Alert mail, light, 600px wide" data-email="alert" data-scheme="light" data-width="600"></iframe>
</figure>
<figure class="email-figure">
<figcaption>dark, 320px</figcaption>
<iframe class="email-frame" title="Alert mail, dark, 320px wide" data-email="alert" data-scheme="dark" data-width="320"></iframe>
</figure>
<figure class="email-figure">
<figcaption>dark, 600px</figcaption>
<iframe class="email-frame" title="Alert mail, dark, 600px wide" data-email="alert" data-scheme="dark" data-width="600"></iframe>
</figure>
</div>
Notice
<div class="email-row">
<figure class="email-figure">
<figcaption>light, 320px</figcaption>
<iframe class="email-frame" title="Notice mail, light, 320px wide" data-email="notice" data-scheme="light" data-width="320"></iframe>
</figure>
<figure class="email-figure">
<figcaption>light, 600px</figcaption>
<iframe class="email-frame" title="Notice mail, light, 600px wide" data-email="notice" data-scheme="light" data-width="600"></iframe>
</figure>
<figure class="email-figure">
<figcaption>dark, 320px</figcaption>
<iframe class="email-frame" title="Notice mail, dark, 320px wide" data-email="notice" data-scheme="dark" data-width="320"></iframe>
</figure>
<figure class="email-figure">
<figcaption>dark, 600px</figcaption>
<iframe class="email-frame" title="Notice mail, dark, 600px wide" data-email="notice" data-scheme="dark" data-width="600"></iframe>
</figure>
</div>
Digest
<div class="email-row">
<figure class="email-figure">
<figcaption>light, 320px</figcaption>
<iframe class="email-frame" title="Digest mail, light, 320px wide" data-email="digest" data-scheme="light" data-width="320"></iframe>
</figure>
<figure class="email-figure">
<figcaption>dark, 600px</figcaption>
<iframe class="email-frame" title="Digest mail, dark, 600px wide" data-email="digest" data-scheme="dark" data-width="600"></iframe>
</figure>
</div>
Email change
<div class="email-row">
<figure class="email-figure">
<figcaption>to the current address, light, 320px</figcaption>
<iframe class="email-frame" title="Email change mail to the current address, light, 320px wide" data-email="emailChangeCurrent" data-scheme="light" data-width="320"></iframe>
</figure>
<figure class="email-figure">
<figcaption>to the new address, dark, 600px</figcaption>
<iframe class="email-frame" title="Email change mail to the new address, dark, 600px wide" data-email="emailChangeNew" data-scheme="dark" data-width="600"></iframe>
</figure>
</div>
Security notice
<div class="email-row">
<figure class="email-figure">
<figcaption>light, 320px</figcaption>
<iframe class="email-frame" title="Security notice mail, light, 320px wide" data-email="securityNotice" data-scheme="light" data-width="320"></iframe>
</figure>
<figure class="email-figure">
<figcaption>dark, 600px</figcaption>
<iframe class="email-frame" title="Security notice mail, dark, 600px wide" data-email="securityNotice" data-scheme="dark" data-width="600"></iframe>
</figure>
</div>
API reference
Functions
| Function | Signature | Does |
|---|---|---|
checkUrl | (url: string): string | A link is accepted only as https: or mailto:, with no space or control character in it and no user or password before the host, which would let https://trusted.example@evil.example/ read as the trusted name. Anything else throws; the caller must not swallow it. The string comes back untouched, so a token in the address is never rewritten. |
renderEmail | <D>(template: Template<D>, data: D & Common): Rendered | Renders one template to a subject, an HTML part and a text part, from the same blocks. |
Accessibility
- The document has a language, a title (the subject) and one
h1; the button is a real link with a visible text label. - Body and link text is 16px or more (the footer is 14px), and every text pair is in the contrast report for all three families in both themes.
Last checked by hand: not yet. The check in a real mail client (Gmail, Apple Mail, Outlook, a phone) is Dustin's own, from his inbox; it has not been done.