{"id":27232861,"url":"https://github.com/levinunnink/batch-markdown-email","last_synced_at":"2026-04-13T21:01:35.221Z","repository":{"id":286721432,"uuid":"962330711","full_name":"levinunnink/batch-markdown-email","owner":"levinunnink","description":"Send markdown newsletters using Postmark","archived":false,"fork":false,"pushed_at":"2025-04-08T02:31:37.000Z","size":25,"stargazers_count":1,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-04-10T14:23:44.354Z","etag":null,"topics":["email","markdown","postmark"],"latest_commit_sha":null,"homepage":"https://www.npmjs.com/package/batch-markdown-email","language":"JavaScript","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/levinunnink.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE.txt","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":"2025-04-08T02:05:28.000Z","updated_at":"2025-04-08T05:20:05.000Z","dependencies_parsed_at":"2025-04-08T03:25:06.647Z","dependency_job_id":"d5a39cc9-b422-4493-a7b3-d4d556ba2eef","html_url":"https://github.com/levinunnink/batch-markdown-email","commit_stats":null,"previous_names":["levinunnink/batch-markdown-email"],"tags_count":4,"template":false,"template_full_name":null,"purl":"pkg:github/levinunnink/batch-markdown-email","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/levinunnink%2Fbatch-markdown-email","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/levinunnink%2Fbatch-markdown-email/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/levinunnink%2Fbatch-markdown-email/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/levinunnink%2Fbatch-markdown-email/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/levinunnink","download_url":"https://codeload.github.com/levinunnink/batch-markdown-email/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/levinunnink%2Fbatch-markdown-email/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":31770726,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-04-13T20:17:16.280Z","status":"ssl_error","status_checked_at":"2026-04-13T20:17:08.216Z","response_time":93,"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":["email","markdown","postmark"],"created_at":"2025-04-10T14:10:15.981Z","updated_at":"2026-04-13T21:01:35.192Z","avatar_url":"https://github.com/levinunnink.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Batch Markdown Email\n\n[![npm version](https://img.shields.io/npm/v/batch-markdown-email.svg?style=flat-square)](https://www.npmjs.com/package/batch-markdown-email)\n\nA CLI tool for sending markdown-based newsletters via Postmark. This tool converts a Markdown file into HTML and sends it as an email newsletter to a list of recipients using Postmark's batch API.\n\n## Features\n\n- **Secure Credentials:** Uses [keytar](https://github.com/atom/node-keytar) to securely store your Postmark API credentials and broadcast stream.\n- **Markdown to HTML:** Converts Markdown files to HTML using [markdown-it](https://github.com/markdown-it/markdown-it).\n- **CSV Parsing:** Reads recipient emails from a CSV file.\n- **Batch Processing:** Automatically splits messages into batches of up to 500 to comply with Postmark limits.\n- **CLI Commands:** Offers `validate` and `send` commands for configuration testing and sending emails.\n\n## Installation\n\nInstall the package globally from npm:\n\n```bash\nnpm install -g batch-markdown-email\n```\n\n## Usage\n\nThe CLI provides two commands: `validate` and `send`.\n\n## Send\n\nThe send command sends your newsletter via Postmark. You can optionally provide the --apiKey and --broadcastStream flags; if omitted, you’ll be prompted to enter them.\n\n```bash\nbatch-markdown-email send --markdown ./path/to/newsletter.md --subject \"Your Subject\" --to ./path/to/recipients.csv [--apiKey YOUR_POSTMARK_API_KEY] [--broadcastStream YOUR_FROM_EMAIL]\n```\n\nYou should format your email csv like this:\n\n```csv\nEmails\ntest@email.com\ntest2@email.com\n\"Testing Name\" \u003ctestingname@email.com\u003e\n```\n\n## Development\n\nClone the repository and install dependencies:\n\n```bash\ngit clone https://github.com/yourusername/batch-markdown-email.git\ncd batch-markdown-email\nnpm install\n```\n\n## Building\n\nCompile the TypeScript source code to JavaScript:\n\n```bash\nnpm run build\n```\n\n### Testing\n\nYou can test the CLI commands locally using:\n\n```bash\nnpm run validate -- --markdown ./path/to/newsletter.md --subject \"Test Subject\" --to ./path/to/recipients.csv\nnpm run send -- --markdown ./path/to/newsletter.md --subject \"Test Subject\" --to ./path/to/recipients.csv\n```\n\n### License\n\nThis project is licensed under the MIT License.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Flevinunnink%2Fbatch-markdown-email","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Flevinunnink%2Fbatch-markdown-email","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Flevinunnink%2Fbatch-markdown-email/lists"}