📧 node-smtp-mail

API simples utilizada para serviço de e-mail via SMTP sobre a plataforma NodeJs.

Conteúdo

• Sobre
• Requisitos
• Instalação
• Tecnologias

 

📌 Sobre

A ideia deste projeto é ser um recurso rápido a ser utilizado em pequenos projetos.

Este projeto simplifica uma camada muito comum em diversos projetos: a camada de envio de e-mail.

Com isso, torna-se muito mais simples enviar um e-mail a um usuário do seu aplicativo, ou um cliente do seu sistema web, ou para os assinantes do seu serviço de newsletter, e até mesmo para enviar documentos de maneira formal, simples e automatizada.

E as vantagens de abstrair esta camada de envio de e-mail são diversas, como:

• Rápido e simples de utilizar
• Desacoplamento de serviços
• Mantém a regra / lógica de negócio limpa de grandes implementações
• Lógica especilizada na construção de templates
• Facilmente substituível e escalável

Além de ser ótimo para estudos e simulações em ambiente de desenvolvimento

 

📌 Requisitos

• NodeJs instalado (LTS version) - necessário para o gerenciamento de pacotes da aplicação, com npm (Node Package Manager)
• IDE / Editor de texto - recomendado: Visual Studio Code

Requisitos específicos para Windows

Caso seu sistema operacional seja Windows, talvez alguns recursos adicionais sejam necessários:

Chocolatey ou qualquer outro gerenciador de pacotes para Windows - não é necessário, utilize apenas o npm

 

📌 Instalação

Observe atentamente os requisitos necessários para poder executar a aplicação no seu computador

• Faça um fork deste projeto para sua conta

• Defina as variáveis de ambiente do projeto de acordo com o exemplo

  • Exemplo em src/env/environment.example.js
  • Este arquivo deve ser duplicado e nomeado como environment.js

• Dentro do repositório do projeto, da sua conta, abra um terminal/cmd e siga as seguintes instruções:

1️⃣ Instale as dependências do projeto

npm install

2️⃣ Inicie a execução local do projeto

npm start

 

📌 Tecnologias

Este serviço é desenvolvido sobre as seguintes tecnologias:

• NodeJS
• Express - Framework para NodeJS
• EJS e Handlebars - Renders para templates dinâmicos (em desenvolvimento)
• Nodemailer - Biblioteca/camada de abstração da interface de comunicação via SMTP