Herramientas de usuario

Herramientas del sitio


ada:howto:sicoferp:factory:integrations:msadaemailservice

¡Esta es una revisión vieja del documento!


Fábrica - Servicios Web - Integraciones - AdaEmailService

Este servicio permite el envío de correos electrónicos. Actualmente soporta los siguientes servidores de correo:

  • Ionos
  • Gmail*
  • Outlook

*Requiere generación de clave de aplicaciones

Descripción del Servicio

NombreDescripciónTipo ServicioTecnologíaLenguajeTipo DesarrolloVersión DesarrolloArchivo de Configuración
AdaEmailServiePermite el envío de correos electrónicos.RestSpringBoot 2.6.4Java 11.0.315Nuevo11.6.0.1application.properties
Tipo EmpaquetadoGestor de DependenciasServidor de DespliegueIDE ProyectoTipo RepositorioUrl DesarrolloUrl CalidadUrl Producción
warMaven 3.8.1WildFly 20SpringTools 4.6SubversiónSVN branchesSVN trunkSVN tags
Dependencias
groupIdartifactIdversionscopeoptionalDescripción
org.springframework.bootspring-boot-starter-data-restN/AN/AN/AAPI de mapeo de rutas
org.springframework.bootspring-boot-starter-webN/AN/AN/ACore Servicios Web
org.springframework.bootspring-boot-devtoolsN/AruntimetrueRecarga de aplicaciones
org.projectlomboklombokN/AN/AtrueAPI de anotaciones para reducción de código
org.springframework.cloudspring-cloud-sleuth-zipkinN/AN/AtrueAPI de gestión de logs centralizados
org.springframework.bootspring-boot-starter-testN/AtestN/ACore Springboot
org.postgresqlwebjars-locator-jboss-vfs0.1.0N/AN/APlugins para despliegue en Wildfly
org.springframework.bootspring-boot-starter-tomcatN/AprovidedN/AServidor Embebido Tomcat
org.apache.maven.pluginsmaven-compiler-plugin3.8.1N/AN/AGestor de dependencias
org.springdocspringdoc-openapi-ui1.5.12N/AN/APlugins para generar documentación Swagger
org.springframework.bootspring-boot-starterN/AN/AN/ACore Springboot
com.sun.mailjavax.mail1.6.2N/AN/AEnvío de correos
Documentación Operaciones
TipoDocumentaciónVisor
SwaggerVer Documento Jsonhttps://editor.swagger.io/
JavadocDirectorio JavadocNavegador Web
Ambientes de Despliegue
TipoUrlObservaciones
Desarrollo:http://localhost:8080Ambiente de desarrollo
Calidad:http://srv-appeon-000-w23.adacsc.co/AdaEmailServiceAmbiente de validación
Producción: Ambiente de producción

Información Adicional

Despliegue

Requisitos Técnicos Servidor

  • Servidor Wildlfy 20 o superior
  • Java 11 o OpenJDK 11
  • S.O. Linux
  • Ram 4GB o superior
  • Disco Duro 64 GB
  • Publicar la URL y Puerto del WildFly

Notas

Ejemplos de envio de correos

Envio servidor Ionos

{
  "smtpHost": "smtp.ionos.com",
  "smtpPort": 587,
  "smtpAuth": "true",
  "smtpMailUser": "email.test@ada.co",
  "smtpMailPassword": "password",
  "smtpStartTlsEnabled": false,
  "smtpSessionDebug": true,
  "subject": "Título de Prueba",
  "content": "Contenido de prueba",
  "html": false,  
  "toEmail": [
    {
      "address": "notififacionTo.test@ada.co",
      "persona": "Notificación To"
    }
  ],
  "ccEmail": [
    {
      "address": "notififacionCc.test@ada.co",
      "persona": "Notificación Cc"
    }
  ],
  "bccEmail": [
    {
      "address": "notififacionBcc.test@ada.co",
      "persona": "Notificación Bcc"
    }
  ]
}

Envio servidor Outlook

{
  "smtpHost": "smtp.outlook.com",
  "smtpPort": 587,
  "smtpAuth": "true",
  "smtpMailUser": "correo",
  "smtpMailPassword": "password",
  "smtpStartTlsEnabled": true,
  "smtpSessionDebug": true,
  "subject": "Prueba",
  "content": "Ejemplo",
  "html": false,  
  "toEmail": [
    {
      "address": "correo",
      "persona": "persona"
    }
  ],
  "ccEmail": [
    {
      "address": "correo copia",
      "persona": "Persona Copia"
    }
  ],
  "bccEmail": [
    {
      "address": "Correo copia oculta",
      "persona": "Persona copia oculta"
    }
  ]
}

Envio servidor Gmail

{
  "smtpHost": "smtp.gmail.com",
  "smtpPort": 587,
  "smtpAuth": "true",
  "smtpMailUser": "correo",
  "smtpMailPassword": "clave aplicacion",
  "smtpStartTlsEnabled": true,
  "smtpSessionDebug": true,
  "subject": "Prueba",
  "content": "Ejemplo",
  "html": false,  
  "toEmail": [
    {
      "address": "Correo",
      "persona": "Persona"
    }
  ],
  "ccEmail": [
    {
      "address": "Correo copia",
      "persona": "Persona copia"
    }
  ],
  "bccEmail": [
    {
      "address": "Correo copia oculta",
      "persona": "Persona copia oculta"
    }
  ]
}

Liberación Versión 2.0.0 Correos Masivos

Se libera versión con soporte de envios masivos sin necesidad de servidor SMTP.

Documentación Técnica Javadoc

Se libera la documentación técnica javadoc la cual puede ser consultada desde la carpeta de documentación del proyecto en la ruta del SVN

