Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
26 changes: 16 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,9 @@

NPM library and CLI for sending text and HTML emails using Gmail SMTP with Google OAuth2.

[![DeepWiki](https://img.shields.io/badge/DeepWiki-weaponsforge%2Fsend--email-blue.svg?logo=data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAACwAAAAyCAYAAAAnWDnqAAAAAXNSR0IArs4c6QAAA05JREFUaEPtmUtyEzEQhtWTQyQLHNak2AB7ZnyXZMEjXMGeK/AIi+QuHrMnbChYY7MIh8g01fJoopFb0uhhEqqcbWTp06/uv1saEDv4O3n3dV60RfP947Mm9/SQc0ICFQgzfc4CYZoTPAswgSJCCUJUnAAoRHOAUOcATwbmVLWdGoH//PB8mnKqScAhsD0kYP3j/Yt5LPQe2KvcXmGvRHcDnpxfL2zOYJ1mFwrryWTz0advv1Ut4CJgf5uhDuDj5eUcAUoahrdY/56ebRWeraTjMt/00Sh3UDtjgHtQNHwcRGOC98BJEAEymycmYcWwOprTgcB6VZ5JK5TAJ+fXGLBm3FDAmn6oPPjR4rKCAoJCal2eAiQp2x0vxTPB3ALO2CRkwmDy5WohzBDwSEFKRwPbknEggCPB/imwrycgxX2NzoMCHhPkDwqYMr9tRcP5qNrMZHkVnOjRMWwLCcr8ohBVb1OMjxLwGCvjTikrsBOiA6fNyCrm8V1rP93iVPpwaE+gO0SsWmPiXB+jikdf6SizrT5qKasx5j8ABbHpFTx+vFXp9EnYQmLx02h1QTTrl6eDqxLnGjporxl3NL3agEvXdT0WmEost648sQOYAeJS9Q7bfUVoMGnjo4AZdUMQku50McDcMWcBPvr0SzbTAFDfvJqwLzgxwATnCgnp4wDl6Aa+Ax283gghmj+vj7feE2KBBRMW3FzOpLOADl0Isb5587h/U4gGvkt5v60Z1VLG8BhYjbzRwyQZemwAd6cCR5/XFWLYZRIMpX39AR0tjaGGiGzLVyhse5C9RKC6ai42ppWPKiBagOvaYk8lO7DajerabOZP46Lby5wKjw1HCRx7p9sVMOWGzb/vA1hwiWc6jm3MvQDTogQkiqIhJV0nBQBTU+3okKCFDy9WwferkHjtxib7t3xIUQtHxnIwtx4mpg26/HfwVNVDb4oI9RHmx5WGelRVlrtiw43zboCLaxv46AZeB3IlTkwouebTr1y2NjSpHz68WNFjHvupy3q8TFn3Hos2IAk4Ju5dCo8B3wP7VPr/FGaKiG+T+v+TQqIrOqMTL1VdWV1DdmcbO8KXBz6esmYWYKPwDL5b5FA1a0hwapHiom0r/cKaoqr+27/XcrS5UwSMbQAAAABJRU5ErkJggg==)](https://deepwiki.com/weaponsforge/send-email)
<!-- DeepWiki badge generated by https://deepwiki.ryoppippi.com/ -->

> [!TIP]
> - **Run via npx (no installation required)**
> - Requirements: NodeJS LTS v24.11.0 or later
Expand All @@ -16,6 +19,10 @@ NPM library and CLI for sending text and HTML emails using Gmail SMTP with Googl
> - **Docker image**<br>
> A Docker image is available at https://hub.docker.com/r/weaponsforge/sendemail

**Windows Binary**

![sendemail windows cli](/docs/sendemail.gif)

### Table of Contents

- [Requirements](#-requirements)
Expand Down Expand Up @@ -49,15 +56,14 @@ NPM library and CLI for sending text and HTML emails using Gmail SMTP with Googl

(Installed via npm)

1. [googleapis](https://www.npmjs.com/package/googleapis) `v171.4.0` - Manages Gmail token access
2. [nodemailer](https://www.npmjs.com/package/nodemailer) `v8.0.1` - Sends emails using various transport options
3. [typescript](https://www.npmjs.com/package/typescript) `v5.9.3` - Compile-time error checker
4. [tsx](https://www.npmjs.com/package/tsx) `v4.21.0` - Runs TS files in development mode
5. [vitest](https://www.npmjs.com/package/vitest) `v4.0.18` - Runs tests
6. [commander](https://www.npmjs.com/package/commander) `v14.0.3` - CLI library
7. [sanitize-html](https://www.npmjs.com/package/sanitize-html) `v2.17.1` - Sanitizes WYSIWYG HTML input
8. [zod](https://www.npmjs.com/package/zod) `v3.24.2` - Run-time input validation
9. [ejs](https://www.npmjs.com/package/ejs) `v4.0.1` - Composes HTML with dynamic text content
1. [nodemailer](https://www.npmjs.com/package/nodemailer) `v9.0.0` - Sends emails using various transport options
2. [typescript](https://www.npmjs.com/package/typescript) `v6.0.3` - Compile-time error checker
3. [tsx](https://www.npmjs.com/package/tsx) `v4.22.4` - Runs TS files in development mode
4. [vitest](https://www.npmjs.com/package/vitest) `v4.1.9` - Runs tests
5. [commander](https://www.npmjs.com/package/commander) `v15.0.0` - CLI library
6. [sanitize-html](https://www.npmjs.com/package/sanitize-html) `v2.17.5` - Sanitizes WYSIWYG HTML input
7. [zod](https://www.npmjs.com/package/zod) `v3.24.2` - Run-time input validation
8. [ejs](https://www.npmjs.com/package/ejs) `v6.0.1` - Composes HTML with dynamic text content

</details>
<br>
Expand Down Expand Up @@ -106,7 +112,7 @@ We welcome contributions! Please see [CONTRIBUTING.md](/CONTRIBUTING.md) and the
npm run sendemail -- html \
-s "WYSIWYG Email" \
-w "<div style='width:100px; height:100px; border:5px solid blue; border-radius: 3px; padding: 8px; text-align: center; background-color: azure;'><h3>Hello, World</h3></div>" \
-r "tester@gmail.com"
-r tester@gmail.com
```

> 💡 **TIP:** Development mode via `"sendemail:dev"` skips transpilation
Expand Down
Loading
Loading