Skip to content

README.md

Latest commit

 

History

History
47 lines (31 loc) · 1.28 KB

README.md

File metadata and controls

47 lines (31 loc) · 1.28 KB

Inky Example: Ruby

A minimal example showing how to use the Inky email framework from Ruby via the Fiddle bindings.

Requires Inky v2. See installation instructions.

Prerequisites

  • Ruby >= 2.7
  • The libinky shared library (build from source: cargo build -p inky-ffi --release)

Quick Start

bundle install
ruby build.rb

File Structure

src/emails/welcome.inky    Source template
data/welcome.json           Sample merge data
dist/                       Built output (generated)
build.rb                    Build script
send.rb                     Email sending example

Building

ruby build.rb transforms the Inky template, generates a merged version with sample data, and creates a plain text version.

Sending

Edit send.rb with your SMTP credentials, then:

ruby send.rb

The example uses the mail gem. Install it with gem install mail.

Documentation