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.

# Install CLI
npm install -g mailiam

# Get instant form endpoint
mailiam form

# Returns: https://api.mailiam.dev/f/abc123def
# Point your HTML form to this URL immediately!

Use it in your HTML:

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

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

• Email Forwarding: Route *@yourdomain.com to your inbox
• Reply Support: Customers can reply to form emails
• Custom Templates: Professional branded emails
• Spam Protection: Built-in honeypots and validation
• Sub-100ms Speed: Lightning-fast global deployment

Next Steps

• Set up email forwarding
• Create form collections
• Configure custom domains
• View all CLI commands