@easybits.cloud/mailmask 0.1.0 → 0.1.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 +50 -0
- package/package.json +12 -3
package/README.md
ADDED
|
@@ -0,0 +1,50 @@
|
|
|
1
|
+
# @easybits.cloud/mailmask
|
|
2
|
+
|
|
3
|
+
Official TypeScript/JavaScript SDK for the [MailMask](https://mailmask.studio) email alias and forwarding API.
|
|
4
|
+
|
|
5
|
+
## Install
|
|
6
|
+
|
|
7
|
+
```bash
|
|
8
|
+
npm i @easybits.cloud/mailmask
|
|
9
|
+
```
|
|
10
|
+
|
|
11
|
+
## Quick start
|
|
12
|
+
|
|
13
|
+
```ts
|
|
14
|
+
import { MailMask } from "@easybits.cloud/mailmask";
|
|
15
|
+
|
|
16
|
+
const mm = new MailMask({ apiKey: "mm_live_..." });
|
|
17
|
+
|
|
18
|
+
// Create an alias — emails to hello@yourdomain.com forward to your inbox
|
|
19
|
+
const alias = await mm.aliases.create({
|
|
20
|
+
domainId: "domain-id",
|
|
21
|
+
local: "hello",
|
|
22
|
+
destinations: ["you@example.com"],
|
|
23
|
+
});
|
|
24
|
+
|
|
25
|
+
// Send an email (routed through MailMask for high deliverability)
|
|
26
|
+
await mm.emails.send({
|
|
27
|
+
domainId: "domain-id",
|
|
28
|
+
from: "hello",
|
|
29
|
+
to: "client@example.com",
|
|
30
|
+
subject: "Welcome!",
|
|
31
|
+
html: "<p>Thanks for signing up.</p>",
|
|
32
|
+
});
|
|
33
|
+
|
|
34
|
+
// List aliases for a domain
|
|
35
|
+
const aliases = await mm.aliases.list("domain-id");
|
|
36
|
+
```
|
|
37
|
+
|
|
38
|
+
## Docs
|
|
39
|
+
|
|
40
|
+
Full API reference and examples: https://mailmask.studio/docs
|
|
41
|
+
|
|
42
|
+
## Links
|
|
43
|
+
|
|
44
|
+
- [MailMask](https://mailmask.studio) — Email alias & forwarding service
|
|
45
|
+
- [EasyBits](https://easybits.cloud) — Cloud platform
|
|
46
|
+
- [Fixter](https://fixter.org) — Development team
|
|
47
|
+
|
|
48
|
+
## License
|
|
49
|
+
|
|
50
|
+
MIT
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@easybits.cloud/mailmask",
|
|
3
|
-
"version": "0.1.
|
|
3
|
+
"version": "0.1.2",
|
|
4
4
|
"description": "Official SDK for the MailMask email alias/forwarding API",
|
|
5
5
|
"type": "module",
|
|
6
6
|
"main": "./dist/index.cjs",
|
|
@@ -13,7 +13,10 @@
|
|
|
13
13
|
"require": "./dist/index.cjs"
|
|
14
14
|
}
|
|
15
15
|
},
|
|
16
|
-
"files": [
|
|
16
|
+
"files": [
|
|
17
|
+
"dist",
|
|
18
|
+
"README.md"
|
|
19
|
+
],
|
|
17
20
|
"scripts": {
|
|
18
21
|
"build": "tsup",
|
|
19
22
|
"prepublishOnly": "npm run build"
|
|
@@ -22,6 +25,12 @@
|
|
|
22
25
|
"tsup": "^8.0.0",
|
|
23
26
|
"typescript": "^5.0.0"
|
|
24
27
|
},
|
|
25
|
-
"keywords": [
|
|
28
|
+
"keywords": [
|
|
29
|
+
"mailmask",
|
|
30
|
+
"email",
|
|
31
|
+
"alias",
|
|
32
|
+
"forwarding",
|
|
33
|
+
"sdk"
|
|
34
|
+
],
|
|
26
35
|
"license": "MIT"
|
|
27
36
|
}
|