@skailan/email
v1.0.0
Published
Servicio de email para Skailan
Downloads
4
Maintainers
Readme
@skailan/email
Servicio de email para la plataforma Skailan.
Descripción
Este módulo proporciona funcionalidades completas de envío de emails para la plataforma Skailan. Incluye:
- Envío de emails transaccionales y de marketing
- Plantillas personalizables
- Integración con Resend para envío confiable
- Gestión de listas de distribución
- Seguimiento de apertura y clics
- Notificaciones automáticas
Instalación
npm install @skailan/emailUso
Importación básica
import { EmailService } from '@skailan/email';
const emailService = new EmailService();
// Enviar email simple
await emailService.sendEmail({
to: "[email protected]",
subject: "Bienvenido a Skailan",
template: "welcome",
data: {
name: "Juan Pérez",
organization: "Empresa ABC"
}
});Configuración de variables de entorno
RESEND_API_KEY="your-resend-api-key"
DATABASE_URL="postgresql://user:password@localhost:5432/skailan"API Endpoints
Emails
POST /emails/send- Enviar emailGET /emails- Listar emails enviadosGET /emails/:id- Obtener emailPOST /emails/bulk- Envío masivo
Plantillas
GET /templates- Listar plantillasPOST /templates- Crear plantillaGET /templates/:id- Obtener plantillaPUT /templates/:id- Actualizar plantilla
Listas de distribución
GET /lists- Listar listasPOST /lists- Crear listaGET /lists/:id/subscribers- Listar suscriptoresPOST /lists/:id/subscribers- Agregar suscriptor
Características
- Envío confiable: Integración con Resend para alta entregabilidad
- Plantillas dinámicas: Sistema de templates con variables
- Envío masivo: Soporte para campañas de email marketing
- Seguimiento: Tracking de apertura y clics
- Notificaciones: Emails automáticos para eventos del sistema
- Multitenancy: Aislamiento por organización
Dependencias
- Express.js para el servidor web
- Resend para envío de emails
- Prisma para ORM
- @skailan/core para autenticación
Desarrollo
# Instalar dependencias
npm install
# Ejecutar en modo desarrollo
npm run dev
# Construir para producción
npm run buildEjemplos de uso
Enviar email de bienvenida
import { EmailService } from '@skailan/email';
const emailService = new EmailService();
await emailService.sendWelcomeEmail({
to: "[email protected]",
name: "María García",
organizationName: "Empresa XYZ",
loginUrl: "https://app.skailan.com/login"
});Enviar notificación de conversación
await emailService.sendConversationNotification({
to: "[email protected]",
contactName: "Juan Pérez",
platform: "WhatsApp",
message: "Hola, necesito información sobre sus servicios",
conversationUrl: "https://app.skailan.com/conversations/123"
});Enviar cotización por email
await emailService.sendQuote({
to: "[email protected]",
contactName: "Ana López",
quoteNumber: "Q-2024-001",
totalAmount: 25000,
validUntil: "2024-02-15",
quoteUrl: "https://app.skailan.com/quotes/123"
});Plantillas disponibles
welcome- Email de bienvenidapassword-reset- Restablecimiento de contraseñaconversation-notification- Notificación de nueva conversaciónquote- Envío de cotizacióninvoice- Envío de facturamarketing- Email de marketing
Licencia
MIT
