@nauth-toolkit/email-nodemailer 0.2.1 → 0.2.3
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +43 -3
- package/package.json +2 -2
package/README.md
CHANGED
|
@@ -2,8 +2,48 @@
|
|
|
2
2
|
|
|
3
3
|
Nodemailer email provider for [nauth-toolkit](https://nauth.dev).
|
|
4
4
|
|
|
5
|
-
Sends verification codes,
|
|
5
|
+
Sends verification codes, password reset emails, and MFA notifications using Nodemailer. Works with any SMTP server, AWS SES, Gmail, or other Nodemailer-supported transports. Includes Handlebars-based email templates with file-based customization.
|
|
6
6
|
|
|
7
|
-
|
|
7
|
+
**[Documentation](https://nauth.dev)** · **[GitHub](https://github.com/noorixorg/nauth)**
|
|
8
8
|
|
|
9
|
-
|
|
9
|
+
> Part of [nauth-toolkit](https://www.npmjs.com/package/@nauth-toolkit/core). Requires `@nauth-toolkit/core`.
|
|
10
|
+
|
|
11
|
+
---
|
|
12
|
+
|
|
13
|
+
## Install
|
|
14
|
+
|
|
15
|
+
```bash
|
|
16
|
+
npm install @nauth-toolkit/email-nodemailer
|
|
17
|
+
```
|
|
18
|
+
|
|
19
|
+
Configure in your auth config:
|
|
20
|
+
|
|
21
|
+
```typescript
|
|
22
|
+
import { NodemailerEmailProvider } from '@nauth-toolkit/email-nodemailer';
|
|
23
|
+
|
|
24
|
+
const authConfig = {
|
|
25
|
+
emailProvider: new NodemailerEmailProvider({
|
|
26
|
+
host: process.env.SMTP_HOST,
|
|
27
|
+
port: 587,
|
|
28
|
+
auth: {
|
|
29
|
+
user: process.env.SMTP_USER,
|
|
30
|
+
pass: process.env.SMTP_PASS,
|
|
31
|
+
},
|
|
32
|
+
from: 'noreply@example.com',
|
|
33
|
+
}),
|
|
34
|
+
};
|
|
35
|
+
```
|
|
36
|
+
|
|
37
|
+
---
|
|
38
|
+
|
|
39
|
+
## Also available
|
|
40
|
+
|
|
41
|
+
| Package | Purpose |
|
|
42
|
+
| --- | --- |
|
|
43
|
+
| [`@nauth-toolkit/email-console`](https://www.npmjs.com/package/@nauth-toolkit/email-console) | Log emails to console — development use |
|
|
44
|
+
|
|
45
|
+
See the [full package list](https://www.npmjs.com/package/@nauth-toolkit/core#package-ecosystem) in the core README.
|
|
46
|
+
|
|
47
|
+
---
|
|
48
|
+
|
|
49
|
+
Free to use. See [license](https://nauth.dev/docs/license).
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@nauth-toolkit/email-nodemailer",
|
|
3
|
-
"version": "0.2.
|
|
3
|
+
"version": "0.2.3",
|
|
4
4
|
"description": "Nodemailer email provider for nauth-toolkit — SMTP, SES, Gmail",
|
|
5
5
|
"main": "dist/index.js",
|
|
6
6
|
"types": "dist/index.d.ts",
|
|
@@ -26,7 +26,7 @@
|
|
|
26
26
|
"nodemailer": "^7.0.11"
|
|
27
27
|
},
|
|
28
28
|
"peerDependencies": {
|
|
29
|
-
"@nauth-toolkit/core": "^0.2.
|
|
29
|
+
"@nauth-toolkit/core": "^0.2.3"
|
|
30
30
|
},
|
|
31
31
|
"devDependencies": {
|
|
32
32
|
"@types/handlebars": "^4.1.0",
|