Skip to content

Commit fa6ff2f

Browse files
committed
supabase + smtp relay
1 parent 457b500 commit fa6ff2f

File tree

12 files changed

+502
-0
lines changed

12 files changed

+502
-0
lines changed
4.4 KB
Loading

assets/integrations/supabase.png

8.43 KB
Loading
161 KB
Loading
238 KB
Loading
468 KB
Loading
252 KB
Loading
432 KB
Loading

concepts/transactional-api.mdx

Lines changed: 46 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -237,6 +237,52 @@ Send files with your transactional emails such as invoices, receipts, tickets, o
237237
- **Reports**: Attach analytics reports and summaries
238238
- **Certificates**: Attach completion certificates and badges
239239

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:
265+
266+
```json
267+
{
268+
"workspace_id": "your_workspace",
269+
"notification": {
270+
"id": "password_reset",
271+
"external_id": "unique-id-123",
272+
"channels": ["email"],
273+
"contact": {
274+
"email": "[email protected]",
275+
"first_name": "John",
276+
"last_name": "Doe"
277+
},
278+
"data": {
279+
"reset_token": "abc123",
280+
"expiry_time": "1 hour"
281+
}
282+
}
283+
}
284+
```
285+
240286
## Template Integration
241287

242288
### Data Structure in Templates

docs.json

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -40,6 +40,10 @@
4040
"group": "Tutorials",
4141
"pages": ["tutorials/newsletter-form-input"]
4242
},
43+
{
44+
"group": "Integrations",
45+
"pages": ["integrations/supabase"]
46+
},
4347
{
4448
"group": "Email Providers",
4549
"pages": [

index.mdx

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -102,6 +102,21 @@ Notifuse supports multiple email service providers, giving you flexibility and r
102102
</Card>
103103
</CardGroup>
104104

105+
## Platform Integrations
106+
107+
Seamlessly integrate Notifuse with your existing tools and workflows:
108+
109+
<CardGroup cols={3}>
110+
<Card title="Supabase" href="/integrations/supabase">
111+
<img
112+
src="/assets/integrations/supabase.png"
113+
alt="Supabase"
114+
className="w-full h-6 object-contain my-6"
115+
/>
116+
Auth emails and user sync integration
117+
</Card>
118+
</CardGroup>
119+
105120
## Getting Started
106121

107122
<CardGroup cols={2}>

0 commit comments

Comments
 (0)