Email Setup Guide

​

Prerequisites

1. Go to Sender Profiles in the dashboard
2. Click New Sender and give it a name
3. Once created, click on the sender to open its settings

​

Sandbox Email (Quick Start)

1

Open your sender profile

Go to Sender Profiles and click on the sender you want to configure.

2

Go to the Channels tab

Click the Channels tab in the sender detail page.

3

Add Email channel and activate Sandbox

Click the Email channel card to open the email configuration dialog. The dialog opens on the Sandbox (Free) tab by default. Click Activate Sandbox Email to create your sandbox domain.

4

Configure your from address

Once the sandbox domain is created, configure:

• From Email Address: The local part before @ (e.g., noreply)
• From Name: The display name recipients see (e.g., Your Company)
• Reply-To Email (optional): Where replies go
• Enable Email Receiving: Toggle this on if you want to receive inbound emails on this address

5

Save

Click Save to enable the email channel on your sender.

​

Send a Test Email

import Zavu from "@zavudev/sdk";

const zavu = new Zavu({ apiKey: process.env.ZAVU_API_KEY });

const result = await zavu.messages.send({
  to: "recipient@example.com",
  channel: "email",
  subject: "Test from Zavu Sandbox",
  text: "If you see this, your sandbox email is working!",
});

console.log("Message ID:", result.message.id);
console.log("Status:", result.message.status);

​

Sandbox vs Custom Domain

​

Custom Domain Email

1

Open the Email channel dialog

Go to Sender Profiles > your sender > Channels tab > click the Email card.

2

Switch to Custom Domain tab

Click the Custom Domain tab at the top of the dialog.

3

Add your domain

Select Add new domain from the dropdown and enter your domain (e.g., yourcompany.com).

4

Configure DKIM records

Zavu displays the DKIM CNAME records you need to add to your DNS. Copy each record and add them to your DNS provider:The records look like:

Copy

selector1._domainkey.yourcompany.com  CNAME  selector1.dkim.zavu.dev
selector2._domainkey.yourcompany.com  CNAME  selector2.dkim.zavu.dev
selector3._domainkey.yourcompany.com  CNAME  selector3.dkim.zavu.dev

DNS propagation typically takes a few minutes, but can take up to 72 hours. Use the copy buttons next to each record to avoid typos.

5

Verify DNS

Click Verify DNS to check if your records have propagated. Once verified, the domain status changes to Verified and the from address fields appear.

6

Configure from address

Set your:

• From Email Address: e.g., noreply
• From Name: e.g., Your Company
• Reply-To Email (optional): e.g., support@yourcompany.com

7

Save

Click Save to enable the email channel with your custom domain.

​

Receiving Emails

​

For Custom Domains: Add MX Record

yourcompany.com  MX  10  inbound.zavu.dev

​

For Sandbox Domains

​

Set Up Webhook for Inbound Emails

1. Go to your sender > Webhooks tab
2. Add your webhook URL and subscribe to the message.inbound event

await zavu.senders.update({
  senderId: "sender_abc123",
  webhookUrl: "https://api.yourcompany.com/webhooks/zavu",
  webhookEvents: ["message.inbound"],
});

{
  "id": "evt_1736850000000_abc123",
  "type": "message.inbound",
  "timestamp": 1736850000000,
  "senderId": "sender_abc123",
  "projectId": "proj_xyz789",
  "data": {
    "messageId": "msg_def456",
    "to": "support@yourcompany.com",
    "from": "customer@gmail.com",
    "channel": "email",
    "status": "received",
    "subject": "Question about my order",
    "text": "Hi, I have a question about order #12345..."
  }
}

​

Testing Your Setup

​

Verify Sending

1. Send a test email using the code examples above
2. Check the message status in Messages in the dashboard
3. Verify the email arrived in the recipient’s inbox

​

Verify Receiving

1. Send an email to your configured address (e.g., support@yourcompany.com)
2. Check your webhook endpoint received the message.inbound event
3. Verify the inbound message appears in the dashboard under Messages

​

Common Issues

​

Next Steps

• Sending Emails - API reference for email messages
• Webhooks - Set up webhooks for delivery events
• Email Health - Monitor bounce rates and deliverability