@flutry/mail 0.0.1 → 0.0.2
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 +14 -12
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -1,28 +1,30 @@
|
|
|
1
|
-
# @flutry/
|
|
1
|
+
# @flutry/mail
|
|
2
2
|
|
|
3
|
-
|
|
4
4
|
|
|
5
|
-
|
|
6
|
-
|
|
7
|
-
This package provides the main infrastructure for server initialization and integration with other Flutry modules (e.g., @flutry/fastify, etc.).
|
|
5
|
+
This package provides a simple email sending system for the Flutry project, using nodemailer with SMTP configuration.
|
|
8
6
|
|
|
9
7
|
## 🔧 Features
|
|
10
8
|
|
|
11
|
-
-
|
|
12
|
-
-
|
|
13
|
-
-
|
|
9
|
+
- Easy email sending via SMTP
|
|
10
|
+
- nodemailer integration
|
|
11
|
+
- Configuration via environment variables (SMTP_HOST, SMTP_PORT, SMTP_USER, SMTP_PASS)
|
|
14
12
|
|
|
15
13
|
## 🚀 Usage
|
|
16
14
|
|
|
17
15
|
```ts
|
|
18
|
-
import {
|
|
19
|
-
|
|
16
|
+
import { FlutryMail } from '@flutry/mail';
|
|
17
|
+
|
|
18
|
+
await FlutryMail.sendMail('sender@email.com', 'recipient@email.com', 'Subject', '<b>Email HTML content</b>');
|
|
20
19
|
```
|
|
21
20
|
|
|
22
|
-
|
|
21
|
+
> SMTP credentials must be set in your environment variables:
|
|
22
|
+
> SMTP_HOST, SMTP_PORT, SMTP_USER, SMTP_PASS
|
|
23
|
+
|
|
24
|
+
## 📄 License
|
|
23
25
|
|
|
24
26
|
MIT
|
|
25
27
|
|
|
26
28
|
## 🌐 Website
|
|
27
29
|
|
|
28
|
-
|
|
30
|
+
Official documentation: [https://flutry.com/docs/package/mail](https://flutry.com/docs/package/mail)
|