mailchannels-sdk 0.7.11 → 0.8.0-0
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 +8 -6
- package/dist/mailchannels.d.mts +206 -657
- package/dist/mailchannels.mjs +179 -831
- package/package.json +6 -6
package/README.md
CHANGED
|
@@ -6,10 +6,12 @@
|
|
|
6
6
|
[![npm downloads][npm-downloads-src]][npm-downloads-href]
|
|
7
7
|
[![codecov][codecov-coverage-src]][codecov-coverage-href]
|
|
8
8
|
|
|
9
|
-
|
|
9
|
+
> Built and tested against Email API `0.21.1`
|
|
10
|
+
|
|
11
|
+
Node.js SDK to integrate [MailChannels Email API](https://docs.mailchannels.net/email-api) into your JavaScript or TypeScript server-side applications.
|
|
10
12
|
|
|
11
13
|
<!-- #region overview -->
|
|
12
|
-
This library provides a simple way to interact with the [MailChannels API](https://docs.mailchannels.net/). It is written in TypeScript and can be used in both JavaScript and TypeScript projects and in different runtimes.
|
|
14
|
+
This library provides a simple way to interact with the [MailChannels Email API](https://docs.mailchannels.net/email-api). It is written in TypeScript and can be used in both JavaScript and TypeScript projects and in different runtimes.
|
|
13
15
|
<!-- #endregion overview -->
|
|
14
16
|
|
|
15
17
|
- [✨ Release Notes](CHANGELOG.md)
|
|
@@ -29,7 +31,7 @@ This library provides a simple way to interact with the [MailChannels API](https
|
|
|
29
31
|
## <a name="features">🚀 Features</a>
|
|
30
32
|
|
|
31
33
|
<!-- #region features -->
|
|
32
|
-
This SDK fully supports all features and operations available in the [MailChannels API](https://docs.mailchannels.net/). It is actively maintained to ensure compatibility and to quickly add support for new API features as they are released.
|
|
34
|
+
This SDK fully supports all features and operations available in the [MailChannels Email API](https://docs.mailchannels.net/email-api). It is actively maintained to ensure compatibility and to quickly add support for new API features as they are released.
|
|
33
35
|
|
|
34
36
|
Some of the things you can do with the SDK:
|
|
35
37
|
|
|
@@ -42,8 +44,6 @@ Some of the things you can do with the SDK:
|
|
|
42
44
|
- Inspect webhook delivery batches
|
|
43
45
|
- Handle suppressions
|
|
44
46
|
- Run a local simulator for development testing
|
|
45
|
-
- Configure inbound domains
|
|
46
|
-
- Manage account and recipient lists
|
|
47
47
|
|
|
48
48
|
> [!TIP]
|
|
49
49
|
> For a detailed reference mapping each SDK method to its corresponding MailChannels API endpoint reference, see the [SDK-API Mapping](https://mailchannels.yizack.com/sdk-api-mapping)
|
|
@@ -110,7 +110,6 @@ This package includes a local MailChannels simulator you can run via the CLI. It
|
|
|
110
110
|
| API | Source |
|
|
111
111
|
| ----------- | -------------------------------------------------------------------------------------------------------------- |
|
|
112
112
|
| Email API | [`src/simulator/email-api.mjs`](https://github.com/Yizack/mailchannels/blob/main/src/simulator/email-api.mjs) |
|
|
113
|
-
| Inbound API | N/A |
|
|
114
113
|
|
|
115
114
|
> [!IMPORTANT]
|
|
116
115
|
> The simulator approximates the MailChannels service for local development and testing. It is not a production implementation and may differ from the live service.
|
|
@@ -212,6 +211,9 @@ pnpm parity:fixtures
|
|
|
212
211
|
# Run the local simulator
|
|
213
212
|
pnpm simulate
|
|
214
213
|
|
|
214
|
+
# Run a playground script
|
|
215
|
+
npx jiti playground/emails/send.ts
|
|
216
|
+
|
|
215
217
|
# Release new version
|
|
216
218
|
pnpm release
|
|
217
219
|
```
|