travisdmathis / svelte-email Goto Github PK

View Code? Open in Web Editor NEW

Write and send emails with Svelte ✉️🚀

License: MIT License

JavaScript 7.66% TypeScript 9.99% HTML 1.91% Svelte 80.43%

svelte-email's Introduction

Svelte Email

Designing emails has never been easier.

Documentation · GitHub

Introduction

After seeing react-email I have decided to create a similar library for Svelte. 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:

npm install svelte-email

pnpm install svelte-email

Getting started

1. Create an email using Svelte

src/$lib/emails/Hello.svelte

<script>
	import { Button, Hr, Html, Text } from 'svelte-email';

	export let name = 'World';
</script>

<Html lang="en">
	<Text>
		Hello, {name}!
	</Text>
	<Hr />
	<Button href="https://svelte.dev">Visit Svelte</Button>
</Html>

2. Send email

This example uses Nodemailer to send the email. You can use any other email service provider.

src/routes/emails/hello/+server.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: '[email protected]',
	to: '[email protected]',
	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.