Getting Started
MX Mail Gateway provides enterprise-grade email routing, filtering, and relay services. This documentation covers the REST API, SMTP configuration, and administration.
Authentication
All API requests require a valid Bearer token. Obtain tokens from the admin dashboard under Settings → API Keys.
Authorization: Bearer <your-api-key>
API Reference
GET /api/v1/status
Returns current system health and queue metrics.
{
"status": "operational",
"queue_size": 12,
"uptime_pct": 99.97,
"version": "4.2.1"
}
POST /api/v1/relay/test
Send a test message through the relay to verify configuration.
{
"from": "test@company.com",
"to": "admin@company.com",
"subject": "Relay test"
}
GET /api/v1/logs
Retrieve delivery logs. Supports pagination via offset and limit query parameters.
SMTP Configuration
Configure your mail client or application to use MX Gateway as the outbound relay:
- Host: Use the gateway hostname assigned to your organization
- Port: 587 (STARTTLS) or 465 (implicit TLS)
- Auth: PLAIN or LOGIN with your service account credentials
FAQ
What is the maximum message size?
The default limit is 25 MB per message, including attachments. Contact support to request a higher limit for your organization.
How often are spam filter rules updated?
Rules are updated automatically every 2 hours from our threat intelligence feed.