@kumbify/sdk 1.0.6 → 1.0.8
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 +32 -1
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -50,7 +50,7 @@ const sendMail = await mailClient.sendSimpleMail({
|
|
|
50
50
|
},
|
|
51
51
|
});
|
|
52
52
|
|
|
53
|
-
console.log("Email Response:", sendMail);
|
|
53
|
+
console.log("Email Response: ", sendMail);
|
|
54
54
|
```
|
|
55
55
|
|
|
56
56
|
**Parameters explained:**
|
|
@@ -65,6 +65,37 @@ console.log("Email Response:", sendMail);
|
|
|
65
65
|
|
|
66
66
|
---
|
|
67
67
|
|
|
68
|
+
```ts
|
|
69
|
+
// 📤 Send a Template Email
|
|
70
|
+
const sendMail = await mailClient.sendTemplateMail({
|
|
71
|
+
from: "app@example.com",
|
|
72
|
+
to: ["user@example.com"],
|
|
73
|
+
template: {
|
|
74
|
+
name: "my-template-name",
|
|
75
|
+
data: {
|
|
76
|
+
customer: {
|
|
77
|
+
name: "Ricardo Castle",
|
|
78
|
+
email: "doe@gmail.com"
|
|
79
|
+
}
|
|
80
|
+
},
|
|
81
|
+
},
|
|
82
|
+
});
|
|
83
|
+
|
|
84
|
+
console.log("Email Response: ", sendMail);
|
|
85
|
+
|
|
86
|
+
```
|
|
87
|
+
|
|
88
|
+
**Parameters explained:**
|
|
89
|
+
|
|
90
|
+
| Property | Type | Description |
|
|
91
|
+
| --------------- | -------- | ------------------------------------------------------------------------ |
|
|
92
|
+
| `from` | string | Sender email address. Must be a verified domain in your Kumbify account. |
|
|
93
|
+
| `to` | string[] | List of recipient email addresses. |
|
|
94
|
+
| `template.name` | string | Name of the template created in your Kumbify dashboard. |
|
|
95
|
+
| `template.data` | object | Dynamic data that will be injected into the template. |
|
|
96
|
+
|
|
97
|
+
---
|
|
98
|
+
|
|
68
99
|
### SMS — KSMSClient
|
|
69
100
|
|
|
70
101
|
#### 📍 Create an SMS Client
|
package/package.json
CHANGED