Menu
Getting Started Email Sending Templates Security
Getting Started
Getting Started Introduction Installation Configuration Quick Start Bulk Sender Requirements API Conventions Scaling out Splitting the roles
API Reference
API Reference
Email Sending
Email Sending Single Email Template Email Batch Email Scheduled Email Signed Mail Attachments Email Status Email Log Email Verification Email Sandbox
Templates
Templates Overview Creating Templates Versioning Localization Languages Stylesheets Preview & Test Import & Export System Variables
Subscribers
Subscribers Subscriber Management Bulk Import Subscriber Lists
Campaigns
Campaigns Overview Sending & Lifecycle A/B Testing
SMTP and Domains
SMTP and Domains SMTP Servers Server Groups Domain Verification Sender Addresses Relay Nodes Running Relay Nodes Amazon SES Bounce Handling SES Notifications
Security
Security Authentication API Keys SMTP Submission Passkeys Two-Factor Authentication Rate Limiting Session Management
Contacts and Suppression
Contacts and Suppression Contact Management Contact Lists Bounce Handling Suppression List Unsubscribe Lists
Tracking and Engagement
Tracking and Engagement Tracking Overview Unsubscribe & One-Click
Webhooks and Events
Webhooks and Events Overview Event Types Delivery Tracking Audit Log
Inbound Email
Inbound Email Overview Receiving Email Managing Inbound Email
Analytics and Monitoring
Analytics and Monitoring Dashboard Stats Email Analytics Prometheus Metrics Health Checks
Projects
Projects Overview Members and Invitations Settings, Plan, and Audit Log
Admin Panel
Admin Panel User Management Platform Settings Platform Metrics Shared SMTP Pool Scheduled Jobs Identity Providers Plans & Quotas Platform Mail Certificates
Data
Data Data Export & Import Data Deletion
GitHub ↗
Section

Getting Started

Standing an instance up: installation, configuration, the first send, the API surfaces, and running more than one node

Introduction
What is Mailyard and why use it
→
Installation
Deploy Mailyard with Docker Compose or build it from source
→
Configuration
Environment variables and configuration options
→
Quick Start
Send your first email with Mailyard in minutes
→
Bulk Sender Requirements
What Gmail, Yahoo, Microsoft and Apple demand of a domain that sends at volume, and which Mailyard feature answers each demand
→
API Conventions
The two API surfaces, how each authenticates, and the response shape
→
Scaling out
Run several nodes against one database, with PostgreSQL as the only coordinator
→
Splitting the roles
Run the API and the delivery worker as separate nodes
→