Skip to main content
IMAP (Internet Message Access Protocol) is the standard protocol for reading and organizing email while keeping messages stored on the server. Unlike POP3, IMAP keeps your client and mailbox in sync — actions you take in one client (reading, moving, deleting, flagging) are reflected everywhere else. Use IMAP when you need live access to a mailbox from multiple devices, a desktop email client, or a custom application that monitors incoming messages.

Connection settings

Configure your IMAP client with the following details:

Authentication

Use your mailbox’s full email address as the username (e.g. alice@example.com) and the password you set via the secrets field in the Management API as the password. The same credentials work across IMAP, SMTP, POP3, and all other UGMail protocols.

Compatible email clients

UGMail’s IMAP server is compatible with any standards-compliant email client, including:
  • Mozilla Thunderbird (Windows, macOS, Linux)
  • Apple Mail (macOS, iOS)
  • Microsoft Outlook (Windows, macOS)
  • Gmail app (iOS, Android — via “Add other account”)
  • mutt / neomutt (terminal)
  • K-9 Mail (Android)
  • Spark, Airmail, Canary Mail, and other third-party clients

Configuring an email client

The exact steps differ by client, but the following sequence applies to virtually every IMAP-capable application.
1

Open account settings

In your email client, navigate to Settings (or Preferences) and choose Add Account or Add Mail Account.
2

Enter your account details

Provide your name, your full mailbox email address, and your mailbox password when prompted.
3

Choose manual / custom setup

If your client offers automatic configuration, skip it and select Manual setup or Custom so you can enter the UGMail server details directly.
4

Enter incoming server settings

Set the incoming mail server to mail.ugmail.co, port 993, with SSL/TLS encryption.
5

Enter outgoing server settings

Set the outgoing (SMTP) server to mail.ugmail.co, port 587, with STARTTLS encryption. Use the same email address and password for SMTP authentication.
6

Save and verify

Save the account. Your client will connect and begin syncing your inbox. If the connection fails, double-check the server address, port, security type, and credentials.

Code example

Use Python’s built-in imaplib to connect programmatically, search your inbox, and read messages.
Python (imaplib)
The imap.search(None, 'ALL') call returns the IDs of every message in the selected folder. You can replace 'ALL' with any valid IMAP search criterion — for example, 'UNSEEN' to fetch only unread messages, or 'FROM "sender@example.com"' to filter by sender.

Troubleshooting

If you see an AUTHENTICATE failed error, confirm that your username is the full email address (not just the local part before the @) and that the password matches what you set in the secrets field of the Management API exactly.
Last modified on July 17, 2026