Documentation

Comprehensive guides and API documentation to help you get the most out of XMail.

Getting Started

Welcome to XMail! This guide will help you get up and running with your email server in minutes.

Prerequisites

  • Linux server (Ubuntu 20.04+ recommended)
  • Minimum 2GB RAM
  • 10GB available disk space
  • Domain name with DNS access

Quick Installation

# Download and install XMail
curl -fsSL https://xmail.com/install.sh | bash

# Configure your domain
xmail configure domain=yourdomain.com

# Start the service
sudo systemctl start xmail

Webmail Interface

XMail provides a modern, responsive webmail interface that works on all devices.

Key Features

  • Modern, intuitive interface
  • Real-time email synchronization
  • Advanced search and filtering
  • Email composition with rich text editor
  • File attachment support
  • Mobile-responsive design

API Reference

XMail provides a comprehensive REST API for integration with your applications.

Authentication

All API requests require authentication using API keys or OAuth 2.0.

curl -H "Authorization: Bearer YOUR_API_KEY" \
    https://api.xmail.com/v1/emails

Common Endpoints

GET /v1/emails

List emails

POST /v1/emails

Send email

GET /v1/users

List users

POST /v1/users

Create user