@beignet/provider-mail-smtp 0.0.21 → 0.0.22
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/CHANGELOG.md +6 -0
- package/README.md +22 -0
- package/package.json +1 -1
package/CHANGELOG.md
CHANGED
package/README.md
CHANGED
|
@@ -40,6 +40,10 @@ Required environment variables:
|
|
|
40
40
|
| `MAIL_PASS` | SMTP password |
|
|
41
41
|
| `MAIL_FROM` | Default sender address |
|
|
42
42
|
|
|
43
|
+
`beignet doctor --strict` checks that installed SMTP mail providers are
|
|
44
|
+
registered in `server/providers.ts` and that all required `MAIL_*` env vars are
|
|
45
|
+
present in app env examples or config.
|
|
46
|
+
|
|
43
47
|
## Use in application code
|
|
44
48
|
|
|
45
49
|
```typescript
|
|
@@ -50,6 +54,12 @@ await ctx.ports.mailer.send({
|
|
|
50
54
|
});
|
|
51
55
|
```
|
|
52
56
|
|
|
57
|
+
The provider contributes:
|
|
58
|
+
|
|
59
|
+
- `ctx.ports.mailer`, the standard Beignet `MailerPort`
|
|
60
|
+
- `ctx.ports.smtp`, an escape hatch with the Nodemailer transporter and default
|
|
61
|
+
sender
|
|
62
|
+
|
|
53
63
|
The same `MailerPort` works with Resend, memory fakes, and other adapters:
|
|
54
64
|
|
|
55
65
|
```typescript
|
|
@@ -94,6 +104,18 @@ When `ctx.ports.devtools` is installed, this provider records `mail.send`,
|
|
|
94
104
|
Delivery failures throw `MailDeliveryError` from `@beignet/core/mail`.
|
|
95
105
|
Startup configuration and connection problems throw during provider setup.
|
|
96
106
|
|
|
107
|
+
## Local and tests
|
|
108
|
+
|
|
109
|
+
Use a memory or fake `MailerPort` in use-case tests. For local SMTP testing,
|
|
110
|
+
point the provider at a local capture service such as Mailpit or MailHog and
|
|
111
|
+
keep those credentials out of production env files.
|
|
112
|
+
|
|
113
|
+
## Deployment notes
|
|
114
|
+
|
|
115
|
+
SMTP delivery semantics depend on the configured server. Treat mail delivery as
|
|
116
|
+
an external side effect: trigger important mail from committed workflow state,
|
|
117
|
+
usually through notifications, jobs, or outbox-backed listeners.
|
|
118
|
+
|
|
97
119
|
## License
|
|
98
120
|
|
|
99
121
|
MIT
|