You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: concepts/transactional-api.mdx
+46Lines changed: 46 additions & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -237,6 +237,52 @@ Send files with your transactional emails such as invoices, receipts, tickets, o
237
237
-**Reports**: Attach analytics reports and summaries
238
238
-**Certificates**: Attach completion certificates and badges
239
239
240
+
## SMTP Relay
241
+
242
+
Notifuse includes a built-in SMTP relay server that allows you to send transactional emails using standard SMTP clients instead of HTTP API calls. This is particularly useful when:
243
+
244
+
-**Legacy Systems**: Integrating with existing applications that only support SMTP
245
+
-**Email Libraries**: Using standard email libraries in any programming language
246
+
-**Framework Integration**: Working with frameworks that have built-in SMTP support
247
+
-**Gradual Migration**: Moving from existing email providers without changing application code
248
+
249
+
### How It Works
250
+
251
+
The SMTP relay server accepts emails via SMTP with TLS encryption on port 587. The email body must contain a JSON payload matching the Transactional API format. Authentication is done using your workspace API credentials.
252
+
253
+
### Sending Emails via SMTP
254
+
255
+
#### Authentication
256
+
257
+
-**Username**: Your workspace API email (the email associated with your API key)
258
+
-**Password**: Your workspace API key
259
+
-**Security**: STARTTLS (port 587)
260
+
-**Server**: Your configured SMTP relay host (e.g., `smtp.yourdomain.com`)
261
+
262
+
#### Email Format
263
+
264
+
The email body must be a JSON payload matching the Transactional API format:
0 commit comments