preview

Named examples of your emails, built from sample data, for the admin area to render without running the flow that sends them.

pub fn previews() -> List(preview.Preview) {
  [
    preview.new("Welcome", fn() { emails.welcome(sample_user()) }),
    preview.new("Invoice", fn() { emails.invoice(sample_invoice()) })
      |> preview.in_group("Billing"),
  ]
}

A preview is built each time it is shown, so with howdy/dev an edited template shows on the next refresh.

Types

Preview

opaque </>

pub opaque type Preview

Values

build

</>

pub fn build(preview: Preview) -> Result(mail.Message, String)

Build the message. A template that panics or crashes on the sample data gives Error with the reason instead.

find

</>

pub fn find(
  previews: List(Preview),
  wanted: String,
) -> Result(Preview, Nil)

The preview with this key.

group

</>

pub fn group(preview: Preview) -> String

in_group

</>

pub fn in_group(preview: Preview, group: String) -> Preview

Show the preview under this heading.

key

</>

pub fn key(preview: Preview) -> String

A URL-safe key for the preview, from its group and name.

name

</>

pub fn name(preview: Preview) -> String

new

</>

pub fn new(name: String, build: fn() -> mail.Message) -> Preview

A preview in the group “Emails”.