Quick Start Guide

Get up and running in 5 minutes

This guide will walk you through setting up your first Mailpipe project, configuring your domain, and making your first API call.

Prerequisites

Mailpipe Account

Sign up at mailpipe.dev if you haven't already

Domain Access

Access to your domain's DNS settings

1

Create Your Account

Sign up for a Mailpipe account to access the dashboard and API. You can sign in with Google or create an account with email.

Create AccountSign In
2

Add Your Domain

Navigate to Domain Settings

From your dashboard, go to Settings → Domains and click "Add Domain".

Open Domain Settings

Configure DNS Records

After adding your domain, you'll need to configure DNS records. Add the following MX record to receive email:

MX Record
Type: MX
Host: @ (or your subdomain)
Priority: 10
Value: mx.mailpipe.dev

DNS changes can take up to 48 hours to propagate, but usually complete within a few minutes.

3

Create a Mailbox

Create a mailbox to start receiving email. A mailbox is an email address associated with your domain (e.g., hello@yourdomain.com).

  1. Go to your Inbox in the dashboard
  2. Click the + button or "Create Mailbox"
  3. Enter the email address (e.g., support, hello, info)
  4. Select your verified domain from the dropdown
  5. Click "Create" to finish
Create Your First Mailbox
4

Generate an API Key

API keys authenticate your requests to the Mailpipe API. Generate one from your dashboard settings.

  1. Navigate to Settings → API Keys
  2. Click "Create New Key"
  3. Give your key a descriptive name
  4. Select the permission scopes you need
  5. Copy and securely store your key - it won't be shown again!

Keep your API key secure

Never commit API keys to version control. Use environment variables instead.

Generate API Key
5

Make Your First API Call

Test your setup by making an API call to list your mailboxes:

cURL
curl -X GET "https://api.mailpipe.dev/v1/mailboxes" \
  -H "Authorization: Bearer mp_live_your-api-key-here" \
  -H "Content-Type: application/json"

Or using the Node.js SDK:

Node.js
const { MailpipeClient } = require('@mailpipe/sdk');

const client = new MailpipeClient({
  apiKey: process.env.MAILPIPE_API_KEY,
});

// List all mailboxes
const mailboxes = await client.mailboxes.list();
console.log(mailboxes);

Next Steps

API Reference

Explore all available endpoints and parameters

MCP Server

Connect Claude to manage your email with AI

Webhooks

Receive real-time notifications for email events

SDKs

Client libraries for Node.js, Python, Go, and more

Need Help Getting Started?

Our team is here to help you set up your email infrastructure. Reach out if you have any questions.

Contact Support