{"id":36444940,"url":"https://github.com/hyperboloide/qmail","last_synced_at":"2026-01-11T22:04:10.423Z","repository":{"id":57598606,"uuid":"55922991","full_name":"hyperboloide/qmail","owner":"hyperboloide","description":"A mailer that reads from a RabbitMQ queue and generates messages from Markdown templates.","archived":false,"fork":false,"pushed_at":"2016-04-27T21:19:58.000Z","size":8,"stargazers_count":3,"open_issues_count":0,"forks_count":0,"subscribers_count":2,"default_branch":"master","last_synced_at":"2024-06-20T13:38:52.434Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"","language":"Go","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/hyperboloide.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2016-04-10T21:17:26.000Z","updated_at":"2018-04-25T09:31:38.000Z","dependencies_parsed_at":"2022-08-30T00:00:40.589Z","dependency_job_id":null,"html_url":"https://github.com/hyperboloide/qmail","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/hyperboloide/qmail","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/hyperboloide%2Fqmail","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/hyperboloide%2Fqmail/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/hyperboloide%2Fqmail/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/hyperboloide%2Fqmail/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/hyperboloide","download_url":"https://codeload.github.com/hyperboloide/qmail/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/hyperboloide%2Fqmail/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":28324856,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-01-11T18:42:50.174Z","status":"ssl_error","status_checked_at":"2026-01-11T18:39:13.842Z","response_time":60,"last_error":"SSL_read: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"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":[],"created_at":"2026-01-11T22:04:10.361Z","updated_at":"2026-01-11T22:04:10.417Z","avatar_url":"https://github.com/hyperboloide.png","language":"Go","funding_links":[],"categories":[],"sub_categories":[],"readme":"# qmail\n\n[![Build Status](https://travis-ci.org/hyperboloide/qmail.svg?branch=master)](https://travis-ci.org/hyperboloide/qmail)\n[![GoDoc](https://godoc.org/github.com/hyperboloide/qmail?status.svg)](https://godoc.org/github.com/hyperboloide/qmail)\n\nA mailer that reads from a RabbitMQ queue and generates messages from Markdown templates.\n\nThis project has a client and a server.\n\n## Client\nTo send email you need to create and instance of the `client.Mailer`.\n\nStart by importing the client package:\n\n```\nimport \"github.com/hyperboloide/qmail/client\"\n```\n\nThen connect to the queue and send an email:\n\n```\nmailer, err := client.New(\"mails\", \"amqp://guest:guest@rabbitmq:5672/\")\n\nif err != nil {\n\tlog.Fatal(err)\n}\n\nemail := client.Mail{\n\tDests:    []string{\"dest@example.com\"},\n\tSubject:  \"test\",\n\tTemplate: \"example_template\",\n\tData:     map[string]string{\"User\": \"test user\"},\n\tFiles:    []string{\"/myfiles/some_file.txt\"},\n}\n\nif err := mailer.Send(email); err != nil {\n\tlog.Fatal(err)\n}\n\n```\n\n## Server\n\nThe server is available as a Docker container\n\n```\ndocker pull hyperboloide/qmail\n```\n\nAll configuration options are passed as environment variables:\n\n```\ndocker run \\\n\t-v ~/templates:/templates \\\n    -v ~/myfiles:/myfiles \\\n\t-link rabbitmq:rabbitmq \\\n\t-e TEMPLATES=/templates/*.md \\\n\t-e QUEUE_NAME=mails \\\n\t-e QUEUE_HOST=amqp://guest:guest@rabbitmq:5672/ \\\n\t-e SMTP_HOST=smtp.example.com \\\n\t-e SMTP_PORT=465 \\\n\t-e SMTP_USER=user@example.com \\\n\t-e SMTP_PASSWORD=password \\\n\t-e SENDER=\"Example User \u003cuser@example.com\u003e\" \\\n\thyperboloide/qmail\n```\n\nNote that if you want to send files you need to mount them in a Docker\nvolume (here the volume `myfiles`).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fhyperboloide%2Fqmail","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fhyperboloide%2Fqmail","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fhyperboloide%2Fqmail/lists"}