Nota

Debe descargar el proyecto para visualizar la documentación.

Documentación Técnica OpenAPI

Se libera documentación OpenAPI V3 la cual se comparte a continuación y puede se utiliza en el visor swagger

{"openapi":"3.0.1","info":{"title":"OpenAPI definition","version":"v0"},"servers":[{"url":"http://localhost:8088","description":"Generated server url"}],"tags":[{"name":"EmailController","description":"Controlador que gestiona los envíos de correos electrónicos en las aplicaciones."}],"paths":{"/email/v2/sendMasive":{"post":{"tags":["EmailController"],"summary":"sendMasive","description":"Envía correos electrónicos de forma masiva.","operationId":"sendMasive","parameters":[{"name":"token","in":"header","description":"Token API utilizado para realiza el envío. Si no se especifica se utiliza uno genérico.","required":false,"schema":{"type":"string"},"example":"eyFDSFDSF4%$#%$#%VFDvcxvkxkvljxkljelkrjklcjvklcxjvklxjv"},{"name":"emailDto","in":"query","description":"Objeto con la configuración del envio y contenido del correo electrónico que será enviado","required":true,"schema":{"$ref":"#/components/schemas/EmailDto"}}],"responses":{"500":{"description":"Se han generado inconsistencias al crear el registro.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GenericResponseDto"}}}},"202":{"description":"Correo electrónico enviado correctamente.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GenericResponseDto"}}}},"503":{"description":"No se puede enviar el correo electrónico.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GenericResponseDto"}}}}}}},"/email/v1/send":{"post":{"tags":["EmailController"],"summary":"send","description":"Envía correos electrónicos.","operationId":"send","parameters":[{"name":"emailConfigDto","in":"query","description":"Objeto con la configuración del envio y contenido del correo electrónico que será enviado","required":true,"schema":{"$ref":"#/components/schemas/EmailConfigDto"},"example":{"smtpHost":"smtp.ionos.com","smtpPort":587,"smtpAuth":"true","smtpMailUser":"email.test@ada.co","smtpMailPassword":"password","smtpStartTlsEnabled":false,"smtpSessionDebug":true,"subject":"Título de Prueba","content":"Contenido de prueba","html":false,"toEmail":[{"address":"notififacionTo.test@ada.co","persona":"Notificación To"}],"ccEmail":[{"address":"notififacionCc.test@ada.co","persona":"Notificación Cc"}],"bccEmail":[{"address":"notififacionBcc.test@ada.co","persona":"Notificación Bcc"}]}}],"responses":{"500":{"description":"Se han generado inconsistencias al crear el registro.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GenericResponseDto"}}}},"202":{"description":"Correo electrónico enviado correctamente.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GenericResponseDto"}}}},"503":{"description":"No se puede enviar el correo electrónico.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GenericResponseDto"}}}}},"deprecated":true}},"/email/":{"get":{"tags":["EmailController"],"summary":"index","description":"Método de validación de estado del microservicio","operationId":"index","responses":{"200":{"description":"Microsericio en linea","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EmailController"}}}}}}}},"components":{"schemas":{"AddressConfigDto":{"type":"object","properties":{"address":{"type":"string"},"persona":{"type":"string"}},"description":"Clase Dto que contiene la configuración de la dirección de correo electronico."},"AttachmentConfigDto":{"type":"object","properties":{"fileName":{"type":"string"},"fileContentStringBase64":{"type":"string"},"typeContent":{"type":"string"}},"description":"Clase Dto que contiene la configuración del archivo que se adjuntará al correo electrónico."},"EmailDto":{"type":"object","properties":{"from":{"$ref":"#/components/schemas/AddressConfigDto"},"subject":{"type":"string"},"content":{"type":"string"},"html":{"type":"boolean"},"attachmentBase64":{"type":"array","items":{"$ref":"#/components/schemas/AttachmentConfigDto"}},"toEmail":{"type":"array","items":{"$ref":"#/components/schemas/AddressConfigDto"}},"ccEmail":{"type":"array","items":{"$ref":"#/components/schemas/AddressConfigDto"}},"bccEmail":{"type":"array","items":{"$ref":"#/components/schemas/AddressConfigDto"}}},"description":"Clase Dto que contiene la configuración e información del correo electrónico."},"GenericResponseDto":{"type":"object","properties":{"code":{"type":"integer","format":"int64"},"message":{"type":"string"},"content":{"type":"object"}},"description":"Dto generico utilizado para respuestas en servicios."},"EmailConfigDto":{"type":"object","properties":{"smtpHost":{"type":"string"},"smtpPort":{"type":"string"},"smtpAuth":{"type":"string"},"smtpMailUser":{"type":"string"},"smtpMailPassword":{"type":"string"},"smtpStartTlsEnabled":{"type":"string"},"smtpSslTrust":{"type":"string"},"smtpSessionDebug":{"type":"boolean"},"subject":{"type":"string"},"content":{"type":"string"},"html":{"type":"boolean"},"attachmentBase64":{"type":"array","items":{"$ref":"#/components/schemas/AttachmentConfigDto"}},"toEmail":{"type":"array","items":{"$ref":"#/components/schemas/AddressConfigDto"}},"ccEmail":{"type":"array","items":{"$ref":"#/components/schemas/AddressConfigDto"}},"bccEmail":{"type":"array","items":{"$ref":"#/components/schemas/AddressConfigDto"}}},"description":"Clase Dto que contiene las configuraciones de autenticación y envío del correo electrónico."},"EmailController":{"type":"object"}}}}

←Volver atrás

ada/howto/sicoferp/factory/integrations/msadaemailservice.1685736649.txt.gz · Última modificación: 2023/06/02 20:10 por 192.168.175.173