isomorfeus-mailer

Build mails with components and send them with Mailhandler.

Community and Support

At the Isomorfeus Framework Project

Configuration

Configuration options can be set as hash passed to:

Isomorfeus.email_sender_config = { type: :smtp }

All configuration options of Mailhandler can be passed in the hash. For Mailhandler option see Email sending section of the Mailhandler docs.

Usage

Mail Components

Within a isomorfeus project components for building emails are the app/mail_components directory. When using LucidComponent or LucidMaterial::Component the main component passed to the mail must be either a LucidApp or LucidMaterial::App component. Each mail template build of components can be considered a tiny App.

Mail components are rendered using the Preact static renderer, so the Preact rules for static rendering apply.

Inline styles work in Mail Components too.

Example component:

class EmailComponent < LucidApp::Base
  # the top level component must be a App component
  # then other LucidComponent's can be used in the render block

  prop :name

  render do
    DIV "Welcome #{props.name}!"
  end
end

Sending Mail

One class is provided to actually build and send the mail: LucidMail. This class is only available on the server to prevent abuse.

Sending mail with the rendered component from the server:

mail = LucidMail.new(component: 'EmailComponent',
                     props: { name: 'Siegfried' }, # are passed to the component
                     from: 'me@test.com',
                     to: 'you@test.com',
                     subject: 'Welcome')
mail.send

Inspecting the rendered component

The generated HTML is accessible after building the mail using:

mail.build
html = mail.rendered_component

Accessing the mail before sending

It is possible to access the actual mail object after building it for further inspection or modification:

mail.build
mail_object = mail.mail

For documentation about the Mail Object see the Mail Documentation.

Triggering mail from a client

LucidMail is available only on the server to prevent abuse. It can be wrapped in a operation to allow triggering the sending of mail from a client. Example:

class MailOp < LucidQuickOp::Base
  op do
    LucidMail.new(component: 'EmailComponent',
                  from: 'me@test.com',
                  to: current_user.email,
                  subject: 'Welcome')
  end
end

Make sure policy allows running the operation:

class MyUserPolicy
  allow MailOp, :promise_run
end

Then on a client mail can be triggered:

MailOp.promise_run