1
Create your account
Go to my.ugmail.co and sign up for a UGMail account. The sign-up flow takes under a minute — no credit card required to explore the platform.
2
Retrieve your Bearer token
After signing in, navigate to Settings → API Connection. Copy the Bearer token shown there. Every Management API request you make must include this token in the
Authorization header.Keep this token private. Treat it like a password — anyone who holds it can manage your entire tenant.3
Add a domain
Register the domain you want to use for email. Replace A successful response returns the new domain object including its
YOUR_TOKEN and example.com with your own values.id.4
Fetch DNS records and configure your registrar
Retrieve the DNS records UGMail needs you to publish. These include MX, SPF, and DKIM records.The response lists each record with its type, name, and value. Log in to your domain registrar and add every record exactly as shown.
DNS propagation can take anywhere from a few minutes to 48 hours depending on your registrar and TTL settings. UGMail will begin routing mail for your domain once it detects the records are live. You can re-query the endpoint at any time to check propagation status.
5
Provision a mailbox
Create your first mailbox. Assign it a secure password and one or more email addresses on your domain.The response returns the mailbox object. The mailbox is active immediately — no additional activation step required.
6
Connect via SMTP or IMAP
Use the credentials you just created to connect any email client or application. The server settings are the same for every mailbox on your tenant.
Use
alice@example.com as the username and the password you set in secrets above.What’s next
You now have a working mailbox on your own domain. Here are a few natural next steps:- Add aliases or forwarders — route additional addresses to the same mailbox without creating new credentials.
- Configure DKIM — verify your DKIM record is live to maximise deliverability.
- Automate provisioning — integrate the Management API into your application’s onboarding flow.
- Explore JMAP — if you’re building a custom mail client or AI agent, JMAP gives you a modern, efficient alternative to IMAP.
Authentication
Learn more about Bearer token auth and see Python and Node.js examples.
Set Up a Domain
A deeper walkthrough of domain registration, DNS, and DKIM verification.
Protocols Overview
Full details on all seven supported protocols and their connection settings.
API Reference
Complete endpoint reference for the UGMail Management API.

