[{"_1":2,"_168":-5,"_169":-5},"loaderData",{"_3":4,"_13":14,"_19":20,"_144":145},"root",{"_5":-5,"_6":-7,"_7":8,"_9":-7,"_10":11,"_12":-7},"currentUser","primaryEmail","siteVerification","6LeIxAcTAAAAAJcZVRqyHh71UMIEGNQ_MXjiZKhI","toast","enableDev",false,"incidentStatus","routes/_layout",{"_15":-5,"_16":17,"_18":17},"username","isAskGordonEnabled",true,"isUsingNewTemplate","routes/_layout.r.$namespace.$reponame",{"_21":22,"_23":-5,"_24":11,"_25":11,"_26":27,"_28":29,"_30":-5,"_31":11,"_32":33,"_89":-5,"_90":91,"_137":-5,"_138":11,"_139":11,"_140":11,"_141":-5,"_142":143},"canonicalUrl","https://hub.docker.com/r/souravbapari/emailing/tags","mcpServer","canSeeDockerfile","canSeeAutobuilds","namespace","souravbapari","reponame","emailing","cloudBuildSource","isAutobuildsAvailable","repo",{"_34":35,"_44":45,"_47":48,"_49":50,"_51":11,"_52":53,"_54":55,"_56":57,"_37":29,"_26":27,"_59":60,"_61":-5,"_62":63,"_64":65,"_66":67,"_68":-5,"_69":63,"_70":71,"_72":11,"_73":27,"_74":75,"_80":11,"_81":82,"_86":27,"_87":88},"categories",[36,41],{"_37":38,"_39":40},"name","Message queues","slug","message-queues",{"_37":42,"_39":43},"Developer tools","developer-tools","content_types",[46],"image","date_registered","2025-12-22T08:29:05.069692Z","description","High-performance email delivery and scheduling service using Bun, BullMQ, and Redis.","is_private","last_updated","2025-12-23T21:31:00.124672Z","last_modified","2025-12-23T11:50:27.663317Z","media_types",[58],"application/vnd.oci.image.index.v1+json","pull_count",846,"repository_type","star_count",0,"status",1,"status_description","active","source","collaborator_count","full_description","

Mailing Service

\n\nA production-ready **email delivery and scheduling service** built with **Bun** , **BullMQ** , and **Redis** , designed to run seamlessly with Docker and Docker Compose.\n\n---\n\n## Features\n\n- SMTP email sending\n- Scheduled email delivery\n- Redis-backed job queue (BullMQ)\n- High-performance Bun runtime\n- Docker-first deployment\n- Graceful shutdown & retry support\n\n---\n\n## Architecture\n\n```\n┌──────────────────┐ ┌──────────────┐\n│ Mailing Service │ 6379 │ Redis 7 │\n│ (Bun + BullMQ) │──────▶│ Job Queue │\n└──────────────────┘ └──────────────┘\n```\n\nEach service runs in its own container following Docker best practices.\n\n---\n\n## Requirements\n\n- Docker 20+\n- Docker Compose v2+\n\n---\n\n## Quick Start\n\n### 1. Clone the repository\n\n```bash\ngit clone \ncd mailing-service\n```\n\n---\n\n### 2. Start services\n\n```bash\ndocker compose up --build -d\n```\n\nServices started:\n\n- Mailing Service → `http://localhost:5878`\n- Redis → internal container network\n\n---\n\n### 3. Stop services\n\n```bash\ndocker compose down\n```\n\n---\n\n## docker-compose.yml\n\n```yaml\nversion: \"3.9\"\n\nservices:\n app:\n build: .\n container_name: mailing-service\n ports:\n - \"5878:5878\"\n environment:\n PORT: 5878\n REDIS_HOST: redis\n REDIS_PORT: 6379\n API_KEY: hello\n depends_on:\n - redis\n restart: unless-stopped\n\n redis:\n image: redis:7\n container_name: redis\n restart: unless-stopped\n volumes:\n - redis-data:/data\n\nvolumes:\n redis-data:\n```\n\n---\n\n## Environment Variables\n\n| Variable | Description | Required |\n| ---------------- | ---------------------- | -------- |\n| `PORT` | Application port | ✅ |\n| `REDIS_HOST` | Redis hostname | ✅ |\n| `REDIS_PORT` | Redis port | ✅ |\n| `API_KEY` | API authentication key | ✅ |\n| `REDIS_USERNAME` | Redis ACL username | ❌ |\n| `REDIS_PASSWORD` | Redis password | ❌ |\n\n---\n\n## API Authentication\n\nAll requests must include the API key:\n\n### Header\n\n```\nAuthorization: Bearer token\n```\n\n---\n\n## Using the Node.js Client\n\nThe easiest way to interact with the Mailing Service is using the official Node.js client package.\n\n### Installation\n\n```bash\nnpm install emailing-service\n```\n\nor\n\n```bash\npnpm add emailing-service\n```\n\nor\n\n```bash\nbun add emailing-service\n```\n\n### Quick Start\n\n```ts\nimport { Mailing } from \"emailing-service\";\n\nconst mailer = new Mailing({\n host: \"http://localhost:5878\", // Your mailing service URL\n apiKey: \"your-api-key\",\n credential: {\n host: \"smtp.gmail.com\",\n port: 587,\n secure: false,\n auth: {\n user: \"no-reply@gmail.com\",\n pass: \"app-password\",\n },\n },\n});\n\n// Send email immediately\nawait mailer.send({\n from: \"no-reply@gmail.com\",\n to: \"user@example.com\",\n subject: \"Welcome\",\n text: \"Hello from Mailing Service\",\n});\n\n// Schedule email for later\nconst scheduled = await mailer.schedule(\n new Date(Date.now() + 60 * 60 * 1000) // 1 hour later\n);\n\nconst result = await scheduled.send({\n from: \"no-reply@gmail.com\",\n to: \"user@example.com\",\n subject: \"Scheduled Email\",\n html: \"

Hello

This email was scheduled.

\",\n});\n\n// Check email existence\nconst check = await mailer.isEmailExistence(\"user@example.com\");\nconsole.log(check.data.exists); // true or false\n\n// Cancel scheduled email\nawait mailer.cancelMail(result.data.id);\n```\n\nFor more details, visit the [npm package page](https://www.npmjs.com/package/emailing-service).\n\n---\n\n## Example API Request\n\n### Send Email\n\n```http\nPOST /mail/send\nContent-Type: application/json\nAuthorization: Bearer token\n```\n\n```json\n{\n \"credential\": {\n \"host\": \"smtp.gmail.com\",\n \"port\": 587,\n \"secure\": false,\n \"auth\": {\n \"user\": \"no-reply@gmail.com\",\n \"pass\": \"app-password\"\n }\n },\n \"email\": {\n \"from\": \"no-reply@gmail.com\",\n \"to\": \"user@example.com\",\n \"subject\": \"Test Email\",\n \"text\": \"Hello from Mailing Service\"\n }\n}\n```\n\n---\n\n### Schedule Email\n\n```http\nPOST /mail/schedule?date=2025-01-30T10:00:00Z\nContent-Type: application/json\nAuthorization: Bearer token\n```\n\n```json\n{\n \"credential\": {\n \"host\": \"smtp.gmail.com\",\n \"port\": 587,\n \"secure\": false,\n \"auth\": {\n \"user\": \"no-reply@gmail.com\",\n \"pass\": \"app-password\"\n }\n },\n \"email\": {\n \"from\": \"no-reply@gmail.com\",\n \"to\": \"user@example.com\",\n \"subject\": \"Scheduled Email\",\n \"html\": \"

Hello

This email was scheduled.

\"\n }\n}\n```\n\n### Check Email Existence\n\n```http\nGET /mail/existence?email=user@example.com\nAuthorization: Bearer token\n```\n\n**Response:**\n\n```json\n{\n \"status\": true,\n \"email\": \"user@example.com\",\n \"exists\": true,\n \"date\": \"2025-01-30T10:00:00.000Z\"\n}\n```\n\n---\n\n### Cancel Scheduled Job\n\n```http\nPOST /mail/cancel/:jobId\nAuthorization: Bearer token\n```\n\n**Example:**\n\n```http\nPOST /mail/cancel/job-id-456\nAuthorization: Bearer token\n```\n\n**Response:**\n\n```json\n{\n \"status\": true,\n \"jobId\": \"job-id-456\",\n \"result\": true,\n \"date\": \"2025-01-30T10:00:00.000Z\"\n}\n```\n\n---\n\n## Redis Persistence\n\nRedis data is persisted using Docker volumes:\n\n```\nredis-data\n```\n\nThis ensures queued jobs survive container restarts.\n\n---\n\n## Health & Stability\n\n- Automatic container restart (`unless-stopped`)\n- Redis ≥ 7 (BullMQ recommended)\n- Graceful shutdown using exec-form CMD\n- No manual Redis connection handling\n\n---\n\n## Security Best Practices\n\n- Do **not** commit `.env` files\n- Use secrets management in production\n- Restrict Redis access to internal networks\n- Rotate SMTP credentials regularly\n\n---\n\n## Production Notes\n\n- Use immutable image tags (`v1.0.0`)\n- Add Redis authentication for public deployments\n- Scale workers horizontally if needed\n- Use a managed Redis service for high availability\n\n---\n\n## License\n\nMIT License\n\n---\n\n## Support & Contributions\n\nIssues and pull requests are welcome.\nFor production hardening or enterprise setups, please open a discussion.\n","has_starred","hub_user","immutable_tags_settings",{"_76":11,"_77":78},"enabled","rules",[79],".*","is_automated","permissions",{"_83":17,"_84":11,"_85":11},"read","write","admin","user","storage_size",110765093,"orgData","recentTags",[92],{"_93":46,"_94":95,"_96":97,"_98":99,"_100":101,"_102":103,"_52":126,"_127":95,"_128":27,"_129":58,"_37":130,"_131":132,"_133":123,"_134":126,"_135":67,"_136":17},"content_type","creator",38740557,"digest","sha256:6d930cbfa8270e7e8bb372b1074bf14bc30f757dc4a4d5dba857a12e9fbf963b","full_size",101897602,"id",1035881367,"images",[104,120],{"_105":106,"_96":107,"_108":109,"_110":111,"_112":113,"_114":115,"_116":109,"_117":-5,"_118":99,"_64":67,"_119":-5},"architecture","amd64","sha256:45b02d169679712681752f7299f93fed4e06c51f682c8d7de8b55609fe3f9477","features","","last_pulled","2026-08-10T03:09:31.806265771Z","last_pushed","2025-12-23T11:01:59.503846288Z","os","linux","os_features","os_version","size","variant",{"_105":121,"_96":122,"_108":109,"_110":123,"_112":124,"_114":121,"_116":109,"_117":-5,"_118":125,"_64":67,"_119":-5},"unknown","sha256:e568ec8fcbdead0ee122ca6df8e14c60187a96d9b14939a5dbacbad4ab258b13","2026-08-11T02:53:42.617608362Z","2025-12-23T11:01:59.577954727Z",1180,"2025-12-23T11:02:00.935933Z","last_updater","last_updater_username","media_type","latest","repository",29536724,"tag_last_pulled","tag_last_pushed","tag_status","v2","sbxKitMetadata","isPotentialSpam","isHubSbxKitsEnabled","displaySecurityMetadata","tagAttestations","tagsHaveAttestations",[],"routes/_layout.r.$namespace.$reponame.tags",{"_32":146,"_155":156,"_142":166,"_167":11},{"_34":147,"_44":150,"_47":48,"_49":50,"_51":11,"_52":53,"_54":55,"_56":151,"_37":29,"_26":27,"_59":60,"_61":-5,"_62":63,"_64":65,"_66":67,"_68":-5,"_69":63,"_70":71,"_72":11,"_73":27,"_74":152,"_80":11,"_81":154,"_86":27,"_87":88},[148,149],{"_37":38,"_39":40},{"_37":42,"_39":43},[46],[58],{"_76":11,"_77":153},[79],{"_83":17,"_84":11,"_85":11},"tags",{"_157":65,"_158":-5,"_159":-5,"_160":161},"count","next","previous","results",[162],{"_93":46,"_94":95,"_96":97,"_98":99,"_100":101,"_102":163,"_52":126,"_127":95,"_128":27,"_129":58,"_37":130,"_131":132,"_133":123,"_134":126,"_135":67,"_136":17},[164,165],{"_105":106,"_96":107,"_108":109,"_110":111,"_112":113,"_114":115,"_116":109,"_117":-5,"_118":99,"_64":67,"_119":-5},{"_105":121,"_96":122,"_108":109,"_110":123,"_112":124,"_114":121,"_116":109,"_117":-5,"_118":125,"_64":67,"_119":-5},[],"canDeleteTags","actionData","errors"]

Help

System theme

Docker Suite

souravbapari/emailing

Tags for souravbapari/emailing