@eplata/communication-core
v1.1.1
Published
Communication Core Module
Downloads
408
Readme
Communication Core Module
Modulo que centraliza las comunicaciones de los diferentes paises.
Instalación del módulo
Para instalar es necesario tener el archivo .npmrc en la carpeta raíz del proyecto de node, el cual contiene el token de autenticación para la descarga de los módulos.
npm install @eplata/communication-coreVersión latest
Variables de entorno requeridas:
| Variable | Descripción | | -------- | ----------- |
Variables de entorno opcionales:
| Variable | Descripción | Default | | :---------------------------------- | ---------------------------------------------- | :-----: | | COMUNICATION_MODULE__STATICDOMAIN | URL donde se encuntrar los archivos estaticos. | |
Identidades de correo
Por país existe una identidad SMTP original (la de siempre) y una identidad opcional aura, cada una con sus propias credenciales SMTP y su propio remitente. Se elige por envío con provider.identity; si no se especifica, se usa original.
await comunication.email.send({
country: 'COL',
comunication: comunication.COMUNICATIONS.OTP,
data: { to: '[email protected]' },
provider: {
email: 'smtp',
sms: 'aws',
identity: comunication.IDENTITIES.AURA // 'original' (default) | 'aura'
}
});Variables de entorno opcionales para la identidad aura (si no se configuran, esa identidad simplemente no está disponible y falla solo si se solicita explícitamente):
| Variable | Descripción | | :----------------------------------------------- | ------------------------------------- | | COMUNICATION_MODULE__SMTP_HOST_COL_AURA | Host SMTP de la identidad aura (COL). | | COMUNICATION_MODULE__SMTP_PORT_COL_AURA | Puerto SMTP de la identidad aura (COL). | | COMUNICATION_MODULE__SMTP_USER_COL_AURA | Usuario SMTP de la identidad aura (COL). | | COMUNICATION_MODULE__SMTP_PASSWORD_COL_AURA | Contraseña SMTP de la identidad aura (COL). | | COMUNICATION_MODULE__SMTP_SECURE_COL_AURA | Conexión segura (true/false) de la identidad aura (COL). | | COMUNICATION_MODULE__SMTP_FROM_EMAIL_COL_AURA | Remitente por defecto de la identidad aura (COL). | | COMUNICATION_MODULE__SMTP_HOST_MEX_AURA | Host SMTP de la identidad aura (MEX). | | COMUNICATION_MODULE__SMTP_PORT_MEX_AURA | Puerto SMTP de la identidad aura (MEX). | | COMUNICATION_MODULE__SMTP_USER_MEX_AURA | Usuario SMTP de la identidad aura (MEX). | | COMUNICATION_MODULE__SMTP_PASSWORD_MEX_AURA | Contraseña SMTP de la identidad aura (MEX). | | COMUNICATION_MODULE__SMTP_SECURE_MEX_AURA | Conexión segura (true/false) de la identidad aura (MEX). | | COMUNICATION_MODULE__SMTP_FROM_EMAIL_MEX_AURA | Remitente por defecto de la identidad aura (MEX). |
