@antelopejs/interface-dms-mailing 0.5.0 → 0.7.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 CHANGED
@@ -35,6 +35,15 @@ await RecordEmailEvent(tenantId, {
35
35
  });
36
36
  ```
37
37
 
38
+ A template whose footer links to an unsubscribe or a preferences page
39
+ expects `unsubscribeUrl` / `preferencesUrl` in `variables` (required for the
40
+ `marketing` category); a link without its URL is left out of the e-mail.
41
+
42
+ A recipient on the workspace's suppression list (a hard bounce, a spam
43
+ complaint, an unsubscription or a manual entry) gets no e-mail: its result
44
+ has the status `suppressed`. A hard `bounced`, a `spam` or an `unsubscribed`
45
+ event recorded through `RecordEmailEvent` puts the address on that list.
46
+
38
47
  Declaring this package as a dependency is what wires a consumer to whichever
39
48
  module implements the interface; the implementation lives in
40
49
  `@antelopejs/dms-mailing` and is documented
package/dist/index.d.ts CHANGED
@@ -103,6 +103,6 @@ export interface EmailEvent {
103
103
  details?: Record<string, unknown>;
104
104
  }
105
105
  export type SendEventType = "queued" | "sent" | "delivered" | "opened" | "clicked" | "bounced" | "spam" | "failed" | "unsubscribed";
106
- export type SendStatus = "queued" | "sent" | "delivered" | "opened" | "clicked" | "bounced" | "spam" | "failed" | "unsubscribed";
106
+ export type SendStatus = SendEventType | "suppressed";
107
107
  export declare const SendTemplate: (slug: string, params: SendTemplateParams) => Promise<SendTemplateResult>;
108
108
  export declare const RecordEmailEvent: (tenantId: string, event: EmailEvent) => Promise<boolean>;
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@antelopejs/interface-dms-mailing",
3
- "version": "0.5.0",
3
+ "version": "0.7.0",
4
4
  "description": "AntelopeJS interface for DMS mailing",
5
5
  "license": "Apache-2.0",
6
6
  "repository": {
@@ -45,7 +45,7 @@
45
45
  "@antelopejs/interface-email": ">=0.0.5 <1.0.0"
46
46
  },
47
47
  "devDependencies": {
48
- "@antelopejs/tooling-configs": ">=0.0.6 <1.0.0",
48
+ "@antelopejs/tooling-configs": ">=0.0.7 <1.0.0",
49
49
  "@types/node": "^24.0.0",
50
50
  "oxfmt": "^0.66.0",
51
51
  "oxlint": "1.81.0",