Quick Start

This guide will get you up and running with mailiam in 30 seconds.

Method 1: Instant Form (Zero Config)

Need a form endpoint immediately? No setup required. Create a live form in 30 seconds.

# Install CLI
npm install -g mailiam

# Create instant form
mailiam instant create --email hello@yourcompany.com --name "Contact Form"

# ✨ Creating your instant form...
# ✅ Instant form created successfully!
#
# Form Endpoint: https://api.mailiam.dev/f/form_abc123def
# Form ID: form_abc123def

mailiam instantly provides ready-to-use HTML:

<form action="https://api.mailiam.dev/f/form_abc123def" method="POST">
  <input type="email" name="email" placeholder="Your email" required>
  <input type="text" name="name" placeholder="Your name">
  <textarea name="message" placeholder="Your message" required></textarea>
  <!-- Anti-spam honeypot (keep hidden) -->
  <input type="text" name="pooh-bear" style="display: none;">
  <button type="submit">Send Message</button>
</form>

That’s it! Your form is live and sending emails. No configuration, no DNS setup, no waiting.

Method 2: Custom Domain Setup

For professional setups with your own domain:

1. Initialize Project

mailiam init mysite.com
cd mysite.com

This creates mailiam.config.yaml:

domains:
  mysite.com:
    forwarding:
      "*@mysite.com": "you@gmail.com"
    forms:
      contact:
        template: "professional"
        replies: true

2. Deploy

mailiam push

3. Use Your Domain

<form action="https://api.mailiam.dev/v1/mysite.com/send" method="POST">
  <input type="email" name="email" placeholder="Email" required>
  <textarea name="message" placeholder="Message" required>
  <button type="submit">Send</button>
</form>

Key Features You Get

Instant Forms: Live in 30 seconds, zero configuration required
Email Forwarding: Route *@yourdomain.com to your inbox with catch-all support
Industry-First Replies: Enable real conversations, no more noreply@ addresses
Magical SRS: Maintain thread continuity even through forwarding
Custom Templates: Professional branded emails with acknowledgments
Spam Protection: Built-in honeypots and validation
Email Retention: Never lose emails - we store them until you’re ready
Lightning Fast: Sub-200ms API responses, < 5 second email delivery