npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

@cherry-code/mailer

v0.0.16

Published

Framework suportar tecnologias de view para desenvolver layout de e-mail de forma mais bonita

Downloads

19

Readme

Sobre a biblioteca

Focado em facilitar e deixar o código mais bonito, em vez de mandar uma string de html, utilizando as tecnologias front-end React, vue, ejs, assim evitando qualquer erro de escopo. Biblioteca focado com os desenvolvimentos dentro da CherryCode com intuito de facilitar os desenvolvedores.

yarn add @cherry-code/mailer

Como inicializar

Para inicializar seu primeito "Hello World", precisamos instancia a Mailer da biblioteca e dentro dele vai existir as seguintes opções:

  • Dentro das opções de Client constructor:

| Atributo | Tipo de valor | | ------------ | ------------------- | | transporters | TransporterOption[] | | templates | TemplatesOptions[] |

a opção transporters é herdada de nodemailer no atributo chamado transport é você pode informar opção de uma criação de transport igual do exemplo do nodemailer em createTransport

  • Mailer.options.transporters [OPCIONAL]

    | Atributo | Tipo de valor | | --------- | ----------------------------------------------------- | | name | string | | transport | SMTPTransport.Options |

  • Mailer.options.templates

    Caso seja path, ira renderizar para ejs, caso seja render vai renderizar para React JSX | Atributo | Tipo de valor | | -------- | -------------------------------------------------------------- | | name | string | | path? | string | | render? | ReactElement |

    OBS: Para conseguir renderizar um componente em react é preciso utilizar babel para transpilar.

Funções

addTemplate(name: string, template: TemplatesOptions )

  • Função para adicionar mais um template de acordo com a render no atributo template utiliza mesmo tipo no new Mailer() TemplatesOptions.

start()

  • Caso inicialize o transport na constructor de Mailer, execute essa fução para ser criada os transport

addTransport(name: string, transport: SMTPTransport.Options )

  • Função para adicionar um novo transport de nodemailer.

send(options: Mail.Options)

  • A mesma utilidade de sendMail de nodemailer

getTransport(name: string)

  • Recuperar um transport especifico

  • dentro de transport você usa as funções de renderização:

    • renderEngineView(name: string, data?: any) renderizar para ejs

    • renderReact(name: string) renderizar para react

    • renderEngineViewString(template: string, data?: any) compilar uma string ejs para html

Exemplos de inicialização:

import { Mailer } from "@cherry-code/mailer";

const app = new Mailer();

// estou adicionando um transport (não é preciso usar start caso use o add)
app.addTransport("transportNotify", {
  host: "sandbox.smtp.mailtrap.io",
  port: 465,
  secure: false,
  auth: {
    user: "edummelo",
    pass: "senhadeseuemail",
  },
});

// aqui estou adicionando um template que vai renderizar como ejs
app.addTemplate("eduardoTemplate", { path: "./views/email.ejs" });

// estou recuperando um transport especifico
const transport = app.transporter.getTransport("transportNotify");

// como escolhi template que renderiza em ejs irei utilizar a função renderEngineView
await transport.renderEngineView("eduardoTemplate", { value: "Hello World" });

await transport.renderEngiveViewString("<h1>Olá <%= name %>!!!", {
  name: "Eduardo",
});
// após renderizar (é preciso aguardar a renderização você execute o send)
transport.send({
  from: "<CherryMailer>",
  to: "[email protected]",
  subject: "Cherry code libs",
});

Caso seja em react JSX

import React from "react";

app.addTemplate("eduardoTemplate", { render: <p>Eduardo melo</p> });

await transport.renderReact("eduardoTemplate");

transport.send({
  from: "<CherryMailer>",
  to: "[email protected]",
  subject: "Cherry code libs",
});

Caso esteja em aplicação lado client ou que já transpila utilizando presets react , caso contrario utilize babel para transpilar

EX: npx babel test/index.js --out-file test/app.js

Esta biblioteca é para fins de trabalhos pessoais, mas você pode usar, caso tenha alguma sugestão ou algo a melhorar só abrir um PR ou um issue que irei avaliar.