Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.mailbreeze.com/llms.txt

Use this file to discover all available pages before exploring further.

​
Get Your API Key

  1. Sign up at console.mailbreeze.com
  2. Navigate to Settings > API Keys
  3. Click Create API Key
  4. Copy your new key (starts with sk_live_ or sk_test_)
Keep your API key secret. Never commit it to version control or expose it in client-side code.

​
Install an SDK

Choose your preferred language: 
npm install mailbreeze

​
Send Your First Email

import { MailBreeze } from "mailbreeze";

const mailbreeze = new MailBreeze({ apiKey: "sk_live_xxx" });

const result = await mailbreeze.emails.send({
  from: "hello@yourdomain.com",
  to: "user@example.com",
  subject: "Hello from MailBreeze!",
  html: "<p>This is my first email sent via MailBreeze.</p>",
  text: "This is my first email sent via MailBreeze.",
});

console.log("Email sent:", result.id);

​
Test Mode

Use a test API key (starts with sk_test_) to simulate sending without delivering real emails: 
const mailbreeze = new MailBreeze({ apiKey: "sk_test_xxx" });

// Emails are simulated, not delivered
const result = await mailbreeze.emails.send({ ... });
console.log(result.sandbox); // true

​
Verify Your Domain

Before sending from your domain in production, you’ll need to verify it:
  1. Add your domain in the MailBreeze dashboard
  2. Add the DNS records (SPF, DKIM, DMARC)
  3. Click Verify to confirm
Domain verification ensures deliverability and prevents spoofing. Emails from unverified domains will be rejected.

​
Next Steps

Send with Templates

Use pre-built templates with variable substitution

Add Attachments

Upload and attach files to emails

Manage Contacts

Create and organize your audience

Verify Emails

Validate addresses before sending