Skip to content
EmBoux

Quick Start

This guide walks you through the basics: authenticate, create a domain, add a mailbox, and set up an alias.

Prerequisites

Section titled “Prerequisites”
  • An EmBoux API key (get one from your Odoo portal at /my/emboux/api or from your account manager)
  • curl or any HTTP client

1. Verify your connection

Section titled “1. Verify your connection”
Terminal window
curl https://api.emboux.com/ \
  -H "Authorization: Bearer YOUR_API_KEY"
{"message": "EmBoux Core API is running"}

2. Create a domain

Section titled “2. Create a domain”
Terminal window
curl -X POST https://api.emboux.com/domains/ \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"name": "mycompany.com"}'
{
  "id": 1,
  "name": "mycompany.com",
  "created_at": "2025-01-15T10:30:00"
}

3. Create a mailbox

Section titled “3. Create a mailbox”
Terminal window
curl -X POST https://api.emboux.com/users/ \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "domain_name": "mycompany.com",
    "email": "[email protected]",
    "password": "a-very-secure-password"
  }'
{
  "id": 1,
  "domain_id": 1,
  "email": "[email protected]",
  "created_at": "2025-01-15T10:31:00"
}

The mailbox is immediately active. You can connect with any IMAP/SMTP client using:

SettingValue
IMAP Servermail.emboux.com
IMAP Port993 (SSL)
SMTP Servermail.emboux.com
SMTP Port587 (STARTTLS)
Username[email protected]
PasswordThe password you set

4. Add an alias

Section titled “4. Add an alias”
Terminal window
curl -X POST https://api.emboux.com/aliases/ \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "domain_name": "mycompany.com",
    "source": "[email protected]",
    "destination": "[email protected]"
  }'

Emails sent to [email protected] will now be forwarded to [email protected].

5. Set up a catch-all (optional)

Section titled “5. Set up a catch-all (optional)”
Terminal window
curl -X POST https://api.emboux.com/aliases/ \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "domain_name": "mycompany.com",
    "source": "@mycompany.com",
    "destination": "[email protected]"
  }'

Any email sent to an unmatched address at mycompany.com will land in the hello@ mailbox.

Next Steps

Section titled “Next Steps”