@antelopejs/interface-email 0.0.2 → 0.0.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 +12 -2
- package/package.json +8 -7
package/README.md
CHANGED
|
@@ -1,18 +1,28 @@
|
|
|
1
1
|
# Interface Email
|
|
2
2
|
|
|
3
3
|
<div align="center">
|
|
4
|
+
<a href="https://www.npmjs.com/package/@antelopejs/interface-email"><img src="https://img.shields.io/npm/v/@antelopejs/interface-email?style=for-the-badge&labelColor=000000&color=000000" alt="npm"></a>
|
|
4
5
|
<a href="./LICENSE"><img alt="License" src="https://img.shields.io/badge/License-Apache_2.0-blue.svg?style=for-the-badge&labelColor=000000"></a>
|
|
5
6
|
<a href="https://discord.gg/sjK28QHrA7"><img src="https://img.shields.io/badge/Discord-18181B?logo=discord&style=for-the-badge&color=000000" alt="Discord"></a>
|
|
7
|
+
<a href="./docs/1.introduction.md"><img src="https://img.shields.io/badge/Docs-18181B?style=for-the-badge&color=000000" alt="Documentation"></a>
|
|
6
8
|
</div>
|
|
7
9
|
|
|
8
|
-
A
|
|
10
|
+
A standardized email interface for AntelopeJS that provides a unified API for sending emails, batch sending, template rendering, and attachment handling. The interface abstracts away provider-specific details, allowing you to switch email providers without changing application code.
|
|
9
11
|
|
|
10
12
|
## Installation
|
|
11
13
|
|
|
12
14
|
```bash
|
|
13
|
-
|
|
15
|
+
npm install @antelopejs/interface-email
|
|
14
16
|
```
|
|
15
17
|
|
|
18
|
+
## Documentation
|
|
19
|
+
|
|
20
|
+
Detailed documentation is available in the `docs` directory:
|
|
21
|
+
|
|
22
|
+
- [Introduction](./docs/1.introduction.md) - Overview of the interface, email address types, and core concepts
|
|
23
|
+
- [Sending Emails](./docs/2.sending-emails.md) - Email parameters, priority, tracking, scheduling, templates, and batch sending
|
|
24
|
+
- [Attachments](./docs/3.attachments.md) - Attachment types, inline images, and usage examples
|
|
25
|
+
|
|
16
26
|
## License
|
|
17
27
|
|
|
18
28
|
This project is licensed under the Apache License 2.0 - see the [LICENSE](LICENSE) file for details.
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@antelopejs/interface-email",
|
|
3
|
-
"version": "0.0.
|
|
3
|
+
"version": "0.0.3",
|
|
4
4
|
"description": "AntelopeJS interface for email sending with support for templates, batch, and attachments",
|
|
5
5
|
"keywords": [
|
|
6
6
|
"antelopejs",
|
|
@@ -34,17 +34,18 @@
|
|
|
34
34
|
"release": "pnpm run lint && pnpm run prepack && release-it"
|
|
35
35
|
},
|
|
36
36
|
"dependencies": {
|
|
37
|
-
"@antelopejs/interface-core": "^0.0.
|
|
37
|
+
"@antelopejs/interface-core": "^0.0.3"
|
|
38
38
|
},
|
|
39
39
|
"devDependencies": {
|
|
40
40
|
"@biomejs/biome": "2.3.2",
|
|
41
|
-
"@types/node": "^22.
|
|
42
|
-
"release-it": "^19.
|
|
41
|
+
"@types/node": "^22.19.15",
|
|
42
|
+
"release-it": "^19.2.4",
|
|
43
43
|
"release-it-changelogen": "^0.1.0",
|
|
44
|
-
"rimraf": "^6.
|
|
45
|
-
"typescript": "^5.
|
|
44
|
+
"rimraf": "^6.1.3",
|
|
45
|
+
"typescript": "^5.9.3"
|
|
46
46
|
},
|
|
47
47
|
"publishConfig": {
|
|
48
48
|
"access": "public"
|
|
49
|
-
}
|
|
49
|
+
},
|
|
50
|
+
"antelopeJs": {}
|
|
50
51
|
}
|