@bgroup/mailer-fdl
v1.0.0
Published
Node JS Basic application
Downloads
4
Keywords
Readme
bg-mailer
bg-mailer es una herramienta para enviar correos electrónicos HTML dinámicos. Con bg-mailer, puedes recibir un token asociado a una aplicación que se guarda en la base de datos y utilizar esa información para personalizar la plantilla HTML antes de enviar el correo electrónico.
Funciones principales
El corazón de bg-mailer es la clase MailManager, que se encarga de administrar el proceso de envío. Hay dos funciones principales que debes conocer para usar bg-mailer:
hasPermission
: Esta función te dice si el token pasado por argumento pertenece a una aplicación registrada en la base de datos.send
: Esta función envía el correo electrónico, recibiendo como parámetros{to, subject, module, data, attachments }
.to
es el correo electrónico del destinatario,subject
es el asunto del correo,module
es el módulo a tomar de la base de datos ydata
son los valores que se establecerán en el documento HTML,attachments
es un array de objetos con estructura
{
filename: "nombre del archivo",
path: "path del archivo"
}
Instalación
Instalar bg-mailer es muy sencillo. Solo debes ejecutar el comando npm i
para instalar todos los paquetes dependientes.
Uso
Para utilizar bg-mailer, primero debes asegurarte de tener una aplicación registrada en la base de datos con un token válido. Luego, puedes utilizar las funciones hasPermission
y send
para verificar el permiso y enviar el correo electrónico, respectivamente.
Contribución
Si deseas contribuir a bg-mailer, por favor envíanos un correo electrónico a [email protected] con tu propuesta.
Contacto
Si tienes alguna pregunta o problema con bg-mailer, por favor envíanos un correo electrónico a [email protected] o abre un issue en el repositorio de GitHub.