{"id":22432114,"url":"https://github.com/normalhuman01/service-mail","last_synced_at":"2025-03-27T07:41:28.751Z","repository":{"id":215713194,"uuid":"739621673","full_name":"normalhuman01/service-mail","owner":"normalhuman01","description":"a service provides an email sending system with rabbitmq and maildev integration","archived":false,"fork":false,"pushed_at":"2024-01-06T03:17:45.000Z","size":158,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-02-01T12:45:25.940Z","etag":null,"topics":["maildev","rabbitmq"],"latest_commit_sha":null,"homepage":"","language":"Nunjucks","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/normalhuman01.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2024-01-06T03:12:56.000Z","updated_at":"2024-01-06T03:18:31.000Z","dependencies_parsed_at":null,"dependency_job_id":"fb34f348-7eae-45f1-aa2d-0c204064aaeb","html_url":"https://github.com/normalhuman01/service-mail","commit_stats":null,"previous_names":["normalhuman01/service-mail"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/normalhuman01%2Fservice-mail","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/normalhuman01%2Fservice-mail/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/normalhuman01%2Fservice-mail/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/normalhuman01%2Fservice-mail/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/normalhuman01","download_url":"https://codeload.github.com/normalhuman01/service-mail/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":245805989,"owners_count":20675291,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["maildev","rabbitmq"],"created_at":"2024-12-05T22:10:38.615Z","updated_at":"2025-03-27T07:41:28.744Z","avatar_url":"https://github.com/normalhuman01.png","language":"Nunjucks","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Service Mail\n\nEste servicio proporciona un sistema de envío de correos electrónicos con integración de RabbitMQ y MailDev. Es ideal para entornos de desarrollo y pruebas.\n\n## Preparación del Entorno\n\n### Requisitos Previos\n- Docker y Docker Compose\n- Node.js y Yarn\n\n### Instrucciones para Ejecutar\n\n1. **Iniciar servicios con Docker**\n   Ejecuta `docker-compose up -d` para iniciar MailDev y RabbitMQ.\n\n2. **Instalar dependencias**\n   Ejecuta `yarn` para instalar las dependencias necesarias.\n\n3. **Iniciar el servicio en modo depuración**\n   Ejecuta `yarn start:debug`. En este modo, se utilizará el archivo `./nodemon-debug.json`.\n\n### Configuración\n\n- **Variables de entorno**: Encuentra las variables de entorno en el archivo `.env.dist`. Configúralas según tus necesidades.\n- **Directorio de configuración**: `./config`.\n- **Directorio de plantillas**: `./templates`. Las plantillas se copian automáticamente al directorio `dist` después de ejecutar `yarn build`.\n\n## Interfaz de Usuario\n\n- **RabbitMQ UI**\n  - **Host**: http://localhost:15672\n  - **Username**: onsweb-mail\n  - **Password**: password\n\n- **MailDev UI**\n  - **Host**: http://localhost:1080\n  - **Username**: admin\n  - **Password**: password\n\n## Uso\n\nEnvía mensajes a través de RabbitMQ utilizando el siguiente formato JSON:\n\n```json\n{\n  \"templateName\": \"nombre_plantilla\",\n  \"to\": \"destinatario@example.com\",\n  \"data\": {\n    \"subject\": \"Asunto\",\n    \"exampleParameter\": \"Valor de ejemplo\"\n  },\n  \"language\": \"en\",\n  \"from\": \"remitente@example.com\",\n  \"cc\": [\"cc@example.com\"],\n  \"bcc\": [\"bcc@example.com\"],\n  \"attachments\": [\n    {\n      \"filename\": \"archivo.zip\",\n      \"content\": \"BASE64_STRING\",\n      \"encoding\": \"base64\",\n      \"contentType\": \"application/zip\"\n    }\n  ]\n}\n```\n\n## Notas Adicionales\n\n- **Intercambio en RabbitMQ**: Utiliza el nombre `send-email`, definido en `./src/lib/amqp/exchange.enum.ts` como `mailExchange`.\n- **Plantillas de Correo**: Actualmente soportamos plantillas simples como `test`, `default` y `new-document`.\n\n\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fnormalhuman01%2Fservice-mail","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fnormalhuman01%2Fservice-mail","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fnormalhuman01%2Fservice-mail/lists"}