mailchannels-sdk 0.7.1 → 0.7.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/dist/mailchannels.d.mts +16 -1
- package/dist/mailchannels.d.ts +16 -1
- package/dist/mailchannels.mjs +1 -0
- package/package.json +7 -7
package/dist/mailchannels.d.mts
CHANGED
|
@@ -54,7 +54,7 @@ interface EmailsSendRecipient {
|
|
|
54
54
|
*/
|
|
55
55
|
email: string;
|
|
56
56
|
/**
|
|
57
|
-
* The name of the recipient.
|
|
57
|
+
* The name of the recipient. Display name in raw text, e.g. John Doe, 张三.
|
|
58
58
|
*/
|
|
59
59
|
name?: string;
|
|
60
60
|
}
|
|
@@ -147,6 +147,16 @@ interface EmailsSendOptionsBase {
|
|
|
147
147
|
*/
|
|
148
148
|
selector: string;
|
|
149
149
|
};
|
|
150
|
+
/**
|
|
151
|
+
* Optional envelope sender address. If not set, the envelope sender defaults to the `from.email` field. Can be overridden per-personalization. Only the email portion is used; the name field is ignored.
|
|
152
|
+
* @example
|
|
153
|
+
* { email: 'email@example.com', name: 'Example' }
|
|
154
|
+
* @example
|
|
155
|
+
* 'email@example.com'
|
|
156
|
+
* @example
|
|
157
|
+
* 'Name <email@example.com>'
|
|
158
|
+
*/
|
|
159
|
+
envelopeFrom?: EmailsSendRecipient | string;
|
|
150
160
|
/**
|
|
151
161
|
* The sender of the email. Can be a string or an object with email and name properties.
|
|
152
162
|
* @example
|
|
@@ -185,6 +195,11 @@ interface EmailsSendOptionsBase {
|
|
|
185
195
|
to: EmailsSendRecipient[] | EmailsSendRecipient | string[] | string;
|
|
186
196
|
/**
|
|
187
197
|
* Adjust open and click tracking for the message. Please note that enabling tracking for your messages requires a subscription that supports open and click tracking.
|
|
198
|
+
*
|
|
199
|
+
* Only links (`<a>` tags) meeting all of the following conditions are processed for click tracking:
|
|
200
|
+
* - The URL is non-empty.
|
|
201
|
+
* - The URL starts with `http` or `https`.
|
|
202
|
+
* - The link does not have a `clicktracking` attribute set to `off`.
|
|
188
203
|
*/
|
|
189
204
|
tracking?: EmailsSendTracking;
|
|
190
205
|
/**
|
package/dist/mailchannels.d.ts
CHANGED
|
@@ -54,7 +54,7 @@ interface EmailsSendRecipient {
|
|
|
54
54
|
*/
|
|
55
55
|
email: string;
|
|
56
56
|
/**
|
|
57
|
-
* The name of the recipient.
|
|
57
|
+
* The name of the recipient. Display name in raw text, e.g. John Doe, 张三.
|
|
58
58
|
*/
|
|
59
59
|
name?: string;
|
|
60
60
|
}
|
|
@@ -147,6 +147,16 @@ interface EmailsSendOptionsBase {
|
|
|
147
147
|
*/
|
|
148
148
|
selector: string;
|
|
149
149
|
};
|
|
150
|
+
/**
|
|
151
|
+
* Optional envelope sender address. If not set, the envelope sender defaults to the `from.email` field. Can be overridden per-personalization. Only the email portion is used; the name field is ignored.
|
|
152
|
+
* @example
|
|
153
|
+
* { email: 'email@example.com', name: 'Example' }
|
|
154
|
+
* @example
|
|
155
|
+
* 'email@example.com'
|
|
156
|
+
* @example
|
|
157
|
+
* 'Name <email@example.com>'
|
|
158
|
+
*/
|
|
159
|
+
envelopeFrom?: EmailsSendRecipient | string;
|
|
150
160
|
/**
|
|
151
161
|
* The sender of the email. Can be a string or an object with email and name properties.
|
|
152
162
|
* @example
|
|
@@ -185,6 +195,11 @@ interface EmailsSendOptionsBase {
|
|
|
185
195
|
to: EmailsSendRecipient[] | EmailsSendRecipient | string[] | string;
|
|
186
196
|
/**
|
|
187
197
|
* Adjust open and click tracking for the message. Please note that enabling tracking for your messages requires a subscription that supports open and click tracking.
|
|
198
|
+
*
|
|
199
|
+
* Only links (`<a>` tags) meeting all of the following conditions are processed for click tracking:
|
|
200
|
+
* - The URL is non-empty.
|
|
201
|
+
* - The URL starts with `http` or `https`.
|
|
202
|
+
* - The link does not have a `clicktracking` attribute set to `off`.
|
|
188
203
|
*/
|
|
189
204
|
tracking?: EmailsSendTracking;
|
|
190
205
|
/**
|
package/dist/mailchannels.mjs
CHANGED
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "mailchannels-sdk",
|
|
3
|
-
"version": "0.7.
|
|
3
|
+
"version": "0.7.2",
|
|
4
4
|
"description": "Node.js SDK to integrate MailChannels API into your JavaScript or TypeScript server-side applications.",
|
|
5
5
|
"type": "module",
|
|
6
6
|
"license": "MIT",
|
|
@@ -38,12 +38,12 @@
|
|
|
38
38
|
},
|
|
39
39
|
"devDependencies": {
|
|
40
40
|
"@eslint/compat": "^2.0.1",
|
|
41
|
-
"@stylistic/eslint-plugin": "^5.7.
|
|
41
|
+
"@stylistic/eslint-plugin": "^5.7.1",
|
|
42
42
|
"@types/markdown-it": "^14.1.2",
|
|
43
|
-
"@types/node": "^25.0.
|
|
44
|
-
"@typescript-eslint/eslint-plugin": "^8.
|
|
45
|
-
"@typescript-eslint/parser": "^8.
|
|
46
|
-
"@vitest/coverage-v8": "^4.0.
|
|
43
|
+
"@types/node": "^25.0.10",
|
|
44
|
+
"@typescript-eslint/eslint-plugin": "^8.54.0",
|
|
45
|
+
"@typescript-eslint/parser": "^8.54.0",
|
|
46
|
+
"@vitest/coverage-v8": "^4.0.18",
|
|
47
47
|
"changelogen": "^0.6.2",
|
|
48
48
|
"eslint": "^9.39.2",
|
|
49
49
|
"eslint-plugin-import-x": "^4.16.1",
|
|
@@ -54,7 +54,7 @@
|
|
|
54
54
|
"vitepress": "^v2.0.0-alpha.15",
|
|
55
55
|
"vitepress-plugin-group-icons": "^1.7.1",
|
|
56
56
|
"vitepress-plugin-llms": "^1.10.0",
|
|
57
|
-
"vitest": "^4.0.
|
|
57
|
+
"vitest": "^4.0.18"
|
|
58
58
|
},
|
|
59
59
|
"scripts": {
|
|
60
60
|
"build": "unbuild",
|