Sending Emails

Email is ideal for rich content delivery, transactional notifications, and messages that need to be referenced later.

When to Use Email

• Transactional emails: Order confirmations, receipts, shipping updates
• Account notifications: Password resets, security alerts, welcome emails
• Rich content: HTML formatting, images, detailed information
• File attachments: Invoices, receipts, reports, documents (up to 40MB)
• Asynchronous communication: Messages that don't require immediate attention

Sending an Email

TypeScriptcURLCopy
const result = await zavu.messages.send({
  to: "user@example.com",
  channel: "email",
  subject: "Your order has shipped",
  text: "Hi John, your order #12345 has shipped and will arrive in 2-3 business days."
});

HTML Emails

Send rich HTML emails by including htmlBody. The text field serves as the plain-text fallback:

TypeScriptcURLCopy
const result = await zavu.messages.send({
  to: "user@example.com",
  channel: "email",
  subject: "Welcome to Zavu",
  text: "Welcome to Zavu! We are excited to have you on board.",
  htmlBody: `
    <h2>Welcome to Zavu!</h2>
    <p>We are excited to have you on board.</p>
    <a href="https://dashboard.zavu.dev">Get Started</a>
  `,
  replyTo: "support@yourcompany.com"
});

Attachments

Send files by including the attachments array. Each attachment can provide file content as base64 or a URL to fetch from.

Base64 Content

TypeScriptcURLCopy
const fs = require("fs");
const content = fs.readFileSync("invoice.pdf").toString("base64");

const result = await zavu.messages.send({
  to: "user@example.com",
  channel: "email",
  subject: "Your invoice",
  text: "Please find your invoice attached.",
  attachments: [
    {
      filename: "invoice.pdf",
      content: content,
      content_type: "application/pdf",
    },
  ],
});

URL Path

Instead of encoding the file, provide a URL and Zavu will fetch it:

TypeScriptcURLCopy
const result = await zavu.messages.send({
  to: "user@example.com",
  channel: "email",
  subject: "Your report",
  text: "Please find your report attached.",
  attachments: [
    {
      filename: "report.pdf",
      path: "https://your-server.com/reports/report.pdf",
    },
  ],
});

Inline Images

Embed images directly in HTML using content_id:

TypeScriptcURLCopy
const result = await zavu.messages.send({
  to: "user@example.com",
  channel: "email",
  subject: "Your weekly report",
  text: "See your weekly report.",
  htmlBody: `
    <h2>Weekly Report</h2>
    <img src="cid:chart" alt="Performance chart" />
    <p>Your performance improved 15% this week.</p>
  `,
  attachments: [
    {
      filename: "chart.png",
      path: "https://your-server.com/charts/weekly.png",
      content_type: "image/png",
      content_id: "chart",
    },
  ],
});

Attachment Fields

Request Fields

Channel Detection

If you send to an email address without specifying a channel, Zavu automatically selects email:

TypeScriptcURLCopy
const result = await zavu.messages.send({
  to: "user@example.com",
  subject: "Hello",
  text: "This will be sent as email automatically"
});

Setting Up Email

Before sending emails, you need to configure your sender with a verified domain.

1. Add Your Domain

Go to Email Domains in the dashboard and add your domain (e.g., yourcompany.com).

2. Configure DNS

Add the DKIM records provided by Zavu to your DNS:

CodeCopy
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

3. Verify Domain

Zavu automatically checks your DNS records every 5 minutes. Once verified, your domain status will change to verified.

4. Assign to Sender

Assign the verified domain to a sender and configure your from address:

• From address: noreply@yourcompany.com
• Reply-To address: support@yourcompany.com (optional)

Delivery Status

Check message status by ID:

TypeScriptcURLCopy
const result = await zavu.messages.retrieve({ messageId: "msg_abc123" });
console.log("Status:", result.message.status);

Common Errors

Email vs SMS/WhatsApp

Best Practices

1. Always include plain text - Some email clients only show plain text
2. Use a verified domain - Improves deliverability and avoids spam filters
3. Set Reply-To - Make it easy for recipients to respond
4. Keep subjects clear - Descriptive subjects improve open rates
5. Test before sending - Preview HTML emails in multiple clients
6. Respect unsubscribes - Honor opt-out requests promptly

Compliance

Requirements

• Consent: Have permission before sending marketing emails
• Unsubscribe: Include a working unsubscribe link
• Sender identification: Clearly identify your business
• Physical address: Include your business address (for marketing emails)
• Honest subject lines: Don't use deceptive subject lines

Example Compliant Email

HTMLCopy
<h2>Your Order Has Shipped!</h2>
<p>Hi John, your order #12345 has shipped.</p>
<p>Track your package: <a href="https://track.co/abc">View Tracking</a></p>

<hr>
<p style="font-size: 12px; color: #666;">
  YourCompany, Inc. | 123 Main St, San Francisco, CA 94102<br>
  <a href="https://yourcompany.com/unsubscribe">Unsubscribe</a>
</p>