mysigmail / vue-email

A collection of high-quality, unstyled components for creating beautiful emails using Vue.

Vue Email Components

A collection of high-quality, unstyled components
for creating beautiful emails using Vue.

Demo

SPONSORS

 

Support

If you find this project useful, you can support development via the following methods:

Introduction

Reduces the difficulty of coding responsive emails, easing the challenges of development and ensuring consistency across various email clients, such as Gmail, Outlook, and others.

Motivation

Email still remains one of the most widely used and popular communication channels to this day, and its popularity shows no signs of diminishing over time.

We aim to simplify the process of creating emails and make it more accessible for everyone.

Install

pnpm add @mysigmail/vue-email-components

Use

Global

import { createApp } from 'vue'
import App from './App.vue'
import VueEmail from '@mysigmail/vue-email-components'

createApp(App).use(VueEmail).mount('#app')

Local

<script setup>
import { MButton } from '@mysigmail/vue-email-components'
</script>

<template>
  <div>
    <MButton>Click me</MButton>
  </div>
</template>

Render to HTML

<script setup>
import { render } from '@mysigmail/vue-email-components'
import YourEmail from './YourEmail.vue'

const html = render(YourEmail)
</script>

Components

This is a collection of pre-built components that can be used to create impressive emails without the hassle of manually creating tables and managing outdated code.

• MBody
• MButton
• MColumn
• MContainer
• MHead
• MHeading
• MHr
• MHtml
• MImage
• MLink
• MPreview
• MSection
• MText

Client

This repository contains a client application that serves as a local testing environment. Using this client, you can create email templates by selecting from pre-built components, apply styles to these components, preview the final render, and obtain the corresponding HTML code. You can also perform a test send email.

Install

git clone https://github.com/mysigmail/vue-email.git

pnpm install

Environment

Set up variables for test email sending.

NUXT_EMAIL_HOST= # The hostname of the SMTP server used to send emails.
NUXT_EMAIL_PORT= # The port of the SMTP server.
NUXT_EMAIL_USER= # The username used to authenticate on the SMTP server.
NUXT_EMAIL_PASSWORD= # The password used to authenticate on the SMTP server.

Run

pnpm run dev

Development

To start developing your next email template, create a .vue file in the packages/client/emails folder.

TODO

• Test sending an email using Nodemailer.
• Add the script to the automatic setup for the client.

Other

Inspired by react-email

License

MIT

Copyright (c) 2023-present, Anton Reshetov.