Skip to content

Write and send emails with Svelte โœ‰๏ธ๐Ÿš€

License

Notifications You must be signed in to change notification settings

keycloakify/svelte-email

ย 
ย 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

ย 

History

58 Commits
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 

Repository files navigation

svelte-email-banner

Svelte Email
Designing emails has never been easier.

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:

npm install @keycloakify/svelte-email
yarn install @keycloakify/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.

Integrations

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

Author

Authors of the original project svelte-email

About

Write and send emails with Svelte โœ‰๏ธ๐Ÿš€

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages

  • Svelte 59.6%
  • TypeScript 25.7%
  • JavaScript 14.7%