Quickstart
Build Airpost, add a mail account, and learn the basics of reading, searching, scheduling and sending.
This page takes you from a fresh checkout to reading, searching and sending mail, and shows where the same actions live outside the desktop app.
There is no published release yet, so step one is building from source. Once releases exist, Install will list the download and Homebrew options.
Set up
Build and run the app
You need the Node version in .node-version, Rust (pinned by rust-toolchain.toml), Python 3 and a C/C++ toolchain.
git clone https://github.com/airpost-mail/airpost.git
cd airpost
make setup # npm ci, Python deps, debug Rust builds
make desktop # runs the app on a sandbox profile in .dev/profile
make desktop uses a sandbox profile, so it never touches a real Airpost profile. To try things without a real account, make mail starts fake IMAP and SMTP accounts you can connect to. Building from source covers the rest.
Pick a layout and shortcut set
On first launch Airpost asks for a layout (a single panel like Gmail, or two panels with a reading pane) and a shortcut set (Gmail, Outlook, Apple Mail or Inbox by Gmail). Change them later in Preferences > Appearance and Preferences > Shortcuts.
Connect an email account
On Connect an email account, choose your provider:
| Provider | How you sign in |
|---|---|
| Gmail or G Suite, Office 365, Outlook.com / Hotmail | A sign-in page opens in your browser (OAuth) |
| Yahoo, iCloud, FastMail, GMX, Yandex | Your email address and an app password |
| IMAP / SMTP | Server settings for any other provider |
The engine stores the credentials, not the desktop app. Accounts has the details for each provider.
If you used Mailspring on this computer, the screen offers to import that profile. You can also do it later from Preferences > Accounts > Import from Mailspring.
Wait for the first sync
Mail starts syncing right away. Search runs against the local copy, so it covers what has synced so far. Sync explains how the engine fetches and keeps folders up to date.
Read, reply and send
- Press
mod+n(Cmd on macOS, Ctrl on Linux) for a new message, andmod+enterto send. - After you click Send you have 5 seconds to undo it. Change the delay in Preferences > Composing & sending > Undo Send.
- Archive, trash, star and mark read from the toolbar or the keyboard. The keys depend on your shortcut set; Keyboard shortcuts lists them.
- Signatures and templates are in Preferences > Signatures and Preferences > Templates. See Templates and signatures.
Search
Click the search bar (or press / with the Gmail shortcut set) and try:
from:alice has:attachment
in:inbox is:unread after:yesterday
subject:invoice (from:billing OR from:accounts) NOT in:trash
Words match as prefixes, "quoted phrases" match exactly, after: includes the day and before: excludes it. Searches run against the engine’s local index. Search lists every operator.
Snooze, send later and remind
- Snooze a thread to take it out of the inbox until a time you pick.
- Send later from the arrow next to Send.
- Send reminders bring a thread back to the top of the inbox if nobody has replied by a time.
The engine runs all three, so they still happen while the app is closed, as long as the engine is running. See Scheduling and Keep the engine running.
Do the same from a terminal
The desktop app bundles the airpost command. Turn on the link in Preferences > General to put it on your PATH, then:
airpost status # engines and account state
airpost search 'from:alice has:attachment' # same grammar as the search bar
airpost show <thread-id> # a thread and its messages
airpost snooze <thread-id> --until tomorrow # same as the snooze menu
airpost remind <message-id> --in 3d # a send reminder
airpost undo # take back airpost's last change
Add --json to any command for machine-readable output. CLI overview and Commands have the full list.