{"id":19142120,"url":"https://github.com/eldoy/mailus","last_synced_at":"2026-06-12T20:31:35.698Z","repository":{"id":122396559,"uuid":"610685734","full_name":"eldoy/mailus","owner":"eldoy","description":"Utility for mass sending of emails","archived":false,"fork":false,"pushed_at":"2023-03-11T08:28:38.000Z","size":43,"stargazers_count":1,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-09-07T09:09:17.141Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"isc","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/eldoy.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,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2023-03-07T09:22:43.000Z","updated_at":"2023-05-27T13:58:16.000Z","dependencies_parsed_at":"2023-03-22T22:02:30.330Z","dependency_job_id":null,"html_url":"https://github.com/eldoy/mailus","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/eldoy/mailus","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/eldoy%2Fmailus","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/eldoy%2Fmailus/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/eldoy%2Fmailus/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/eldoy%2Fmailus/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/eldoy","download_url":"https://codeload.github.com/eldoy/mailus/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/eldoy%2Fmailus/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":34262155,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-05-26T15:22:16.424Z","status":"online","status_checked_at":"2026-06-12T02:00:06.859Z","response_time":109,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"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":"2024-11-09T07:26:00.013Z","updated_at":"2026-06-12T20:31:35.459Z","avatar_url":"https://github.com/eldoy.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Mailus\n\nUtility for mass sending of emails.\n\n### Install\n\nTo install the mailus terminal command, do this:\n\n```\nnpm i -g mailus\n```\n\n### Usage\n\nAs an example, we will create a campaign called `hello`.\n\nCreate a directory structure like this:\n\n```\nmailus\n├── campaigns\n│   └── hello.json\n├── lists\n│   └── test.json\n├── messages\n│   └── hello.md\n└── servers\n    └── test.json\n```\n\n### Construct your email\n\nIn the `campaigns/hello.json` file add from, subject and message reference:\n```json\n{\n  \"from\": \"Vidar Eldøy \u003cvidar@eldoy.com\u003e\",\n  \"subject\": \"Hey, what's going on?\",\n  \"message\": \"hello\"\n}\n```\n\nThe message reference should be the same name as one of the messages in the `messages` directory, here it is referencing `messages/hello.md`.\n\n#### Add list of contacts\n\nThe `lists/test.json` file has to be an array of contacts containing a field named `email`, and can have any other data your want to use in your email:\n\n```json\n[\n  {\n    \"name\": \"Vidar\",\n    \"email\": \"Vidar Eldøy \u003cvidar@eldoy.com\u003e\"\n  }\n]\n```\n\n#### Compose your message\n\nThe message in `messages/hello.md` is written in markdown, but also supports HTML and Mustache with front matter data:\n\n```md\n# Hello {{name}}\n\nYou have been selected to join our program, are you ready?\n\nBest regards\n\\- Vidar\n```\n\n### Add a server to send through\n\nIn `servers/test.json` add server info like this:\n\n```json\n{    \n  \"host\": \"smtp.ethereal.email\",\n  \"port\": 587,\n  \"auth\": {\n    \"user\": \"nicola.breitenberg58@ethereal.email\",\n    \"pass\": \"eUpHSnV96EM8uRbJ9S\"\n  }  \n}\n```\n\nThe server info can be any outgoing SMTP server. Here we use a test server that doesn't actually send any emails.\n\n### Send your emails\n\nTo start sending mails to all of your contacts in your list, write this in terminal:\n\n```\nmailus hello test test\n```\n\nThis means \"send the hello campaign to the test list through the test server\":\n\n```\nmailus \u003ccampaign\u003e \u003clist\u003e \u003cserver\u003e\n```\n\n### License\n\nISC Licensed. Enjoy!\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Feldoy%2Fmailus","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Feldoy%2Fmailus","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Feldoy%2Fmailus/lists"}