outlook
Email IMAP/SMTP setup instructions and the GoAdmio FTP download link to one mailbox, one domain's mailboxes, or every mailbox
- Command:
/go/outlook - Category: Mail
- Required option: An email address, or
all - Output: No screen output; two emails per mailbox
- Last updated: 2026-11-21
On this page: Overview · Quick start · Syntax · Options · Output · Examples · Troubleshooting · Details · See also
Overview
/go/outlook emails mail-client setup details to your mailboxes, so people can configure Outlook or any other mail app. Each mailbox receives two messages:
- IMAP Configuration: the incoming (IMAP) and outgoing (SMTP) server hostnames, ports, and encryption
- Download GoAdmio FTP: a link to download the GoAdmio FTP client
The connection details depend on which SSL certificates exist on the server (see Which settings the email contains). You can send to a single mailbox, to every mailbox of one domain, or to every mailbox on the server.
The command runs sudo internally, so run it as root or as a user with sudo rights. It needs mailx, dig, curl, and sqlite3.
Quick start
# Send the setup emails to one mailbox
/go/outlook info@example.com example.com
Syntax
# One mailbox
/go/outlook <email> <domain>
# Every mailbox of one domain
/go/outlook all <domain>
# Every mailbox on the server
/go/outlook all
| Form | Behavior |
|---|---|
/go/outlook <email> <domain> |
Sends both emails to that one address. |
/go/outlook all <domain> |
Sends both emails to every mailbox of that domain. |
/go/outlook all |
Sends both emails to every mailbox on the server. |
Every run is recorded in /var/log/go/outlook.log, with the time and the arguments you passed.
Options
The command takes positional arguments and has no -- options.
| Argument | Required | Default | Notes |
|---|---|---|---|
email |
Yes | — | A mailbox address, or all for every mailbox. |
domain |
See notes | — | With a single address, pass the mailbox's domain: it is used to build the hostnames in the email. With all, it limits the send to that domain. |
[!WARNING] With a single address,
domainis not taken from the address. If you leave it out, the email can contain incomplete hostnames such asimap.andsmtp.. Always pass the domain with a single address.
Output
The command prints nothing when it works. It doesn't report how many emails were sent or whether delivery succeeded.
| Outcome | What you get |
|---|---|
| Emails handed to the mail system | Nothing printed. Each recipient gets two messages. |
| Server hostname has fewer than 2 dots | OUTLOOK:Invalid Server Hostname, A hostname should consist of a name and a domain name. All valid hostnames should have 2 dots in them. Exit status 1. Nothing is sent. |
The emails
Each mailbox receives these two messages, sent from GoAdmio<goadmio@...> (see The sender address):
| Subject | Content |
|---|---|
IMAP Configuration (<email>) |
The IMAP and SMTP settings, with a contact line. |
Download GoAdmio FTP |
A short description and a download link for the GoAdmio FTP client (Go-FTP.exe). |
Example IMAP message when SSL is installed for the domain:
Incoming Mail Server (IMAP):
Account Type: IMAP
Hostname: imap.example.com
PORT: 993
Encryption: SSL
Outgoing Mail Server (SMTP):
Hostname: smtp.example.com
PORT: 465
Encryption: SSL
Log
Each run appends one line to /var/log/go/outlook.log:
[Nov 21 12:00:00]# outlook info@example.com example.com
Examples
# One mailbox
/go/outlook info@example.com example.com
# Every mailbox of one domain
/go/outlook all example.com
# Every mailbox on the server
/go/outlook all
# Check that the messages were sent (sent from goadmio@..., so check the mail log)
grep 'IMAP Configuration' /var/log/maillog | tail
Troubleshooting
| Symptom | Likely cause | Fix |
|---|---|---|
OUTLOOK:Invalid Server Hostname ... |
The server hostname has fewer than 2 dots (for example example.com). |
Set a full hostname such as server.example.com with hostname, then run again. |
The email shows imap. or smtp. with no domain |
A single address was given without a domain. | Run again and pass the domain after the address. |
| The email shows port 143 or 25 with no encryption | No SSL certificate exists for smtp.<domain> or for the server hostname. |
Install the certificates with mailssl, then send the emails again. |
The email shows the server hostname instead of imap.<domain> |
No certificate exists for smtp.<domain>, but one exists for the server hostname. |
Install the domain's certificate with mailssl if you want domain-specific names. |
| Nothing is received | The mail system accepted the messages but could not deliver them, or they were filed as spam. | Check the mail log and the mail queue. See troubleshoot. |
mailx: command not found |
The mailx package isn't installed. |
Install mailx (or s-nail / mailutils, depending on the system). |
all sent nothing |
The mail database has no mailboxes for that domain. | Check the domain name, or create the mailboxes with mail. |
Details
Which settings the email contains
The command checks which certificates are installed in /etc/letsencrypt/live/ and uses the first match. For all, this is checked for each mailbox using that mailbox's own domain.
| Check | IMAP | SMTP |
|---|---|---|
A certificate exists for smtp.<domain> |
imap.<domain>, port 993, SSL |
smtp.<domain>, port 465, SSL |
| Otherwise, a certificate exists for the server hostname | The contents of /etc/imap (the server hostname unless you changed it), port 993, SSL |
The server hostname, port 465, SSL |
| Otherwise | imap.<domain>, port 143, no encryption |
smtp.<domain>, port 25, no encryption |
If /etc/imap doesn't exist, the command creates it and writes the server hostname into it.
The sender address
The emails come from a goadmio@ address. The domain part depends on DNS.
| Check | Sender |
|---|---|
The server hostname's parent domain (for example example.com from server.example.com) resolves to this server's public IP |
goadmio@<parent domain> |
| Otherwise | goadmio@<server hostname> |
The server's public IP is looked up from checkip.amazonaws.com, so the server needs outbound internet access.
Sending to every mailbox
With all, the command lists the addresses from GoAdmio's mail database (optionally for one domain), then sends both emails to each address, one mailbox at a time. A domain with 500 mailboxes therefore sends 1,000 emails. There is no progress output, and running the command twice sends everything twice.
flowchart TD
A["outlook email [domain]"] --> B["Log the run"]
B --> C{"Hostname has 2 or more dots?"}
C -- "No" --> X["Error, exit 1"]
C -- "Yes" --> D["Choose the sender address from DNS"]
D --> E{"First argument is all?"}
E -- "Yes" --> F["List mailboxes from the mail database"]
F --> G["For each mailbox: choose settings by its domain, send both emails"]
E -- "No" --> H["Choose settings by the given domain, send both emails"]
See also
| Command | Description |
|---|---|
mail |
Create an email address in GoAdmio via the command line |
mailpwd |
Bulk-change passwords for all email accounts of a single domain |
mailssl |
Install SSL certificates for SMTP and IMAP |
checkimap |
Check the IMAP hostname, its DNS record, and the SSL certificate on port 993 |
hostname |
Change the server hostname and set up GoAdmio, mail, and SSL for it |
troubleshoot |
Troubleshoot email problems in GoAdmio |