!svelte-email-banner

Introduction

This is a fork of Carsten Lebek's Svelte Email project.

svelte-email enables you to write and design email templates with svelte and render them to HTML or plain text.

Installation

Install the package to your existing SvelteKit project:

``bash title="npm"
npm install @keycloakify/svelte-email
`

`bash title="yarn"
yarn install @keycloakify/svelte-email
`

Getting started

1. Create an email using Svelte

src/$lib/emails/Hello.svelte

`html



Hello, {name}!


src/routes/emails/hello/+server.js

`js
import { render } from 'svelte-email';
import Hello from '$lib/emails/Hello.svelte';
import nodemailer from 'nodemailer';

const transporter = nodemailer.createTransport({
host: 'smtp.ethereal.email',
port: 587,
secure: false,
auth: {
user: 'my_user',
pass: 'my_password',
},
});

const emailHtml = render({
template: Hello,
props: {
name: 'Svelte',
},
});

const options = {
from: 'you@example.com',
to: 'user@gmail.com',
subject: 'hello world',
html: emailHtml,
};

transporter.sendMail(options);
``

Documentation

For more information, please visit the documentation.

Components

A set of standard components to help you build amazing emails without having to deal with the mess of creating table-based layouts and maintaining archaic markup.

- HTML
- Head
- Heading
- Button
- Link
- Image
- Divider
- Paragraph
- Container
- Preview
- Body
- Column
- Section

Integrations

Emails built with React Email can be converted into HTML and sent using any email service provider. Here are some examples:

- Nodemailer
- SendGrid
- Postmark
- AWS SES

Author

- Luca Peruzzo (@luca-peruzzo)

$3

- Carsten Lebek (@carstenlebek)